LocaleDisplayNames.GetUiList Method

Definition

Return a list of information used to construct a UI list of locale names.

[Android.Runtime.Register("getUiList", "(Ljava/util/Set;ZLjava/util/Comparator;)Ljava/util/List;", "GetGetUiList_Ljava_util_Set_ZLjava_util_Comparator_Handler", ApiSince=26)]
public virtual System.Collections.Generic.IList<Android.Icu.Text.LocaleDisplayNames.UiListItem>? GetUiList (System.Collections.Generic.ICollection<Android.Icu.Util.ULocale>? localeSet, bool inSelf, Java.Util.IComparator? collator);
[<Android.Runtime.Register("getUiList", "(Ljava/util/Set;ZLjava/util/Comparator;)Ljava/util/List;", "GetGetUiList_Ljava_util_Set_ZLjava_util_Comparator_Handler", ApiSince=26)>]
abstract member GetUiList : System.Collections.Generic.ICollection<Android.Icu.Util.ULocale> * bool * Java.Util.IComparator -> System.Collections.Generic.IList<Android.Icu.Text.LocaleDisplayNames.UiListItem>
override this.GetUiList : System.Collections.Generic.ICollection<Android.Icu.Util.ULocale> * bool * Java.Util.IComparator -> System.Collections.Generic.IList<Android.Icu.Text.LocaleDisplayNames.UiListItem>

Parameters

localeSet
ICollection<ULocale>

a list of locales to present in a UI list. The casing uses the settings in the LocaleDisplayNames instance.

inSelf
Boolean

if true, compares the nameInSelf, otherwise the nameInDisplayLocale. Set depending on which field (displayLocale vs self) is to show up in the UI. If both are to show up in the UI, then it should be the one used for the primary sort order.

collator
IComparator

how to collate—should normally be Collator.getInstance(getDisplayLocale())

Returns

an ordered list of UiListItems.

Attributes

Remarks

Return a list of information used to construct a UI list of locale names.

Java documentation for android.icu.text.LocaleDisplayNames.getUiList(java.util.Set<android.icu.util.ULocale>, boolean, java.util.Comparator<java.lang.Object>).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to