|
HATS 7.5.1 Web API ReferencePublicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.hsr.screen.HsrScreen
com.ibm.hats.common.HostScreen
public class HostScreen
This is the HATS implementation of an ECLPS. Please refer to the ECLPS javadoc for information on usage.
ECLPS| Field Summary | |
|---|---|
static int |
COLOR_PLANE
a plane indicator for color data |
static int |
CONST_HostScreenFIELDTYPE_DISPLAY
indicator of field information item for displayable data |
static int |
CONST_HostScreenFIELDTYPE_HIGHINTENSITY
indicator of field information item for high intensity data |
static int |
CONST_HostScreenFIELDTYPE_MODIFIED
indicator of field information item for modified data |
static int |
CONST_HostScreenFIELDTYPE_NUMERIC
indicator of field information item for numeric data |
static int |
CONST_HostScreenFIELDTYPE_PENDETECTABLE
indicator of field information item for pen detectable data |
static int |
CONST_HostScreenFIELDTYPE_PROTECTED
indicator of field information item for protected data |
static int |
DBCS_PLANE
a plane indicator for dbcs data |
static char |
END_BOUNDARY
end of boundary for boundary plane |
static int |
EXFIELD_PLANE
a plane indicator for extended field data, alternate spelling |
static int |
EXTFIELD_PLANE
a plane indicator for extended field data |
static int |
FIELD_PLANE
a plane indicator for field data |
int[][] |
fieldlist
a 0-based list of the fields by order on the screen fieldlist int[orderid][0 for start,1for length,2 for attrib]=value, //GM3a 3 for isUnicode{0=false,1=true} Ex. |
String[] |
fieldname
fieldname contains bms field name or null. |
static int |
GRID_PLANE
a plane indicator for dbcs grid data |
static int |
HOST_PLANE
a plane indicator for host special data |
static char |
INSIDE_FIELD
inside field for boundary plane |
Vector |
keystext
this vector stores the command tree of the host screen before submitting to the host items should be made of items such as [tab][tab],[pf3], etc. |
static Hashtable |
limitingAttribToPlane
|
ArrayList |
mapOriginList
originlist is an array of strings containing list of bms mapset and map names. |
ArrayList |
mapSetOriginList
|
com.ibm.hats.common.SelectorField[] |
pentype
|
char[][] |
plane
the array of planes used in the host screen the first array in the matrix is the plane indicator and the second array is the character buffer for the plane Ex. |
static int |
planeDepth
a plane indicator count |
static int |
PROTECTED_TEXT_PLANE
a plane indicator for protected text data |
static int |
PS_PLANE
a plane indicator for original text data |
static String |
SESSION_TN_ENHANCED
the session TN enhanced default |
static int |
SESSION_TYPE_3270
a session type indicator for 3270 hosts |
static int |
SESSION_TYPE_5250
a session type indicator for 5250 hosts |
static int |
SESSION_TYPE_CICS
a session type indicator for CICS hosts (not supported) |
static int |
SESSION_TYPE_VT
a session type indicator for VT hosts (not supported) |
static int |
SOURCE_DOCUMENT
source indicator for xml document based changes |
static int |
SOURCE_ECLPS
source indicator for ECLPS based changes |
static int |
SOURCE_HOSTSCREEN
source indicator for HostScreen object based changes |
static int |
SOURCE_METHOD
source indicator for HostScreen method based changes |
static int |
SSL_DONT_KNOW
SSL information not available |
static int |
SSL_OFF
SSL is not engaed from HOD to host |
static int |
SSL_ON
SSL is engaged from HOD to host for anything at least this value |
static int |
TEXT_PLANE
a plane indicator for text |
static int |
UPDATE_ALL
what changed indicator for all changes made |
static int |
UPDATE_COMMAND
what changed indicator for command/function key changes |
static int |
UPDATE_CURSOR
what changed indicator for cursor changes |
static int |
UPDATE_INFO
what changed indicator for session information changes |
static int |
UPDATE_TEXT
what changed indicator for text plane changes |
static int |
VISIBLE_TEXT_PLANE
a plane indicator for visible text data |
| Fields inherited from class com.ibm.hsr.screen.HsrScreen |
|---|
cursorCol, cursorPos, cursorRow, hsrBidi, PROTECTED_TEXT_ONLY, screenSize, sizeCols, sizeRows, VISIBLE_SHIFTLESS_TEXT, VISIBLE_TEXT_ONLY |
| Fields inherited from interface com.ibm.hats.util.HatsConstants |
|---|
HATS_INSTANCE_NAME, HatsConstantsC, KEY_SCAFFOLDING_FLAG, NULL_TYPE, RCP_TYPE, RTE_RUNNING, RTE_SHUTTING_DOWN, RTE_STOPPED, SCAFFOLDING_OFF, SCAFFOLDING_ON, SCAFFOLDING_UNKNOWN, SKEY_USER_LOCALE, SYSPROP_INSTALL_DIR, WEB_TYPE |
| Fields inherited from interface com.ibm.hats.util.RasConstants |
|---|
CKEY_ADMIN_PORTNUM, CKEY_APPLET_SERVER_SOCKET_BACKLOG, CKEY_COMP_MASK_PREFIX, CKEY_COMP_PREFIX, CKEY_CONFIG_DIRECTORY, CKEY_HATS_INSTANCE_NAME, CKEY_HOD_DISPLAY_TERMINAL, CKEY_HOD_MACRO_TRACING_LEVEL, CKEY_HOD_PS_TRACING_LEVEL, CKEY_HOD_SESSION_TRACING_LEVEL, CKEY_HOD_SUPPORT_TRACING, CKEY_HOD_TRACING_PREFIX, CKEY_HOD_TRANSPORT_TRACING_LEVEL, CKEY_HOD_USER_MACRO_TRACING, CKEY_IO_PATTERN, CKEY_LAST_CHECKED_CONFIG, CKEY_LICENSE_HARD_LIMIT, CKEY_LICENSE_TRACKING, CKEY_LICFILE, CKEY_LOG_DIRECTORY, CKEY_LOGFILE, CKEY_LOGMASK, CKEY_MAX_HOD_EVENT_THREADS, CKEY_MAX_HOD_THREAD_MANAGER_THREADS, CKEY_MAX_LOGFILES, CKEY_MAX_SIMULATIONFILES, CKEY_MAX_SIZE_LOGFILE, CKEY_MAX_SIZE_TRACEFILE, CKEY_MAX_TRACEFILES, CKEY_NUM_LICENSES, CKEY_RECORD_SIMULATION_TRACE, CKEY_SERVLET_CONTEXT_NAME, CKEY_SERVLET_REAL_PATH, CKEY_SIMULATOR_END_PORT, CKEY_SIMULATOR_START_PORT, CKEY_TRACEFILE, CKEY_TRACELOG_DIRECTORY, COMP_ACTION, COMP_ACTION_KEY, COMP_ALL, COMP_ALL_KEY, COMP_APPLET, COMP_APPLET_KEY, COMP_COMPONENT, COMP_COMPONENT_KEY, COMP_HOD, COMP_HOD_COMMEVENT, COMP_HOD_COMMEVENT_KEY, COMP_HOD_DISPLAYTERMINAL, COMP_HOD_DISPLAYTERMINAL_KEY, COMP_HOD_DS, COMP_HOD_DS_KEY, COMP_HOD_KEY, COMP_HOD_MACRO, COMP_HOD_MACRO_KEY, COMP_HOD_OIAEVENT, COMP_HOD_OIAEVENT_KEY, COMP_HOD_PS, COMP_HOD_PS_KEY, COMP_HOD_PSEVENT, COMP_HOD_PSEVENT_KEY, COMP_HOD_SESSION, COMP_HOD_SESSION_KEY, COMP_HOD_TRANSPORT, COMP_HOD_TRANSPORT_KEY, COMP_HOD_USERMACRO, COMP_HOD_USERMACRO_KEY, COMP_IO, COMP_IO_KEY, COMP_RUNTIME, COMP_RUNTIME_KEY, COMP_SIMULATION_KEY, COMP_TRANSFORM, COMP_TRANSFORM_KEY, COMP_UTILITY, COMP_UTILITY_KEY, COMP_WIDGET, COMP_WIDGET_KEY, CONFIG_CHECK_INTERVAL, DEFAULT_ADMIN_PORTNUM, DEFAULT_LIC_FILE_NUMBER, DEFAULT_LIC_FILE_SIZE, DEFAULT_LOG_FILE_NUMBER, DEFAULT_LOG_FILE_SIZE, DEFAULT_SIMULATION_FILE_NUMBER, DEFAULT_SIMULATION_RECORDING_STATE, DEFAULT_SIMULATOR_END_PORT, DEFAULT_SIMULATOR_START_PORT, DEFAULT_TRACE_FILE_NUMBER, DEFAULT_TRACE_FILE_SIZE, DEFAULT_TRACE_MASK, enableTracing, Err, HOD_MACRO_TRACER_LEVEL_1, HOD_MACRO_TRACER_LEVEL_2, HOD_TRACE_MAXIMUM, HOD_TRACE_MINIMUM, HOD_TRACE_NONE, HOD_TRACE_NORMAL, hodPrefix, Info, LICENSE_FILE_NAME, LOG_FILENAME, LOG_TYPE_ERROR, LOG_TYPE_INFO, LOG_TYPE_WARNING, NUM_TRACE_MASKS, RAS_CALLED_CLASS, RAS_CALLED_METHOD, RAS_CALLING_CLASS, RAS_CALLING_METHOD, RasConstantsC, RUNTIME_DEBUG_PROPERTIES_FILENAME, RUNTIME_DEBUG_PROPERTIES_SHORTNAME, RUNTIME_PROPERTIES_FILENAME, RUNTIME_PROPERTIES_SHORTNAME, Sev, specialKeyPrefix, SYS_PROP_OS_NAME, SYS_PROP_OVERRIDE_OS_NAME, SYS_PROP_RUNTIME_PROPERTIES, TRACE_FILENAME, TRACE_LEVEL_NONE, TRACE_LEVEL_NOT_SPECIFIED, TRACE_MASK_NONE, Warn |
| Fields inherited from interface com.ibm.logging.IRecordType |
|---|
TYPE_ALL, TYPE_API, TYPE_CALLBACK, TYPE_DEBUG_MAX, TYPE_DEBUG_MID, TYPE_DEBUG_MIN, TYPE_DEFAULT_MESSAGE, TYPE_DEFAULT_TRACE, TYPE_ENTRY, TYPE_ENTRY_EXIT, TYPE_ERR, TYPE_ERROR, TYPE_ERROR_EXC, TYPE_EXIT, TYPE_FATAL, TYPE_INFO, TYPE_INFORMATION, TYPE_LEVEL1, TYPE_LEVEL2, TYPE_LEVEL3, TYPE_MISC_DATA, TYPE_NONE, TYPE_OBJ_CREATE, TYPE_OBJ_DELETE, TYPE_PERF, TYPE_PRIVATE, TYPE_PUBLIC, TYPE_STATIC, TYPE_SVC, TYPE_WARN, TYPE_WARNING |
| Fields inherited from interface com.ibm.hats.common.connmgr.ConnMgrConstants |
|---|
ADMIN_EJB_INSTANCE, ADMIN_PARAM_ADMIN_JNDINAME, ADMIN_PARAM_APPLICATIONS_DIR, ADMIN_PARAM_APPMANIFESTS_DIR, ADMIN_PARAM_BEANS_DIR, ADMIN_PARAM_COMMON_DIR, ADMIN_PARAM_DOCUMENTS_DIR, ADMIN_PARAM_INSTALL_DIR, ADMIN_PARAM_LICENSE_HARD_LIMIT, ADMIN_PARAM_LOG_DIR, ADMIN_PARAM_NUM_LICENSES, ADMIN_PARAM_POOLSPECS_DIR, ADMIN_PARAM_PRODUCTION_DIR, ADMIN_PARAM_RMIREG_PORTNUM, ADMIN_PARAM_RTE_DIR, ADMIN_PARAM_RTE_JNDINAME, ADMIN_PARAM_RTE_LIB_DIR, ADMIN_PARAM_SERVER_DIR, ADMIN_PARAM_SHARED_DIR, ADMIN_PARAM_STAGING_DIR, ADMIN_RMIREG_PORTNUM_DEFAULT, ADMINRTE_SLEEP_TIME, ADMINRTE_TIMEOUT, APP_UNREMOVABLE, BASE_EJB_INSTANCE, BUFFER_SIZE, BUILD_LEVEL_IDX, BUILD_RLSE_IDX, BUILD_VER_IDX, connspecExtension, DEFAULT_APPSERVER_NAME, DEFAULT_POOLMGR_CLASSNAME, DRTE_EJB_LOCK_REBIND_HOLDTIME, DRTE_EJB_LOCK_TIMEOUT, DRTE_EJB_TIMEOUT, DRTE_SLEEP_TIME, enableTracing, Err, HARD_SHUTDOWN, HARD_TEARDOWN, HOST_LIST_FILE_NAME, HP_ADMIN_JNDINAME, HP_RTE_JNDINAME, HPADMINEJB_REFERENCE, Info, IWA_PKG, KEY_DIGEST_DIGEST_FILENAME, KEY_NON_WEBCONN, KEY_ORIGINAL_FILENAME, KEY_POOLMGR_CLASSNAME, KEY_WEBADMINCLIENT, KEY_WEBCONN, KEYRINGPW, LICENSE_COUNT_SAMPLE_SIZE, LOCALHOST_NAME_SPACE_PROVIDER, logonspecExtension, MAINTAIN_MIN_CONNS, manifestExtension, MAX_NUM_ADMIN_WORKER_THREADS, MAX_NUM_POLL_WORKER_THREADS, MAX_VALID_PORT_NUM, MESSAGE_FILE_NAME, NAME_SPACE_PROVIDER_PREFIX, NONDRTE_EJB_INSTANCE, NUM_ADMIN_WORKER_THREADS, PKCS12_FILENAME, poolspecExtension, PROFILENAMEKEY, PROPERTY_FILENAME, PS_CONNECT_TIMEOUT, PS_CONNS_PER_THREAD, PS_CONNS_VECTOR_CAPACITY, PS_CONNS_VECTOR_INCREMENT, PS_INITIAL_CONNECTIONS, PS_MAX_BUSYTIME, PS_MAX_CONNECTIONS, PS_MAX_IDLETIME, PS_MAX_WORKER_THREADS, PS_MEASUREMENTS, PS_MEASUREMENTS_INTERVAL, PS_MIN_CONNECT_TIMEOUT, PS_MIN_CONNECTIONS, PS_MIN_MAX_BUSYTIME, PS_MIN_MAX_IDLETIME, PS_NEVER, PS_OVERFLOW_ALLOWED, PS_POOLING_ENABLED, PS_RECOVERY_TIME, RAS_PROPERTIES_FILENAME, RECOVER_CONNS, RTE_VERSION, RUNTIME_PARAM_HPAPPLEJB_HANDLE, RUNTIME_PARAM_HPAPPLEJB_HOME, SERVER_PROPERTIES_FILENAME, Sev, SHUTDOWN_CONNS, SHUTDOWN_DISCONNECT_TIMEOUT, SOFT_SHUTDOWN, SOFT_TEARDOWN, SR_SEPARATOR_CHAR, STASHKEYRINGPW, STASHUSERLISTPW, SYS_PROP_FOR_APPSERVER_NAME, SYS_PROP_FOR_CA400, SYS_PROP_FOR_INSTALL_DIR, SYS_PROP_FOR_JVM_ADMINISTRATION, SYS_PROP_FOR_JVM_SUFFIX, SYS_PROP_FOR_JVM_ZOSADMIN, SYS_PROP_FOR_ZOSADMIN_DRTE, SYS_PROP_FOR_ZOSLOGGING, TS_SEPARATOR_CHAR, USERLISTPW, userpoolExtension, Warn, ZOS_EJB_INSTANCE |
| Constructor Summary | |
|---|---|
HostScreen()
Default constructor |
|
HostScreen(Document xmld)
Construct a HostScreen from an hsc document. |
|
HostScreen(ECLPS eclps)
Construct a HostScreen object based on the data represented by a ECLPS presentation space. |
|
HostScreen(HostScreen eclps)
Construct a HostScreen object based on the data represented by another HostScreen presentation space. |
|
| Method Summary | |
|---|---|
void |
addBackShifts(char[] buffer)
Replace space with SOSI if the space at DBCS side. |
void |
addOrigin(String mapSetName,
String mapName)
Adds a mapset/map name combination for this map. |
String |
arabicDataExchange(String inputString,
boolean shapeArabicData)
|
String |
ArabicDataExchange(String inputString,
boolean shapeArabicData)
Deprecated. |
int |
caculateProperStringLength(char[] buffer)
Deprecated. |
int |
calculateProperStringLength(char[] buffer)
Originally this method is named "eraseShifts" but this method recalculate the proper length of the input buffer(String). |
char |
charAt(int cursorPos)
Returns a screen character from the host screen at the specified cursor position |
char |
charAt(int cursorPos,
int planar)
Returns character in the plane at a location. |
char |
charAt(int cursorPos,
String limitingAttrib)
Returns a screen character from the host screen at the specified cursor position. |
void |
claimUpdate(int source,
int type)
Monitors for most recent change occurance to the host screen. |
void |
clear()
Not implemented. |
boolean |
containsPenSelectableFields()
Tests if there is a pen selectable field |
String |
ConvertLogicalToVisual(String inputBuffer,
boolean isLTRImplicit,
boolean isLTRVisual)
Convert a bidi string from logical format to visual format. |
String |
ConvertLogicalToVisual(String inputBuffer,
boolean isLTRImplicit,
boolean isLTRVisual,
boolean compressLamAlef)
Convert a bidi string from logical format to visual format. |
int |
ConvertPosToCol(int pos)
Returns the column from the position using the column size of the hostscreen. |
static int |
ConvertPosToCol(int pos,
int sizecols)
Returns the column from the position using the column size of the hostscreen. |
int |
ConvertPosToRow(int pos)
Returns the row from the position using the column size of the hostscreen. |
static int |
ConvertPosToRow(int pos,
int sizecols)
Returns the row from the position using the column size given. |
int |
ConvertRowColToPos(int row,
int col)
Returns the position based on the row and column. |
static int |
ConvertRowColToPos(int row,
int col,
int sizecols)
Returns the position based on the row and column. |
String |
ConvertVisualToLogical(String inputBuffer,
boolean isLTRVisual,
boolean isLTRImplicit)
Convert a bidi string from visual format to logical format. |
String |
ConvertVisualToLogical(String inputBuffer,
boolean isLTRVisual,
boolean isLTRImplicit,
boolean swapchars)
Convert a bidi string from visual format to logical format. |
boolean[] |
decodeFieldPlane(int start,
int end,
int type)
Decodes the field plane for the given area for each character in the text plane. |
int |
distToNextField(int spot)
Returns the distance to the next field from the current position. |
int |
distToNextField(int spot,
int type)
Returns the distance to the next field from the current position. |
void |
doEnptuiField(com.ibm.hats.common.RequestScreenField rsf,
ECLPS ps)
|
void |
doEnptuiSelect(com.ibm.hats.common.RequestScreenField rsf,
Vector v,
ECLInputFieldAttribute fld,
int choiceIndex,
int choicePos,
ECLPS ps)
Simulate an enptui select the position specified. |
void |
doSelectionField(com.ibm.hats.common.RequestScreenField rsf,
ECLPS ps)
|
boolean |
ECLPSNeedsCommandUpdate()
Returns whether or not the HostScreen has had commands which should be sent to the host session |
boolean |
ECLPSNeedsCursorUpdate()
Returns whether or not the HostScreen has had cursor position changes which should be sent to the host session. |
boolean |
ECLPSNeedsTextUpdate()
Returns whether or not the HostScreen has had changes to the text plane which should be sent to the host session. |
boolean |
ECLPSNeedsUpdating()
Returns whether or not the HostScreen has had changes which should be sent to the host session. |
int |
encryptionLevel()
Returns the SSL status indicator (for HOD connection security). |
int |
eraseShifts(char[] buffer)
Erase SOSI in array. |
char[] |
ExpandLamAlef(char[] UniBuff,
int length,
boolean visualmode)
Expands the Arabic character LamAlef into two Arabic characters Lam and Alef. |
String |
extractDBCSString(int start,
int len)
Extract string from text plane with DBCS process in real time. |
int |
fieldLookup(int spot)
Returns which field is at the given location. |
short |
fieldShortLookup(int spot)
Returns the field short at the given location. |
String |
getArabicOrientation()
Returns whether the Arabic orientation is left-to-right ("ltr") or right-to-left ("rtl") |
int |
getBackgroundColor(int screenposition)
Gets the background color at the given position. |
static String |
getBlockScreenRegionString(BlockScreenRegion bsr,
HostScreen hs)
Returns the rectangle defined in the block screen region as a string. |
static String |
getBlockScreenRegionString(BlockScreenRegion bsr,
HostScreen hs,
String strbreak)
Returns the rectangle defined in the block screen region as a string. |
char[] |
getBoundaryPlane()
Returns the boundary plane. |
int |
GetCodePage()
Returns the codepage for the connection. |
int |
GetConnType()
Returns the connection type for the connection. |
int |
getCursorCol()
Returns the cursor position column. |
int |
GetCursorCol()
Returns the cursor position column. |
int |
getCursorPos()
Returns the cursor position. |
int |
GetCursorPos()
Returns the cursor position |
int |
getCursorRow()
Returns the cursor position row. |
int |
GetCursorRow()
Returns the cursor position row. |
boolean |
GetCursorVisible()
not in use |
com.ibm.hats.common.DBCSSettings |
getDBCSSettings()
Returns the DBCS settings for the HostScreen |
int |
getDefaultBackgroundColor()
Returns the default background color for the host screen. |
int |
getDefaultCharSet()
Returns the default cahracter set for the host screen. |
int |
getDefaultForegroundColor()
Returns the default foreground color for the host screen. |
String |
getDescription()
Returns the description of the HostScreen. |
Document |
getDocument()
Create an hsc document representing the host screen. |
com.ibm.hats.common.HostScreenEnptuiWindow[] |
getEnptuiWindows()
Returns the 5250 ENPTUI window data. |
HsrScreenField |
getFieldAssociatedWithPos(int pos)
Returns the host screen field at the given location. |
HostScreenField |
getFieldAssociatedWithPos(int row,
int col)
Returns the host screen field at the given location (includes the field separator bits at the beginning ). |
HsrScreenField |
getFieldAtPos(int pos)
Retrieves the HsrScreenField at the given location. |
HsrScreenField |
getFieldAtPos(int row,
int col)
Returns the host screen field at the given location. |
int |
getFieldCount()
Returns the number of fields in the HostScreen. |
HostScreenField |
getFieldFromAttributeLocation(int pos)
Returns the host screen field associated to the field separator bit at the given location. |
IScreenFieldList |
getFieldList()
Returns the HostScreenFieldList for this HostScreen. |
HostScreenFieldList |
GetFieldList()
Returns the HostScreenFieldList for this HostScreen. |
HostScreenFieldList |
getFieldList(int planes)
Returns the HostScreenFieldList for this HostScreen |
HostScreenFieldList |
GetFieldList(int planes)
Returns the HostScreenFieldList for this HostScreen. |
String |
getFieldName(int position)
|
int |
getForegroundColor(int screenposition)
Gets the foreground color at the given position. |
int |
getHashCode()
Returns the hashcode of the HostScreen. |
String |
GetHost()
Returns the host for the connection. |
Hashtable |
getHTMLDDS()
Returns the 5250 HTML DDS data. |
Vector |
getInputFieldAttributes()
Returns the input field attributes. |
int |
getInsertionPoint()
|
int |
getLastOIAStatus()
Returns the status indicator OIA bit. |
String |
GetLUName()
Returns the LU name (3270). |
String |
getName()
Returns the name of the HostScreen |
int |
getOriginCount()
|
String |
getOriginMap(int index)
|
String |
getOriginMapSet(int index)
|
HostScreen |
GetParent()
HOD consistency class: returns this class. |
int |
GetPort()
Returns the host port for the connection. |
int |
getProtectedFieldCount()
Returns the number of protected fields on this HostScreen (ECLPS). |
ECLPSBIDIServices |
GetPSBIDIServices()
Always returns null |
boolean |
getRuntimertl()
Returns if the current screen orientation is right-to-left. |
int |
GetScreen(char[] buffer,
int bufferLength,
int plane)
Returns the planar information of the screen. |
int |
GetScreen(char[] buffer,
int bufferLength,
int position,
int length,
int planei)
Returns the planar information of the screen. |
int |
GetScreen(char[] buffer,
int bufferLength,
int row,
int col,
int length,
int plane)
Returns the planar information of the screen. |
String |
getScreenId()
Returns the screen identifier of the HostScreen. |
int |
GetScreenRect(char[] buffer,
int bufferLength,
int startPos,
int endPos,
int plane)
Returns the rectangular planar information of the screen. |
int |
GetScreenRect(char[] buffer,
int bufferLength,
int startRow,
int startCol,
int endRow,
int endCol,
int plane)
Returns the rectangular planar information of the screen. |
String |
getScreenSettlingResults()
Returns the screen settling results. |
char |
getSelectorFieldType(ECLField f)
|
String[] |
GetSendKeyMnemonics()
HOD consistency class: returns example array of possible function key strings. |
String |
GetSessionName()
Returns the session name for the connection. |
String |
getSessionNumber()
Returns the session number of the HostScreen. |
String |
getSessionSize()
Returns the size of the host screen for the session. |
short[] |
getShortArray()
Returns the entire text plane as an array of type short. |
short[] |
getShortArray(int plane)
Returns the entire requested plane information as an array of type short. |
short[] |
getShortArray(int pos,
int len)
Returns the area of text planar information requested as an array of type short. |
short[] |
getShortArray(int position,
int len,
int planeval)
Returns the area of planar information requested as an array of type short |
boolean |
getShowCursor()
not in use |
int |
getSize()
Returns the size of the host screen. |
int |
GetSize()
Returns the size of the host screen. |
int |
getSizeCols()
Returns the number of columns in the host screen. |
int |
GetSizeCols()
Returns the number of columns in the host screen. |
int |
getSizeRows()
Returns the number of rows in the host screen. |
int |
GetSizeRows()
Returns the number of rows in the host screen. |
String |
GetString()
Returns the String represented by the host screen. |
int |
GetString(char[] buffer,
int bufferLength)
Returns the text planar information of the screen. |
int |
GetString(char[] buffer,
int bufferLength,
int position,
int length)
Returns the planar information of the screen. |
int |
GetString(char[] buffer,
int bufferLength,
int row,
int col,
int length)
Returns the text planar information of the screen. |
String |
getString(int pos,
int len)
Returns the String represented by the area specified on the host screen. |
String |
GetString(int pos,
int len)
Returns the String represented by the area specified from the host screen. |
String |
getString(int pos,
int len,
int fromPlane)
Returns the String represented by the area specified from the host screen. |
int |
GetString2(char[] buffer,
int bufferLength,
int position,
int length)
Returns the original text planar information of the screen. |
int |
GetString2(char[] buffer,
int bufferLength,
int row,
int col,
int length)
Returns the original text planar information of the screen. |
String |
getString2(int pos,
int len)
New method for DBCS session Returns the String represented by the area specified on the host screen. |
int |
getTotalFieldCount()
Returns the total number of fields on this HostScreen (ECLPS). |
int |
getUnprotectedFieldCount()
Returns the number of unprotected fields on this HostScreen (ECLPS). |
int |
getVisibleString(char[] buffer,
int bufferLength,
int position,
int length)
Returns an array of visible text (non hidden text) at the specified 1-based linear start position |
int |
getVisibleString(char[] buffer,
int bufferLength,
int row,
int col,
int length)
Returns an array of visible text (non hidden text) at the specified row, column position.. |
String |
GetWorkstationID()
Returns the Workstation ID (5250) |
void |
HandleFEData(char[] UniBuff)
Convert FE Arabic data to 06 so the BIDI classes are not loaded in each file. |
String |
HandleGVBIDISwap(String inputString,
boolean symswap,
boolean numswap)
|
boolean |
is3270()
Returns whether or not the connection is 3270. |
boolean |
is3270Screen()
Returns whether or not the connection is 3270. |
boolean |
is5250()
Returns whether or not the connection is 5250. |
boolean |
is5250Screen()
Returns whether or not the connection is 5250. |
boolean |
isAccentedCharacter()
Returns the useAccentedCharacters setting for the connection. |
boolean |
isArabic()
Returns whether or not the session is Arabic session. |
boolean |
isArabicSession()
Returns whether or not the session is an Arabic session. |
boolean |
isArea(int start,
int end,
int type,
boolean value)
Given a "start" and an "end", is the area's field "type" set to "value"? Example : is from 1 to 10 protected data? would be isArea(1,10,CONST_HostScreenFIELDTYPE_PROTECTED,true) |
boolean |
isAutoFldRev()
Returns stored value of current HATS emulation auto field reverse mode. |
boolean |
isBidi()
Returns whether or not the session is a bidirectional session. |
boolean |
isBIDI5250()
indicates if the screen is 5250 and BIDI |
boolean |
isBIDISession()
Returns whether or not the session is a bidirectional session. |
static boolean |
isBlankScreen(Properties settings,
HostScreen screen)
|
boolean |
IsDBCSChar(char charInput)
Tests if the character given is a DBCS character. |
boolean |
isDbcsScreen()
indicates if the screen is DBCS |
boolean |
isDBCSSession()
Returns whether or not the session is a DBCS Session. |
boolean |
isDisableWesternNumbersEntry()
|
boolean |
isDisplay(int pos)
Tests if the position given is displayable. |
boolean |
isFieldShapeDisabled()
indicates if the screen is field shape disabled |
boolean |
isHebrewSession()
Returns whether or not the session is Hebrew session. |
boolean |
isHighIntensity(int pos)
Tests if the position given is high intensity. |
boolean |
isHighSurrogate(char unichar)
An util method to check whether a char is a JIS2004 high byte char, using HOD code |
boolean |
isLowSurrogate(char unichar)
An util method to check whether a char is a JIS2004 low byte char, using HOD code |
boolean |
isMessageWaiting()
Returns the message waiting status |
boolean |
isModified(int pos)
Tests if the position given is modified. |
boolean |
isNumeric(int pos)
Tests if the position given is numeric. |
boolean |
isNumericSwapping()
Returns whether or not numeric swapping is enabled. |
boolean |
isPenDetectable(int pos)
Tests if the position given is pen detectable. |
boolean |
isProtected(int pos)
Tests if the position given is protected. |
boolean |
isRLTB()
indicates if the screen has a right to left tabbing order |
boolean |
isRTLCursorDirection()
|
boolean |
isRTLCursorDirectionSaved()
|
boolean |
isRTLScreen()
Returns whether the screen is right-to-left oriented. |
boolean |
isScreenReversed()
Returns whether or not the screen is reversed. |
boolean |
IsSuppressClearEvent()
not in use |
boolean |
isSurrogate(char highchar,
char lowchar)
An util method to check whether a char is a JIS2004 char, using HOD code |
boolean |
isSymmetricSwapping()
Returns the current value of Directional Swapping. |
boolean |
isTNEnhanced()
Returns whether or not the telnet connection is enhanced (TN3270E). |
boolean |
isUnicodeField()
Tests whether the current position is in a Unicode enabled field. |
boolean |
isUnicodeField(int pos)
Tests whether the position is in a Unicode enabled field. |
boolean |
isVT()
Returns whether or no the connection is VT. |
boolean |
isVTLogical()
Tests whether or not the VT session is a logical session. |
int |
lastUpdateSource()
Returns the source of the last update to the host screen. |
int |
nextFieldStart(int spot)
Returns the next field from the current position. |
int |
nextFieldStart(int spot,
int type)
Returns the next field from the current position with a given type indicator. |
String |
outputBoundaryDebug()
|
void |
RegisterPSEvent(ECLPSListener listener)
not in use |
void |
RegisterPSEvent(ECLPSListener listener,
int type)
not in use |
String |
RemoveTail(String str)
Removes the Bidi tail attribute from the given string. |
void |
resetToECLPS(ECLPS eclps)
This method initializes the HostScreen object based on the data represented by the ECLPS presentation space. |
void |
resetToHostScreen(HostScreen eclps)
Initialize the HostScreen object based on the data represented by another HostScreen presentation space. |
void |
restoreECLPStextPlane()
Restore ECLPS's text plane form hostscreen's text plane |
int |
SearchString(String text,
int direction)
Searches for the given text in the host screen. |
int |
SearchString(String text,
int position,
int direction)
Searches for the given text in the host screen. |
int |
SearchString(String text,
int row,
int column,
int direction)
Searches for the given text in the host screen. |
int |
SearchText(String text,
int direction)
Searches for the given text in the host screen. |
int |
SearchText(String text,
int position,
int direction)
Searches for the given text in the host screen. |
int |
SearchText(String text,
int row,
int column,
int direction)
Searches for the given text in the host screen. |
void |
SendKeys(String text)
Add keys to keytext as if the text entered is a comand |
void |
SendKeys(String text,
int pos)
Add keys to keytext as if the text entered is a comand at the specified cursor position. |
void |
SendKeys(String text,
int row,
int col)
Add keys to keytext as if the text entered is a comand at the specified cursor position. |
void |
SetAccentedCharacter(boolean bAccentedCharacters)
Sets the useAccentedCharacters setting for the connection. |
void |
setArabicOrientation(String Orientation)
Sets the Arabic orientation either right-to-left ("rtl") or left-to-right ("ltr"). |
void |
setAutoFldRev(boolean isAutoFldRev)
Sets the stored value of current HATS emulation auto field reverse Bidi mode |
void |
SetCodePage(int codepage)
Sets the codepage for the connection. |
void |
SetConnType(int conntype)
Sets the connection type for the connection. |
void |
setCursorCol(int col)
Sets the cursor position column |
void |
SetCursorCol(int col)
Sets the cursor position column. |
void |
setCursorPos(int pos)
Sets the cursor position. |
void |
SetCursorPos(int pos)
Sets the cursor position. |
void |
setCursorPos(int row,
int col)
Sets the cursor position. |
void |
SetCursorPos(int row,
int col)
Sets the cursor position. |
void |
setCursorRow(int row)
Sets the cursor position row |
void |
SetCursorRow(int row)
Sets the cursor position row. |
void |
SetCursorVisible(boolean bVisible)
not in use |
void |
setDefaultBackgroundColor(int background)
Sets the host screen background color. |
void |
setDefaultCharSet(int charset)
Sets the host screen default character set. |
void |
setDefaultForegroundColor(int foreground)
Sets the host screen foreground color. |
void |
setDescription(String description)
Sets a description for the host screen. |
void |
setDisableWesternNumbersEntry(boolean isDisabled)
Set the flag disableNumSwap to indicate if the "Disable entry of Arabic-Western digits in RTL screens checkbox is checked or not |
void |
setEnptuiWindows(com.ibm.hats.common.HostScreenEnptuiWindow[] hsew)
Sets the 5250 ENPTUI window data. |
boolean |
setFieldName(int position,
String label)
Sets the BMS field name for a field starting at a given position. |
void |
setFieldShapeDisabled(boolean FieldShapeDisabled)
|
void |
SetHost(String host)
Sets the host name for the connection. |
void |
setHTMLDDS(Hashtable h)
Sets the 5250 HTML DDS data. |
void |
setInputFieldAttributes(Vector v)
Sets the input field attributes. |
void |
SetisRTLScreen(boolean isrtlscreen)
Sets whether or not the screen orientation is right-to-left. |
void |
SetisScreenReversed(boolean isscreenVTreversed)
Sets whether or not the screen is reversed. |
void |
SetisTNEnhanced(boolean istnenhanced)
Sets the the enhanced mode for the connection. |
void |
SetLUName(String luname)
Sets the LU name for the connection (3270). |
void |
setNumericSwap(boolean value)
|
void |
SetPort(int port)
Sets the port number for the connection. |
void |
setProcessShifts(boolean processShifts)
|
void |
setRuntimertl(boolean value)
Sets whether or not the screen orientation is right-to-left. |
void |
setScreenSettlingResults(String s)
Sets the screen settling results. |
void |
setSessionID(String sessionid)
Sets the host screen session identifier. |
void |
SetSessionName(String sessionname)
Sets the session name for the connection. |
void |
setSessionNumber(String sessionnumber)
Sets the host screen session number. |
void |
setSessionSize(String strsz)
Sets the session size. |
void |
setShowCursor(boolean showIt)
not in use |
void |
setSize(int size)
Sets the size of the screen. |
void |
SetSize(int size)
Sets the screen size. |
void |
setSize(int rows,
int cols)
Sets the screen size. |
void |
SetSize(int rows,
int cols)
Sets the screen size. |
void |
setSizeCols(int cols)
Sets the number of columns. |
void |
SetSizeCols(int cols)
Sets the number of columns |
void |
setSizeRows(int rows)
Sets the number of rows. |
void |
SetSizeRows(int rows)
Sets the number of rows. |
void |
setString_Fields_Insert_2(String text,
int pos)
Sets the strings into fields using insertion using a different algorithm. |
void |
setString_Fields_Insert(String text,
int pos)
Sets the strings into fields using insert. |
void |
setString_Fields_Overwrite_2(String text,
int pos)
Sets the strings into fields using overwrite using a different algorithm. |
void |
setString_Fields_Overwrite(String text,
int pos)
Sets the strings into fields using overwrite and a specified position. |
void |
SetString(String text)
Sets the text specified into the host at the beginning of the host screen. |
void |
SetString(String text,
int pos)
Sets the text specified into the host at the specified location of the host screen. |
void |
SetString(String text,
int row,
int column)
Sets the text specified into the host at the specified location of the host screen. |
void |
SetString(String text,
int row,
int column,
boolean suppressUnchangedData)
Sets the text specified into the host at the specified location of the host screen. |
void |
setSupportsHighlighting(boolean supporthighlight)
Sets whether or not the host screen supports highlighting. |
void |
SetSuppressClearEvent(boolean argVal)
not in use |
void |
setSymmetricSwap(boolean value)
|
void |
SetText(String text)
Sets the text specified into the host at the beginning of the host screen. |
void |
SetText(String text,
int pos)
Sets the text specified into the host at the specified location of the host screen. |
void |
SetText(String text,
int row,
int column)
Sets the text specified into the host at the specified location of the host screen. |
void |
SetWorkstationID(String workstationid)
Sets the workstation ID name for the connection (5250). |
short |
shortForField(int field)
Returns the field short for a given field. |
boolean |
supportsHighlighting()
Returns whether or not this host screen supports highlighting in fields. |
String |
toString()
Return a String representation of the HostScreen as a single line |
void |
UnregisterPSEvent(ECLPSListener listener)
not in use |
void |
UnregisterPSEvent(ECLPSListener listener,
int type)
not in use |
void |
updateECLPS(ECLPS ps)
Update the host with the information in the HostScreen. |
void |
updateECLPS(ECLPS ps,
Properties settings)
This method updates the PS with the contents of the HostScreen. |
void |
updateFromRequestScreen(com.ibm.hats.common.RequestScreen rs)
Updates the host screen from the HTTP request. |
void |
UpdateRequestScreen(com.ibm.hats.common.RequestScreen rs)
Not implemented. |
String |
UpdateStatusString()
Returns the sources and types of the last update to the host screen. |
void |
updateTextScreen(int start,
int length,
String text)
Update the text plane with new text. |
protected boolean |
validFingerprint(byte[] fingerPrint)
|
boolean |
WaitForAttrib(int row,
int col,
char attrib,
int plane)
not in use |
boolean |
WaitForAttrib(int row,
int col,
char attrib,
int plane,
long timeOut,
boolean waitForInput)
not in use |
boolean |
WaitForCursor(int row,
int col,
long timeOut,
boolean waitForInput)
not in use |
boolean |
WaitForScreen(ECLScreenDesc screenDesc)
not in use |
boolean |
WaitForScreen(ECLScreenDesc screenDesc,
long timeOut)
not in use |
boolean |
WaitForString(String str)
not in use |
boolean |
WaitForString(String str,
int row,
int col)
not in use |
boolean |
WaitForString(String str,
int row,
int col,
long timeOut,
boolean waitForInput,
boolean caseSensitive)
not in use |
boolean |
WaitForStringInRect(String str,
int sRow,
int sCol,
int eRow,
int eCol)
not in use |
boolean |
WaitForStringInRect(String str,
int sRow,
int sCol,
int eRow,
int eCol,
long timeOut,
boolean waitForInput,
boolean caseSensitive)
not in use |
boolean |
WaitWhileAttrib(int row,
int col,
char attrib,
int plane)
not in use |
boolean |
WaitWhileAttrib(int row,
int col,
char attrib,
int plane,
long timeOut,
boolean waitForInput)
not in use |
boolean |
WaitWhileCursor(int row,
int col)
not in use |
boolean |
WaitWhileCursor(int row,
int col,
long timeOut,
boolean waitForInput)
not in use |
boolean |
WaitWhileScreen(ECLScreenDesc screenDesc)
not in use |
boolean |
WaitWhileScreen(ECLScreenDesc screenDesc,
long timeOut)
not in use |
boolean |
WaitWhileString(String str)
not in use |
boolean |
WaitWhileString(String str,
int row,
int col)
not in use |
boolean |
WaitWhileString(String str,
int row,
int col,
long timeOut,
boolean waitForInput,
boolean caseSensitive)
not in use |
boolean |
WaitWhileStringInRect(String str,
int sRow,
int sCol,
int eRow,
int eCol)
not in use |
boolean |
WaitWhileStringInRect(String str,
int sRow,
int sCol,
int eRow,
int eCol,
long timeOut,
boolean waitForInput,
boolean caseSensitive)
not in use |
| Methods inherited from class com.ibm.hsr.screen.HsrScreen |
|---|
getFieldAttributes, getHsrBidiServices, getScreenFingerprint, getScreenRect, getScreenSize, getScreenText, getScreenText, getScreenText, getScreenText, getScreenText, setHsrBidiServices, setScreenSize |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static int TEXT_PLANE
public static int FIELD_PLANE
public static int EXTFIELD_PLANE
public static int EXFIELD_PLANE
public static int COLOR_PLANE
public static int DBCS_PLANE
public static int GRID_PLANE
public static int HOST_PLANE
public static int PS_PLANE
public static int VISIBLE_TEXT_PLANE
public static int PROTECTED_TEXT_PLANE
public static int planeDepth
public static Hashtable limitingAttribToPlane
public static final int SESSION_TYPE_3270
public static final int SESSION_TYPE_5250
public static final int SESSION_TYPE_CICS
public static final int SESSION_TYPE_VT
public static final String SESSION_TN_ENHANCED
public char[][] plane
public static final char END_BOUNDARY
public static final char INSIDE_FIELD
public int[][] fieldlist
public String[] fieldname
public ArrayList mapOriginList
public ArrayList mapSetOriginList
public com.ibm.hats.common.SelectorField[] pentype
public Vector keystext
public static final int SOURCE_ECLPS
public static final int SOURCE_METHOD
public static final int SOURCE_HOSTSCREEN
public static final int SOURCE_DOCUMENT
public static final int UPDATE_ALL
public static final int UPDATE_CURSOR
public static final int UPDATE_COMMAND
public static final int UPDATE_TEXT
public static final int UPDATE_INFO
public static final int SSL_DONT_KNOW
public static final int SSL_OFF
public static final int SSL_ON
public static final int CONST_HostScreenFIELDTYPE_HIGHINTENSITY
public static final int CONST_HostScreenFIELDTYPE_NUMERIC
public static final int CONST_HostScreenFIELDTYPE_MODIFIED
public static final int CONST_HostScreenFIELDTYPE_PENDETECTABLE
public static final int CONST_HostScreenFIELDTYPE_PROTECTED
public static final int CONST_HostScreenFIELDTYPE_DISPLAY
| Constructor Detail |
|---|
public HostScreen(HostScreen eclps)
eclps - The HATS representation of the host session presentation space and associated data.public HostScreen(ECLPS eclps)
eclps - The HOD representation of the host session presentation space and associated datapublic HostScreen()
public HostScreen(Document xmld)
xmld - The .hsc xml data representation of the host screen object| Method Detail |
|---|
public int getInsertionPoint()
public void claimUpdate(int source,
int type)
source - Source indicator for eventtype - The change indicator typentpublic int lastUpdateSource()
public String UpdateStatusString()
public boolean ECLPSNeedsUpdating()
public boolean ECLPSNeedsTextUpdate()
public boolean ECLPSNeedsCommandUpdate()
public boolean ECLPSNeedsCursorUpdate()
public int getLastOIAStatus()
public int encryptionLevel()
public boolean isMessageWaiting()
public String toString()
toString in class Objectpublic void resetToECLPS(ECLPS eclps)
eclps - The HOD representation of the host session presentation space and associated datapublic void resetToHostScreen(HostScreen eclps)
eclps - The HATS representation of the host session presentation space and associated data.
public short[] getShortArray(int position,
int len,
int planeval)
position - The start of the array information being requested, must be >=0 and < hostScreen.GetSize()len - The length of the array information being requested, must be >0 and < hostScreen.GetSize()planeval - The plane indicator of which plane is requested, such as TEXT_PLANE
public short[] getShortArray(int pos,
int len)
pos - The start of the array information being requested, must be >=0 and < hostScreen.GetSize()len - The length of the array information being requested, must be >0 and < hostScreen.GetSize()
public short[] getShortArray(int plane)
plane - The plane indicator of which plane is requested, such as TEXT_PLANE
public short[] getShortArray()
public void updateECLPS(ECLPS ps,
Properties settings)
ps - The presentation spacesettings - Settings to effect the update.public void updateECLPS(ECLPS ps)
ps - The HOD presentation space for the host sessionpublic void UpdateRequestScreen(com.ibm.hats.common.RequestScreen rs)
rs - The request screenpublic Document getDocument()
public void clear()
public int GetSize()
GetSize in class HsrScreenpublic int GetSizeRows()
GetSizeRows in class HsrScreenpublic int GetSizeCols()
GetSizeCols in class HsrScreenpublic int getSize()
getSize in class HsrScreenpublic int getSizeRows()
getSizeRows in class HsrScreenpublic int getSizeCols()
getSizeCols in class HsrScreenpublic String getSessionSize()
public void SetSize(int size)
size - The new screen size.public void setSessionSize(String strsz)
strsz - The new session size.
public void SetSize(int rows,
int cols)
rows - The number of rowscols - The number of columnspublic void SetSizeRows(int rows)
rows - The number of rows.public void SetSizeCols(int cols)
cols - The number of columns
public void setSize(int rows,
int cols)
rows - The number of rowscols - The number of columnspublic void setSize(int size)
size - public void setSizeRows(int rows)
setSizeRows in class HsrScreenrows - The number of rows.public void setSizeCols(int cols)
setSizeCols in class HsrScreencols - The number of columns.public int GetCursorPos()
GetCursorPos in class HsrScreenpublic int GetCursorRow()
GetCursorRow in class HsrScreenpublic int GetCursorCol()
GetCursorCol in class HsrScreenpublic int getCursorPos()
getCursorPos in class HsrScreenpublic int getCursorRow()
getCursorRow in class HsrScreenpublic int getCursorCol()
getCursorCol in class HsrScreenpublic void SetCursorPos(int pos)
pos - The new cursor position
public void SetCursorPos(int row,
int col)
row - The cursor position rowcol - The cursor position columnpublic void SetCursorRow(int row)
row - The cursor position rowpublic void SetCursorCol(int col)
col - The cursor position columnpublic void setCursorPos(int pos)
setCursorPos in class HsrScreenpos - The cursor position
public void setCursorPos(int row,
int col)
row - The cursor position rowcol - The cursor position columnpublic void setCursorRow(int row)
setCursorRow in class HsrScreenrow - The cursor position rowpublic void setCursorCol(int col)
setCursorCol in class HsrScreencol - The cursor position columnpublic HostScreen GetParent()
public String[] GetSendKeyMnemonics()
public void SendKeys(String text)
text - The text of the command
public void SendKeys(String text,
int pos)
text - The text of the commandpos - The cursor position to insert text.
public void SendKeys(String text,
int row,
int col)
text - The text of the commandrow - The row to insert the text.col - The column to insert the text.public String getName()
public String getSessionNumber()
public String getDescription()
public String getScreenId()
public int getFieldCount()
getFieldCount in class HsrScreenpublic int getHashCode()
public com.ibm.hats.common.DBCSSettings getDBCSSettings()
public boolean supportsHighlighting()
public int getDefaultForegroundColor()
public int getDefaultBackgroundColor()
public int getDefaultCharSet()
public void setDescription(String description)
description - The description for the host screen.public void setSupportsHighlighting(boolean supporthighlight)
supporthighlight - true if the host screen support highlighting, false otherwise.public void setSessionNumber(String sessionnumber)
sessionnumber - The session number.public void setSessionID(String sessionid)
sessionid - The session identifier.public void setDefaultForegroundColor(int foreground)
foreground - The host screen foreground color.public void setDefaultBackgroundColor(int background)
background - The host screen background color.public void setDefaultCharSet(int charset)
charset - The default character set.
public int SearchText(String text,
int direction)
text - The text to look fordirection - The direction to search the text
public int SearchString(String text,
int direction)
text - The text to look fordirection - The direction to search the text
public int SearchText(String text,
int row,
int column,
int direction)
text - The text to look forrow - The starting row for the searchcolumn - The starting column for the searchdirection - The direction to search the text
public int SearchString(String text,
int row,
int column,
int direction)
text - The text to look forrow - The starting row for the searchcolumn - The starting column for the searchdirection - The direction to search the text
public int SearchText(String text,
int position,
int direction)
text - The text to look forposition - The starting position for the searchdirection - The direction to search the text
public int SearchString(String text,
int position,
int direction)
text - The text to look forposition - The starting position for the searchdirection - The direction to search the text
public ECLPSBIDIServices GetPSBIDIServices()
public int GetScreen(char[] buffer,
int bufferLength,
int plane)
buffer - The buffer to place text intobufferLength - The length of the bufferplane - The plane from which to extract data
public int GetString(char[] buffer,
int bufferLength)
buffer - The buffer to place text intobufferLength - The length of the buffer
public int GetScreen(char[] buffer,
int bufferLength,
int row,
int col,
int length,
int plane)
buffer - The buffer to place text intobufferLength - The length of the bufferrow - The row to start fromcol - The column to start fromlength - The length of data to retrieveplane - The plane from which to extract data
public int GetString(char[] buffer,
int bufferLength,
int row,
int col,
int length)
buffer - The buffer to place text intobufferLength - The length of the bufferrow - The row to start fromcol - The column to start fromlength - The length of data to retrieve
public int GetScreen(char[] buffer,
int bufferLength,
int position,
int length,
int planei)
buffer - The buffer to place text intobufferLength - The length of the bufferposition - The position to start fromlength - The length of data to retrieveplanei - The plane from which to extract data
public String getString(int pos,
int len)
pos - The starting position of the Stringlen - The length of the String to extract
public String getString(int pos,
int len,
int fromPlane)
pos - The starting position of the Stringlen - The length of the String to extractfromPlane - The plane to extract the string from
public String GetString(int pos,
int len)
pos - The starting position of the Stringlen - The length of the String to extract
public String GetString()
public int GetString(char[] buffer,
int bufferLength,
int position,
int length)
buffer - The buffer to place text intobufferLength - The length of the bufferposition - The position to start fromlength - The length of data to retrieve
public int getVisibleString(char[] buffer,
int bufferLength,
int row,
int col,
int length)
buffer - buffer to set the text intobufferLength - length of the bufferrow - 1-based row start positioncol - 1-based column start positionlength - number of characters to get
public int getVisibleString(char[] buffer,
int bufferLength,
int position,
int length)
buffer - buffer to set the text intobufferLength - length of the bufferposition - 1-based linear start positionlength - number of characters to get
public int GetScreenRect(char[] buffer,
int bufferLength,
int startPos,
int endPos,
int plane)
buffer - The buffer to place text intobufferLength - The length of the bufferstartPos - The position to start fromendPos - The column to end Atplane - The plane form which to extract data
public int GetScreenRect(char[] buffer,
int bufferLength,
int startRow,
int startCol,
int endRow,
int endCol,
int plane)
buffer - The buffer to place text intobufferLength - The length of the bufferstartRow - The row to start fromstartCol - The column to start fromendRow - The row to end atendCol - The column to end atplane - The plane form which to extract data
public void SetText(String text)
text - The text to place on the host screenpublic void SetString(String text)
text - The text to place on the host screen
public void SetText(String text,
int pos)
text - The text to place on the host screen.pos - The location to set the text.
public void SetString(String text,
int pos)
text - The text to place on the host screen.pos - The location to set the text.
public void SetText(String text,
int row,
int column)
text - The text to place on the host screen.row - The row to set the text.column - The column to set the text.
public void SetString(String text,
int row,
int column,
boolean suppressUnchangedData)
text - The text to place on the host screen.row - The row to set the text.column - The column to set the text.suppressUnchangedData - true if unchanged data should not be sent to the host application, false otherwise
public void SetString(String text,
int row,
int column)
text - The text to place on the host screen.row - The row to set the text.column - The column to set the text.public void RegisterPSEvent(ECLPSListener listener)
public void RegisterPSEvent(ECLPSListener listener,
int type)
public void UnregisterPSEvent(ECLPSListener listener)
public void UnregisterPSEvent(ECLPSListener listener,
int type)
public boolean WaitForAttrib(int row,
int col,
char attrib,
int plane)
public boolean WaitForAttrib(int row,
int col,
char attrib,
int plane,
long timeOut,
boolean waitForInput)
public boolean WaitForCursor(int row,
int col,
long timeOut,
boolean waitForInput)
public boolean WaitForScreen(ECLScreenDesc screenDesc)
public boolean WaitForScreen(ECLScreenDesc screenDesc,
long timeOut)
public boolean WaitForString(String str)
public boolean WaitForString(String str,
int row,
int col)
public boolean WaitForString(String str,
int row,
int col,
long timeOut,
boolean waitForInput,
boolean caseSensitive)
public boolean WaitForStringInRect(String str,
int sRow,
int sCol,
int eRow,
int eCol)
public boolean WaitForStringInRect(String str,
int sRow,
int sCol,
int eRow,
int eCol,
long timeOut,
boolean waitForInput,
boolean caseSensitive)
public boolean WaitWhileAttrib(int row,
int col,
char attrib,
int plane)
public boolean WaitWhileAttrib(int row,
int col,
char attrib,
int plane,
long timeOut,
boolean waitForInput)
public boolean WaitWhileCursor(int row,
int col)
public boolean WaitWhileCursor(int row,
int col,
long timeOut,
boolean waitForInput)
public boolean WaitWhileScreen(ECLScreenDesc screenDesc)
public boolean WaitWhileScreen(ECLScreenDesc screenDesc,
long timeOut)
public boolean WaitWhileString(String str)
public boolean WaitWhileString(String str,
int row,
int col)
public boolean WaitWhileString(String str,
int row,
int col,
long timeOut,
boolean waitForInput,
boolean caseSensitive)
public boolean WaitWhileStringInRect(String str,
int sRow,
int sCol,
int eRow,
int eCol)
public boolean WaitWhileStringInRect(String str,
int sRow,
int sCol,
int eRow,
int eCol,
long timeOut,
boolean waitForInput,
boolean caseSensitive)
public int getTotalFieldCount()
getTotalFieldCount in class HsrScreenpublic int getProtectedFieldCount()
public int getUnprotectedFieldCount()
public HostScreenFieldList GetFieldList()
public HostScreenFieldList GetFieldList(int planes)
planes - Not used.
public IScreenFieldList getFieldList()
getFieldList in class HsrScreenpublic HostScreenFieldList getFieldList(int planes)
planes - Not used
public boolean isScreenReversed()
public void SetisScreenReversed(boolean isscreenVTreversed)
isscreenVTreversed - true if the screen is reversed, false otherwise.public void SetCursorVisible(boolean bVisible)
public boolean GetCursorVisible()
public boolean IsSuppressClearEvent()
public void SetSuppressClearEvent(boolean argVal)
public boolean getShowCursor()
public void setShowCursor(boolean showIt)
public void updateTextScreen(int start,
int length,
String text)
start - The starting location to begin the updatelength - The length of the area to updatetext - The text to update the screen with
public void doEnptuiField(com.ibm.hats.common.RequestScreenField rsf,
ECLPS ps)
public void doEnptuiSelect(com.ibm.hats.common.RequestScreenField rsf,
Vector v,
ECLInputFieldAttribute fld,
int choiceIndex,
int choicePos,
ECLPS ps)
rsf - Not used.v - Not used.fld - Input field attribute.choiceIndex - Not used.choicePos - To position for the simulated selection.ps - The presentation space.
public void doSelectionField(com.ibm.hats.common.RequestScreenField rsf,
ECLPS ps)
public void updateFromRequestScreen(com.ibm.hats.common.RequestScreen rs)
rs - The request from the browser form.public int GetCodePage()
public boolean isAccentedCharacter()
public String GetHost()
public int GetPort()
public int GetConnType()
public String GetSessionName()
public boolean isTNEnhanced()
public String GetLUName()
public String GetWorkstationID()
public void SetCodePage(int codepage)
codepage - The codepage.public void SetAccentedCharacter(boolean bAccentedCharacters)
bAccentedCharacters - true if using accented characters, false otherwise.public void SetHost(String host)
host - The host name.public void SetPort(int port)
port - The port numberpublic void SetConnType(int conntype)
conntype - The connection typepublic void SetSessionName(String sessionname)
sessionname - The session name.public void SetisTNEnhanced(boolean istnenhanced)
istnenhanced - true if the telnet connection is enhanced (TN3270E), false otherwise.public void SetLUName(String luname)
luname - The LU name.public void SetWorkstationID(String workstationid)
workstationid - The workstation id.public boolean isBidi()
isBidi in class HsrScreenpublic boolean isArabic()
isArabic in class HsrScreenpublic boolean isHebrewSession()
public boolean isDbcsScreen()
isDbcsScreen in class HsrScreenpublic boolean isFieldShapeDisabled()
public void setFieldShapeDisabled(boolean FieldShapeDisabled)
public void setSymmetricSwap(boolean value)
public void setNumericSwap(boolean value)
public boolean isRLTB()
public boolean isBIDI5250()
public void setString_Fields_Overwrite(String text,
int pos)
text - The string to write into the host screenpos - The starting position
public void setString_Fields_Insert(String text,
int pos)
text - The string to write into the host screenpos - The starting position
public void setString_Fields_Insert_2(String text,
int pos)
text - The string to write into the host screenpos - The starting position
public void setString_Fields_Overwrite_2(String text,
int pos)
text - The string to write into the host screenpos - The starting position
public boolean isArea(int start,
int end,
int type,
boolean value)
start - The starting positionend - The ending positiontype - The type indicator of field information item for datavalue - The value that the type indicator should be
public boolean[] decodeFieldPlane(int start,
int end,
int type)
start - The starting position.end - The ending positiontype - The type indicator
public char charAt(int cursorPos)
HsrScreen
charAt in class HsrScreencursorPos - - position for retrieving the screen character
public char charAt(int cursorPos,
String limitingAttrib)
HsrScreen
charAt in class HsrScreencursorPos - Position for retrieving the screen character.limitingAttrib - Limit the screen text, for example, return protected-text only, or visible-text only
(such as HsrScreen variable VISIBLE_TEXT_DATA).
public int fieldLookup(int spot)
spot - The position to look for the field
public short shortForField(int field)
field - The field position (0 for first field)
public short fieldShortLookup(int spot)
spot - The position to look for the field
public int nextFieldStart(int spot)
spot - The starting position
public int distToNextField(int spot)
spot - The starting position
public int nextFieldStart(int spot,
int type)
spot - The starting positiontype - The type indicator for the field, ex. CONST_HostScreenFIELDTYPE_PROTECTED
public int distToNextField(int spot,
int type)
spot - The starting positiontype - The type indicator for the field, ex. CONST_HostScreenFIELDTYPE_PROTECTED
public boolean isHighIntensity(int pos)
pos - The position to check
public boolean isModified(int pos)
pos - The position to check
public boolean isProtected(int pos)
pos - The position to check
public boolean isNumeric(int pos)
pos - The position to check
public boolean isPenDetectable(int pos)
pos - The position to check
public boolean isDisplay(int pos)
pos - The position to check
public boolean IsDBCSChar(char charInput)
charInput - The character to check
public boolean isHighSurrogate(char unichar)
unichar - High byte characterpublic boolean isLowSurrogate(char unichar)
unichar - Low byte character
public boolean isSurrogate(char highchar,
char lowchar)
highchar - High byte characterlowchar - Low byte characterpublic int eraseShifts(char[] buffer)
buffer - The array need to check
public int caculateProperStringLength(char[] buffer)
public int calculateProperStringLength(char[] buffer)
buffer - The array need to check
public void addBackShifts(char[] buffer)
buffer - The array need to checkpublic void restoreECLPStextPlane()
public int GetString2(char[] buffer,
int bufferLength,
int row,
int col,
int length)
buffer - The buffer to place text intobufferLength - The length of the bufferrow - The row to start fromcol - The column to start fromlength - The length of data to retrieve
public int GetString2(char[] buffer,
int bufferLength,
int position,
int length)
buffer - The buffer to place text intobufferLength - The length of the bufferposition - The position to start fromlength - The length of data to retrieve
public String getString2(int pos,
int len)
pos - The starting position of the Stringlen - The length of the String to extract
public String extractDBCSString(int start,
int len)
start - The starting position of the Stringlen - The length of the String to extract
public String getScreenSettlingResults()
public void setScreenSettlingResults(String s)
s - The string data of the screen settling results.public boolean is3270Screen()
is3270Screen in class HsrScreenpublic boolean is5250Screen()
is5250Screen in class HsrScreenpublic boolean isVT()
public HsrScreenField getFieldAtPos(int row,
int col)
getFieldAtPos in class HsrScreenrow - The starting row positioncol - The starting column position
public HsrScreenField getFieldAtPos(int pos)
HsrScreen
getFieldAtPos in class HsrScreenpos - - the position of the screen
public HostScreenField getFieldAssociatedWithPos(int row,
int col)
row - The starting row positioncol - The starting column position
public HsrScreenField getFieldAssociatedWithPos(int pos)
getFieldAssociatedWithPos in class HsrScreenpos - The starting position
public int getBackgroundColor(int screenposition)
getBackgroundColor in class HsrScreenscreenposition - The 1-based screen position.
public int getForegroundColor(int screenposition)
getForegroundColor in class HsrScreenscreenposition - The 1-based screen position.
public HostScreenField getFieldFromAttributeLocation(int pos)
pos - The starting position
protected boolean validFingerprint(byte[] fingerPrint)
public char[] getBoundaryPlane()
public String outputBoundaryDebug()
public static String getBlockScreenRegionString(BlockScreenRegion bsr,
HostScreen hs)
bsr - The region of the screen to retrievehs - The host screen object
public static String getBlockScreenRegionString(BlockScreenRegion bsr,
HostScreen hs,
String strbreak)
bsr - The region of the screen to retrievehs - The host screen objectstrbreak - The row separator string to use
public Vector getInputFieldAttributes()
public void setInputFieldAttributes(Vector v)
v - The input field attributespublic com.ibm.hats.common.HostScreenEnptuiWindow[] getEnptuiWindows()
public void setEnptuiWindows(com.ibm.hats.common.HostScreenEnptuiWindow[] hsew)
hsew - The 5250 ENPTUI window data.public Hashtable getHTMLDDS()
public void setHTMLDDS(Hashtable h)
h - The 5250 HTML DDS data.public boolean isUnicodeField(int pos)
pos - The position to test
public boolean isUnicodeField()
public boolean isVTLogical()
public boolean isRTLCursorDirection()
public boolean isRTLCursorDirectionSaved()
public void setProcessShifts(boolean processShifts)
public boolean setFieldName(int position,
String label)
position - The offset of start of the fieldlabel - The label
public String getFieldName(int position)
public void addOrigin(String mapSetName,
String mapName)
mapSetName - The map set namemapName - The map namepublic String getOriginMapSet(int index)
public String getOriginMap(int index)
public int getOriginCount()
public static boolean isBlankScreen(Properties settings,
HostScreen screen)
public char getSelectorFieldType(ECLField f)
public boolean containsPenSelectableFields()
public String arabicDataExchange(String inputString,
boolean shapeArabicData)
public String ArabicDataExchange(String inputString,
boolean shapeArabicData)
public char charAt(int cursorPos,
int planar)
cursorPos - The position to look for the character atplanar - Which plane to retrieve the character from (like TEXT_PLANE)
public String ConvertLogicalToVisual(String inputBuffer,
boolean isLTRImplicit,
boolean isLTRVisual)
inputBuffer - The input string in logical formatisLTRImplicit - The output string to Left-To-Right Screen or notisLTRVisual - The input string from Left-to-Right Screen or not
public String ConvertLogicalToVisual(String inputBuffer,
boolean isLTRImplicit,
boolean isLTRVisual,
boolean compressLamAlef)
inputBuffer - The input string in logical formatisLTRImplicit - The output string to Left-To-Right Screen or notisLTRVisual - The input string from Left-to-Right Screen or notcompressLamAlef - Enable or disable LAM-ALEF compression in Arabic sessions
public String ConvertVisualToLogical(String inputBuffer,
boolean isLTRVisual,
boolean isLTRImplicit)
inputBuffer - The input string in visual formatisLTRVisual - The input string from Left-to-Right Screen or notisLTRImplicit - The output string to Left-To-Right Screen or not
public String ConvertVisualToLogical(String inputBuffer,
boolean isLTRVisual,
boolean isLTRImplicit,
boolean swapchars)
inputBuffer - The input string in visual formatisLTRVisual - The input string from Left-to-Right Screen or notisLTRImplicit - The output string to Left-To-Right Screen or notswapchars - Enable or disable Symmetric swapping in conversion
public int ConvertPosToCol(int pos)
ConvertPosToCol in class HsrScreenpos - The position to query
public static int ConvertPosToCol(int pos,
int sizecols)
pos - The position to querysizecols - The number of columns in a row
public int ConvertPosToRow(int pos)
ConvertPosToRow in class HsrScreenpos - The position to query
public static int ConvertPosToRow(int pos,
int sizecols)
pos - The position to querysizecols - The number of columns in a row
public int ConvertRowColToPos(int row,
int col)
ConvertRowColToPos in class HsrScreenrow - The row of the positioncol - The column of the position
public static int ConvertRowColToPos(int row,
int col,
int sizecols)
row - The row of the positioncol - The column of the positionsizecols - The number of columns in a row
public void setArabicOrientation(String Orientation)
Orientation - Either the String rtl or the String ltr
public char[] ExpandLamAlef(char[] UniBuff,
int length,
boolean visualmode)
UniBuff - The input stringlength - Length of the buffervisualmode - true if in visual mode, false otherwise
public String getArabicOrientation()
public void setRuntimertl(boolean value)
value - true if the screen orientation is right-to-left, false otherwise.public boolean getRuntimertl()
public void HandleFEData(char[] UniBuff)
UniBuff - Buffer to convert
public String HandleGVBIDISwap(String inputString,
boolean symswap,
boolean numswap)
public boolean is3270()
is3270 in class HsrScreenpublic boolean is5250()
is5250 in class HsrScreenpublic boolean isArabicSession()
isArabicSession in class HsrScreenpublic boolean isBIDISession()
isBIDISession in class HsrScreenpublic boolean isDBCSSession()
isDBCSSession in class HsrScreenpublic boolean isNumericSwapping()
public boolean isRTLScreen()
public boolean isSymmetricSwapping()
public String RemoveTail(String str)
str - The input string
public void SetisRTLScreen(boolean isrtlscreen)
isrtlscreen - true if the screen orientation is right-to-left, false otherwise.public void setDisableWesternNumbersEntry(boolean isDisabled)
isDisabled - is true when the checkbox is checkedpublic boolean isDisableWesternNumbersEntry()
public void setAutoFldRev(boolean isAutoFldRev)
isAutoFldRev - is true when current application
auto field reverse mode is on, false otherwise.public boolean isAutoFldRev()
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||