com.ibm.bidiTools.bdlayout

Class ArabicOption

  1. java.lang.Object
  2. extended bycom.ibm.bidiTools.bdlayout.ArabicOption

  1. public class ArabicOption
  2. extends java.lang.Object
This class represents ArabicOption objects and provides initial values for each shaping option.

Arabic text has some special characters that can be converted to different formats, which are characterized by four Arabic options, these options are stored in four Arabic objects. These four options constitute an ArabicOptionSet.

An ArabicOptionSet object contains a value for each of the four Arabic objects which represent the Arabic options. The four options are:

The Arabic options values are pre-defined in this class. Each one represents one possible value of one Arabic option.

For more information on Arabic Shaping options, see: Bidirectional support in IBM SDK: A user guide

Multi-threading considerations: There are no multi-threading concerns for this class because it only defines static final instances.


Field Summary

Modifier and Type Field and Description
  1. static
  2. ArabicOption
LAMALEF_ATBEGIN
Value identifying At Begin.
  1. static
  2. ArabicOption
LAMALEF_ATEND
Value identifying At End.
  1. static
  2. ArabicOption
LAMALEF_AUTO
Value identifying Auto.
  1. static
  2. ArabicOption
LAMALEF_NEAR
Value identifying Near.
  1. static
  2. ArabicOption
SEEN_AUTO
Value identifying Auto.
  1. static
  2. ArabicOption
SEEN_NEAR
Value identifying Near.
  1. static
  2. ArabicOption
TASHKEEL_AUTO
Value identifying Auto.
  1. static
  2. ArabicOption
TASHKEEL_CUSTOMIZED_ATBEGIN
Value identifying Customized At Begin.
  1. static
  2. ArabicOption
TASHKEEL_CUSTOMIZED_ATEND
Value identifying Customized At End.
  1. static
  2. ArabicOption
TASHKEEL_KEEP
Value identifying Keep Tashkeel.
  1. static
  2. ArabicOption
YEHHAMZA_AUTO
Value identifying Auto.
  1. static
  2. ArabicOption
YEHHAMZA_TWO_CELL_NEAR
Value identifying Near.

Method Summary

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

Field Detail

LAMALEF_NEAR

  1. public static final ArabicOption LAMALEF_NEAR
Value identifying Near.

When converting from visual to implicit code pages, Lam-Alef characters are expanded to Lam plus Alef consuming the blank space next to it. If no blank space is available, the Lam-Alef character remains as is in the Unicode uFExx range.

When converting from implicit to visual code pages, Lam plus Alef sequences are compressed to a unique Lam-Alef character; the space resulting from Lam-Alef compression is positioned next to each generated Lam-Alef character.


LAMALEF_ATBEGIN

  1. public static final ArabicOption LAMALEF_ATBEGIN
Value identifying At Begin.

When converting from visual to implicit code pages, Lam-Alef characters are expanded to Lam plus Alef consuming a blank space at the absolute beginning of the buffer. If no blank space is available, the Lam-Alef character remains as is in the Unicode uFExx range.

When converting from implicit to visual code pages, Lam plus Alef sequences are compressed to a unique Lam-Alef character; the space resulting from Lam-Alef compression is positioned at the absolute beginning of the buffer.


LAMALEF_ATEND

  1. public static final ArabicOption LAMALEF_ATEND
Value identifying At End.

When converting from visual to implicit code pages, Lam-Alef characters are expanded to Lam plus Alef consuming a blank space at the absolute end of the buffer. If no blank space is available, the Lam-Alef character remains as is in the Unicode uFExx range.

When converting from implicit to visual code pages, Lam plus Alef sequences are compressed to a unique Lam-Alef character; the space resulting from Lam-Alef compression is positioned at the absolute end of the buffer.


LAMALEF_AUTO

  1. public static final ArabicOption LAMALEF_AUTO
Value identifying Auto.

When converting from visual to implicit code pages, Lam-Alef characters are expanded to Lam plus Alef consuming a blank space at the beginning of the buffer with respect to the orientation, i.e. buffer[0] in case of left-to-right and buffer[length - 1] in case of right-to-left. If no blank space is available, the Lam-Alef character remains as is in the Unicode uFExx range.

When converting from implicit to visual code pages, Lam plus Alef sequences are compressed to a unique Lam-Alef character; the space resulting from Lam-Alef compression is positioned at the beginning of the buffer with respect to the orientation.


SEEN_NEAR

  1. public static final ArabicOption SEEN_NEAR
Value identifying Near.

Conversion from visual to implicit converts final forms of the Seen family represented by two characters (the three quarters shape and the Tail character) to corresponding final forms represented by one character and a space replacing the Tail. This space is positioned next to the Seen final form.

In conversion from implicit to visual, each final form of characters in the Seen family (represented by one character) is converted to the the corresponding final form of the Seen family that is represented by two characters, consuming the space next to the Seen character. If there is no space available, it will be converted to one character only which is the three quarters shape Seen.


SEEN_AUTO

  1. public static final ArabicOption SEEN_AUTO
Value identifying Auto.

Same behavior as NEAR for this release


YEHHAMZA_TWO_CELL_NEAR

  1. public static final ArabicOption YEHHAMZA_TWO_CELL_NEAR
Value identifying Near.

Conversion from visual to implicit converts each Yeh character followed by a Hamza character to a Yeh-Hamza character; the space resulting from the contraction is positioned next to the Yeh-Hamza character.

In conversion from implicit to visual, each Yeh-Hamza character is expanded to two characters (Yeh and Hamza), consuming the space located next to the original Yeh-Hamza character. If there is no space available, it will be converted to one character which is Yeh.


YEHHAMZA_AUTO

  1. public static final ArabicOption YEHHAMZA_AUTO
Value identifying Auto.

Same behavior as NEAR for this release


TASHKEEL_KEEP

  1. public static final ArabicOption TASHKEEL_KEEP
Value identifying Keep Tashkeel.

No special processing is done


TASHKEEL_CUSTOMIZED_ATBEGIN

  1. public static final ArabicOption TASHKEEL_CUSTOMIZED_ATBEGIN
Value identifying Customized At Begin.

All Tashkeel characters except for Shadda are replaced by spaces. The resulting spaces are moved to the absolute beginning of the buffer.


TASHKEEL_CUSTOMIZED_ATEND

  1. public static final ArabicOption TASHKEEL_CUSTOMIZED_ATEND
Value identifying Customized At End.

All Tashkeel characters except for Shadda are replaced by spaces. The resulting spaces are moved to the absolute end of the buffer.


TASHKEEL_AUTO

  1. public static final ArabicOption TASHKEEL_AUTO
Value identifying Auto.

Same behavior as KEEP for this release