IlvBidiUtil (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.util.text.IlvBidiUtil

```
public class IlvBidiUtil
extends Object
```
The IlvBidiUtil class consists of static definitions and methods that are of general use when working with bidirectional text. Instances of this class cannot be created.

Since:

JViews 8.8

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ADVANCED_BIDI` System property used to control level of bidi support
`static String`	`BASE_TEXT_DIRECTION` Name of the baseTextDirection property, used by IlvSDMNodes and Links
`static int`	`COMPONENT_DIRECTION` Constant defines that the base text direction corresponds to the current component orientation
`static String`	`COMPONENT_DIRECTION_NAME` Textual notation for COMPONENT_DIRECTION
`static int`	`CONTEXTUAL_DIRECTION` Constant defines the contextual base text direction.
`static String`	`CONTEXTUAL_DIRECTION_NAME` Textual notation for CONTEXTUAL_DIRECTION
`static int`	`CONTEXTUAL_LEFT_TO_RIGHT` Constant defines the contextual base text direction with left-to-right preference.
`static String`	`CONTEXTUAL_LEFT_TO_RIGHT_NAME` Textual notation for CONTEXTUAL_LEFT_TO_RIGHT
`static int`	`CONTEXTUAL_RIGHT_TO_LEFT` Constant defines the contextual base text direction with right-to-left preference.
`static String`	`CONTEXTUAL_RIGHT_TO_LEFT_NAME` Textual notation for CONTEXTUAL_RIGHT_TO_LEFT
`static int`	`INHERITED_DIRECTION` Constant defines that the base text direction of the current object is inherited from its parent
`static String`	`INHERITED_DIRECTION_NAME` Textual notation for INHERITED_DIRECTION
`static int`	`LEFT_TO_RIGHT` Constant defines the left-to-right base text direction
`static String`	`LEFT_TO_RIGHT_NAME` Textual notation for LEFT_TO_RIGHT direction
`static String`	`LRE` Left-To-Right Embedding.
`static String`	`LRM` Simple Left-To-Right Mark.
`static String`	`PDF` Pop Directional Format.
`static int`	`RIGHT_TO_LEFT` Constant defines the right-to-left base text direction
`static String`	`RIGHT_TO_LEFT_NAME` Textual notation for RIGHT_TO_LEFT direction
`static String`	`RLE` Right-To-Left Embedding.
`static String`	`RLM` Simple Right-To-Left Mark.
`static int`	`UNDEFINED_DIRECTION` Constant used internally to show missing of base text direction definition.
`static String`	`UNDEFINED_DIRECTION_NAME` Textual notation for UNDEFINED_DIRECTION

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`bidiTransform(String str, boolean isRTL)` Returns string, transformed from Logical to Visual Left-To-Right format with symmetric swapping and reshaping of the text.
`static void`	`checkBaseTextDirectionChoice(int choice, boolean allowUndefined, boolean allowExtContextual)` Checks whether the input value is a valid base text direction choice.
`static boolean`	`checkStrongDir(String str, boolean isRTL)` Check if string started from the embedded direction mark, which corresponds to given direction.
`static AttributedString`	`getAttrStringWithMarks(AttributedString astr)` Add RLM characters to the start and end of AttributedString.
`static AttributedString`	`getAttrStringWithMarks(AttributedString astr, boolean isRTL, boolean start, boolean end)` Add simple direction marks to the start and end of AttributedString.
`static int`	`getBaseTextDirectionFromName(String baseTextDirectionName)` Returns base text direction, which corresdponds to given textual notation.
`static String`	`getBaseTextDirectionName(int baseTextDirection)` Returns textual notation of the given base text direction Allowed input values are: `UNDEFINED_DIRECTION` `INHERITED_DIRECTION` `COMPONENT_DIRECTION` `LEFT_TO_RIGHT` `RIGHT_TO_LEFT` `CONTEXTUAL_DIRECTION` `CONTEXTUAL_LEFT_TO_RIGHT` `CONTEXTUAL_RIGHT_TO_LEFT`
`static DocumentFilter`	`getBidiDocumentHandler(JTextComponent jText, ComponentOrientation co)` Return document filter fo JTextComponent, Used in case of CONTEXTUAL base text direction.
`static String`	`getCombinedString(String text, int textDirection, ComponentOrientation co, boolean override)` Returns string which is started from LRE or RLE depending on given base text direction and component orientation.
`static String`	`getDirectedSimpleHTMLText(String text, int textDirection)` If a tooltip is given as HTML specification, this method returns a HTML specification by adding Bidi control characters to the text sections (between the tags).
`static String`	`getDirectedString(String text, int textDirection)` Returns string which is started from LRE or RLE depending on given base text direction.
`static String`	`getDirectedString(String text, int textDirection, ComponentOrientation co)` Returns string which is started from LRE or RLE depending on given base text direction and component orientation.
`static String`	`getEmbeddableCombinedString(String text, int textDirection, ComponentOrientation co, boolean override)` Returns string which is started from LRE or RLE depending on given base text direction and component orientation and ended with PDF.
`static AttributedCharacterIterator`	`getIteratorWithMarks(AttributedCharacterIterator aIter)` Get AttributedCharacterIterator for AttributedString, started and ended with RLM marks.
`static AttributedCharacterIterator`	`getIteratorWithMarks(AttributedCharacterIterator aIter, boolean isRTL, boolean start, boolean end)` Get AttributedCharacterIterator for AttributedString, started and/or ended with one of simple direction marks.
`static String`	`getStringWithMarks(String str)` Returns string, which is started and ended with RLM character.
`static String`	`getStringWithMarks(String str, boolean isRTL, boolean start, boolean end)` Returns string, which is started and/or ended with one of simple direction marks.
`static String`	`getStringWithMarks(String str, boolean isRTL, boolean start, boolean end, boolean strong)` Returns string, which is started and/or ended with simple or embedded direction marks.
`static String`	`getStringWithMarks(String str, String btd)` Returns string, which is started and ended with direction marks based on given value of baseTextDirection.
`static boolean`	`isAdvancedBidiOn()` Check if advanced bidi is switched on.
`static boolean`	`isStringRTL(IlvBaseTextDirectionInterface obj, String str, ComponentOrientation co)` Returns `true` if the input text of the input object should be displayed in right-to-left direction; otherwise returns `false`.
`static boolean`	`isStringRTL(String str, ComponentOrientation co)` Determines, in which order (left-to-right or right-to-left) the given text should be displayed.
`static boolean`	`isStringRTL(String str, int defBaseTextDirection)` Determines, in which order (left-to-right or right-to-left) the given text should be displayed.
`static boolean`	`isStringRTL(String str, int bTextDirection, ComponentOrientation co)` Determines, in which order (left-to-right or right-to-left) the given text should be displayed.
`static boolean`	`isStringRTL(String str, int bTextDirection, int defBaseTextDirection)` Determines, in which order (left-to-right or right-to-left) the given text should be displayed.
`static String`	`removeAllBidiMarks(String str)` Remove bidi marks, used in JViews
`static AttributedString`	`removeMarksFromAttrString(AttributedString astr)` Removes bidi marks from the start and from the end of the given AttributedString.
`static String`	`removeMarksFromString(String str)` Removes bidi marks from the start and from the end of the string
`static void`	`setAdvancedBidiOn(boolean newValue)` Allows to switch advanced bidi off in applets.
`static void`	`setBidiDocumentHandler(JTextComponent jText, ComponentOrientation co)` Add document filter fo JTextComponent.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LRM
```
public static final String LRM
```
    Simple Left-To-Right Mark. Acts as Latin character.
    
    See Also:
    
    Constant Field Values
  - RLM
```
public static final String RLM
```
    Simple Right-To-Left Mark. Acts as Arabic or Hebrew character.
    
    See Also:
    
    Constant Field Values
  - LRE
```
public static final String LRE
```
    Left-To-Right Embedding. Treat the following text as left-to-right
    
    See Also:
    
    Constant Field Values
  - RLE
```
public static final String RLE
```
    Right-To-Left Embedding. Treats the followed text as right-to-left
    
    See Also:
    
    Constant Field Values
  - PDF
```
public static final String PDF
```
    Pop Directional Format. Ceases to influence of the last LRE/RLE
    
    See Also:
    
    Constant Field Values
  - UNDEFINED_DIRECTION
```
public static final int UNDEFINED_DIRECTION
```
    Constant used internally to show missing of base text direction definition.
    
    See Also:
    
    Constant Field Values
  - INHERITED_DIRECTION
```
public static final int INHERITED_DIRECTION
```
    Constant defines that the base text direction of the current object is inherited from its parent
    
    See Also:
    
    Constant Field Values
  - COMPONENT_DIRECTION
```
public static final int COMPONENT_DIRECTION
```
    Constant defines that the base text direction corresponds to the current component orientation
    
    See Also:
    
    Constant Field Values
  - LEFT_TO_RIGHT
```
public static final int LEFT_TO_RIGHT
```
    Constant defines the left-to-right base text direction
    
    See Also:
    
    Constant Field Values
  - RIGHT_TO_LEFT
```
public static final int RIGHT_TO_LEFT
```
    Constant defines the right-to-left base text direction
    
    See Also:
    
    Constant Field Values
  - CONTEXTUAL_DIRECTION
```
public static final int CONTEXTUAL_DIRECTION
```
    Constant defines the contextual base text direction. In this case real text direction is determined from the text itself, if it contains at least one character with the strong left-to-right or right-to-left direction. If text doesn't contain any character with the strong direction, real text direction is determined from the current component orientation of the object.
    
    See Also:
    
    Constant Field Values
  - CONTEXTUAL_LEFT_TO_RIGHT
```
public static final int CONTEXTUAL_LEFT_TO_RIGHT
```
    Constant defines the contextual base text direction with left-to-right preference. This is used internally. It is similar to CONTEXTUAL_DIRECTION: the real text direction is determined from the text itself, if it contains at least one character with the strong left-to-right or right-to-left direction. If the text doesn't contain any character with the strong direction, the real text direction is left-to-right.
    
    See Also:
    
    Constant Field Values
  - CONTEXTUAL_RIGHT_TO_LEFT
```
public static final int CONTEXTUAL_RIGHT_TO_LEFT
```
    Constant defines the contextual base text direction with right-to-left preference. This is used internally. It is similar to CONTEXTUAL_DIRECTION: the real text direction is determined from the text itself, if it contains at least one character with the strong left-to-right or right-to-left direction. If the text doesn't contain any character with the strong direction, the real text direction is right-to-left.
    
    See Also:
    
    Constant Field Values
  - UNDEFINED_DIRECTION_NAME
```
public static final String UNDEFINED_DIRECTION_NAME
```
    Textual notation for UNDEFINED_DIRECTION
    
    See Also:
    
    Constant Field Values
  - INHERITED_DIRECTION_NAME
```
public static final String INHERITED_DIRECTION_NAME
```
    Textual notation for INHERITED_DIRECTION
    
    See Also:
    
    Constant Field Values
  - COMPONENT_DIRECTION_NAME
```
public static final String COMPONENT_DIRECTION_NAME
```
    Textual notation for COMPONENT_DIRECTION
    
    See Also:
    
    Constant Field Values
  - LEFT_TO_RIGHT_NAME
```
public static final String LEFT_TO_RIGHT_NAME
```
    Textual notation for LEFT_TO_RIGHT direction
    
    See Also:
    
    Constant Field Values
  - RIGHT_TO_LEFT_NAME
```
public static final String RIGHT_TO_LEFT_NAME
```
    Textual notation for RIGHT_TO_LEFT direction
    
    See Also:
    
    Constant Field Values
  - CONTEXTUAL_DIRECTION_NAME
```
public static final String CONTEXTUAL_DIRECTION_NAME
```
    Textual notation for CONTEXTUAL_DIRECTION
    
    See Also:
    
    Constant Field Values
  - CONTEXTUAL_LEFT_TO_RIGHT_NAME
```
public static final String CONTEXTUAL_LEFT_TO_RIGHT_NAME
```
    Textual notation for CONTEXTUAL_LEFT_TO_RIGHT
    
    See Also:
    
    Constant Field Values
  - CONTEXTUAL_RIGHT_TO_LEFT_NAME
```
public static final String CONTEXTUAL_RIGHT_TO_LEFT_NAME
```
    Textual notation for CONTEXTUAL_RIGHT_TO_LEFT
    
    See Also:
    
    Constant Field Values
  - ADVANCED_BIDI
```
public static final String ADVANCED_BIDI
```
    System property used to control level of bidi support
    
    See Also:
    
    Constant Field Values
  - BASE_TEXT_DIRECTION
```
public static final String BASE_TEXT_DIRECTION
```
    Name of the baseTextDirection property, used by IlvSDMNodes and Links
    
    See Also:
    
    Constant Field Values
- Method Detail
  - checkBaseTextDirectionChoice
```
public static void checkBaseTextDirectionChoice(int choice,
                                                boolean allowUndefined,
                                                boolean allowExtContextual)
```
    Checks whether the input value is a valid base text direction choice. Throws an illegal argument exception if it is not a valid choice. Valid choices are:
    - INHERITED_DIRECTION
    - COMPONENT_DIRECTION
    - LEFT_TO_RIGHT
    - RIGHT_TO_LEFT
    - CONTEXTUAL_DIRECTION
    - UNDEFINED_DIRECTION, if the parameter allowUndefined is true.
    - CONTEXTUAL_LEFT_TO_RIGHT and CONTEXTUAL_RIGHT_TO_LEFT , if the parameter allowExtContextual is true.
    Parameters:
    
    choice - The base text direction value
    
    allowUndefined - Whether UNDEFINED_DIRECTION is allowed.
    
    allowExtContextual - Whether CONTEXTUAL_LEFT_TO_RIGHT and CONTEXTUAL_RIGHT_TO_LEFT are allowed.
  - isStringRTL
```
public static boolean isStringRTL(IlvBaseTextDirectionInterface obj,
                                  String str,
                                  ComponentOrientation co)
```
    Returns true if the input text of the input object should be displayed in right-to-left direction; otherwise returns false.
    
    Parameters:
    
    obj - The object.
    
    str - The text to be displayed.
    
    co - The component orientation.
  - isStringRTL
```
public static boolean isStringRTL(String str,
                                  int defBaseTextDirection)
```
    Determines, in which order (left-to-right or right-to-left) the given text should be displayed. Used in case of contextual base text direction.
    Parameters:
    
    str - Text
    defBaseTextDirection - Base text direction used as a default in case, if text doesn't contain any character with strong direction. May have one of the following values:
    
    LEFT_TO_RIGHT: left-to-right text direction.
    RIGHT_TO_LEFT: right-to-left text direction.
    Returns:
    
    Returns true, if given text should be displayed in right-to-left order, otherwise returns false
  - isStringRTL
```
public static boolean isStringRTL(String str,
                                  ComponentOrientation co)
```
    Determines, in which order (left-to-right or right-to-left) the given text should be displayed. Used in case of contextual base text direction.
    
    Parameters:
    
    str - Text
    
    co - ComponentOrientation of the object, containing text
    
    Returns:
    
    Returns true, if given text should be displayed in right-to-left order, otherwise returns false
    
    See Also:
    
    ComponentOrientation
  - isStringRTL
```
public static boolean isStringRTL(String str,
                                  int bTextDirection,
                                  ComponentOrientation co)
```
    Determines, in which order (left-to-right or right-to-left) the given text should be displayed.
    Parameters:
    
    str - Text
    bTextDirection - Resolved base text direction, e.g. one of the following values:
    
    LEFT_TO_RIGHT: left-to-right text direction.
    RIGHT_TO_LEFT: right-to-left text direction.
    CONTEXTUAL_DIRECTION: contextual text direction.
    co - ComponentOrientation of the object, containing text
    
    Returns:
    
    Returns true, if given text should be displayed in right-to-left order, otherwise returns false
    
    See Also:
    
    ComponentOrientation
  - isStringRTL
```
public static boolean isStringRTL(String str,
                                  int bTextDirection,
                                  int defBaseTextDirection)
```
    Determines, in which order (left-to-right or right-to-left) the given text should be displayed.
    Parameters:
    
    str - Text
    bTextDirection - Resolved base text direction, e.g. one of the following values:
    
    LEFT_TO_RIGHT: left-to-right text direction.
    RIGHT_TO_LEFT: right-to-left text direction.
    CONTEXTUAL_DIRECTION: contextual text direction.
    defBaseTextDirection - Base text direction used as a default in case, if ComponentOrientation is undefined. with strong direction. May have one of the following values:
    
    LEFT_TO_RIGHT: left-to-right text direction.
    RIGHT_TO_LEFT: right-to-left text direction.
    Returns:
    
    Returns true, if given text should be displayed in right-to-left order, otherwise returns false
  - getStringWithMarks
```
public static String getStringWithMarks(String str)
```
    Returns string, which is started and ended with RLM character.
    
    Parameters:
    
    str - Source text
    
    Returns:
    
    Text with RLM's in the start and end.
  - getStringWithMarks
```
public static String getStringWithMarks(String str,
                                        String btd)
```
    Returns string, which is started and ended with direction marks based on given value of baseTextDirection.
    Parameters:
    
    str - Source text
    btd - Resolved base text direction, e.g. one of the following values:
    
    LTR: left-to-right text direction.
    RTL: right-to-left text direction.
    CONTEXTUAL: contextual text direction.
    Returns:
    
    Text with direction marks in the start and end.
  - getStringWithMarks
```
public static String getStringWithMarks(String str,
                                        boolean isRTL,
                                        boolean start,
                                        boolean end)
```
    Returns string, which is started and/or ended with one of simple direction marks.
    
    Parameters:
    
    str - Source text
    
    isRTL - If true, RLM is added; otherwise, used LRM.
    
    start - If true, direction mark id added to the start of string.
    
    end - If true, direction mark id added to the end of string.
    
    Returns:
    
    Text with simple direction marks
  - getStringWithMarks
```
public static String getStringWithMarks(String str,
                                        boolean isRTL,
                                        boolean start,
                                        boolean end,
                                        boolean strong)
```
    Returns string, which is started and/or ended with simple or embedded direction marks.
    
    Parameters:
    
    str - Source text
    
    isRTL - If true, then rtl marks are added; otherwise, ltr marks are used.
    
    start - If true, corresponding mark id added to the start of the string.
    
    end - If true, corresponding marker id added to the end of the string.
    
    strong - If false, simple marks are added; otherwise, embedded direction marks are used.
    
    Returns:
    
    Text with simple direction marks
  - getDirectedString
```
public static String getDirectedString(String text,
                                       int textDirection,
                                       ComponentOrientation co)
```
    Returns string which is started from LRE or RLE depending on given base text direction and component orientation.
    Parameters:
    
    text - Source text
    textDirection - Resolved base text direction, one of the following:
    
    LEFT_TO_RIGHT: left-to-right base text direction.
    RIGHT_TO_LEFT: right-to-left base text direction.
    CONTEXTUAL_DIRECTION: contextual base text direction.
    co - Component orientation
    
    Returns:
    
    Text, started from LRE or RLE, depending on parameters
  - getDirectedString
```
public static String getDirectedString(String text,
                                       int textDirection)
```
    Returns string which is started from LRE or RLE depending on given base text direction.
    Parameters:
    
    text - Source text
    textDirection - Resolved base text direction, one of the following:
    
    LEFT_TO_RIGHT: left-to-right base text direction.
    RIGHT_TO_LEFT: right-to-left base text direction.
    CONTEXTUAL_LEFT_TO_RIGHT: contextual base text direction with preference left-to-right if no strongly directional character is found.
    CONTEXTUAL_RIGHT_TO_LEFT: contextual base text direction with preference right-to-left if no strongly directional character is found.
    Returns:
    
    Text, started from LRE or RLE, depending on parameters
  - getCombinedString
```
public static String getCombinedString(String text,
                                       int textDirection,
                                       ComponentOrientation co,
                                       boolean override)
```
    Returns string which is started from LRE or RLE depending on given base text direction and component orientation.
    The returned string cannot be used to construct larger strings. If you want to create a larger string through string concatenation, use getEmbeddableCombinedString(String, int, ComponentOrientation, boolean) instead of this method.
    Parameters:
    
    text - Source text
    textDirection - Resolved base text direction, one of the following:
    
    LEFT_TO_RIGHT: left-to-right base text direction.
    RIGHT_TO_LEFT: right-to-left base text direction.
    CONTEXTUAL_DIRECTION: contextual base text direction.
    co - Component orientation
    
    override - If true, previous LRE or RLE marks introduced by this method are removed first. If false, bidi marks in the source text are kept unmodified.
    
    Returns:
    
    Text, started from LRE or RLE, depending on parameters.
  - getEmbeddableCombinedString
```
public static String getEmbeddableCombinedString(String text,
                                                 int textDirection,
                                                 ComponentOrientation co,
                                                 boolean override)
```
    Returns string which is started from LRE or RLE depending on given base text direction and component orientation and ended with PDF.
    The returned string can be used as a substring of larger strings.
    Parameters:
    
    text - Source text
    textDirection - Resolved base text direction, one of the following:
    
    LEFT_TO_RIGHT: left-to-right base text direction.
    RIGHT_TO_LEFT: right-to-left base text direction.
    CONTEXTUAL_DIRECTION: contextual base text direction.
    co - Component orientation
    
    override - If true, previous LRE or RLE marks introduced by this method are removed first. If false, bidi marks in the source text are kept unmodified.
    
    Returns:
    
    Text, starting with LRE or RLE, depending on parameters, and ending with PDF.
  - getDirectedSimpleHTMLText
```
public static String getDirectedSimpleHTMLText(String text,
                                               int textDirection)
```
    If a tooltip is given as HTML specification, this method returns a HTML specification by adding Bidi control characters to the text sections (between the tags). This works only for simple HTML specifications that do not contain unnecessary white space, such as tooltips generated by IlvSwingUtil.createMultiLineToolTipText(java.lang.String[], int).
    Parameters:
    
    text - HTML source text
    textDirection - Resolved base text direction, one of the following:
    
    LEFT_TO_RIGHT: left-to-right base text direction.
    RIGHT_TO_LEFT: right-to-left base text direction.
    CONTEXTUAL_LEFT_TO_RIGHT: contextual base text direction with preference left-to-right if no strongly directional character is found.
    CONTEXTUAL_RIGHT_TO_LEFT: contextual base text direction with preference right-to-left if no strongly directional character is found.
    Returns:
    
    A HTML specification containing Bidi markers.
  - removeAllBidiMarks
```
public static String removeAllBidiMarks(String str)
```
    Remove bidi marks, used in JViews
    
    Parameters:
    
    str - Source text
    
    Returns:
    
    Text without mark
  - removeMarksFromString
```
public static String removeMarksFromString(String str)
```
    Removes bidi marks from the start and from the end of the string
    
    Parameters:
    
    str - Text started and/or ended with bidi marks
    
    Returns:
    
    Text without bidi marks in its start and end.
  - getAttrStringWithMarks
```
public static AttributedString getAttrStringWithMarks(AttributedString astr)
```
    Add RLM characters to the start and end of AttributedString. If given AttributdString already contains some bidi marks in its start and/or end, they have previously removed.
    
    Parameters:
    
    astr - Source attributed string
    
    Returns:
    
    Attributed string, started and ended with RLM charactes.
    
    See Also:
    
    AttributedString
  - getAttrStringWithMarks
```
public static AttributedString getAttrStringWithMarks(AttributedString astr,
                                                      boolean isRTL,
                                                      boolean start,
                                                      boolean end)
```
    Add simple direction marks to the start and end of AttributedString. If given AttributdString already contains some bidi marks in its start and/or end, they have previously removed.
    
    Parameters:
    
    astr - Source attributed string
    
    isRTL - If true, RLM is added; otherwise used LRM.
    
    start - If true, mark is added to the start of string.
    
    end - If true, mark is added to the end of string.
    
    Returns:
    
    Attributed string with direction marks in its start and/or end.
    
    See Also:
    
    AttributedString, IlvAttributedStringUtil
  - getIteratorWithMarks
```
public static AttributedCharacterIterator getIteratorWithMarks(AttributedCharacterIterator aIter)
```
    Get AttributedCharacterIterator for AttributedString, started and ended with RLM marks. If given AttributdString already contains some bidi marks in its start and/or end, they have previously removed.
    
    Parameters:
    
    aIter - Iterator for source AttributedString
    
    Returns:
    
    Return iterator for AttributedString, started and ended with RLM marks.
    
    See Also:
    
    AttributedString, IlvAttributedStringUtil
  - getIteratorWithMarks
```
public static AttributedCharacterIterator getIteratorWithMarks(AttributedCharacterIterator aIter,
                                                               boolean isRTL,
                                                               boolean start,
                                                               boolean end)
```
    Get AttributedCharacterIterator for AttributedString, started and/or ended with one of simple direction marks. If given AttributdString already contains some bidi marks in its start and/or end, they have previously removed.
    
    Parameters:
    
    aIter - Iterator for source AttributedString
    
    isRTL - If true, RLM marks are added; otherwise LRM marks are used.
    
    start - If true, bidi mark is added to the start of AttributedString
    
    end - If true, bidi mark is added to the end of AttributedString
    
    Returns:
    
    Return iterator for AttributedString, started and/or ended with corresponding direction marks.
    
    See Also:
    
    AttributedString, IlvAttributedStringUtil
  - removeMarksFromAttrString
```
public static AttributedString removeMarksFromAttrString(AttributedString astr)
```
    Removes bidi marks from the start and from the end of the given AttributedString.
    
    Parameters:
    
    astr - Source AttributedString
    
    Returns:
    
    AttributedString without bid marks in its start adnd end.
    
    See Also:
    
    AttributedString, IlvAttributedStringUtil
  - checkStrongDir
```
public static boolean checkStrongDir(String str,
                                     boolean isRTL)
```
    Check if string started from the embedded direction mark, which corresponds to given direction.
    
    Parameters:
    
    str - Source string
    
    isRTL - Direction of the text
    
    Returns:
    
    Return true, if string starts with the embedded direction mark, suitable for given text direction.
  - getBaseTextDirectionName
```
public static String getBaseTextDirectionName(int baseTextDirection)
```
    Returns textual notation of the given base text direction Allowed input values are:
    Parameters:
    
    baseTextDirection - The base text direction value.
    
    Returns:
    
    Textual notation of the given base text direction
  - getBaseTextDirectionFromName
```
public static int getBaseTextDirectionFromName(String baseTextDirectionName)
```
    Returns base text direction, which corresdponds to given textual notation.
    
    Parameters:
    
    baseTextDirectionName - Textual notation
    
    Returns:
    
    Corresponding base text direction
  - bidiTransform
```
public static String bidiTransform(String str,
                                   boolean isRTL)
```
    Returns string, transformed from Logical to Visual Left-To-Right format with symmetric swapping and reshaping of the text.
    
    Parameters:
    
    str - Source string
    
    isRTL - If true, source format is Logical RTL; otherwise, it is Logical LTR.
    
    Returns:
    
    Transformed string
  - isAdvancedBidiOn
```
public static boolean isAdvancedBidiOn()
```
    Check if advanced bidi is switched on.
    
    Returns:
    
    Return true if bidi is on.
  - setAdvancedBidiOn
```
public static void setAdvancedBidiOn(boolean newValue)
```
    Allows to switch advanced bidi off in applets.
    
    Parameters:
    
    newValue - New value if advanced bidi switcher.
  - getBidiDocumentHandler
```
public static DocumentFilter getBidiDocumentHandler(JTextComponent jText,
                                                    ComponentOrientation co)
```
    Return document filter fo JTextComponent, Used in case of CONTEXTUAL base text direction.
    
    Parameters:
    
    jText - JTextComponent
    
    co - ComponentOrientation, used to determine default base text direction
    
    Returns:
    
    A document filter, used for editing text in contextual format.
  - setBidiDocumentHandler
```
public static void setBidiDocumentHandler(JTextComponent jText,
                                          ComponentOrientation co)
```
    Add document filter fo JTextComponent. Used in case of CONTEXTUAL base text direction.
    
    Parameters:
    
    jText - Text component
    
    co - ComponentOrientation, used to determine default base text direction

Class IlvBidiUtil

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LRM

RLM

LRE

RLE

PDF

UNDEFINED_DIRECTION

INHERITED_DIRECTION

COMPONENT_DIRECTION

LEFT_TO_RIGHT

RIGHT_TO_LEFT

CONTEXTUAL_DIRECTION

CONTEXTUAL_LEFT_TO_RIGHT

CONTEXTUAL_RIGHT_TO_LEFT

UNDEFINED_DIRECTION_NAME

INHERITED_DIRECTION_NAME

COMPONENT_DIRECTION_NAME

LEFT_TO_RIGHT_NAME

RIGHT_TO_LEFT_NAME

CONTEXTUAL_DIRECTION_NAME

CONTEXTUAL_LEFT_TO_RIGHT_NAME

CONTEXTUAL_RIGHT_TO_LEFT_NAME

ADVANCED_BIDI

BASE_TEXT_DIRECTION

Method Detail

checkBaseTextDirectionChoice

isStringRTL

isStringRTL

isStringRTL

isStringRTL

isStringRTL

getStringWithMarks

getStringWithMarks

getStringWithMarks

getStringWithMarks

getDirectedString

getDirectedString

getCombinedString

getEmbeddableCombinedString

getDirectedSimpleHTMLText

removeAllBidiMarks

removeMarksFromString

getAttrStringWithMarks

getAttrStringWithMarks

getIteratorWithMarks

getIteratorWithMarks

removeMarksFromAttrString

checkStrongDir

getBaseTextDirectionName

getBaseTextDirectionFromName

bidiTransform

isAdvancedBidiOn

setAdvancedBidiOn

getBidiDocumentHandler

setBidiDocumentHandler