HATS 7.5.1 Web API Reference

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

com.ibm.hats.common
Class HostScreen

java.lang.Object
  extended by com.ibm.hsr.screen.HsrScreen
      extended by com.ibm.hats.common.HostScreen
All Implemented Interfaces:
com.ibm.hats.common.CommonConstants, com.ibm.hats.common.connmgr.ConnMgrConstants, com.ibm.hats.util.HatsConstants, com.ibm.hats.util.HatsCopyright, com.ibm.hats.util.RasConstants, com.ibm.logging.IRecordType

public class HostScreen
extends HsrScreen
implements com.ibm.hats.common.CommonConstants, com.ibm.hats.util.HatsConstants

This is the HATS implementation of an ECLPS. Please refer to the ECLPS javadoc for information on usage.

See Also:
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

TEXT_PLANE

public static int TEXT_PLANE
a plane indicator for text


FIELD_PLANE

public static int FIELD_PLANE
a plane indicator for field data


EXTFIELD_PLANE

public static int EXTFIELD_PLANE
a plane indicator for extended field data


EXFIELD_PLANE

public static int EXFIELD_PLANE
a plane indicator for extended field data, alternate spelling


COLOR_PLANE

public static int COLOR_PLANE
a plane indicator for color data


DBCS_PLANE

public static int DBCS_PLANE
a plane indicator for dbcs data


GRID_PLANE

public static int GRID_PLANE
a plane indicator for dbcs grid data


HOST_PLANE

public static int HOST_PLANE
a plane indicator for host special data


PS_PLANE

public static int PS_PLANE
a plane indicator for original text data


VISIBLE_TEXT_PLANE

public static int VISIBLE_TEXT_PLANE
a plane indicator for visible text data


PROTECTED_TEXT_PLANE

public static int PROTECTED_TEXT_PLANE
a plane indicator for protected text data


planeDepth

public static int planeDepth
a plane indicator count


limitingAttribToPlane

public static Hashtable limitingAttribToPlane

SESSION_TYPE_3270

public static final int SESSION_TYPE_3270
a session type indicator for 3270 hosts

See Also:
Constant Field Values

SESSION_TYPE_5250

public static final int SESSION_TYPE_5250
a session type indicator for 5250 hosts

See Also:
Constant Field Values

SESSION_TYPE_CICS

public static final int SESSION_TYPE_CICS
a session type indicator for CICS hosts (not supported)

See Also:
Constant Field Values

SESSION_TYPE_VT

public static final int SESSION_TYPE_VT
a session type indicator for VT hosts (not supported)

See Also:
Constant Field Values

SESSION_TN_ENHANCED

public static final String SESSION_TN_ENHANCED
the session TN enhanced default

See Also:
Constant Field Values

plane

public 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. to access the first character in the text plane use char firstChar= plane[HostScreen.TEXT_PLANE][0];


END_BOUNDARY

public static final char END_BOUNDARY
end of boundary for boundary plane

See Also:
Constant Field Values

INSIDE_FIELD

public static final char INSIDE_FIELD
inside field for boundary plane

See Also:
Constant Field Values

fieldlist

public 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. for the fifth field's length use int fifthFieldLength = fieldlist[4][1];


fieldname

public String[] fieldname
fieldname contains bms field name or null.


mapOriginList

public ArrayList mapOriginList
originlist is an array of strings containing list of bms mapset and map names.


mapSetOriginList

public ArrayList mapSetOriginList

pentype

public com.ibm.hats.common.SelectorField[] pentype

keystext

public 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. only the last item in the tree will be sent it is expected that all items in the keystext Vector be of type String and adhere to proper keys formatting


SOURCE_ECLPS

public static final int SOURCE_ECLPS
source indicator for ECLPS based changes

See Also:
Constant Field Values

SOURCE_METHOD

public static final int SOURCE_METHOD
source indicator for HostScreen method based changes

See Also:
Constant Field Values

SOURCE_HOSTSCREEN

public static final int SOURCE_HOSTSCREEN
source indicator for HostScreen object based changes

See Also:
Constant Field Values

SOURCE_DOCUMENT

public static final int SOURCE_DOCUMENT
source indicator for xml document based changes

See Also:
Constant Field Values

UPDATE_ALL

public static final int UPDATE_ALL
what changed indicator for all changes made

See Also:
Constant Field Values

UPDATE_CURSOR

public static final int UPDATE_CURSOR
what changed indicator for cursor changes

See Also:
Constant Field Values

UPDATE_COMMAND

public static final int UPDATE_COMMAND
what changed indicator for command/function key changes

See Also:
Constant Field Values

UPDATE_TEXT

public static final int UPDATE_TEXT
what changed indicator for text plane changes

See Also:
Constant Field Values

UPDATE_INFO

public static final int UPDATE_INFO
what changed indicator for session information changes

See Also:
Constant Field Values

SSL_DONT_KNOW

public static final int SSL_DONT_KNOW
SSL information not available

See Also:
Constant Field Values

SSL_OFF

public static final int SSL_OFF
SSL is not engaed from HOD to host

See Also:
Constant Field Values

SSL_ON

public static final int SSL_ON
SSL is engaged from HOD to host for anything at least this value

See Also:
Constant Field Values

CONST_HostScreenFIELDTYPE_HIGHINTENSITY

public static final int CONST_HostScreenFIELDTYPE_HIGHINTENSITY
indicator of field information item for high intensity data

See Also:
Constant Field Values

CONST_HostScreenFIELDTYPE_NUMERIC

public static final int CONST_HostScreenFIELDTYPE_NUMERIC
indicator of field information item for numeric data

See Also:
Constant Field Values

CONST_HostScreenFIELDTYPE_MODIFIED

public static final int CONST_HostScreenFIELDTYPE_MODIFIED
indicator of field information item for modified data

See Also:
Constant Field Values

CONST_HostScreenFIELDTYPE_PENDETECTABLE

public static final int CONST_HostScreenFIELDTYPE_PENDETECTABLE
indicator of field information item for pen detectable data

See Also:
Constant Field Values

CONST_HostScreenFIELDTYPE_PROTECTED

public static final int CONST_HostScreenFIELDTYPE_PROTECTED
indicator of field information item for protected data

See Also:
Constant Field Values

CONST_HostScreenFIELDTYPE_DISPLAY

public static final int CONST_HostScreenFIELDTYPE_DISPLAY
indicator of field information item for displayable data

See Also:
Constant Field Values
Constructor Detail

HostScreen

public HostScreen(HostScreen eclps)
Construct a HostScreen object based on the data represented by another HostScreen presentation space.

Parameters:
eclps - The HATS representation of the host session presentation space and associated data.

HostScreen

public HostScreen(ECLPS eclps)
Construct a HostScreen object based on the data represented by a ECLPS presentation space.

Parameters:
eclps - The HOD representation of the host session presentation space and associated data

HostScreen

public HostScreen()
Default constructor


HostScreen

public HostScreen(Document xmld)
Construct a HostScreen from an hsc document.

Parameters:
xmld - The .hsc xml data representation of the host screen object
Method Detail

getInsertionPoint

public int getInsertionPoint()

claimUpdate

public void claimUpdate(int source,
                        int type)
Monitors for most recent change occurance to the host screen.

Parameters:
source - Source indicator for event
type - The change indicator typent

lastUpdateSource

public int lastUpdateSource()
Returns the source of the last update to the host screen.

Returns:
The source of the last update to the host screen.

UpdateStatusString

public String UpdateStatusString()
Returns the sources and types of the last update to the host screen.

Returns:
The sources and types of the last update to the host screen.

ECLPSNeedsUpdating

public boolean ECLPSNeedsUpdating()
Returns whether or not the HostScreen has had changes which should be sent to the host session.

Returns:
true is the HostScreen has had changes which should be sent to the host session, false otherwise.

ECLPSNeedsTextUpdate

public boolean ECLPSNeedsTextUpdate()
Returns whether or not the HostScreen has had changes to the text plane which should be sent to the host session.

Returns:
true is the HostScreen has had changes to the text plane which should be sent to the host session, false otherwise.

ECLPSNeedsCommandUpdate

public boolean ECLPSNeedsCommandUpdate()
Returns whether or not the HostScreen has had commands which should be sent to the host session

Returns:
true is the HostScreen has had commands which should be sent to the host session, false otherwise.

ECLPSNeedsCursorUpdate

public boolean ECLPSNeedsCursorUpdate()
Returns whether or not the HostScreen has had cursor position changes which should be sent to the host session.

Returns:
true is the HostScreen has had cursor position changes which should be sent to the host session, false otherwise.

getLastOIAStatus

public int getLastOIAStatus()
Returns the status indicator OIA bit.

Returns:
the status indicator OIA bit.

encryptionLevel

public int encryptionLevel()
Returns the SSL status indicator (for HOD connection security).

Returns:
The SSL status indicator.

isMessageWaiting

public boolean isMessageWaiting()
Returns the message waiting status

Returns:
the message waiting status

toString

public String toString()
Return a String representation of the HostScreen as a single line

Overrides:
toString in class Object
Returns:
A string representation of the text plane.

resetToECLPS

public void resetToECLPS(ECLPS eclps)
This method initializes the HostScreen object based on the data represented by the ECLPS presentation space.

Parameters:
eclps - The HOD representation of the host session presentation space and associated data

resetToHostScreen

public void resetToHostScreen(HostScreen eclps)
Initialize the HostScreen object based on the data represented by another HostScreen presentation space.

Parameters:
eclps - The HATS representation of the host session presentation space and associated data.

getShortArray

public short[] getShortArray(int position,
                             int len,
                             int planeval)
Returns the area of planar information requested as an array of type short

Parameters:
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
Returns:
The array of plane information

getShortArray

public short[] getShortArray(int pos,
                             int len)
Returns the area of text planar information requested as an array of type short.

Parameters:
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()
Returns:
The array of plane information

getShortArray

public short[] getShortArray(int plane)
Returns the entire requested plane information as an array of type short.

Parameters:
plane - The plane indicator of which plane is requested, such as TEXT_PLANE
Returns:
The array of plane information.

getShortArray

public short[] getShortArray()
Returns the entire text plane as an array of type short.

Returns:
The array of plane information

updateECLPS

public void updateECLPS(ECLPS ps,
                        Properties settings)
This method updates the PS with the contents of the HostScreen.

Parameters:
ps - The presentation space
settings - Settings to effect the update.

updateECLPS

public void updateECLPS(ECLPS ps)
Update the host with the information in the HostScreen. Note that this does not update the keytext functionkeys and commands and that that needs to be updated to the host seperately.

Parameters:
ps - The HOD presentation space for the host session

UpdateRequestScreen

public void UpdateRequestScreen(com.ibm.hats.common.RequestScreen rs)
Not implemented.

Parameters:
rs - The request screen

getDocument

public Document getDocument()
Create an hsc document representing the host screen.

Returns:
The .hsc xml data representation of the host screen object.

clear

public void clear()
Not implemented.


GetSize

public int GetSize()
Returns the size of the host screen.

Overrides:
GetSize in class HsrScreen
Returns:
The size of the host screen.

GetSizeRows

public int GetSizeRows()
Returns the number of rows in the host screen.

Overrides:
GetSizeRows in class HsrScreen
Returns:
The number of rows in the host screen.

GetSizeCols

public int GetSizeCols()
Returns the number of columns in the host screen.

Overrides:
GetSizeCols in class HsrScreen
Returns:
The number of columns in the host screen.

getSize

public int getSize()
Returns the size of the host screen.

Overrides:
getSize in class HsrScreen
Returns:
The size of the host screen.

getSizeRows

public int getSizeRows()
Returns the number of rows in the host screen.

Overrides:
getSizeRows in class HsrScreen
Returns:
The number of rows in the host screen.

getSizeCols

public int getSizeCols()
Returns the number of columns in the host screen.

Overrides:
getSizeCols in class HsrScreen
Returns:
The number of columns in the host screen.

getSessionSize

public String getSessionSize()
Returns the size of the host screen for the session. Ex. 24x80, 27x132, 32x80, 43x80, 24x132

Returns:
The size of the host screen for the session.

SetSize

public void SetSize(int size)
Sets the screen size.

Parameters:
size - The new screen size.

setSessionSize

public void setSessionSize(String strsz)
Sets the session size.

Parameters:
strsz - The new session size.

SetSize

public void SetSize(int rows,
                    int cols)
Sets the screen size.

Parameters:
rows - The number of rows
cols - The number of columns

SetSizeRows

public void SetSizeRows(int rows)
Sets the number of rows.

Parameters:
rows - The number of rows.

SetSizeCols

public void SetSizeCols(int cols)
Sets the number of columns

Parameters:
cols - The number of columns

setSize

public void setSize(int rows,
                    int cols)
Sets the screen size.

Parameters:
rows - The number of rows
cols - The number of columns

setSize

public void setSize(int size)
Sets the size of the screen.

Parameters:
size -

setSizeRows

public void setSizeRows(int rows)
Sets the number of rows.

Overrides:
setSizeRows in class HsrScreen
Parameters:
rows - The number of rows.

setSizeCols

public void setSizeCols(int cols)
Sets the number of columns.

Overrides:
setSizeCols in class HsrScreen
Parameters:
cols - The number of columns.

GetCursorPos

public int GetCursorPos()
Returns the cursor position

Overrides:
GetCursorPos in class HsrScreen
Returns:
The cursor position

GetCursorRow

public int GetCursorRow()
Returns the cursor position row.

Overrides:
GetCursorRow in class HsrScreen
Returns:
The cursor position row.

GetCursorCol

public int GetCursorCol()
Returns the cursor position column.

Overrides:
GetCursorCol in class HsrScreen
Returns:
The cursor position column.

getCursorPos

public int getCursorPos()
Returns the cursor position.

Overrides:
getCursorPos in class HsrScreen
Returns:
The cursor position.

getCursorRow

public int getCursorRow()
Returns the cursor position row.

Overrides:
getCursorRow in class HsrScreen
Returns:
The cursor position row.

getCursorCol

public int getCursorCol()
Returns the cursor position column.

Overrides:
getCursorCol in class HsrScreen
Returns:
Tthe cursor position column.

SetCursorPos

public void SetCursorPos(int pos)
Sets the cursor position.

Parameters:
pos - The new cursor position

SetCursorPos

public void SetCursorPos(int row,
                         int col)
Sets the cursor position.

Parameters:
row - The cursor position row
col - The cursor position column

SetCursorRow

public void SetCursorRow(int row)
Sets the cursor position row.

Parameters:
row - The cursor position row

SetCursorCol

public void SetCursorCol(int col)
Sets the cursor position column.

Parameters:
col - The cursor position column

setCursorPos

public void setCursorPos(int pos)
Sets the cursor position.

Overrides:
setCursorPos in class HsrScreen
Parameters:
pos - The cursor position

setCursorPos

public void setCursorPos(int row,
                         int col)
Sets the cursor position.

Parameters:
row - The cursor position row
col - The cursor position column

setCursorRow

public void setCursorRow(int row)
Sets the cursor position row

Overrides:
setCursorRow in class HsrScreen
Parameters:
row - The cursor position row

setCursorCol

public void setCursorCol(int col)
Sets the cursor position column

Overrides:
setCursorCol in class HsrScreen
Parameters:
col - The cursor position column

GetParent

public HostScreen GetParent()
HOD consistency class: returns this class.

Returns:
this HostScreen object.

GetSendKeyMnemonics

public String[] GetSendKeyMnemonics()
HOD consistency class: returns example array of possible function key strings.

Returns:
An example array of possible function key strings.

SendKeys

public void SendKeys(String text)
Add keys to keytext as if the text entered is a comand

Parameters:
text - The text of the command

SendKeys

public void SendKeys(String text,
                     int pos)
Add keys to keytext as if the text entered is a comand at the specified cursor position.

Parameters:
text - The text of the command
pos - The cursor position to insert text.

SendKeys

public 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.

Parameters:
text - The text of the command
row - The row to insert the text.
col - The column to insert the text.

getName

public String getName()
Returns the name of the HostScreen

Returns:
The name of this HostScreen

getSessionNumber

public String getSessionNumber()
Returns the session number of the HostScreen.

Returns:
The session number.

getDescription

public String getDescription()
Returns the description of the HostScreen.

Returns:
The description of the HostScreen.

getScreenId

public String getScreenId()
Returns the screen identifier of the HostScreen.

Returns:
The screen identifier of the HostScreen.

getFieldCount

public int getFieldCount()
Returns the number of fields in the HostScreen.

Overrides:
getFieldCount in class HsrScreen
Returns:
The number of fields in the HostScreen.

getHashCode

public int getHashCode()
Returns the hashcode of the HostScreen.

Returns:
The hashcode of the HostScreen.

getDBCSSettings

public com.ibm.hats.common.DBCSSettings getDBCSSettings()
Returns the DBCS settings for the HostScreen

Returns:
The DBCS settings for the HostScreen.

supportsHighlighting

public boolean supportsHighlighting()
Returns whether or not this host screen supports highlighting in fields.

Returns:
true if the host screen supports highlighting in fields, false otherwise.

getDefaultForegroundColor

public int getDefaultForegroundColor()
Returns the default foreground color for the host screen. See the HOD APIs for more details.

Returns:
The default foreground color for the host screen.

getDefaultBackgroundColor

public int getDefaultBackgroundColor()
Returns the default background color for the host screen. See the HOD APIs for more details.

Returns:
The default background color for the host screen.

getDefaultCharSet

public int getDefaultCharSet()
Returns the default cahracter set for the host screen. See the HOD APIs for more details.

Returns:
The default character set for the host screen.

setDescription

public void setDescription(String description)
Sets a description for the host screen.

Parameters:
description - The description for the host screen.

setSupportsHighlighting

public void setSupportsHighlighting(boolean supporthighlight)
Sets whether or not the host screen supports highlighting.

Parameters:
supporthighlight - true if the host screen support highlighting, false otherwise.

setSessionNumber

public void setSessionNumber(String sessionnumber)
Sets the host screen session number.

Parameters:
sessionnumber - The session number.

setSessionID

public void setSessionID(String sessionid)
Sets the host screen session identifier.

Parameters:
sessionid - The session identifier.

setDefaultForegroundColor

public void setDefaultForegroundColor(int foreground)
Sets the host screen foreground color.

Parameters:
foreground - The host screen foreground color.

setDefaultBackgroundColor

public void setDefaultBackgroundColor(int background)
Sets the host screen background color.

Parameters:
background - The host screen background color.

setDefaultCharSet

public void setDefaultCharSet(int charset)
Sets the host screen default character set.

Parameters:
charset - The default character set.

SearchText

public int SearchText(String text,
                      int direction)
Searches for the given text in the host screen. See HOD APIs for further details.

Parameters:
text - The text to look for
direction - The direction to search the text
Returns:
The position of the found text or -1 if error.

SearchString

public int SearchString(String text,
                        int direction)
Searches for the given text in the host screen. See HOD APIs for further details.

Parameters:
text - The text to look for
direction - The direction to search the text
Returns:
The position of the found text or -1 if error.

SearchText

public int SearchText(String text,
                      int row,
                      int column,
                      int direction)
Searches for the given text in the host screen. See HOD APIs for further details.

Parameters:
text - The text to look for
row - The starting row for the search
column - The starting column for the search
direction - The direction to search the text
Returns:
The position of the found text or -1 if error.

SearchString

public int SearchString(String text,
                        int row,
                        int column,
                        int direction)
Searches for the given text in the host screen. See HOD APIs for further details.

Parameters:
text - The text to look for
row - The starting row for the search
column - The starting column for the search
direction - The direction to search the text
Returns:
The position of the found text or -1 if error.

SearchText

public int SearchText(String text,
                      int position,
                      int direction)
Searches for the given text in the host screen. See HOD APIs for further details.

Parameters:
text - The text to look for
position - The starting position for the search
direction - The direction to search the text
Returns:
The position of the found text or -1 if error.

SearchString

public int SearchString(String text,
                        int position,
                        int direction)
Searches for the given text in the host screen. See HOD APIs for further details.

Parameters:
text - The text to look for
position - The starting position for the search
direction - The direction to search the text
Returns:
The position of the found text or -1 if error.

GetPSBIDIServices

public ECLPSBIDIServices GetPSBIDIServices()
Always returns null

Returns:
null

GetScreen

public int GetScreen(char[] buffer,
                     int bufferLength,
                     int plane)
Returns the planar information of the screen. See the HOD APIs for more information.

Parameters:
buffer - The buffer to place text into
bufferLength - The length of the buffer
plane - The plane from which to extract data
Returns:
The length of the buffer changes.

GetString

public int GetString(char[] buffer,
                     int bufferLength)
Returns the text planar information of the screen. See the HOD APIs for more information.

Parameters:
buffer - The buffer to place text into
bufferLength - The length of the buffer
Returns:
The length of the buffer changes.

GetScreen

public int GetScreen(char[] buffer,
                     int bufferLength,
                     int row,
                     int col,
                     int length,
                     int plane)
Returns the planar information of the screen. See the HOD APIs for more information.

Parameters:
buffer - The buffer to place text into
bufferLength - The length of the buffer
row - The row to start from
col - The column to start from
length - The length of data to retrieve
plane - The plane from which to extract data
Returns:
The length of the buffer changes

GetString

public int GetString(char[] buffer,
                     int bufferLength,
                     int row,
                     int col,
                     int length)
Returns the text planar information of the screen. See the HOD APIs for more information.

Parameters:
buffer - The buffer to place text into
bufferLength - The length of the buffer
row - The row to start from
col - The column to start from
length - The length of data to retrieve
Returns:
The length of the buffer changes

GetScreen

public int GetScreen(char[] buffer,
                     int bufferLength,
                     int position,
                     int length,
                     int planei)
Returns the planar information of the screen. See the HOD APIs for more information.

Parameters:
buffer - The buffer to place text into
bufferLength - The length of the buffer
position - The position to start from
length - The length of data to retrieve
planei - The plane from which to extract data
Returns:
The length of the buffer changes

getString

public String getString(int pos,
                        int len)
Returns the String represented by the area specified on the host screen.

Parameters:
pos - The starting position of the String
len - The length of the String to extract
Returns:
The host screen information in the area given

getString

public String getString(int pos,
                        int len,
                        int fromPlane)
Returns the String represented by the area specified from the host screen.

Parameters:
pos - The starting position of the String
len - The length of the String to extract
fromPlane - The plane to extract the string from
Returns:
The host screen information in the area given

GetString

public String GetString(int pos,
                        int len)
Returns the String represented by the area specified from the host screen.

Parameters:
pos - The starting position of the String
len - The length of the String to extract
Returns:
The host screen information in the area given

GetString

public String GetString()
Returns the String represented by the host screen.

Returns:
The string representing the entire host screen.

GetString

public int GetString(char[] buffer,
                     int bufferLength,
                     int position,
                     int length)
Returns the planar information of the screen. See the HOD APIs for more information.

Parameters:
buffer - The buffer to place text into
bufferLength - The length of the buffer
position - The position to start from
length - The length of data to retrieve
Returns:
The length of the buffer changes

getVisibleString

public 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..

Parameters:
buffer - buffer to set the text into
bufferLength - length of the buffer
row - 1-based row start position
col - 1-based column start position
length - number of characters to get
Returns:
The array of visible text at the specified position.

getVisibleString

public 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

Parameters:
buffer - buffer to set the text into
bufferLength - length of the buffer
position - 1-based linear start position
length - number of characters to get
Returns:
The array visible text at the specified position.

GetScreenRect

public int GetScreenRect(char[] buffer,
                         int bufferLength,
                         int startPos,
                         int endPos,
                         int plane)
Returns the rectangular planar information of the screen. see the HOD APIs for more information

Parameters:
buffer - The buffer to place text into
bufferLength - The length of the buffer
startPos - The position to start from
endPos - The column to end At
plane - The plane form which to extract data
Returns:
The length of the buffer changes

GetScreenRect

public int GetScreenRect(char[] buffer,
                         int bufferLength,
                         int startRow,
                         int startCol,
                         int endRow,
                         int endCol,
                         int plane)
Returns the rectangular planar information of the screen. See the HOD APIs for more information.

Parameters:
buffer - The buffer to place text into
bufferLength - The length of the buffer
startRow - The row to start from
startCol - The column to start from
endRow - The row to end at
endCol - The column to end at
plane - The plane form which to extract data
Returns:
The length of the buffer changes

SetText

public void SetText(String text)
Sets the text specified into the host at the beginning of the host screen. Note that this is different than the HOD APIs

Parameters:
text - The text to place on the host screen

SetString

public void SetString(String text)
Sets the text specified into the host at the beginning of the host screen. Note that this is different than the HOD APIs

Parameters:
text - The text to place on the host screen

SetText

public void SetText(String text,
                    int pos)
Sets the text specified into the host at the specified location of the host screen. Note that this is different than the HOD APIs.

Parameters:
text - The text to place on the host screen.
pos - The location to set the text.

SetString

public void SetString(String text,
                      int pos)
Sets the text specified into the host at the specified location of the host screen. Note that this is different than the HOD APIs.

Parameters:
text - The text to place on the host screen.
pos - The location to set the text.

SetText

public void SetText(String text,
                    int row,
                    int column)
Sets the text specified into the host at the specified location of the host screen.

Parameters:
text - The text to place on the host screen.
row - The row to set the text.
column - The column to set the text.

SetString

public 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.

Parameters:
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

SetString

public void SetString(String text,
                      int row,
                      int column)
Sets the text specified into the host at the specified location of the host screen.

Parameters:
text - The text to place on the host screen.
row - The row to set the text.
column - The column to set the text.

RegisterPSEvent

public void RegisterPSEvent(ECLPSListener listener)
not in use


RegisterPSEvent

public void RegisterPSEvent(ECLPSListener listener,
                            int type)
not in use


UnregisterPSEvent

public void UnregisterPSEvent(ECLPSListener listener)
not in use


UnregisterPSEvent

public void UnregisterPSEvent(ECLPSListener listener,
                              int type)
not in use


WaitForAttrib

public boolean WaitForAttrib(int row,
                             int col,
                             char attrib,
                             int plane)
not in use


WaitForAttrib

public boolean WaitForAttrib(int row,
                             int col,
                             char attrib,
                             int plane,
                             long timeOut,
                             boolean waitForInput)
not in use


WaitForCursor

public boolean WaitForCursor(int row,
                             int col,
                             long timeOut,
                             boolean waitForInput)
not in use


WaitForScreen

public boolean WaitForScreen(ECLScreenDesc screenDesc)
not in use


WaitForScreen

public boolean WaitForScreen(ECLScreenDesc screenDesc,
                             long timeOut)
not in use


WaitForString

public boolean WaitForString(String str)
not in use


WaitForString

public boolean WaitForString(String str,
                             int row,
                             int col)
not in use


WaitForString

public boolean WaitForString(String str,
                             int row,
                             int col,
                             long timeOut,
                             boolean waitForInput,
                             boolean caseSensitive)
not in use


WaitForStringInRect

public boolean WaitForStringInRect(String str,
                                   int sRow,
                                   int sCol,
                                   int eRow,
                                   int eCol)
not in use


WaitForStringInRect

public boolean WaitForStringInRect(String str,
                                   int sRow,
                                   int sCol,
                                   int eRow,
                                   int eCol,
                                   long timeOut,
                                   boolean waitForInput,
                                   boolean caseSensitive)
not in use


WaitWhileAttrib

public boolean WaitWhileAttrib(int row,
                               int col,
                               char attrib,
                               int plane)
not in use


WaitWhileAttrib

public boolean WaitWhileAttrib(int row,
                               int col,
                               char attrib,
                               int plane,
                               long timeOut,
                               boolean waitForInput)
not in use


WaitWhileCursor

public boolean WaitWhileCursor(int row,
                               int col)
not in use


WaitWhileCursor

public boolean WaitWhileCursor(int row,
                               int col,
                               long timeOut,
                               boolean waitForInput)
not in use


WaitWhileScreen

public boolean WaitWhileScreen(ECLScreenDesc screenDesc)
not in use


WaitWhileScreen

public boolean WaitWhileScreen(ECLScreenDesc screenDesc,
                               long timeOut)
not in use


WaitWhileString

public boolean WaitWhileString(String str)
not in use


WaitWhileString

public boolean WaitWhileString(String str,
                               int row,
                               int col)
not in use


WaitWhileString

public boolean WaitWhileString(String str,
                               int row,
                               int col,
                               long timeOut,
                               boolean waitForInput,
                               boolean caseSensitive)
not in use


WaitWhileStringInRect

public boolean WaitWhileStringInRect(String str,
                                     int sRow,
                                     int sCol,
                                     int eRow,
                                     int eCol)
not in use


WaitWhileStringInRect

public boolean WaitWhileStringInRect(String str,
                                     int sRow,
                                     int sCol,
                                     int eRow,
                                     int eCol,
                                     long timeOut,
                                     boolean waitForInput,
                                     boolean caseSensitive)
not in use


getTotalFieldCount

public int getTotalFieldCount()
Returns the total number of fields on this HostScreen (ECLPS).

Overrides:
getTotalFieldCount in class HsrScreen
Returns:
The number of fields.

getProtectedFieldCount

public int getProtectedFieldCount()
Returns the number of protected fields on this HostScreen (ECLPS).

Returns:
The number of protected (non-input) fields.

getUnprotectedFieldCount

public int getUnprotectedFieldCount()
Returns the number of unprotected fields on this HostScreen (ECLPS).

Returns:
The number of unprotected (input) fields.

GetFieldList

public HostScreenFieldList GetFieldList()
Returns the HostScreenFieldList for this HostScreen.

Returns:
A lsit of all the HostScreenFields in the HostScreen.

GetFieldList

public HostScreenFieldList GetFieldList(int planes)
Returns the HostScreenFieldList for this HostScreen.

Parameters:
planes - Not used.
Returns:
A list of all the HostScreenFields in the HostScreen

getFieldList

public IScreenFieldList getFieldList()
Returns the HostScreenFieldList for this HostScreen.

Specified by:
getFieldList in class HsrScreen
Returns:
A list of all the HostScreenFields in the HostScreen

getFieldList

public HostScreenFieldList getFieldList(int planes)
Returns the HostScreenFieldList for this HostScreen

Parameters:
planes - Not used
Returns:
A list of all the HostScreenFields in the HostScreen

isScreenReversed

public boolean isScreenReversed()
Returns whether or not the screen is reversed.

Returns:
true if the screen is reversed, false otherwise.

SetisScreenReversed

public void SetisScreenReversed(boolean isscreenVTreversed)
Sets whether or not the screen is reversed.

Parameters:
isscreenVTreversed - true if the screen is reversed, false otherwise.

SetCursorVisible

public void SetCursorVisible(boolean bVisible)
not in use


GetCursorVisible

public boolean GetCursorVisible()
not in use


IsSuppressClearEvent

public boolean IsSuppressClearEvent()
not in use


SetSuppressClearEvent

public void SetSuppressClearEvent(boolean argVal)
not in use


getShowCursor

public boolean getShowCursor()
not in use


setShowCursor

public void setShowCursor(boolean showIt)
not in use


updateTextScreen

public void updateTextScreen(int start,
                             int length,
                             String text)
Update the text plane with new text.

Parameters:
start - The starting location to begin the update
length - The length of the area to update
text - The text to update the screen with

doEnptuiField

public void doEnptuiField(com.ibm.hats.common.RequestScreenField rsf,
                          ECLPS ps)

doEnptuiSelect

public 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.

Parameters:
rsf - Not used.
v - Not used.
fld - Input field attribute.
choiceIndex - Not used.
choicePos - To position for the simulated selection.
ps - The presentation space.

doSelectionField

public void doSelectionField(com.ibm.hats.common.RequestScreenField rsf,
                             ECLPS ps)

updateFromRequestScreen

public void updateFromRequestScreen(com.ibm.hats.common.RequestScreen rs)
Updates the host screen from the HTTP request.

Parameters:
rs - The request from the browser form.

GetCodePage

public int GetCodePage()
Returns the codepage for the connection.

Returns:
The codepage for the connection.

isAccentedCharacter

public boolean isAccentedCharacter()
Returns the useAccentedCharacters setting for the connection.

Returns:
true is using accented characters, false otherwise.

GetHost

public String GetHost()
Returns the host for the connection.

Returns:
The host for the connection.

GetPort

public int GetPort()
Returns the host port for the connection.

Returns:
The host port for the connection.

GetConnType

public int GetConnType()
Returns the connection type for the connection.

Returns:
The connection type for the connection.

GetSessionName

public String GetSessionName()
Returns the session name for the connection.

Returns:
The session name for the connection.

isTNEnhanced

public boolean isTNEnhanced()
Returns whether or not the telnet connection is enhanced (TN3270E).

Returns:
true if the telnet connection is enhanced, false otherwise.

GetLUName

public String GetLUName()
Returns the LU name (3270).

Returns:
The LU name (3270).

GetWorkstationID

public String GetWorkstationID()
Returns the Workstation ID (5250)

Returns:
workstationID

SetCodePage

public void SetCodePage(int codepage)
Sets the codepage for the connection.

Parameters:
codepage - The codepage.

SetAccentedCharacter

public void SetAccentedCharacter(boolean bAccentedCharacters)
Sets the useAccentedCharacters setting for the connection.

Parameters:
bAccentedCharacters - true if using accented characters, false otherwise.

SetHost

public void SetHost(String host)
Sets the host name for the connection.

Parameters:
host - The host name.

SetPort

public void SetPort(int port)
Sets the port number for the connection.

Parameters:
port - The port number

SetConnType

public void SetConnType(int conntype)
Sets the connection type for the connection.

Parameters:
conntype - The connection type

SetSessionName

public void SetSessionName(String sessionname)
Sets the session name for the connection.

Parameters:
sessionname - The session name.

SetisTNEnhanced

public void SetisTNEnhanced(boolean istnenhanced)
Sets the the enhanced mode for the connection.

Parameters:
istnenhanced - true if the telnet connection is enhanced (TN3270E), false otherwise.

SetLUName

public void SetLUName(String luname)
Sets the LU name for the connection (3270).

Parameters:
luname - The LU name.

SetWorkstationID

public void SetWorkstationID(String workstationid)
Sets the workstation ID name for the connection (5250).

Parameters:
workstationid - The workstation id.

isBidi

public boolean isBidi()
Returns whether or not the session is a bidirectional session.

Specified by:
isBidi in class HsrScreen
Returns:
true if the session is bidirectional, false otherwise

isArabic

public boolean isArabic()
Returns whether or not the session is Arabic session.

Specified by:
isArabic in class HsrScreen
Returns:
true if the session is Arabic, false otherwise.

isHebrewSession

public boolean isHebrewSession()
Returns whether or not the session is Hebrew session.

Returns:
true if the session is Hebrew, false otherwise.

isDbcsScreen

public boolean isDbcsScreen()
indicates if the screen is DBCS

Specified by:
isDbcsScreen in class HsrScreen
Returns:
DBCS indicator

isFieldShapeDisabled

public boolean isFieldShapeDisabled()
indicates if the screen is field shape disabled

Returns:
field shape disabled indicator

setFieldShapeDisabled

public void setFieldShapeDisabled(boolean FieldShapeDisabled)

setSymmetricSwap

public void setSymmetricSwap(boolean value)

setNumericSwap

public void setNumericSwap(boolean value)

isRLTB

public boolean isRLTB()
indicates if the screen has a right to left tabbing order

Returns:
right to left tabbing order indicator

isBIDI5250

public boolean isBIDI5250()
indicates if the screen is 5250 and BIDI

Returns:
5250 BIDI indicator

setString_Fields_Overwrite

public void setString_Fields_Overwrite(String text,
                                       int pos)
Sets the strings into fields using overwrite and a specified position.

Parameters:
text - The string to write into the host screen
pos - The starting position

setString_Fields_Insert

public void setString_Fields_Insert(String text,
                                    int pos)
Sets the strings into fields using insert.

Parameters:
text - The string to write into the host screen
pos - The starting position

setString_Fields_Insert_2

public void setString_Fields_Insert_2(String text,
                                      int pos)
Sets the strings into fields using insertion using a different algorithm.

Parameters:
text - The string to write into the host screen
pos - The starting position

setString_Fields_Overwrite_2

public void setString_Fields_Overwrite_2(String text,
                                         int pos)
Sets the strings into fields using overwrite using a different algorithm.

Parameters:
text - The string to write into the host screen
pos - The starting position

isArea

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

Parameters:
start - The starting position
end - The ending position
type - The type indicator of field information item for data
value - The value that the type indicator should be
Returns:
true if the areas field type is set to the value, false otherwise.

decodeFieldPlane

public boolean[] decodeFieldPlane(int start,
                                  int end,
                                  int type)
Decodes the field plane for the given area for each character in the text plane. For example, if the first field was from 1 to 30 and was protected, decodeFieldPlane(1,5,CONST_HostScreenFIELDTYPE_PROTECTED) = {true,true,true,true,true}

Parameters:
start - The starting position.
end - The ending position
type - The type indicator
Returns:
The array of results

charAt

public char charAt(int cursorPos)
Description copied from class: HsrScreen
Returns a screen character from the host screen at the specified cursor position

Overrides:
charAt in class HsrScreen
Parameters:
cursorPos - - position for retrieving the screen character
Returns:
char - the screen character at the specified position

charAt

public char charAt(int cursorPos,
                   String limitingAttrib)
Description copied from class: HsrScreen
Returns a screen character from the host screen at the specified cursor position.

Overrides:
charAt in class HsrScreen
Parameters:
cursorPos - 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).
Returns:
Screen character.

fieldLookup

public int fieldLookup(int spot)
Returns which field is at the given location.

Parameters:
spot - The position to look for the field
Returns:
The field by field order (0 for first field) or -1 of no field is at that location

shortForField

public short shortForField(int field)
Returns the field short for a given field.

Parameters:
field - The field position (0 for first field)
Returns:
The field value or -1 of no field is at that location

fieldShortLookup

public short fieldShortLookup(int spot)
Returns the field short at the given location.

Parameters:
spot - The position to look for the field
Returns:
The field value or -1 of no field is at that location.

nextFieldStart

public int nextFieldStart(int spot)
Returns the next field from the current position.

Parameters:
spot - The starting position
Returns:
The location of the next field, -1 if there is no next field.

distToNextField

public int distToNextField(int spot)
Returns the distance to the next field from the current position.

Parameters:
spot - The starting position
Returns:
The distance of the next field, -1 if there is no next field.

nextFieldStart

public int nextFieldStart(int spot,
                          int type)
Returns the next field from the current position with a given type indicator.

Parameters:
spot - The starting position
type - The type indicator for the field, ex. CONST_HostScreenFIELDTYPE_PROTECTED
Returns:
The location of the next field, -1 if there is no next field.

distToNextField

public int distToNextField(int spot,
                           int type)
Returns the distance to the next field from the current position.

Parameters:
spot - The starting position
type - The type indicator for the field, ex. CONST_HostScreenFIELDTYPE_PROTECTED
Returns:
The distance of the next field, -1 if there is no next field.

isHighIntensity

public boolean isHighIntensity(int pos)
Tests if the position given is high intensity.

Parameters:
pos - The position to check
Returns:
true if the position is high intensity, false otherwise.

isModified

public boolean isModified(int pos)
Tests if the position given is modified.

Parameters:
pos - The position to check
Returns:
true if the position is modified, false otherwise.

isProtected

public boolean isProtected(int pos)
Tests if the position given is protected.

Parameters:
pos - The position to check
Returns:
true if the position is protected, false otherwise.

isNumeric

public boolean isNumeric(int pos)
Tests if the position given is numeric.

Parameters:
pos - The position to check
Returns:
true if the position is numeric, false otherwise.

isPenDetectable

public boolean isPenDetectable(int pos)
Tests if the position given is pen detectable.

Parameters:
pos - The position to check
Returns:
true if the position is pen detectable, false otherwise.

isDisplay

public boolean isDisplay(int pos)
Tests if the position given is displayable.

Parameters:
pos - The position to check
Returns:
true if the position is displayable, false otherwise.

IsDBCSChar

public boolean IsDBCSChar(char charInput)
Tests if the character given is a DBCS character.

Parameters:
charInput - The character to check
Returns:
true if the character is a DBCS character, false otherwise.

isHighSurrogate

public boolean isHighSurrogate(char unichar)
An util method to check whether a char is a JIS2004 high byte char, using HOD code

Parameters:
unichar - High byte character

isLowSurrogate

public boolean isLowSurrogate(char unichar)
An util method to check whether a char is a JIS2004 low byte char, using HOD code

Parameters:
unichar - Low byte character

isSurrogate

public boolean isSurrogate(char highchar,
                           char lowchar)
An util method to check whether a char is a JIS2004 char, using HOD code

Parameters:
highchar - High byte character
lowchar - Low byte character

eraseShifts

public int eraseShifts(char[] buffer)
Erase SOSI in array.

Parameters:
buffer - The array need to check
Returns:
int The recount size of array after rease SOSI.

caculateProperStringLength

public int caculateProperStringLength(char[] buffer)
Deprecated. 


calculateProperStringLength

public int calculateProperStringLength(char[] buffer)
Originally this method is named "eraseShifts" but this method recalculate the proper length of the input buffer(String). For example, if the filed length is 10, we can get 10 chars from the request. If all 10 chars are DBCS chars, only 4 chars can be set into the server. (SO + 4 DBCS + SI = 10)

Parameters:
buffer - The array need to check
Returns:
int The recount size of array after rease SOSI.

addBackShifts

public void addBackShifts(char[] buffer)
Replace space with SOSI if the space at DBCS side.

Parameters:
buffer - The array need to check

restoreECLPStextPlane

public void restoreECLPStextPlane()
Restore ECLPS's text plane form hostscreen's text plane


GetString2

public int GetString2(char[] buffer,
                      int bufferLength,
                      int row,
                      int col,
                      int length)
Returns the original text planar information of the screen. See the HOD APIs for more information.

Parameters:
buffer - The buffer to place text into
bufferLength - The length of the buffer
row - The row to start from
col - The column to start from
length - The length of data to retrieve
Returns:
The length of the buffer changes

GetString2

public int GetString2(char[] buffer,
                      int bufferLength,
                      int position,
                      int length)
Returns the original text planar information of the screen. See the HOD APIs for more information.

Parameters:
buffer - The buffer to place text into
bufferLength - The length of the buffer
position - The position to start from
length - The length of data to retrieve
Returns:
The length of the buffer changes

getString2

public String getString2(int pos,
                         int len)
New method for DBCS session Returns the String represented by the area specified on the host screen.

Parameters:
pos - The starting position of the String
len - The length of the String to extract
Returns:
The host screen information in the area given

extractDBCSString

public String extractDBCSString(int start,
                                int len)
Extract string from text plane with DBCS process in real time.

Parameters:
start - The starting position of the String
len - The length of the String to extract
Returns:
The processed string in the text plane

getScreenSettlingResults

public String getScreenSettlingResults()
Returns the screen settling results.

Returns:
The screen settling results.

setScreenSettlingResults

public void setScreenSettlingResults(String s)
Sets the screen settling results.

Parameters:
s - The string data of the screen settling results.

is3270Screen

public boolean is3270Screen()
Returns whether or not the connection is 3270.

Specified by:
is3270Screen in class HsrScreen
Returns:
true if the connection is 3270, false otherwise.

is5250Screen

public boolean is5250Screen()
Returns whether or not the connection is 5250.

Specified by:
is5250Screen in class HsrScreen
Returns:
true if the connection is 5250, false otherwise.

isVT

public boolean isVT()
Returns whether or no the connection is VT.

Returns:
true if the connection is VT, false otherwise.

getFieldAtPos

public HsrScreenField getFieldAtPos(int row,
                                    int col)
Returns the host screen field at the given location.

Overrides:
getFieldAtPos in class HsrScreen
Parameters:
row - The starting row position
col - The starting column position
Returns:
The host screen field at the given location.

getFieldAtPos

public HsrScreenField getFieldAtPos(int pos)
Description copied from class: HsrScreen
Retrieves the HsrScreenField at the given location.

Overrides:
getFieldAtPos in class HsrScreen
Parameters:
pos - - the position of the screen
Returns:
HsrScreenField - the HsrScreenField at the location or null if no field is found

getFieldAssociatedWithPos

public HostScreenField getFieldAssociatedWithPos(int row,
                                                 int col)
Returns the host screen field at the given location (includes the field separator bits at the beginning ).

Parameters:
row - The starting row position
col - The starting column position
Returns:
The host screen field at the given location.

getFieldAssociatedWithPos

public HsrScreenField getFieldAssociatedWithPos(int pos)
Returns the host screen field at the given location.

Overrides:
getFieldAssociatedWithPos in class HsrScreen
Parameters:
pos - The starting position
Returns:
The host screen field at the given location.

getBackgroundColor

public int getBackgroundColor(int screenposition)
Gets the background color at the given position.

Overrides:
getBackgroundColor in class HsrScreen
Parameters:
screenposition - The 1-based screen position.
Returns:
The color representation.

getForegroundColor

public int getForegroundColor(int screenposition)
Gets the foreground color at the given position.

Overrides:
getForegroundColor in class HsrScreen
Parameters:
screenposition - The 1-based screen position.
Returns:
The color representation.

getFieldFromAttributeLocation

public HostScreenField getFieldFromAttributeLocation(int pos)
Returns the host screen field associated to the field separator bit at the given location.

Parameters:
pos - The starting position
Returns:
The host screen field.

validFingerprint

protected boolean validFingerprint(byte[] fingerPrint)

getBoundaryPlane

public char[] getBoundaryPlane()
Returns the boundary plane.

Returns:
The boundary plane.

outputBoundaryDebug

public String outputBoundaryDebug()

getBlockScreenRegionString

public static String getBlockScreenRegionString(BlockScreenRegion bsr,
                                                HostScreen hs)
Returns the rectangle defined in the block screen region as a string.

Parameters:
bsr - The region of the screen to retrieve
hs - The host screen object
Returns:
The region on the screen.

getBlockScreenRegionString

public static String getBlockScreenRegionString(BlockScreenRegion bsr,
                                                HostScreen hs,
                                                String strbreak)
Returns the rectangle defined in the block screen region as a string.

Parameters:
bsr - The region of the screen to retrieve
hs - The host screen object
strbreak - The row separator string to use
Returns:
The region on the screen.

getInputFieldAttributes

public Vector getInputFieldAttributes()
Returns the input field attributes.

Returns:
The input field attributes.

setInputFieldAttributes

public void setInputFieldAttributes(Vector v)
Sets the input field attributes.

Parameters:
v - The input field attributes

getEnptuiWindows

public com.ibm.hats.common.HostScreenEnptuiWindow[] getEnptuiWindows()
Returns the 5250 ENPTUI window data.

Returns:
The 5250 ENPTUI window data.

setEnptuiWindows

public void setEnptuiWindows(com.ibm.hats.common.HostScreenEnptuiWindow[] hsew)
Sets the 5250 ENPTUI window data.

Parameters:
hsew - The 5250 ENPTUI window data.

getHTMLDDS

public Hashtable getHTMLDDS()
Returns the 5250 HTML DDS data.

Returns:
The 5250 HTML DDS data.

setHTMLDDS

public void setHTMLDDS(Hashtable h)
Sets the 5250 HTML DDS data.

Parameters:
h - The 5250 HTML DDS data.

isUnicodeField

public boolean isUnicodeField(int pos)
Tests whether the position is in a Unicode enabled field.

Parameters:
pos - The position to test
Returns:
true if the position is in a Unicode enabled field, false otherwise.

isUnicodeField

public boolean isUnicodeField()
Tests whether the current position is in a Unicode enabled field.

Returns:
true if the position is in a Unicode enabled field, false otherwise.

isVTLogical

public boolean isVTLogical()
Tests whether or not the VT session is a logical session.

Returns:
ture if the VT session is a logical session.

isRTLCursorDirection

public boolean isRTLCursorDirection()

isRTLCursorDirectionSaved

public boolean isRTLCursorDirectionSaved()

setProcessShifts

public void setProcessShifts(boolean processShifts)

setFieldName

public boolean setFieldName(int position,
                            String label)
Sets the BMS field name for a field starting at a given position.

Parameters:
position - The offset of start of the field
label - The label
Returns:
true if the field name was set, false otherwise.

getFieldName

public String getFieldName(int position)

addOrigin

public void addOrigin(String mapSetName,
                      String mapName)
Adds a mapset/map name combination for this map. Note that there is no delete because that situation should not arise.

Parameters:
mapSetName - The map set name
mapName - The map name

getOriginMapSet

public String getOriginMapSet(int index)

getOriginMap

public String getOriginMap(int index)

getOriginCount

public int getOriginCount()

isBlankScreen

public static boolean isBlankScreen(Properties settings,
                                    HostScreen screen)

getSelectorFieldType

public char getSelectorFieldType(ECLField f)

containsPenSelectableFields

public boolean containsPenSelectableFields()
Tests if there is a pen selectable field

Returns:
true if there is a pen selectable field, false otherwise.

arabicDataExchange

public String arabicDataExchange(String inputString,
                                 boolean shapeArabicData)

ArabicDataExchange

public String ArabicDataExchange(String inputString,
                                 boolean shapeArabicData)
Deprecated. 


charAt

public char charAt(int cursorPos,
                   int planar)
Returns character in the plane at a location.

Parameters:
cursorPos - The position to look for the character at
planar - Which plane to retrieve the character from (like TEXT_PLANE)
Returns:
Returns the character in the plane at a location or (char)0 if no character is defined at that point.

ConvertLogicalToVisual

public String ConvertLogicalToVisual(String inputBuffer,
                                     boolean isLTRImplicit,
                                     boolean isLTRVisual)
Convert a bidi string from logical format to visual format.

Parameters:
inputBuffer - The input string in logical format
isLTRImplicit - The output string to Left-To-Right Screen or not
isLTRVisual - The input string from Left-to-Right Screen or not
Returns:
The converted string in visual format.

ConvertLogicalToVisual

public String ConvertLogicalToVisual(String inputBuffer,
                                     boolean isLTRImplicit,
                                     boolean isLTRVisual,
                                     boolean compressLamAlef)
Convert a bidi string from logical format to visual format.

Parameters:
inputBuffer - The input string in logical format
isLTRImplicit - The output string to Left-To-Right Screen or not
isLTRVisual - The input string from Left-to-Right Screen or not
compressLamAlef - Enable or disable LAM-ALEF compression in Arabic sessions
Returns:
The converted string in visual format

ConvertVisualToLogical

public String ConvertVisualToLogical(String inputBuffer,
                                     boolean isLTRVisual,
                                     boolean isLTRImplicit)
Convert a bidi string from visual format to logical format.

Parameters:
inputBuffer - The input string in visual format
isLTRVisual - The input string from Left-to-Right Screen or not
isLTRImplicit - The output string to Left-To-Right Screen or not
Returns:
The converted string in logical format.

ConvertVisualToLogical

public String ConvertVisualToLogical(String inputBuffer,
                                     boolean isLTRVisual,
                                     boolean isLTRImplicit,
                                     boolean swapchars)
Convert a bidi string from visual format to logical format.

Parameters:
inputBuffer - The input string in visual format
isLTRVisual - The input string from Left-to-Right Screen or not
isLTRImplicit - The output string to Left-To-Right Screen or not
swapchars - Enable or disable Symmetric swapping in conversion
Returns:
The converted string in logical format

ConvertPosToCol

public int ConvertPosToCol(int pos)
Returns the column from the position using the column size of the hostscreen.

Overrides:
ConvertPosToCol in class HsrScreen
Parameters:
pos - The position to query
Returns:
The column of the position.

ConvertPosToCol

public static int ConvertPosToCol(int pos,
                                  int sizecols)
Returns the column from the position using the column size of the hostscreen.

Parameters:
pos - The position to query
sizecols - The number of columns in a row
Returns:
The column of the position.

ConvertPosToRow

public int ConvertPosToRow(int pos)
Returns the row from the position using the column size of the hostscreen.

Overrides:
ConvertPosToRow in class HsrScreen
Parameters:
pos - The position to query
Returns:
The row of the position.

ConvertPosToRow

public static int ConvertPosToRow(int pos,
                                  int sizecols)
Returns the row from the position using the column size given.

Parameters:
pos - The position to query
sizecols - The number of columns in a row
Returns:
The row of the position

ConvertRowColToPos

public int ConvertRowColToPos(int row,
                              int col)
Returns the position based on the row and column.

Overrides:
ConvertRowColToPos in class HsrScreen
Parameters:
row - The row of the position
col - The column of the position
Returns:
The position based on the row and column.

ConvertRowColToPos

public static int ConvertRowColToPos(int row,
                                     int col,
                                     int sizecols)
Returns the position based on the row and column.

Parameters:
row - The row of the position
col - The column of the position
sizecols - The number of columns in a row
Returns:
The position based on the row and column.

setArabicOrientation

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

Parameters:
Orientation - Either the String rtl or the String ltr

ExpandLamAlef

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

Parameters:
UniBuff - The input string
length - Length of the buffer
visualmode - true if in visual mode, false otherwise
Returns:
Character array containing Lam and Alef characters.

getArabicOrientation

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

Returns:
The String "ltr" or "rtl"

setRuntimertl

public void setRuntimertl(boolean value)
Sets whether or not the screen orientation is right-to-left.

Parameters:
value - true if the screen orientation is right-to-left, false otherwise.

getRuntimertl

public boolean getRuntimertl()
Returns if the current screen orientation is right-to-left.

Returns:
true if the current screen orientation is right-to-left, false otherwise.

HandleFEData

public void HandleFEData(char[] UniBuff)
Convert FE Arabic data to 06 so the BIDI classes are not loaded in each file.

Parameters:
UniBuff - Buffer to convert

HandleGVBIDISwap

public String HandleGVBIDISwap(String inputString,
                               boolean symswap,
                               boolean numswap)

is3270

public boolean is3270()
Returns whether or not the connection is 3270.

Overrides:
is3270 in class HsrScreen
Returns:
true if the connection is 3270, false otherwise.

is5250

public boolean is5250()
Returns whether or not the connection is 5250.

Overrides:
is5250 in class HsrScreen
Returns:
true if the connection is 5250, false otherwise.

isArabicSession

public boolean isArabicSession()
Returns whether or not the session is an Arabic session.

Overrides:
isArabicSession in class HsrScreen
Returns:
true if the session is Arabic, false otherwise.

isBIDISession

public boolean isBIDISession()
Returns whether or not the session is a bidirectional session.

Overrides:
isBIDISession in class HsrScreen
Returns:
true if the session is bidirectional, false otherwise.

isDBCSSession

public boolean isDBCSSession()
Returns whether or not the session is a DBCS Session.

Overrides:
isDBCSSession in class HsrScreen
Returns:
true if the session is DBCS, false otherwise.

isNumericSwapping

public boolean isNumericSwapping()
Returns whether or not numeric swapping is enabled.

Returns:
true if numeric swapping is enabled, false otherwise.

isRTLScreen

public boolean isRTLScreen()
Returns whether the screen is right-to-left oriented.

Returns:
true if the screen is right-to-left oriented, false otherwise.

isSymmetricSwapping

public boolean isSymmetricSwapping()
Returns the current value of Directional Swapping.

Returns:
true if Symmetric Swapping is enabled, false otherwise.

RemoveTail

public String RemoveTail(String str)
Removes the Bidi tail attribute from the given string.

Parameters:
str - The input string
Returns:
String with the tail attribute removed.

SetisRTLScreen

public void SetisRTLScreen(boolean isrtlscreen)
Sets whether or not the screen orientation is right-to-left.

Parameters:
isrtlscreen - true if the screen orientation is right-to-left, false otherwise.

setDisableWesternNumbersEntry

public 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

Parameters:
isDisabled - is true when the checkbox is checked

isDisableWesternNumbersEntry

public boolean isDisableWesternNumbersEntry()
Returns:
boolean of the flag disableNumSwap to indicate if the "Disable entry of Arabic-Western digits in RTL screens checkbox is checked or not

setAutoFldRev

public void setAutoFldRev(boolean isAutoFldRev)
Sets the stored value of current HATS emulation auto field reverse Bidi mode

Parameters:
isAutoFldRev - is true when current application auto field reverse mode is on, false otherwise.

isAutoFldRev

public boolean isAutoFldRev()
Returns stored value of current HATS emulation auto field reverse mode.

Returns:
true if the auto field reverse is on, false if it is off.

HATS 7.5.1 (201005110649)