|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.icu.text.IndexCharacters
public class IndexCharacters
A set of characters for use as a UI "index", that is, a list of clickable characters (or character sequences) that allow the user to see a segment of a larger "target" list. That is, each character corresponds to a bucket in the target list, where everything in the bucket is greater than or equal to the character (according to the locale's collation). The intention is to have two main functions; one that produces an index list that is relatively static, and the other is a list that produces roughly equally-sized buckets. Only the first is currently provided.
The static list would be presented as something like
A B C D E F G H I J K L M N O P Q R S T U V W X Y ZIn the UI, an index character could be omitted if its bucket is empty. For example, if there is nothing in the bucket for Q, then Q could be omitted.
Important Notes:
Constructor Summary | |
---|---|
IndexCharacters(ULocale locale)
Create the index object. |
|
IndexCharacters(ULocale locale,
UnicodeSet exemplarSet,
Collator collator)
Deprecated. This API is ICU internal only. |
Method Summary | |
---|---|
Map<String,Set<String>> |
getAlreadyIn()
Deprecated. This API is ICU internal only. |
Collection<String> |
getIndexCharacters()
Get the index characters. |
ULocale |
getLocale()
Get the locale |
List<String> |
getNoDistinctSorting()
Deprecated. This API is ICU internal only. |
List<String> |
getNotAlphabetic()
Deprecated. This API is ICU internal only. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IndexCharacters(ULocale locale)
locale
- The locale to be passed.public IndexCharacters(ULocale locale, UnicodeSet exemplarSet, Collator collator)
Method Detail |
---|
public Collection<String> getIndexCharacters()
public ULocale getLocale()
public Map<String,Set<String>> getAlreadyIn()
public List<String> getNoDistinctSorting()
public List<String> getNotAlphabetic()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |