com.ibm.eNetwork.ECL Interface ECLPSBIDIServices

Overview   Package     Class   Tree   Serialized   Deprecated   Index   Help   API User's Guide
PREV CLASS     NEXT CLASS	FRAMES     NO FRAMES
SUMMARY:  INNER |  FIELD | CONSTR |  METHOD	DETAIL:   FIELD | CONSTR |  METHOD

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	RTLUNICODE_OFF           RTLUNICODE property value - RTLUNICODEOFF, this value only applies to BIDI 5250 hosts
static java.lang.String	RTLUNICODE_ON           RTLUNICODE property value - RTLUNICODEON, this value only applies to BIDI 5250 hosts
static java.lang.String	VISUAL           TextType property value - VISUAL

 

Method Summary
java.lang.String	CompressLamAlef (java.lang.String str)           Compresses Arabic characters Lam and Alef into one Arabic character LamAlef.
java.lang.String	CompressLamAlef (java.lang.String str, int length, boolean bRev)           Compresses Arabic characters Lam and Alef into one Arabic character LamAlef.
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	ExpandLamAlef (java.lang.String str)           Expands Arabic character LamAlef into two Arabic characters Lam and Alef.
java.lang.String	ExpandLamAlef (java.lang.String str, int length, boolean bRev, boolean LeaveSpace)           Expands Arabic character LamAlef into two Arabic characters Lam and Alef.
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 or retrieved by ECLPS.GetString() method.
java.lang.String	GetRTLUnicode ()           Returns the current value of the RTL property.
int	GetScreen (char[] buffer, int bufferLength, int plane, boolean noticeBIDIattrs)           GetScreen retrieves the various planes (text, color, attributes, extended attributes) associated with the presentation space.
int	GetScreen (char[] buffer, int bufferLength, int position, int length, int plane, boolean noticeBIDIattrs)           GetScreen retrieves the various planes (text, color, attributes, extended attributes) associated with the presentation space.
int	GetScreen (char[] buffer, int bufferLength, int row, int col, int length, int plane, boolean noticeBIDIattrs)           GetScreen retrieves the various planes (text, color, attributes, extended attributes) associated with the presentation space.
int	GetString (char[] buffer, int bufferLength, boolean noticeBIDIattrs)           GetString retrieves text plane information from the presentation space likes ECLPS.GetString, but if noticeBIDIattrs parameter is set to true, it performs bidirectional reordering according to arranged text type and text orientation.
int	GetString (char[] buffer, int bufferLength, int position, int length, boolean noticeBIDIattrs)           GetString retrieves text plane information from the presentation space likes ECLPS.GetString, but if noticeBIDIattrs parameter is set to true, it performs bidirectional reordering according to arranged text type and text orientation.
int	GetString (char[] buffer, int bufferLength, int row, int col, int length, boolean noticeBIDIattrs)           GetString retrieves text plane information from the presentation space likes ECLPS.GetString, but if noticeBIDIattrs parameter is set to true, it performs bidirectional reordering according to arranged text type and text orientation.
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 or retrieved by ECLPS.GetString() method.
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 or retrieved by ECLPS.GetString() and ECLPS.GetText() methods.
java.lang.String	handleArabicData (java.lang.String str)           Converts Arabic characters into their base-shaped analogs
boolean	is5250AutoEnterField (int pos)           Deprecated and not supported for programming usage.
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	isBoundary ()           Deprecated and not supported for programming usage.
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 ()           Deprecated and not supported for programming usage.
boolean	isRTLScreen ()           Returns true, if Screen orientation is RTL and false, if not
void	noticeRTLScreen (boolean notice)           If parameter notice is true and ECLPS.SCREENREV_STR string has been sent to PS, then methods with noticeBIDIattrs attribute work with text as it could displayed at RTL screen.
void	processFirstNumericField (int value)           Sets the cursor position of the first active numeric field to properly position.
int	SearchString (java.lang.String text, int direction, boolean noticeBIDIattrs)           The SearchString method searches for a given text string within the presentation space similarly to ECLPS#SearchText, but if noticeBIDIattrs parameter is set to true, it performs bidirectional reordering according to arranged text type and text orientation.
int	SearchString (java.lang.String text, int position, int direction, boolean noticeBIDIattrs)           The SearchString method searches for a given text string within the presentation space similarly to ECLPS#SearchText, but if noticeBIDIattrs parameter is set to true, it performs bidirectional reordering according to arranged text type and text orientation.
int	SearchString (java.lang.String text, int row, int column, int direction, boolean noticeBIDIattrs)           The SearchString method searches for a given text string within the presentation space similarly to ECLPS#SearchText, but if noticeBIDIattrs parameter is set to true, it performs bidirectional reordering according to arranged text type and text orientation.
int	SearchText (java.lang.String text, int direction, boolean noticeBIDIattrs)           For bidirectional codepages, SearchText() method is analog of SearchString().
int	SearchText (java.lang.String text, int position, int direction, boolean noticeBIDIattrs)           For bidirectional codepages, SearchText() method is analog of SearchString().
int	SearchText (java.lang.String text, int row, int column, int direction, boolean noticeBIDIattrs)           For bidirectional codepages, SearchText() method is analog of SearchString().
void	SetBIDICursorPos (int pos)           Sets the cursor position to the specified row and column.
void	SetBIDICursorPos (int pos, boolean flag)           Deprecated and not supported for programming usage.
void	SetBIDICursorPos (int row, int col)           Sets the BIDI cursor position to the specified linear position.
void	setFieldReverse (boolean frev)           Deprecated and not supported for programming usage.
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 ()           Deprecated and not supported for programming usage.
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 or retrieved by ECLPS.GetString() method.
void	SetRTLUnicode (java.lang.String tt)           Sets the RTLUnicode property.
void	SetString (java.lang.String text, boolean noticeBIDIattrs)           The SetString method sends a string to the presentation space likes ECLPS.SetString, but if noticeBIDIattrs parameter is set to true, it performs bidirectional reordering according to arranged text type and text orientation.
void	SetString (java.lang.String text, int pos, boolean noticeBIDIattrs)           The SetString method sends a string to the presentation space likes ECLPS.SetString, but if noticeBIDIattrs parameter is set to true, it performs bidirectional reordering according to arranged text type and text orientation.
void	SetString (java.lang.String text, int row, int column, boolean noticeBIDIattrs)           The SetString method sends a string to the presentation space likes ECLPS.SetString, but if noticeBIDIattrs parameter is set to true, it performs bidirectional reordering according to arranged text type and text orientation.
void	setSymmetricSwap (boolean value)           Sets the Symmetric Swapping value (Directional Swapping).
void	SetText (java.lang.String text, boolean noticeBIDIattrs)           For bidirectional codepages, SetText() method is analog of SetString().
void	SetText (java.lang.String text, int pos, boolean noticeBIDIattrs)           For bidirectional codepages, SetText() method is analog of SetString().
void	SetText (java.lang.String text, int row, int column, boolean noticeBIDIattrs)           For bidirectional codepages, SetText() method is analog of SetString().
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 or retrieved by ECLPS.GetString() and ECLPS.GetText() 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 or retrieved by ECLPS.GetString() and ECLPS.GetText() methods.
void	shapeMacro (boolean value)           Deprecated and not supported for programming usage.

 

Field Detail

NOMINAL

public static final java.lang.String 
NOMINAL

         

NATIONAL

public static final java.lang.String 
NATIONAL

         

CONTEXTUAL

public static final java.lang.String 
CONTEXTUAL

         

VISUAL

public static final java.lang.String 
VISUAL

         

LOGICAL

public static final java.lang.String 
LOGICAL

         

LEFT_TO_RIGHT

public static final java.lang.String 
LEFT_TO_RIGHT

         

RIGHT_TO_LEFT

public static final java.lang.String 
RIGHT_TO_LEFT

         

LAMALEF_ON

public static final java.lang.String 
LAMALEF_ON

         

LAMALEF_OFF

public static final java.lang.String 
LAMALEF_OFF

         

RTLUNICODE_ON

public static final java.lang.String 
RTLUNICODE_ON

         

RTLUNICODE_OFF

public static final java.lang.String 
RTLUNICODE_OFF

         

ROUNDTRIP_ON

public static final java.lang.String 
ROUNDTRIP_ON

         

ROUNDTRIP_OFF

public static final java.lang.String 
ROUNDTRIP_OFF

         

Method Detail

SetNumeralShape

public void 
SetNumeralShape(java.lang.String ns)
                     throws 
ECLErr

         

GetNumeralShape

public java.lang.String 
GetNumeralShape()

SetTextType

public void 
SetTextType(java.lang.String tt)
                 throws 
ECLErr

         

GetTextType

public java.lang.String 
GetTextType()

SetTextOrientation

public void 
SetTextOrientation(java.lang.String to)
                        throws 
ECLErr

         

GetTextOrientation

public java.lang.String 
GetTextOrientation()

SetRoundTrip

public void 
SetRoundTrip(java.lang.String to)
                  throws 
ECLErr

         

GetRoundTrip

public java.lang.String 
GetRoundTrip()

SetBIDICursorPos

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

         

SetBIDICursorPos

public void 
SetBIDICursorPos(int pos)
                      throws 
ECLErr

         

SetBIDICursorPos

public void 
SetBIDICursorPos(int row,
                             int col)
                      throws 
ECLErr

         

SetLamAlef

public void 
SetLamAlef(java.lang.String tt)
                throws 
ECLErr

         

GetLamAlef

public java.lang.String 
GetLamAlef()

SetRTLUnicode

public void 
SetRTLUnicode(java.lang.String tt)
                   throws 
ECLErr

         

GetRTLUnicode

public java.lang.String 
GetRTLUnicode()

setNumericSwap

public void 
setNumericSwap(boolean value)

getNumericSwap

public boolean 
getNumericSwap()

setSymmetricSwap

public void 
setSymmetricSwap(boolean value)

getSymmetricSwap

public boolean 
getSymmetricSwap()

processFirstNumericField

public void 
processFirstNumericField(int value)

IsNumericField

public boolean 
IsNumericField(int value)

isRTLScreen

public boolean 
isRTLScreen()

isField5250RTL

public boolean 
isField5250RTL(int pos)

isFieldReversed

public boolean 
isFieldReversed()

IsBIDINumericField

public boolean 
IsBIDINumericField(int pos)

isAutoReversed

public boolean 
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)

ConvertLogicalToVisual

public java.lang.String 
ConvertLogicalToVisual(java.lang.String inputBuffer,
                                               boolean isLTRImplicit,
                                               boolean isLTRVisual)

isBoundary

public boolean 
isBoundary()

GetString

public int 
GetString(char[] buffer,
                     int bufferLength,
                     boolean noticeBIDIattrs)
              throws 
ECLErr

         

GetString

public int 
GetString(char[] buffer,
                     int bufferLength,
                     int position,
                     int length,
                     boolean noticeBIDIattrs)
              throws 
ECLErr

         

GetString

public int 
GetString(char[] buffer,
                     int bufferLength,
                     int row,
                     int col,
                     int length,
                     boolean noticeBIDIattrs)
              throws 
ECLErr

         

GetScreen

public int 
GetScreen(char[] buffer,
                     int bufferLength,
                     int plane,
                     boolean noticeBIDIattrs)
              throws 
ECLErr

         

GetScreen

public int 
GetScreen(char[] buffer,
                     int bufferLength,
                     int position,
                     int length,
                     int plane,
                     boolean noticeBIDIattrs)
              throws 
ECLErr

         

GetScreen

public int 
GetScreen(char[] buffer,
                     int bufferLength,
                     int row,
                     int col,
                     int length,
                     int plane,
                     boolean noticeBIDIattrs)
              throws 
ECLErr

         

SearchString

public int 
SearchString(java.lang.String text,
                        int direction,
                        boolean noticeBIDIattrs)
                 throws 
ECLErr

         

SearchString

public int 
SearchString(java.lang.String text,
                        int position,
                        int direction,
                        boolean noticeBIDIattrs)
                 throws 
ECLErr

         

SearchString

public int 
SearchString(java.lang.String text,
                        int row,
                        int column,
                        int direction,
                        boolean noticeBIDIattrs)
                 throws 
ECLErr

         

SearchText

public int 
SearchText(java.lang.String text,
                      int direction,
                      boolean noticeBIDIattrs)
               throws 
ECLErr

         

SearchText

public int 
SearchText(java.lang.String text,
                      int position,
                      int direction,
                      boolean noticeBIDIattrs)
               throws 
ECLErr

         

SearchText

public int 
SearchText(java.lang.String text,
                      int row,
                      int column,
                      int direction,
                      boolean noticeBIDIattrs)
               throws 
ECLErr

         

SetString

public void 
SetString(java.lang.String text,
                      boolean noticeBIDIattrs)
               throws 
ECLErr

         

SetString

public void 
SetString(java.lang.String text,
                      int pos,
                      boolean noticeBIDIattrs)
               throws 
ECLErr

         

SetString

public void 
SetString(java.lang.String text,
                      int row,
                      int column,
                      boolean noticeBIDIattrs)
               throws 
ECLErr

         

SetText

public void 
SetText(java.lang.String text,
                    boolean noticeBIDIattrs)
             throws 
ECLErr

         

SetText

public void 
SetText(java.lang.String text,
                    int pos,
                    boolean noticeBIDIattrs)
             throws 
ECLErr

         

SetText

public void 
SetText(java.lang.String text,
                    int row,
                    int column,
                    boolean noticeBIDIattrs)
             throws 
ECLErr

         

handleArabicData

public java.lang.String 
handleArabicData(java.lang.String str)

noticeRTLScreen

public void 
noticeRTLScreen(boolean notice)

CompressLamAlef

public java.lang.String 
CompressLamAlef(java.lang.String str)

CompressLamAlef

public java.lang.String 
CompressLamAlef(java.lang.String str,
                                        int length,
                                        boolean bRev)

ExpandLamAlef

public java.lang.String 
ExpandLamAlef(java.lang.String str)

ExpandLamAlef

public java.lang.String 
ExpandLamAlef(java.lang.String str,
                                      int length,
                                      boolean bRev,
                                      boolean LeaveSpace)

Overview   Package     Class   Tree   Serialized   Deprecated   Index   Help   API User's Guide
PREV CLASS     NEXT CLASS	FRAMES     NO FRAMES
SUMMARY:  INNER |  FIELD | CONSTR |  METHOD	DETAIL:   FIELD | CONSTR |  METHOD