Top Description Fields Constructors Methods
com.ibm.icu.text

public Class BidiRun

extends Object
Class Inheritance

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.

ICU Status
Stable since ICU 3.8.
See Also
com.ibm.icu.text.Bidi

Field Summary

Modifier and TypeField and Description
pack-priv int
pack-priv byte
pack-priv int
pack-priv int

Constructor Summary

AccessConstructor and Description
pack-priv
pack-priv
BidiRun(int start, int limit, byte embeddingLevel)

Method Summary

Modifier and TypeMethod and Description
pack-priv void
public byte
getDirection()

Get direction of run

public byte
getEmbeddingLevel()

Get level of run

public int
getLength()

Get length of run

public int
getLimit()

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

public int
getStart()

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

public boolean

Returns:

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

Check if run level is even

public boolean

Returns:

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

Check if run level is odd

public String
toString()

Overrides java.lang.Object.toString.

String to display run
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

insertRemoveback to summary
pack-priv int insertRemove
levelback to summary
pack-priv byte level
limitback to summary
pack-priv int limit
startback to summary
pack-priv int start

Constructor Detail

BidiRunback to summary
pack-priv BidiRun()
BidiRunback to summary
pack-priv BidiRun(int start, int limit, byte embeddingLevel)

Method Detail

copyFromback to summary
pack-priv void copyFrom(BidiRun run)
getDirectionback to summary
public byte getDirection()

Get direction of run

ICU Status
Stable since ICU 3.8.
getEmbeddingLevelback to summary
public byte getEmbeddingLevel()

Get level of run

ICU Status
Stable since ICU 3.8.
getLengthback to summary
public int getLength()

Get length of run

ICU Status
Stable since ICU 3.8.
getLimitback to summary
public int getLimit()

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

ICU Status
Stable since ICU 3.8.
getStartback to summary
public int getStart()

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

ICU Status
Stable since ICU 3.8.
isEvenRunback to summary
public boolean isEvenRun()

Check if run level is even

Returns:boolean

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

ICU Status
Stable since ICU 3.8.
isOddRunback to summary
public boolean isOddRun()

Check if run level is odd

Returns:boolean

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

ICU Status
Stable since ICU 3.8.
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

String to display run

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations
@Override
ICU Status
Stable since ICU 3.8.