HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hsr.screen
Interface HsrBidiServices


public interface HsrBidiServices

The HsrBidiServices interface provides access to the bidirectional (BIDI) language properties in an HsrScreen object. An HsrBidiServices object is only necessary when using bidirectional code pages (420, 424, or 803) in 3270/5250 Sessions.


Method Summary
 char[] compressLamAlef(char[] buffer, int length, boolean isVisualLtr)
          Compresses the lam and alef chars in a string.
 String convertLogicalToVisual(String inputString, boolean isLTRImplicit, boolean isLTRVisual)
          Converts the Given String From Implicit To Visual Format and returns the Visual Format of the String
 String convertLogicalToVisual(String inputString, boolean isLTRImplicit, boolean isLTRVisual, boolean compressLamAlef)
          Converts the Given String From Implicit To Visual Format and returns the Visual Format of the String
 String convertVisualToLogical(String inputString, boolean isLTRVisual, boolean isLTRImplicit)
          Converts the Given String From Visual To Implicit Format and returns the Implicit Format of the String
 String convertVisualToLogical(String inputBuffer, boolean isLTRVisual, boolean isLTRImplicit, boolean swapchars)
          Converts the Given String From Visual To Implicit Format and returns the Implicit Format of the String
 char[] expandLamAlef(char[] UniBuff, int length, boolean visualmode)
          Expands Arabic character LamAlef into two Arabic characters Lam and Alef.
 String getArabicOrientation()
          Return whether the Arabic orientation is left-to-right ("ltr") or right-to-left ("rtl")
 char getBidiTailAttribute()
          Get tail of seen family
 boolean getRuntimeRtl()
          Returns if the runtime screen orientation has been set to right-to-left.
 void handleFEData(char[] UniBuff)
          Convert FE arabic data to 06 in order not to load BIDI classes in each file
 boolean isNumericSwap()
          Returns the current value of Numeric Swapping.
 boolean isRTLScreen()
          Returns true if screen orientation is RTL and false if not.
 boolean isSymmetricSwap()
          Returns the current value of Directional Swapping.
 String removeMarkers(String inputString)
          Removes BIDI markers such as LRM from a buffer
 String removeTail(String value)
          Removes Bidi tail attribute from the given string
 void setArabicOrientation(String orientation)
          Set the Arabic orientation either right-to-left ("rtl") or left-to-right ("ltr").
 void setNumericSwap(boolean value)
          Sets the Numeric Swapping value.
 void setRuntimeRtl(boolean value)
          Sets the screen orientation true if right-to-left and false if not.
 void setSymmetricSwap(boolean value)
          Sets the Symmetric Swapping value.
 String shapeLinuxArabicData(String inputString)
          Shapes Linux Arabic data.
 String shapeLinuxArabicData(String inputString, boolean dirText)
          Shapes Linux Arabic data.
 

Method Detail

convertLogicalToVisual

String convertLogicalToVisual(String inputString,
                              boolean isLTRImplicit,
                              boolean isLTRVisual)
Converts the Given String From Implicit To Visual Format and returns the Visual Format of the String

Parameters:
inputString -
isLTRImplicit -
isLTRVisual -
Returns:
- visual format of String

convertLogicalToVisual

String convertLogicalToVisual(String inputString,
                              boolean isLTRImplicit,
                              boolean isLTRVisual,
                              boolean compressLamAlef)
Converts the Given String From Implicit To Visual Format and returns the Visual Format of the String

Parameters:
inputString -
isLTRImplicit -
isLTRVisual -
compressLamAlef - - for enabling or disabling LAM-ALEF compression
Returns:
- visual format of String

convertVisualToLogical

String convertVisualToLogical(String inputString,
                              boolean isLTRVisual,
                              boolean isLTRImplicit)
Converts the Given String From Visual To Implicit Format and returns the Implicit Format of the String

Parameters:
inputString -
isLTRVisual -
isLTRImplicit -
Returns:
Implicit format of String.

convertVisualToLogical

String convertVisualToLogical(String inputBuffer,
                              boolean isLTRVisual,
                              boolean isLTRImplicit,
                              boolean swapchars)
Converts the Given String From Visual To Implicit Format and returns the Implicit Format of the String

Parameters:
inputBuffer -
isLTRVisual -
isLTRImplicit -
swapchars -
Returns:
- implicit format of String

expandLamAlef

char[] expandLamAlef(char[] UniBuff,
                     int length,
                     boolean visualmode)
Expands Arabic character LamAlef into two Arabic characters Lam and Alef.

Parameters:
UniBuff -
length -
visualmode -
Returns:
Character array containing Lam and Alef characters.

getArabicOrientation

String getArabicOrientation()
Return whether the Arabic orientation is left-to-right ("ltr") or right-to-left ("rtl")

Returns:
value "ltr" or "rtl"

getBidiTailAttribute

char getBidiTailAttribute()
Get tail of seen family

Returns:
- tail of seen family

getRuntimeRtl

boolean getRuntimeRtl()
Returns if the runtime screen orientation has been set to right-to-left.

Returns:
- boolean true or false

handleFEData

void handleFEData(char[] UniBuff)
Convert FE arabic data to 06 in order not to load BIDI classes in each file

Parameters:
UniBuff -

isNumericSwap

boolean isNumericSwap()
Returns the current value of Numeric Swapping.

Returns:
- boolean true or false

isRTLScreen

boolean isRTLScreen()
Returns true if screen orientation is RTL and false if not.

Returns:
- boolean true or false

isSymmetricSwap

boolean isSymmetricSwap()
Returns the current value of Directional Swapping.

Returns:
- boolean true if Symmetric Swapping, else false

removeTail

String removeTail(String value)
Removes Bidi tail attribute from the given string

Parameters:
value -
Returns:
String sans tail

setArabicOrientation

void setArabicOrientation(String orientation)
Set the Arabic orientation either right-to-left ("rtl") or left-to-right ("ltr").

Parameters:
orientation -

setNumericSwap

void setNumericSwap(boolean value)
Sets the Numeric Swapping value. Determines whether Numeric Swapping in RTL screens is enabled/disabled.

Parameters:
value -

setRuntimeRtl

void setRuntimeRtl(boolean value)
Sets the screen orientation true if right-to-left and false if not.

Parameters:
value -

setSymmetricSwap

void setSymmetricSwap(boolean value)
Sets the Symmetric Swapping value. Determines whether Symmetric Swapping in RTL screens is enabled/disabled.

Parameters:
value -

shapeLinuxArabicData

String shapeLinuxArabicData(String inputString)
Shapes Linux Arabic data.

Parameters:
inputString -

shapeLinuxArabicData

String shapeLinuxArabicData(String inputString,
                            boolean dirText)
Shapes Linux Arabic data.

Parameters:
inputString - the string to be shaped.
dirText - the value of the text direction attribute
Returns:
The shaped string.

compressLamAlef

char[] compressLamAlef(char[] buffer,
                       int length,
                       boolean isVisualLtr)
Compresses the lam and alef chars in a string.

Parameters:
buffer - the string to compress lam alef in it
length - the length of the string
isVisualLtr - the orientation of the text
Returns:
The buffer with compressed lam alef chars

removeMarkers

String removeMarkers(String inputString)
Removes BIDI markers such as LRM from a buffer


HATS 7.5.1 (201005110649)