<html> <head> <title>Interface XNumberFormatter</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="XNumberFormatter-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Number_Formats" class="navimain">Devguide</a></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="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</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">util</a> :: </p> </td> </tr> <tr> <td class="title">interface XNumberFormatter</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>represents a number formatter. </dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Number_Formats">OfficeDev - Number Formats</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#attachNumberFormatsSupplier">attachNumberFormatsSupplier</a></td> <td class="imsum_right">attaches an <a href="XNumberFormatsSupplier.html">XNumberFormatsSupplier</a> to this <a href="NumberFormatter.html">NumberFormatter</a>. </td> </tr> <tr> <td class="imsum_left"><a href="#getNumberFormatsSupplier">getNumberFormatsSupplier</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#detectNumberFormat">detectNumberFormat</a></td> <td class="imsum_right">detects the number format in a string which contains a formatted number. </td> </tr> <tr> <td class="imsum_left"><a href="#convertStringToNumber">convertStringToNumber</a></td> <td class="imsum_right">converts a string which contains a formatted number into a number. </td> </tr> <tr> <td class="imsum_left"><a href="#convertNumberToString">convertNumberToString</a></td> <td class="imsum_right">converts a number into a string. </td> </tr> <tr> <td class="imsum_left"><a href="#queryColorForNumber">queryColorForNumber</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#formatString">formatString</a></td> <td class="imsum_right">converts a string into another string. </td> </tr> <tr> <td class="imsum_left"><a href="#queryColorForString">queryColorForString</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getInputString">getInputString</a></td> <td class="imsum_right">converts a number into a string with the specified format. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="attachNumberFormatsSupplier" class="membertitle">attachNumberFormatsSupplier</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>attachNumberFormatsSupplier</b>(</td> <td valign="top">[in] <a href="XNumberFormatsSupplier.html">XNumberFormatsSupplier</a></td> <td valign="bottom"> xSupplier );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>attaches an <a href="XNumberFormatsSupplier.html">XNumberFormatsSupplier</a> to this <a href="NumberFormatter.html">NumberFormatter</a>. </dd> <dd><p>This <a href="NumberFormatter.html">NumberFormatter</a> will only use the <a href="NumberFormats.html">NumberFormats</a> specified in the attached <a href="XNumberFormatsSupplier.html">XNumberFormatsSupplier</a>. Without an attached <a href="XNumberFormatsSupplier.html">XNumberFormatsSupplier</a>, no formatting is possible.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getNumberFormatsSupplier" class="membertitle">getNumberFormatsSupplier</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XNumberFormatsSupplier.html">XNumberFormatsSupplier</a></td> </tr> <tr> <td valign="top"><b>getNumberFormatsSupplier</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the attached <a href="XNumberFormatsSupplier.html">XNumberFormatsSupplier</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="detectNumberFormat" class="membertitle">detectNumberFormat</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>detectNumberFormat</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nKey,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aString )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="NotNumericException.html">NotNumericException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>detects the number format in a string which contains a formatted number. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="convertStringToNumber" class="membertitle">convertStringToNumber</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">double</td> </tr> <tr> <td valign="top"><b>convertStringToNumber</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nKey,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aString )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="NotNumericException.html">NotNumericException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>converts a string which contains a formatted number into a number. </dd> <dd><p>If this is a text format, the string will not be converted.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="convertNumberToString" class="membertitle">convertNumberToString</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>convertNumberToString</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nKey,</td> </tr> <tr> <td/><td valign="top">[in] double</td> <td valign="bottom"> fValue );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>converts a number into a string. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="queryColorForNumber" class="membertitle">queryColorForNumber</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="Color.html">Color</a></td> </tr> <tr> <td valign="top"><b>queryColorForNumber</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nKey,</td> </tr> <tr> <td/><td valign="top">[in] double</td> <td valign="bottom"> fValue,</td> </tr> <tr> <td/><td valign="top">[in] <a href="Color.html">Color</a></td> <td valign="bottom"> aDefaultColor );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the color which is specified for the given value in the number format, which is otherwise the value of <var>aDefaultColor</var>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="formatString" class="membertitle">formatString</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>formatString</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nKey,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aString );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>converts a string into another string. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="queryColorForString" class="membertitle">queryColorForString</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="Color.html">Color</a></td> </tr> <tr> <td valign="top"><b>queryColorForString</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nKey,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aString,</td> </tr> <tr> <td/><td valign="top">[in] <a href="Color.html">Color</a></td> <td valign="bottom"> aDefaultColor );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the color which is specified for the given string in the number format, which is otherwise the value of <var>aDefaultColor</var>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getInputString" class="membertitle">getInputString</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getInputString</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nKey,</td> </tr> <tr> <td/><td valign="top">[in] double</td> <td valign="bottom"> fValue );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>converts a number into a string with the specified format. </dd> <dd><p>This string can always be converted back to a number using the same format. </p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>