CharDirectionality

enum class CharDirectionality (source)

Platform and version requirements: JVM

Represents the Unicode directionality of a character. Character directionality is used to calculate the visual ordering of text.

Enum Values

UNDEFINED

Undefined bidirectional character type. Undefined char values have undefined directionality in the Unicode specification.

LEFT_TO_RIGHT

Strong bidirectional character type "L" in the Unicode specification.

RIGHT_TO_LEFT

Strong bidirectional character type "R" in the Unicode specification.

RIGHT_TO_LEFT_ARABIC

Strong bidirectional character type "AL" in the Unicode specification.

EUROPEAN_NUMBER

Weak bidirectional character type "EN" in the Unicode specification.

EUROPEAN_NUMBER_SEPARATOR

Weak bidirectional character type "ES" in the Unicode specification.

EUROPEAN_NUMBER_TERMINATOR

Weak bidirectional character type "ET" in the Unicode specification.

ARABIC_NUMBER

Weak bidirectional character type "AN" in the Unicode specification.

COMMON_NUMBER_SEPARATOR

Weak bidirectional character type "CS" in the Unicode specification.

NONSPACING_MARK

Weak bidirectional character type "NSM" in the Unicode specification.

BOUNDARY_NEUTRAL

Weak bidirectional character type "BN" in the Unicode specification.

PARAGRAPH_SEPARATOR

Neutral bidirectional character type "B" in the Unicode specification.

SEGMENT_SEPARATOR

Neutral bidirectional character type "S" in the Unicode specification.

WHITESPACE

Neutral bidirectional character type "WS" in the Unicode specification.

OTHER_NEUTRALS

Neutral bidirectional character type "ON" in the Unicode specification.

LEFT_TO_RIGHT_EMBEDDING

Strong bidirectional character type "LRE" in the Unicode specification.

LEFT_TO_RIGHT_OVERRIDE

Strong bidirectional character type "LRO" in the Unicode specification.

RIGHT_TO_LEFT_EMBEDDING

Strong bidirectional character type "RLE" in the Unicode specification.

RIGHT_TO_LEFT_OVERRIDE

Strong bidirectional character type "RLO" in the Unicode specification.

POP_DIRECTIONAL_FORMAT

Weak bidirectional character type "PDF" in the Unicode specification.

Properties

value

val value: Int

Inherited Properties

name

val name: String

Returns the name of this enum constant, exactly as declared in its enum declaration.

ordinal

val ordinal: Int

Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).

Inherited Functions

clone

fun clone(): Any

Throws an exception since enum constants cannot be cloned. This method prevents enum classes from inheriting from Cloneable.

compareTo

fun compareTo(other: E): Int

Compares this object with the specified object for order. Returns zero if this object is equal to the specified other object, a negative number if it's less than other, or a positive number if it's greater than other.

equals

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one. Implementations must fulfil the following requirements:

hashCode

fun hashCode(): Int

Returns a hash code value for the object. The general contract of hashCode is:

toString

open fun toString(): String

Returns a string representation of the object.

Companion Object Functions

valueOf

fun valueOf(directionality: Int): CharDirectionality