com.ibm.eNetwork.ECL
Interface ECLPSBIDIServices


public interface ECLPSBIDIServices

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

See Also:
ECLPS.GetPSBIDIServices()

Field Summary
static java.lang.String CONTEXTUAL
          Numerals Shape property value - CONTEXTUAL, this value only applies to Arabic hosts
static java.lang.String LAMALEF_OFF
          LamAlef property value - LAMALEFOFF, this value only applies to Arabic 5250 hosts
static java.lang.String LAMALEF_ON
          LamAlef property value - LAMALEFON, this value only applies to Arabic 5250 hosts
static java.lang.String LEFT_TO_RIGHT
          TextOrientation property value - LEFTTORIGHT
static java.lang.String LOGICAL
          TextType property value - LOGICAL
static java.lang.String NATIONAL
          Numerals Shape property value - NATIONAL, this value only applies to Arabic hosts
static java.lang.String NOMINAL
          Numerals Shape property value - NOMINAL, this value only applies to Arabic hosts
static java.lang.String RIGHT_TO_LEFT
          TextOrientation property value - RIGHTTOLEFT
static java.lang.String ROUNDTRIP_OFF
          RoundTrip property value - OFF
static java.lang.String ROUNDTRIP_ON
          RoundTrip property value - ON
static java.lang.String VISUAL
          TextType property value - VISUAL
 
Method Summary
 java.lang.String ConvertLogicalToVisual(java.lang.String inputBuffer, boolean isLTRImplicit, boolean isLTRVisual)
          Converts the Given String From Implicit To Visual Format and returns the Visual Format of the String
 java.lang.String ConvertVisualToLogical(java.lang.String inputBuffer, boolean isLTRVisual, boolean isLTRImplicit)
          Converts the Given String From Visual To Implicit Format and returns the Implicit Format of the String
 java.lang.String GetLamAlef()
          Returns the current value of the LamAlef property.
 java.lang.String GetNumeralShape()
          Determines whether numeral shape is Nominal, National or Contextual for string which will be sent to the presentation space by the ECLPS.SetString() and the ECLPS.SetText() methods.
 boolean getNumericSwap()
          Returns the current value of Numeric Swapping.
 java.lang.String GetRoundTrip()
          Determines whether RoundTrip is on or off for string which will be sent to the presentation space by the ECLPS.SetString() and the ECLPS.SetText() methods.
 boolean getSymmetricSwap()
          Returns the current value of Directional Swapping.
 java.lang.String GetTextOrientation()
          Determines whether text orientation is Left To Right or Right To Left for string which will be sent to the presentation space by the ECLPS.SetString() and the ECLPS.SetText() methods
 java.lang.String GetTextType()
          Determines whether text type is Visual or Logical for string which will be sent to the presentation space by the ECLPS.SetString() and the ECLPS.SetText() methods.
 boolean is5250AutoEnterField(int pos)
           
 boolean isAutoReversed()
          Returns true, if mode AutoReverse is ON, and false, if OFF
 boolean IsBIDINumericField(int pos)
          Returns true, if current field is Numeric, and false, if not.
 boolean isField5250RTL(int pos)
          Returns true, if orientation of Field in 5250 Session is RTL, and false, if not
 boolean isFieldReversed()
          Returns true, if current field is reversed, and false, if not
 boolean IsNumericField(int value)
          Returns true, if current field is Numeric and false, if not.
 boolean isPushMode()
           
 boolean isRTLScreen()
          Returns true, if Screen orientation is RTL and false, if not
 void processFirstNumericField(int value)
          Sets the cursor position of the first active numeric field to properly position.
 void SetBIDICursorPos(int pos)
          Sets the cursor position to the specified row and column.
 void SetBIDICursorPos(int pos, boolean flag)
           
 void SetBIDICursorPos(int row, int col)
          Sets the BIDI cursor position to the specified linear position.
 void setFieldReverse(boolean frev)
           
 void SetLamAlef(java.lang.String tt)
          Sets the LamAlef property.
 void SetNumeralShape(java.lang.String ns)
          Sets whether numeral shape is Nominal, National or Contextual for string which will be sent to the presentation space by the ECLPS.SetString() and the ECLPS.SetText() methods.
 void setNumericFromSC()
           
 void setNumericSwap(boolean value)
          Sets the Numeric Swapping value.Determines whether Numeric Swapping in RTL screens is enabled/disabled.
 void SetRoundTrip(java.lang.String to)
          Sets whether RoundTrip is on or off for string which will be sent to the presentation space by the ECLPS.SetString() and the ECLPS.SetText() methods.
 void setSymmetricSwap(boolean value)
          Sets the Symmetric Swapping value (Directional Swapping).
 void SetTextOrientation(java.lang.String to)
          Sets whether text orientation is Left To Right or Right To Left for string which will be sent to the presentation space by the ECLPS.SetString() and the ECLPS.SetText() methods.
 void SetTextType(java.lang.String tt)
          Sets whether text type is Visual or Logical for string which will be sent to the presentation space by the ECLPS.SetString() and the ECLPS.SetText() methods.
 void shapeMacro(boolean value)
           
 

Field Detail

NOMINAL

public static final java.lang.String NOMINAL
Numerals Shape property value - NOMINAL, this value only applies to Arabic hosts

NATIONAL

public static final java.lang.String NATIONAL
Numerals Shape property value - NATIONAL, this value only applies to Arabic hosts

CONTEXTUAL

public static final java.lang.String CONTEXTUAL
Numerals Shape property value - CONTEXTUAL, this value only applies to Arabic hosts

VISUAL

public static final java.lang.String VISUAL
TextType property value - VISUAL

LOGICAL

public static final java.lang.String LOGICAL
TextType property value - LOGICAL

LEFT_TO_RIGHT

public static final java.lang.String LEFT_TO_RIGHT
TextOrientation property value - LEFTTORIGHT

RIGHT_TO_LEFT

public static final java.lang.String RIGHT_TO_LEFT
TextOrientation property value - RIGHTTOLEFT

LAMALEF_ON

public static final java.lang.String LAMALEF_ON
LamAlef property value - LAMALEFON, this value only applies to Arabic 5250 hosts

LAMALEF_OFF

public static final java.lang.String LAMALEF_OFF
LamAlef property value - LAMALEFOFF, this value only applies to Arabic 5250 hosts

ROUNDTRIP_ON

public static final java.lang.String ROUNDTRIP_ON
RoundTrip property value - ON

ROUNDTRIP_OFF

public static final java.lang.String ROUNDTRIP_OFF
RoundTrip property value - OFF
Method Detail

SetNumeralShape

public void SetNumeralShape(java.lang.String ns)
                     throws ECLErr
Sets whether numeral shape is Nominal, National or Contextual for string which will be sent to the presentation space by the ECLPS.SetString() and the ECLPS.SetText() methods. This method only applies to Arabic Hosts.
Parameters:
ns - Can be one of the following string constants:
  • NOMINAL
  • NATIONAL
  • CONTEXTUAL
Throws:
ECLErr - Thrown if the specified value is invalid.
See Also:
GetNumeralShape(), NOMINAL, NATIONAL, CONTEXTUAL

GetNumeralShape

public java.lang.String GetNumeralShape()
Determines whether numeral shape is Nominal, National or Contextual for string which will be sent to the presentation space by the ECLPS.SetString() and the ECLPS.SetText() methods.
See Also:
SetNumeralShape(java.lang.String)

SetTextType

public void SetTextType(java.lang.String tt)
                 throws ECLErr
Sets whether text type is Visual or Logical for string which will be sent to the presentation space by the ECLPS.SetString() and the ECLPS.SetText() methods.
Parameters:
tt - Can be one of the following string constants:
  • VISUAL
  • LOGICAL
Throws:
ECLErr - Thrown if the specified value is invalid.
See Also:
GetTextType(), VISUAL, LOGICAL

GetTextType

public java.lang.String GetTextType()
Determines whether text type is Visual or Logical for string which will be sent to the presentation space by the ECLPS.SetString() and the ECLPS.SetText() methods.
See Also:
SetTextType(java.lang.String), VISUAL, LOGICAL

SetTextOrientation

public void SetTextOrientation(java.lang.String to)
                        throws ECLErr
Sets whether text orientation is Left To Right or Right To Left for string which will be sent to the presentation space by the ECLPS.SetString() and the ECLPS.SetText() methods.
Parameters:
to - Can be one of the following string constants:
  • LEFT_TO_RIGHT
  • RIGHT_TO_LEFT
Throws:
ECLErr - Thrown if the specified value is invalid.
See Also:
GetTextOrientation(), LEFT_TO_RIGHT, RIGHT_TO_LEFT

GetTextOrientation

public java.lang.String GetTextOrientation()
Determines whether text orientation is Left To Right or Right To Left for string which will be sent to the presentation space by the ECLPS.SetString() and the ECLPS.SetText() methods
See Also:
SetTextOrientation(java.lang.String), LEFT_TO_RIGHT, RIGHT_TO_LEFT

SetRoundTrip

public void SetRoundTrip(java.lang.String to)
                  throws ECLErr
Sets whether RoundTrip is on or off for string which will be sent to the presentation space by the ECLPS.SetString() and the ECLPS.SetText() methods.
Parameters:
to - Can be one of the following string constants:
  • ROUNDTRIP_ON
  • ROUNDTRIP_OFF
Throws:
ECLErr - Thrown if the specified value is invalid.
See Also:
GetRoundTrip(), ROUNDTRIP_ON, ROUNDTRIP_OFF

GetRoundTrip

public java.lang.String GetRoundTrip()
Determines whether RoundTrip is on or off for string which will be sent to the presentation space by the ECLPS.SetString() and the ECLPS.SetText() methods.
See Also:
SetRoundTrip(java.lang.String), ROUNDTRIP_ON, ROUNDTRIP_OFF

SetBIDICursorPos

public void SetBIDICursorPos(int pos,
                             boolean flag)
                      throws ECLErr

SetBIDICursorPos

public void SetBIDICursorPos(int pos)
                      throws ECLErr
Sets the cursor position to the specified row and column. Also sets the Keyboard layer and OIA according to the current field type and Screen orientation
Parameters:
row - The new row coordinate of the cursor position. This number must be between 1 and the number of rows in the presentation space inclusive.
column - The new column coordinate of the cursor position. This number must be between 1 and the number of columns in the presentation space inclusive.
Throws:
ECLErr - Thrown when the coordinates given are out of range.
See Also:
SetBIDICursorPos(int)

SetBIDICursorPos

public void SetBIDICursorPos(int row,
                             int col)
                      throws ECLErr
Sets the BIDI cursor position to the specified linear position. Also sets the Keyboard layer and OIA according to the current field type and Screen orientation
Parameters:
pos - The new linear cursor position. This number must be between 1 and the size of the presentation space inclusive.
Throws:
ECLErr - Thrown when the given position is out of range.
See Also:
SetBIDICursorPos(int, int)

SetLamAlef

public void SetLamAlef(java.lang.String tt)
                throws ECLErr
Sets the LamAlef property. This method Enables/Disables the Allocate Space for LamAlef option. This method only applies to Arabic 5250 Hosts.
Parameters:
tt - Can be one of the following string constants:
  • LAMALEFON
  • LAMALEFOFF
Throws:
ECLErr - Thrown if the specified value is invalid.
See Also:
GetLamAlef(), LAMALEF_ON, LAMALEF_OFF

GetLamAlef

public java.lang.String GetLamAlef()
Returns the current value of the LamAlef property.
See Also:
SetLamAlef(java.lang.String), LAMALEF_ON, LAMALEF_OFF

setNumericSwap

public void setNumericSwap(boolean value)
Sets the Numeric Swapping value.Determines whether Numeric Swapping in RTL screens is enabled/disabled. This method only applies to Arabic 3270 sessions.
Parameters:
value - The new Numeric Swapping value
See Also:
setNumericSwap(boolean)

getNumericSwap

public boolean getNumericSwap()
Returns the current value of Numeric Swapping.
See Also:
setNumericSwap(boolean)

setSymmetricSwap

public void setSymmetricSwap(boolean value)
Sets the Symmetric Swapping value (Directional Swapping). Determines whether Symmteric Swapping in RTL screens is enabled/disabled. This method only applies to Arabic 3270 sessions.
Parameters:
value - The new Symmetric Swapping value
See Also:
setSymmetricSwap(boolean)

getSymmetricSwap

public boolean getSymmetricSwap()
Returns the current value of Directional Swapping.
See Also:
setSymmetricSwap(boolean)

processFirstNumericField

public void processFirstNumericField(int value)
Sets the cursor position of the first active numeric field to properly position. Also sets the Keyboard layer and OIA according to the numeric field type and Screen orientation.
Parameters:
value - Current linear cursor position.
See Also:
processFirstNumericField(int)

IsNumericField

public boolean IsNumericField(int value)
Returns true, if current field is Numeric and false, if not.
Parameters:
value - Current linear cursor position.
See Also:
IsNumericField(int)

isRTLScreen

public boolean isRTLScreen()
Returns true, if Screen orientation is RTL and false, if not
See Also:
isRTLScreen()

isField5250RTL

public boolean isField5250RTL(int pos)
Returns true, if orientation of Field in 5250 Session is RTL, and false, if not
Parameters:
pos - Current linear cursor position.
See Also:
isField5250RTL(int)

isFieldReversed

public boolean isFieldReversed()
Returns true, if current field is reversed, and false, if not
See Also:
isFieldReversed()

IsBIDINumericField

public boolean IsBIDINumericField(int pos)
Returns true, if current field is Numeric, and false, if not.
Parameters:
pos - Current linear cursor position.
See Also:
IsBIDINumericField(int)

isAutoReversed

public boolean isAutoReversed()
Returns true, if mode AutoReverse is ON, and false, if OFF
See Also:
isAutoReversed()

setNumericFromSC

public void setNumericFromSC()

setFieldReverse

public void setFieldReverse(boolean frev)

is5250AutoEnterField

public boolean is5250AutoEnterField(int pos)

isPushMode

public boolean isPushMode()

shapeMacro

public void shapeMacro(boolean value)

ConvertVisualToLogical

public java.lang.String ConvertVisualToLogical(java.lang.String inputBuffer,
                                               boolean isLTRVisual,
                                               boolean isLTRImplicit)
Converts the Given String From Visual To Implicit Format and returns the Implicit Format of the String
Parameters:
inputBuffer - The input String in Visual format
isLTRVisual - if true, Input Buffer is in Visual LeftToRight form
isLTRImplicit - if true, Output Buffer is in Implicit LeftToRight form
See Also:
ConvertLogicalToVisual(String, boolean, boolean)

ConvertLogicalToVisual

public java.lang.String ConvertLogicalToVisual(java.lang.String inputBuffer,
                                               boolean isLTRImplicit,
                                               boolean isLTRVisual)
Converts the Given String From Implicit To Visual Format and returns the Visual Format of the String
Parameters:
inputBuffer - The input String in Implicit format
isLTRImplicit - if true, Input Buffer is in Implicit LeftToRight form
isLTRVisual - if true, Output Buffer is in Visual LeftToRight form
See Also:
ConvertVisualToLogical(String, boolean, boolean)