com.ibm.icu.text

Enum DisplayContext

java.lang.Object

java.lang.Enum<DisplayContext>

com.ibm.icu.text.DisplayContext

All Implemented Interfaces:

Serializable, Comparable<DisplayContext>

public enum DisplayContext
extends Enum<DisplayContext>

Display context settings. Note, the specific numeric values are internal and may change.

Status:

Draft ICU 51.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DisplayContext.Type Type values for DisplayContext

Enum Constant Summary

Enum Constants

Enum Constant and Description
CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE A possible setting for CAPITALIZATION: The capitalization context if a date, date symbol or display name is to be formatted with capitalization appropriate for the beginning of a sentence.
CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE A possible setting for CAPITALIZATION: The capitalization context if a date, date symbol or display name is to be formatted with capitalization appropriate for the middle of a sentence.
CAPITALIZATION_FOR_STANDALONE A possible setting for CAPITALIZATION: The capitalization context if a date, date symbol or display name is to be formatted with capitalization appropriate for stand-alone usage such as an isolated name on a calendar page.
CAPITALIZATION_FOR_UI_LIST_OR_MENU A possible setting for CAPITALIZATION: The capitalization context if a date, date symbol or display name is to be formatted with capitalization appropriate for a user-interface list or menu item.
CAPITALIZATION_NONE A possible setting for CAPITALIZATION: The capitalization context to be used is unknown (this is the default value).
DIALECT_NAMES A possible setting for DIALECT_HANDLING: use dialect names, when generating a locale name, e.g. en_GB displays as 'British English'.
STANDARD_NAMES A possible setting for DIALECT_HANDLING: use standard names when generating a locale name, e.g. en_GB displays as 'English (United Kingdom)'.

Method Summary

Methods

Modifier and Type	Method and Description
DisplayContext.Type	type() Get the Type part of the enum item (e.g.
int	value() Get the value part of the enum item (e.g.
static DisplayContext	valueOf(String name) Returns the enum constant of this type with the specified name.
static DisplayContext[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STANDARD_NAMES

public static final DisplayContext STANDARD_NAMES

A possible setting for DIALECT_HANDLING: use standard names when generating a locale name, e.g. en_GB displays as 'English (United Kingdom)'.

Status:

Draft ICU 51.

DIALECT_NAMES

public static final DisplayContext DIALECT_NAMES

A possible setting for DIALECT_HANDLING: use dialect names, when generating a locale name, e.g. en_GB displays as 'British English'.

Status:

Draft ICU 51.

CAPITALIZATION_NONE

public static final DisplayContext CAPITALIZATION_NONE

A possible setting for CAPITALIZATION: The capitalization context to be used is unknown (this is the default value).

Status:

Draft ICU 51.

CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE

public static final DisplayContext CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE

A possible setting for CAPITALIZATION: The capitalization context if a date, date symbol or display name is to be formatted with capitalization appropriate for the middle of a sentence.

Status:

Draft ICU 51.

CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE

public static final DisplayContext CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE

A possible setting for CAPITALIZATION: The capitalization context if a date, date symbol or display name is to be formatted with capitalization appropriate for the beginning of a sentence.

Status:

Draft ICU 51.

CAPITALIZATION_FOR_UI_LIST_OR_MENU

public static final DisplayContext CAPITALIZATION_FOR_UI_LIST_OR_MENU

A possible setting for CAPITALIZATION: The capitalization context if a date, date symbol or display name is to be formatted with capitalization appropriate for a user-interface list or menu item.

Status:

Draft ICU 51.

CAPITALIZATION_FOR_STANDALONE

public static final DisplayContext CAPITALIZATION_FOR_STANDALONE

A possible setting for CAPITALIZATION: The capitalization context if a date, date symbol or display name is to be formatted with capitalization appropriate for stand-alone usage such as an isolated name on a calendar page.

Status:

Draft ICU 51.

Method Detail

values

public static DisplayContext[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DisplayContext c : DisplayContext.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DisplayContext valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

type

public DisplayContext.Type type()

Get the Type part of the enum item (e.g. CAPITALIZATION)

Status:

Draft ICU 51.

value

public int value()

Get the value part of the enum item (e.g. CAPITALIZATION_FOR_STANDALONE)

Status:

Draft ICU 51.