<html> <head> <title>Struct FormatElement</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="FormatElement-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#Elements" class="navisub">Elements' Summary</a></td> <td class="navisub"><a href="#ElementDetails" class="navisub">Elements' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">i18n</a> :: </p> </td> </tr> <tr> <td class="title">struct FormatElement</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>One number format code and its attributes, returned in a sequence by <a href="XLocaleData.html">XLocaleData</a>::<a href="XLocaleData.html#getAllFormats">getAllFormats()</a>. </dd> <dd><p> Contains raw data defined in the XML locale data files. </p> </dd> <dt><b>See also</b></dt> <dd><a href="XLocaleData.html">XLocaleData</a><br> for links to DTD of XML locale data files. </dd> </dl> </td> </tr> </table> <hr> <a name="Elements"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Elements' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#formatCode">formatCode</a></td> <td class="imsum_right">The format code, for example, "YYYY-MM-DD". </td> </tr> <tr> <td class="imsum_left"><a href="#formatName">formatName</a></td> <td class="imsum_right">A name or description that is displayed in the number formatter dialog. </td> </tr> <tr> <td class="imsum_left"><a href="#formatKey">formatKey</a></td> <td class="imsum_right">A unique (within one locale) identifier. </td> </tr> <tr> <td class="imsum_left"><a href="#formatType">formatType</a></td> <td class="imsum_right">Type may be one of "short", "medium", "long". </td> </tr> <tr> <td class="imsum_left"><a href="#formatUsage">formatUsage</a></td> <td class="imsum_right">Usage category, for example, "DATE" or "FIXED_NUMBER", corresponding with <a href="KNumberFormatUsage.html">KNumberFormatUsage</a> values. </td> </tr> <tr> <td class="imsum_left"><a href="#formatIndex">formatIndex</a></td> <td class="imsum_right">The index used by the number formatter, predefined values corresponding with <a href="NumberFormatIndex.html">NumberFormatIndex</a> values. </td> </tr> <tr> <td class="imsum_left"><a href="#isDefault">isDefault</a></td> <td class="imsum_right">If a format code is the default code of a <em>formatType</em> group. </td> </tr> </table> <a name="ElementDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Elements' Details</td> </tr> <tr> <td class="imdetail"><a name="formatCode" class="membertitle">formatCode</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>formatCode</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The format code, for example, "YYYY-MM-DD". </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="formatName" class="membertitle">formatName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>formatName</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>A name or description that is displayed in the number formatter dialog. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="formatKey" class="membertitle">formatKey</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>formatKey</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>A unique (within one locale) identifier. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="formatType" class="membertitle">formatType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>formatType</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Type may be one of "short", "medium", "long". </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="formatUsage" class="membertitle">formatUsage</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>formatUsage</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Usage category, for example, "DATE" or "FIXED_NUMBER", corresponding with <a href="KNumberFormatUsage.html">KNumberFormatUsage</a> values. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="formatIndex" class="membertitle">formatIndex</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>formatIndex</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The index used by the number formatter, predefined values corresponding with <a href="NumberFormatIndex.html">NumberFormatIndex</a> values. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isDefault" class="membertitle">isDefault</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>isDefault</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>If a format code is the default code of a <em>formatType</em> group. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2009 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>