<html> <head> <title>Interface XExtendedIndexEntrySupplier</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="XExtendedIndexEntrySupplier-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Overview_and_Using_the_API#XExtendedIndexEntrySupplier" 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"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</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">i18n</a> :: </p> </td> </tr> <tr> <td class="title">interface XExtendedIndexEntrySupplier</td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XExtendedIndexEntrySupplier</strong> ┗ <a href="XIndexEntrySupplier.html">XIndexEntrySupplier</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XIndexEntrySupplier.html">XIndexEntrySupplier</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>supplies information on index entries to generate a "table of alphabetical index" for a given locale. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>This interface provides information for creating "Table of Index" </dd> <dd><p> It is derived from <a href="XIndexEntrySupplier.html">XIndexEntrySupplier</a> and provides following additional functionalities.</p> <ul> <li>Provide supported language/locale list. <li>Provide supported algorithm list. <li>Provide phonetic entry support for CJK languge. <li>Provide method to compare index entry. </ul> </dd> <dt><b/></dt> <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/Overview_and_Using_the_API#XExtendedIndexEntrySupplier">OfficeDev - Overview and Using the API - XExtendedIndexEntrySupplier</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="#getLocaleList">getLocaleList</a></td> <td class="imsum_right">Returns locale list for which the IndexEntrySupplier provides service. </td> </tr> <tr> <td class="imsum_left"><a href="#getAlgorithmList">getAlgorithmList</a></td> <td class="imsum_right">Returns index algorithm list for specific locale </td> </tr> <tr> <td class="imsum_left"><a href="#usePhoneticEntry">usePhoneticEntry</a></td> <td class="imsum_right">Checks if Phonetic Entry should be used for the locale. </td> </tr> <tr> <td class="imsum_left"><a href="#getPhoneticCandidate">getPhoneticCandidate</a></td> <td class="imsum_right">Returns phonetic candidate for index entry for the locale. </td> </tr> <tr> <td class="imsum_left"><a href="#loadAlgorithm">loadAlgorithm</a></td> <td class="imsum_right">Loads index algorithm for the locale. </td> </tr> <tr> <td class="imsum_left"><a href="#getIndexKey">getIndexKey</a></td> <td class="imsum_right">Returns index key. </td> </tr> <tr> <td class="imsum_left"><a href="#compareIndexEntry">compareIndexEntry</a></td> <td class="imsum_right">Compares index entries </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="getLocaleList" class="membertitle">getLocaleList</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">sequence< ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a> ></td> </tr> <tr> <td valign="top"><b>getLocaleList</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns locale list for which the IndexEntrySupplier provides service. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAlgorithmList" class="membertitle">getAlgorithmList</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">sequence< string ></td> </tr> <tr> <td valign="top"><b>getAlgorithmList</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> aLocale );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns index algorithm list for specific locale </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="usePhoneticEntry" class="membertitle">usePhoneticEntry</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">boolean</td> </tr> <tr> <td valign="top"><b>usePhoneticEntry</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> aLocale );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Checks if Phonetic Entry should be used for the locale. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getPhoneticCandidate" class="membertitle">getPhoneticCandidate</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>getPhoneticCandidate</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aIndexEntry,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> aLocale );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns phonetic candidate for index entry for the locale. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="loadAlgorithm" class="membertitle">loadAlgorithm</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">boolean</td> </tr> <tr> <td valign="top"><b>loadAlgorithm</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> aLocale,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aIndexAlgorithm,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nCollatorOptions );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Loads index algorithm for the locale. </dd> <dt><b>Parameter aIndexAlgorithm</b></dt> <dd>Index algorithm to be loaded. </dd> <dt><b>Parameter nCollatorOptions</b></dt> <dd>Sorting option of <a href="CollatorOptions.html">CollatorOptions</a> for comparing index entries </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if algorithm successfully loaded, <b>false</b> else. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getIndexKey" class="membertitle">getIndexKey</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>getIndexKey</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aIndexEntry,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aPhoneticEntry,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> aLocale );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns index key. </dd> <dd><p> Note that loadAlgorithm should be called before calling this function. </p> </dd> <dt><b>Parameter aIndexEntry</b></dt> <dd>Index entry </dd> <dt><b>Parameter aPhoneticEntry</b></dt> <dd>Phonetic entry </dd> <dt><b>Parameter aLocale</b></dt> <dd>Language attribute for index and phonetic entry. <br/> aLocale and the locale in loadAlgorithm may be different. In the case they are different, phonetic entry will not be used in the index key generation. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="compareIndexEntry" class="membertitle">compareIndexEntry</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">short</td> </tr> <tr> <td valign="top"><b>compareIndexEntry</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aIndexEntry1,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aPhoneticEntry1,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> aLocale1,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aIndexEntry2,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aPhoneticEntry2,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> aLocale2 );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Compares index entries </dd> <dd><p> Note that loadAlgorithm should be called before calling this function. </p> </dd> <dt><b>Parameter aIndexEntry1</b></dt> <dd/><dt><b>Parameter aIndexEntry2</b></dt> <dd>Index entries to be compared </dd> <dt><b>Parameter aPhoneticEntry1</b></dt> <dd/><dt><b>Parameter aPhoneticEntry2</b></dt> <dd>Phonetic entries to be compared </dd> <dt><b>Parameter aLocale1</b></dt> <dd/><dt><b>Parameter aLocale2</b></dt> <dd>Language attribute for index and phonetic entry. <br/> aLocale and the locale in loadAlgorithm may be different. In the case they are different, phonetic entry will not be used in the index key generation. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
3767
