jdk.text.Bidi — clojure-interop/java.text 1.0.5

This class implements the Unicode Bidirectional Algorithm.

A Bidi object provides information on the bidirectional reordering of the text used to create it. This is required, for example, to properly display Arabic or Hebrew text. These languages are inherently mixed directional, as they order numbers from left-to-right while ordering most other text from right-to-left.

Once created, a Bidi object can be queried to see if the text it represents is all left-to-right or all right-to-left. Such objects are very lightweight and this text is relatively easy to process.

If there are multiple runs of text, information about the runs can be accessed by indexing to get the start, limit, and level of a run. The level represents both the direction and the 'nesting level' of a directional run. Odd levels are right-to-left, while even levels are left-to-right. So for example level 0 represents left-to-right text, while level 1 represents right-to-left text, and level 2 represents left-to-right text embedded in a right-to-left run.

*-direction-default-left-to-right clj

Static Constant.

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.

type: int

*-direction-default-right-to-left clj

Static Constant.

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.

type: int

*-direction-left-to-right clj

Static Constant.

Constant indicating base direction is left-to-right.

type: int

*-direction-right-to-left clj

Static Constant.

Constant indicating base direction is right-to-left.

type: int

*reorder-visually clj

(*reorder-visually levels level-start objects object-start count)

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).

levels - an array representing the bidi level of each object - byte[] level-start - the start position in the levels array - int objects - the array of objects to be reordered into visual order - java.lang.Object[] object-start - the start position in the objects array - int count - the number of objects to reorder - int

*requires-bidi clj

(*requires-bidi text start limit)

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.

text - the text containing the characters to test - char[] start - the start of the range of characters to test - int limit - the limit of the range of characters to test - int

returns: true if the range of characters requires bidi analysis - boolean

->bidi clj

(->bidi paragraph)

(->bidi paragraph flags)

(->bidi text text-start embeddings emb-start paragraph-length flags)

Constructor.

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.

text - an array containing the paragraph of text to process. - char[] text-start - the index into the text array of the start of the paragraph. - int embeddings - an array containing embedding values for each character in the paragraph. This can be null, in which case it is assumed that there is no external embedding information. - byte[] emb-start - the index into the embedding array of the start of the paragraph. - int paragraph-length - the length of the paragraph in the text and embeddings arrays. - int flags - a collection of flags that control the algorithm. The algorithm understands the flags DIRECTION_LEFT_TO_RIGHT, DIRECTION_RIGHT_TO_LEFT, DIRECTION_DEFAULT_LEFT_TO_RIGHT, and DIRECTION_DEFAULT_RIGHT_TO_LEFT. Other values are reserved. - int

base-is-left-to-right clj

(base-is-left-to-right this)

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

returns: true if the base direction is left-to-right - boolean

create-line-bidi clj

(create-line-bidi this line-start line-limit)

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.

line-start - the offset from the start of the paragraph to the start of the line. - int line-limit - the offset from the start of the paragraph to the limit of the line. - int

returns: a Bidi object - java.text.Bidi

get-base-level clj

(get-base-level this)

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

returns: the base level - int

get-length clj

(get-length this)

Return the length of text in the line.

returns: the length of text in the line - int

get-level-at clj

(get-level-at this offset)

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

offset - the index of the character for which to return the level - int

returns: the resolved level of the character at offset - int

get-run-count clj

(get-run-count this)

Return the number of level runs.

returns: the number of level runs - int

get-run-level clj

(get-run-level this run)

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

run - the index of the run, between 0 and getRunCount() - int

returns: the level of the run - int

get-run-limit clj

(get-run-limit this run)

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.

run - the index of the run, between 0 and getRunCount() - int

returns: limit the limit of the run - int

get-run-start clj

(get-run-start this run)

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.

run - the index of the run, between 0 and getRunCount() - int

returns: the start of the run - int

left-to-right? clj

(left-to-right? this)

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

returns: true if the line is all left-to-right text and the base direction is left-to-right - boolean

mixed? clj

(mixed? this)

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.

returns: true if the line is not left-to-right or right-to-left. - boolean

right-to-left? clj

(right-to-left? this)

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

returns: true if the line is all right-to-left text, and the base direction is right-to-left - boolean

to-string clj

(to-string this)

Display the bidi internal state, used in debugging.

returns: a string representation of the object. - java.lang.String