Package org.eclipse.equinox.bidi.custom

Class StructuredTextCharTypes

java.lang.Object

org.eclipse.equinox.bidi.custom.StructuredTextCharTypes

public class StructuredTextCharTypes
extends Object

Provides services related to the bidi classification of characters.

Field Summary

Fields

Modifier and Type	Field	Description
protected StructuredTextEnvironment	environment	The environment associated with the expert.
protected IStructuredTextExpert	expert	The IStructuredTextExpert instance which created this instance.
protected StructuredTextTypeHandler	handler	The StructuredTextTypeHandler instance utilized by the expert.
protected String	text	The source text whose characters are analyzed.

Constructor Summary

Constructors

Constructor	Description
StructuredTextCharTypes(IStructuredTextExpert expert, String text)	Constructor

Method Summary

Modifier and Type	Method	Description
byte	getBidiTypeAt(int index)	Gets the directionality of the character in the original string at the specified index.
int	getDirection()	Indicates the base text direction appropriate for an instance of structured text.
int	resolveOrientation()	Gets the orientation of the component in which the text will be displayed.
void	setBidiTypeAt(int index, byte charType)	Forces a bidi type on a character.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

expert

protected final IStructuredTextExpert expert

The IStructuredTextExpert instance which created this instance.

handler

protected final StructuredTextTypeHandler handler

The StructuredTextTypeHandler instance utilized by the expert.

environment

protected final StructuredTextEnvironment environment

The environment associated with the expert.

text

protected final String text

The source text whose characters are analyzed.

Constructor Detail

StructuredTextCharTypes

public StructuredTextCharTypes(IStructuredTextExpert expert,
                               String text)

Constructor

Parameters:

expert - IStructuredTextExpert instance through which this handler is invoked. The handler can use IStructuredTextExpert methods to query items stored in the expert instance, like the current environment.

text - is the text whose characters are analyzed.

Method Detail

getDirection

public int getDirection()

Indicates the base text direction appropriate for an instance of structured text.

Returns:

the base direction of the structured text. This direction may not be the same depending on the environment and on whether the structured text contains Arabic or Hebrew letters.
The value returned is either DIR_LTR or DIR_RTL.

getBidiTypeAt

public byte getBidiTypeAt(int index)

Gets the directionality of the character in the original string at the specified index.

Parameters:

index - position of the character in the lean text

Returns:

the bidi type of the character. It is one of the values which can be returned by Character.getDirectionality(char).

setBidiTypeAt

public void setBidiTypeAt(int index,
                          byte charType)

Forces a bidi type on a character.

Parameters:

index - position of the character whose bidi type is set.

charType - bidirectional type of the character. It must be one of the values which can be returned by java.lang.Character.getDirectionality.

resolveOrientation

public int resolveOrientation()

Gets the orientation of the component in which the text will be displayed.

Returns:

the orientation as either StructuredTextEnvironment.ORIENT_LTR, StructuredTextEnvironment.ORIENT_RTL, StructuredTextEnvironment.ORIENT_UNKNOWN or StructuredTextEnvironment.ORIENT_IGNORE.