com.ibm.eNetwork.ECL
Interface PSVTBIDIServices


public interface PSVTBIDIServices

The PSVTBIDIServices interface provides access to the bidirectional (BIDI) language properties in a BIDI VT session. The PSVTBIDIServices object is only available when using bidirectional code pages.

See Also:
ECLPS.GetPSVTBIDIServices()

Field Summary
static java.lang.String BIDI_MODE_OFF
          BIDIMode property value - BIDIMODEOFF
static java.lang.String BIDI_MODE_ON
          BIDIMode property value - BIDIMODEON
static java.lang.String CONTEXTUAL
          Numerals Shape property value - CONTEXTUAL, this value only applies to Arabic hosts
static java.lang.String CONTEXTUAL_DISP
          Numerals Shape Display property value - CONTEXTUAL_DISP, this value only applies to Arabic hosts
static java.lang.String CURSOR_LTR
          cursorDirection property value - CURSOR_LEFTTORIGHT, this value only applies to Visual Hebrew Sessions
static java.lang.String CURSOR_RTL
          cursorDirection property value - CURSOR_RIGHTTOLEFT, this value only applies to Visual Hebrew Sessions
static java.lang.String LEFT_TO_RIGHT
          TextOrientation property value - LEFTTORIGHT
static java.lang.String LOGICAL
          TextType property value - LOGICAL
static java.lang.String LOGICAL_DISP
          TextType Display property value - LOGICAL_DISP
static java.lang.String NATIONAL
          Numerals Shape property value - NATIONAL, this value only applies to Arabic hosts
static java.lang.String NATIONAL_DISP
          Numerals Shape Display property value - NATIONAL_DISP, 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 NOMINAL_DISP
          Numerals Shape Display property value - NOMINAL_DISP, this value only applies to Arabic hosts
static java.lang.String RIGHT_TO_LEFT
          TextOrientation property value - RIGHTTOLEFT
static java.lang.String SMART_ORDERING_OFF
          smartOrdering property value - SMART_ORDERING_OFF , this value only applies to Logical Sessions
static java.lang.String SMART_ORDERING_ON
          smartOrdering property value - SMART_ORDERING_ON , this value only applies to Logical Sessions
static java.lang.String VISUAL
          TextType property value - VISUAL
static java.lang.String VISUAL_DISP
          TextType Display property value - VISUAL_DISP, this value only applies to Hebrew Hosts
 
Method Summary
 java.lang.String GetBIDIMode()
          Returns the current value of the BIDIMode property.
 java.lang.String GetCursorDirection()
          Returns the current value of the CursorDirection 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.
 java.lang.String GetNumeralShapeDisp()
          Returns the current value of the NumeralShapeDisp property.
 boolean GetShowTextAttributes()
          Returns the current value of the ShowTextAttributes property.
 java.lang.String GetSmartOrdering()
          Returns the current value of the SmartOrdering property.
 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.
 java.lang.String GetTextTypeDisp()
          Returns the current value of the TextTypeDisp property.
 void SetBIDIMode(java.lang.String to)
          Sets the BIDIMode property.
 void SetCursorDirection(java.lang.String to)
          Sets the CursorDirection 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 SetNumeralShapeDisp(java.lang.String to)
          Sets the NumeralShapeDisp property.Determines how numerals should be shaped This method only applies to Arabic Hosts.
 void SetShowTextAttributes(boolean state)
          Sets the ShowTextAttributes property.
 void SetSmartOrdering(java.lang.String ns)
          Sets the SmartOrdering property.
 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 SetTextTypeDisp(java.lang.String to)
          Sets the TextTypeDisp property.
 int visualFromLogical(int logcur)
           
 

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

NOMINAL_DISP

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

NATIONAL_DISP

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

CONTEXTUAL_DISP

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

VISUAL_DISP

public static final java.lang.String VISUAL_DISP
TextType Display property value - VISUAL_DISP, this value only applies to Hebrew Hosts

LOGICAL_DISP

public static final java.lang.String LOGICAL_DISP
TextType Display property value - LOGICAL_DISP

BIDI_MODE_ON

public static final java.lang.String BIDI_MODE_ON
BIDIMode property value - BIDIMODEON

BIDI_MODE_OFF

public static final java.lang.String BIDI_MODE_OFF
BIDIMode property value - BIDIMODEOFF

CURSOR_LTR

public static final java.lang.String CURSOR_LTR
cursorDirection property value - CURSOR_LEFTTORIGHT, this value only applies to Visual Hebrew Sessions

CURSOR_RTL

public static final java.lang.String CURSOR_RTL
cursorDirection property value - CURSOR_RIGHTTOLEFT, this value only applies to Visual Hebrew Sessions

SMART_ORDERING_ON

public static final java.lang.String SMART_ORDERING_ON
smartOrdering property value - SMART_ORDERING_ON , this value only applies to Logical Sessions

SMART_ORDERING_OFF

public static final java.lang.String SMART_ORDERING_OFF
smartOrdering property value - SMART_ORDERING_OFF , this value only applies to Logical Sessions
Method Detail

SetSmartOrdering

public void SetSmartOrdering(java.lang.String ns)
                      throws ECLErr
Sets the SmartOrdering property. Determines whether segment of characters with different text attributes is ordered separatly. This method applies for Logical Sessions only.
Parameters:
ns - Can be one of the following string constants:
  • SMART_ORDERING_ON
  • SMART_ORDERING_OFF
Throws:
ECLErr - Thrown if the specified value is invalid.
See Also:
SetNumeralShape(java.lang.String), SMART_ORDERING_ON, SMART_ORDERING_OFF

GetSmartOrdering

public java.lang.String GetSmartOrdering()
Returns the current value of the SmartOrdering property.
See Also:
SetSmartOrdering(java.lang.String), SMART_ORDERING_ON, SMART_ORDERING_OFF

SetShowTextAttributes

public void SetShowTextAttributes(boolean state)
                           throws ECLErr
Sets the ShowTextAttributes property.
Throws:
ECLErr - Thrown if the specified value is invalid.

GetShowTextAttributes

public boolean GetShowTextAttributes()
Returns the current value of the ShowTextAttributes property.
See Also:
SetShowTextAttributes(boolean)

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), NOMINAL, NATIONAL, CONTEXTUAL

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

SetBIDIMode

public void SetBIDIMode(java.lang.String to)
                 throws ECLErr
Sets the BIDIMode property. Is used to enable or disable Arabic functions, like characters shaping. This method only applies to Arabic VT sessions
Parameters:
to - Can be one of the following string constants:
  • BIDI_MODE_ON
  • BIDI_MODE_OFF
Throws:
ECLErr - Thrown if the specified value is invalid.
See Also:
GetBIDIMode(), BIDI_MODE_ON, BIDI_MODE_OFF

GetBIDIMode

public java.lang.String GetBIDIMode()
Returns the current value of the BIDIMode property.
See Also:
SetBIDIMode(java.lang.String), BIDI_MODE_ON, BIDI_MODE_OFF

SetTextTypeDisp

public void SetTextTypeDisp(java.lang.String to)
                     throws ECLErr
Sets the TextTypeDisp property. Determines whether session works in Logical or Visual mode This method only applies to Hebrew Hosts.
Parameters:
to - Can be one of the following string constants:
  • VISUAL
  • LOGICAL
Throws:
ECLErr - Thrown if the specified value is invalid.
See Also:
GetTextTypeDisp(), LOGICAL, VISUAL

GetTextTypeDisp

public java.lang.String GetTextTypeDisp()
Returns the current value of the TextTypeDisp property.
See Also:
SetTextTypeDisp(java.lang.String), LOGICAL, VISUAL

SetCursorDirection

public void SetCursorDirection(java.lang.String to)
                        throws ECLErr
Sets the CursorDirection property. Determines whether cursor direction is left-to-right or right-to-left. This method only applies to Visual Hebrew Sessions.
Parameters:
to - Can be one of the following string constants:
  • CURSOR_LTR
  • CURSOR_RTL
Throws:
ECLErr - Thrown if the specified value is invalid.
See Also:
GetCursorDirection(), CURSOR_LTR, CURSOR_RTL

GetCursorDirection

public java.lang.String GetCursorDirection()
Returns the current value of the CursorDirection property.
See Also:
SetCursorDirection(java.lang.String), CURSOR_LTR, CURSOR_RTL

SetNumeralShapeDisp

public void SetNumeralShapeDisp(java.lang.String to)
                         throws ECLErr
Sets the NumeralShapeDisp property.Determines how numerals should be shaped This method only applies to Arabic Hosts.
Parameters:
to - Can be one of the following string constants:
  • NOMINAL
  • NATIONAL
  • CONTEXTUAL
Throws:
ECLErr - Thrown if the specified value is invalid.
See Also:
GetNumeralShapeDisp(), NOMINAL, NATIONAL, CONTEXTUAL

GetNumeralShapeDisp

public java.lang.String GetNumeralShapeDisp()
Returns the current value of the NumeralShapeDisp property.
See Also:
SetNumeralShapeDisp(java.lang.String), NOMINAL, NATIONAL, CONTEXTUAL

visualFromLogical

public int visualFromLogical(int logcur)