psdi.iface.bidi.core

Class BidiAttributes

java.lang.Object

psdi.iface.bidi.core.BidiAttributes

public class BidiAttributes
extends java.lang.Object

Class for storing Bidi attributes to control text transformation. The class adapts the fail-safe parameters passing; i.e., null parameters are initialized by default values.

Author:

Hatim Mohammed (hatim@eg.ibm.com) -- Based on code by Mohamed El-Khouly (khouly@eg.ibm.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BidiAttributes.NumeralsShaping Numerals; unspecified, national, nominal (default), contextual_national, contextual_nominal
static class	BidiAttributes.TextOrientation Text orientation; LTR (default), RTL, Contextual_LTR, or Contextual_RTL
static class	BidiAttributes.TextShaping Text shaping; unspecified, shaped, unshaped (default), or tashkeel_isolated
static class	BidiAttributes.TextSymSwapping Text Symmetric Swapping; Disabled, Enabled (default)
static class	BidiAttributes.TextType Text type; Logical (default), or Visual

Constructor Summary

Constructors

Constructor and Description
BidiAttributes() Default class constructor creates with the default initialization in place.
BidiAttributes(BidiAttributes.TextType type, BidiAttributes.TextOrientation orientation) Class constructor setting text type and orientation and assuming default values for the rest of the attributes.
BidiAttributes(BidiAttributes.TextType type, BidiAttributes.TextOrientation orientation, BidiAttributes.TextShaping shaping, BidiAttributes.NumeralsShaping numerals) Class constructor setting all five attributes as passed parameters, and assuming ON symmetric swapping as default.
BidiAttributes(BidiAttributes.TextType type, BidiAttributes.TextOrientation orientation, BidiAttributes.TextSymSwapping swapping, BidiAttributes.TextShaping shaping, BidiAttributes.NumeralsShaping numerals) Class constructor setting all five attributes as passed parameters, and assuming symmetric swapping as an enumeration value.
BidiAttributes(BidiAttributes.TextType type, BidiAttributes.TextOrientation orientation, boolean swapping) Class constructor setting text type, orientation and symmetric swapping, and assuming default values for the rest of the attributes.
BidiAttributes(BidiAttributes.TextType type, BidiAttributes.TextOrientation orientation, boolean swapping, BidiAttributes.TextShaping shaping, BidiAttributes.NumeralsShaping numerals) Class constructor setting all five attributes as passed parameters, and assuming symmetric swapping as boolean value.
BidiAttributes(java.lang.String bidiFlags) Class constructor setting attributes using IBM Java SDK Bidi flag set as passed parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object attrs) Compares the passed attributes with this and returns true if identical
boolean	equalsIgnoreSwapping(BidiAttributes attrs) Compares the passed attributes with this ignoring the Symmetric Swapping field
BidiAttributes.NumeralsShaping	getNumeralsShaping() returns the parameter representing numeral shaping
BidiAttributes.TextOrientation	getTextOrientation() returns the parameter representing orientation
BidiAttributes.TextShaping	getTextShaping() returns the parameter representing textShaping
BidiAttributes.TextSymSwapping	getTextSymSwapping() returns the parameter representing swapping
BidiAttributes.TextType	getTextType() returns the parameter representing textType
int	hashCode()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BidiAttributes

public BidiAttributes()

Default class constructor creates with the default initialization in place.

BidiAttributes

public BidiAttributes(BidiAttributes.TextType type,
                      BidiAttributes.TextOrientation orientation)
               throws BidiTransformationException

Class constructor setting text type and orientation and assuming default values for the rest of the attributes.

Parameters:

type - BidiAttributes.TextType enumeration value

orientation - BidiAttributes.TextOrientation enumeration value

Throws:

BidiTransformationException - if text type and orientation combination is invalid

BidiAttributes

public BidiAttributes(BidiAttributes.TextType type,
                      BidiAttributes.TextOrientation orientation,
                      boolean swapping)
               throws BidiTransformationException

Class constructor setting text type, orientation and symmetric swapping, and assuming default values for the rest of the attributes.

Parameters:

type - BidiAttributes.TextType enumeration value

orientation - BidiAttributes.TextOrientation enumeration value

swapping - BidiAttributes.TextSymSwapping enumeration value

Throws:

BidiTransformationException - if initialization attributes are invalid

BidiAttributes

public BidiAttributes(BidiAttributes.TextType type,
                      BidiAttributes.TextOrientation orientation,
                      boolean swapping,
                      BidiAttributes.TextShaping shaping,
                      BidiAttributes.NumeralsShaping numerals)
               throws BidiTransformationException

Class constructor setting all five attributes as passed parameters, and assuming symmetric swapping as boolean value.

Parameters:

type - BidiAttributes.TextType enumeration value

orientation - BidiAttributes.TextOrientation enumeration value

swapping - boolean for swapping On/Off

shaping - BidiAttributes.TextShaping enumeration value

numerals - BidiAttributes.NumeralsShaping enumeration value

Throws:

BidiTransformationException - if initialization attributes are invalid

BidiAttributes

public BidiAttributes(BidiAttributes.TextType type,
                      BidiAttributes.TextOrientation orientation,
                      BidiAttributes.TextSymSwapping swapping,
                      BidiAttributes.TextShaping shaping,
                      BidiAttributes.NumeralsShaping numerals)
               throws BidiTransformationException

Class constructor setting all five attributes as passed parameters, and assuming symmetric swapping as an enumeration value.

Parameters:

type - BidiAttributes.TextType enumeration value

orientation - BidiAttributes.TextOrientation enumeration value

swapping - BidiAttributes.TextSymSwapping enumeration value

shaping - BidiAttributes.TextShaping enumeration value

numerals - BidiAttributes.NumeralsShaping enumeration value

Throws:

BidiTransformationException - if initialization attributes are invalid

BidiAttributes

public BidiAttributes(BidiAttributes.TextType type,
                      BidiAttributes.TextOrientation orientation,
                      BidiAttributes.TextShaping shaping,
                      BidiAttributes.NumeralsShaping numerals)
               throws BidiTransformationException

Class constructor setting all five attributes as passed parameters, and assuming ON symmetric swapping as default.

Parameters:

type - BidiAttributes.TextType enumeration value

orientation - BidiAttributes.TextOrientation enumeration value

shaping - BidiAttributes.TextShaping enumeration value

numerals - BidiAttributes.NumeralsShaping enumeration value

Throws:

BidiTransformationException - if initialization attributes are invalid

BidiAttributes

public BidiAttributes(java.lang.String bidiFlags)
               throws BidiTransformationException

Class constructor setting attributes using IBM Java SDK Bidi flag set as passed parameters.

Parameters:

bidiFlags - String-based attributes according to IBM Java SDK. BidiFlags

Throws:

BidiTransformationException - if the flag set is invalid

Method Detail

getTextType

public final BidiAttributes.TextType getTextType()

returns the parameter representing textType

Returns:

the textType

getTextOrientation

public final BidiAttributes.TextOrientation getTextOrientation()

returns the parameter representing orientation

Returns:

the orientation

getTextSymSwapping

public final BidiAttributes.TextSymSwapping getTextSymSwapping()

returns the parameter representing swapping

Returns:

the swapping

getTextShaping

public final BidiAttributes.TextShaping getTextShaping()

returns the parameter representing textShaping

Returns:

the textShaping

getNumeralsShaping

public final BidiAttributes.NumeralsShaping getNumeralsShaping()

returns the parameter representing numeral shaping

Returns:

the numerals

equalsIgnoreSwapping

public final boolean equalsIgnoreSwapping(BidiAttributes attrs)

Compares the passed attributes with this ignoring the Symmetric Swapping field

Parameters:

attrs - BidiAttributes to compare to

Returns:

true if identical BidiAttributes

equals

public final boolean equals(java.lang.Object attrs)

Compares the passed attributes with this and returns true if identical

Overrides:

equals in class java.lang.Object

Parameters:

attrs - BidiAttributes to compare to

Returns:

true if identical BidiAttributes

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object