Bidi

DIRECTION_DEFAULT_LEFT_TO_RIGHT

static val DIRECTION_DEFAULT_LEFT_TO_RIGHT: Int

Constant indicating that the base direction depends on the first strong directional character in the text according to the Unicode Bidirectional Algorithm. If no strong directional character is present, the base direction is left-to-right.

Value: -2

DIRECTION_DEFAULT_RIGHT_TO_LEFT

static val DIRECTION_DEFAULT_RIGHT_TO_LEFT: Int

Constant indicating that the base direction depends on the first strong directional character in the text according to the Unicode Bidirectional Algorithm. If no strong directional character is present, the base direction is right-to-left.

Value: -1

DIRECTION_LEFT_TO_RIGHT

static val DIRECTION_LEFT_TO_RIGHT: Int

Constant indicating base direction is left-to-right.

Value: 0

DIRECTION_RIGHT_TO_LEFT

static val DIRECTION_RIGHT_TO_LEFT: Int

Constant indicating base direction is right-to-left.

Value: 1

Bidi

Bidi(
    paragraph: String!, 
    flags: Int)

Create Bidi from the given paragraph of text and base direction.

Bidi

Bidi(paragraph: AttributedCharacterIterator!)

Create Bidi from the given paragraph of text.

The RUN_DIRECTION attribute in the text, if present, determines the base direction (left-to-right or right-to-left). If not present, the base direction is computes using the Unicode Bidirectional Algorithm, defaulting to left-to-right if there are no strong directional characters in the text. This attribute, if present, must be applied to all the text in the paragraph.

The BIDI_EMBEDDING attribute in the text, if present, represents embedding level information. Negative values from -1 to -62 indicate overrides at the absolute value of the level. Positive values from 1 to 62 indicate embeddings. Where values are zero or not defined, the base embedding level as determined by the base direction is assumed.

The NUMERIC_SHAPING attribute in the text, if present, converts European digits to other decimal digits before running the bidi algorithm. This attribute, if present, must be applied to all the text in the paragraph.

Bidi

Bidi(
    text: CharArray!, 
    textStart: Int, 
    embeddings: ByteArray!, 
    embStart: Int, 
    paragraphLength: Int, 
    flags: Int)

Create Bidi from the given text, embedding, and direction information. The embeddings array may be null. If present, the values represent embedding level information. Negative values from -1 to -61 indicate overrides at the absolute value of the level. Positive values from 1 to 61 indicate embeddings. Where values are zero, the base embedding level as determined by the base direction is assumed.

baseIsLeftToRight

fun baseIsLeftToRight(): Boolean

Return true if the base direction is left-to-right.

createLineBidi

fun createLineBidi(
    lineStart: Int, 
    lineLimit: Int
): Bidi!

Create a Bidi object representing the bidi information on a line of text within the paragraph represented by the current Bidi. This call is not required if the entire paragraph fits on one line.

getBaseLevel

fun getBaseLevel(): Int

Return the base level (0 if left-to-right, 1 if right-to-left).

getLength

fun getLength(): Int

Return the length of text in the line.

getLevelAt

fun getLevelAt(offset: Int): Int

Return the resolved level of the character at offset. If offset is < 0 or ≥ the length of the line, return the base direction level.

getRunCount

fun getRunCount(): Int

Return the number of level runs.

getRunLevel

fun getRunLevel(run: Int): Int

Return the level of the nth logical run in this line.

getRunLimit

fun getRunLimit(run: Int): Int

Return the index of the character past the end of the nth logical run in this line, as an offset from the start of the line. For example, this will return the length of the line for the last run on the line.

getRunStart

fun getRunStart(run: Int): Int

Return the index of the character at the start of the nth logical run in this line, as an offset from the start of the line.

isLeftToRight

fun isLeftToRight(): Boolean

Return true if the line is all left-to-right text and the base direction is left-to-right.

isMixed

fun isMixed(): Boolean

Return true if the line is not left-to-right or right-to-left. This means it either has mixed runs of left-to-right and right-to-left text, or the base direction differs from the direction of the only run of text.

isRightToLeft

fun isRightToLeft(): Boolean

Return true if the line is all right-to-left text, and the base direction is right-to-left.

reorderVisually

static fun reorderVisually(
    levels: ByteArray!, 
    levelStart: Int, 
    objects: Array<Any!>!, 
    objectStart: Int, 
    count: Int
): Unit

Reorder the objects in the array into visual order based on their levels. This is a utility function to use when you have a collection of objects representing runs of text in logical order, each run containing text at a single level. The elements at index from objectStart up to objectStart + count in the objects array will be reordered into visual order assuming each run of text has the level indicated by the corresponding element in the levels array (at index - objectStart + levelStart).

requiresBidi

static fun requiresBidi(
    text: CharArray!, 
    start: Int, 
    limit: Int
): Boolean

Return true if the specified text requires bidi analysis. If this returns false, the text will display left-to-right. Clients can then avoid constructing a Bidi object. Text in the Arabic Presentation Forms area of Unicode is presumed to already be shaped and ordered for display, and so will not cause this function to return true.

toString

fun toString(): String

Display the bidi internal state, used in debugging.