|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.bidiTools.bdlayout.ArabicOptionSet
public class ArabicOptionSet
This class represents an ArabicOptionSet object defining the shaping attributes to be used during Bidi Layout Transformation process. It also defines the available values for each option.
Arabic text has some special characters that can be converted to different formats, which are characterized by four Bidi 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:
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, since it only defines static final instances.
Constructor Summary | |
---|---|
ArabicOptionSet()
Constructs an ArabicOptionSet with the default value. |
|
ArabicOptionSet(ArabicOption option)
Constructs an ArabicOptionSet from one ArabicOption. |
|
ArabicOptionSet(ArabicOption option1,
ArabicOption option2)
Constructs an ArabicOptionSet from two ArabicOptions. |
|
ArabicOptionSet(ArabicOption option1,
ArabicOption option2,
ArabicOption option3)
Constructs an ArabicOptionSet from three ArabicOptions. |
|
ArabicOptionSet(ArabicOption option1,
ArabicOption option2,
ArabicOption option3,
ArabicOption option4)
Constructs an ArabicOptionSet from four ArabicOptions. |
|
ArabicOptionSet(ArabicOptionSet set)
Constructs an ArabicOptionSet based on an existing ArabicOptionSet. |
|
ArabicOptionSet(char[] chars)
Constructs an ArabicOptionSet from a char array. |
Method Summary | |
---|---|
boolean |
equals(ArabicOptionSet other)
Compares two ArabicOptionSets. |
ArabicOption |
getLamAlefMode()
Returns the Lam Alef option from an ArabicOptionSet. |
ArabicOption |
getSeenMode()
Returns the Seen option from an ArabicOptionSet. |
ArabicOption |
getTashkeelMode()
Returns the Tashkeel option from an ArabicOptionSet. |
ArabicOption |
getYehHamzaMode()
Returns the Yeh Hamza option from an ArabicOptionSet. |
int |
hashCode()
Returns a hashcode for an ArabicOptionSet. |
void |
setAllOptions(ArabicOptionSet set)
Sets all Arabic options based on another ArabicOptionSet. |
void |
setOneOption(ArabicOption newoption)
Sets a new value for one of the Bidi Options in a set without changing the other Arabic Options. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ArabicOptionSet()
Auto for all options
public ArabicOptionSet(ArabicOptionSet set)
set
- The ArabicOptionSet which is copied.public ArabicOptionSet(ArabicOption option)
Example:
ArabicOptionset bdOpts = new ArabicOptionSet(LAMALEF_NEAR);
option
- The ArabicOption which is explicitly specified.public ArabicOptionSet(ArabicOption option1, ArabicOption option2)
Example:
ArabicOptionset bdOpts = new ArabicOptionSet(LAMALEF_NEAR, SEEN_NEAR);
option1
- The first ArabicOption which is explicitly specified.option2
- The second ArabicOption which is explicitly specified.
java.lang.IllegalArgumentException
- If the arguments conflict or are duplicates.public ArabicOptionSet(ArabicOption option1, ArabicOption option2, ArabicOption option3)
Example:
ArabicOptionset bdOpts = new ArabicOptionSet(LAMALEF_NEAR, SEEN_NEAR, YEHHAMZA_TWO_CELL_NEAR);
option1
- The first ArabicOption which is explicitly specified.option2
- The second ArabicOption which is explicitly specified.option3
- The third ArabicOption which is explicitly specified.
java.lang.IllegalArgumentException
- If the arguments conflict or are duplicates.public ArabicOptionSet(ArabicOption option1, ArabicOption option2, ArabicOption option3, ArabicOption option4)
option1
- The first ArabicOption which is explicitly specified.option2
- The second ArabicOption which is explicitly specified.option3
- The third ArabicOption which is explicitly specified.option4
- The fourth ArabicOption which is explicitly specified.
java.lang.IllegalArgumentException
- If the arguments conflict or are duplicates.public ArabicOptionSet(char[] chars)
Only characters 7 to 10 are used to build the ArabicOptionSet.
chars
- character array in Convert parms format. It contains the
output options specified in the Bidi environment variableMethod Detail |
---|
public boolean equals(ArabicOptionSet other)
other
- The ArabicOptionSet to compare to this.
public ArabicOption getLamAlefMode()
The expected value is one of LAMALEF_NEAR, LAMALEF_ATBEGIN, LAMALEF_ATEND or LAMALEF_AUTO
public ArabicOption getSeenMode()
The expected value is one of SEEN_NEAR or SEEN_AUTO.
public ArabicOption getYehHamzaMode()
The expected value is one of YEHHAMZA_TWO_CELL_NEAR or YEHHAMZA_AUTO.
public ArabicOption getTashkeelMode()
The expected value is one of TASHKEEL_KEEP, TASHKEEL_CUSTOMIZED_ATBEGIN, TASHKEEL_CUSTOMIZED_ATEND or TASHKEEL_AUTO.
public int hashCode()
hashCode
in class java.lang.Object
public void setAllOptions(ArabicOptionSet set)
set
- The ArabicOptionSet which is copied.public void setOneOption(ArabicOption newoption)
The new value must be one of the pre-defined values for ArabicOption.
newoption
- The new value requested for one of the options.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |