com.ibm.icu.text

Class BidiRun

java.lang.Object

com.ibm.icu.text.BidiRun

public class BidiRun
extends Object

A BidiRun represents a sequence of characters at the same embedding level. The Bidi algorithm decomposes a piece of text into sequences of characters at the same embedding level, each such sequence is called a "run".

A BidiRun represents such a run by storing its essential properties, but does not duplicate the characters which form the run.

The "limit" of the run is the position just after the last character, i.e., one more than that position.

This class has no public constructor, and its members cannot be modified by users.

See Also:

Bidi

Status:

Stable ICU 3.8.

Method Summary

Modifier and Type	Method and Description
byte	getDirection() Get direction of run
byte	getEmbeddingLevel() Get level of run
int	getLength() Get length of run
int	getLimit() Get position of one character after the end of the run in the source text
int	getStart() Get the first logical position of the run in the source text
boolean	isEvenRun() Check if run level is even
boolean	isOddRun() Check if run level is odd
String	toString() String to display run

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getStart

public int getStart()

Get the first logical position of the run in the source text

Status:

Stable ICU 3.8.

getLimit

public int getLimit()

Get position of one character after the end of the run in the source text

Status:

Stable ICU 3.8.

getLength

public int getLength()

Get length of run

Status:

Stable ICU 3.8.

getEmbeddingLevel

public byte getEmbeddingLevel()

Get level of run

Status:

Stable ICU 3.8.

isOddRun

public boolean isOddRun()

Check if run level is odd

Returns:

true if the embedding level of this run is odd, i.e. it is a right-to-left run.

Status:

Stable ICU 3.8.

isEvenRun

public boolean isEvenRun()

Check if run level is even

Returns:

true if the embedding level of this run is even, i.e. it is a left-to-right run.

Status:

Stable ICU 3.8.

getDirection

public byte getDirection()

Get direction of run

Status:

Stable ICU 3.8.

toString

public String toString()

String to display run

Overrides:

toString in class Object

Status:

Stable ICU 3.8.