Services Builder for Screens

com.attachmate.common.eai.tasks
Interface INativeAccessEx

All Superinterfaces:
INativeAccess, INativeAccessConstants, ITask
All Known Implementing Classes:
ScreenNativeAccessEx

public interface INativeAccessEx
extends INativeAccess, ITask

Extends the INativeAccess API. New features added: HostUpdate, methods supporting field names and screen counting.

See Also:
INativeAccess, INativeAccessConstants, ITask

Field Summary
 
Fields inherited from interface com.attachmate.common.eai.tasks.INativeAccess
PROPERTY_NOT_INITIALIZED
 
Fields inherited from interface com.attachmate.common.eai.tasks.INativeAccessConstants
ATTR_BLINK, ATTR_CHAR_SET_APL, ATTR_COLUMN_SEPARATOR, ATTR_DEFAULT, ATTR_HIGH_INTENSITY, ATTR_LEFT_LINE, ATTR_OVERLINE, ATTR_REVERSE, ATTR_RIGHT_LINE, ATTR_STRIKETHROUGH, ATTR_UNDERLINE, ATTR_VISIBLE, CMD_ATTENTION, CMD_CLEAR, CMD_CTRL, CMD_DISABLEFORMS, CMD_ENABLEFORMS, CMD_F1, CMD_F10, CMD_F11, CMD_F12, CMD_F13, CMD_F14, CMD_F15, CMD_F16, CMD_F17, CMD_F18, CMD_F19, CMD_F2, CMD_F20, CMD_F21, CMD_F22, CMD_F23, CMD_F24, CMD_F3, CMD_F4, CMD_F5, CMD_F6, CMD_F7, CMD_F8, CMD_F9, CMD_HELP, CMD_LOCAL, CMD_MESSAGE_WAIT, CMD_PA1, CMD_PA2, CMD_PA3, CMD_PRINT, CMD_RECEIVE, CMD_REFRESH_NULL, CMD_RESET, CMD_ROLLDOWN, CMD_ROLLUP, CMD_SPECIFY, CMD_SYSTEM_MODE, CMD_SYSTEM_REQUEST, CMD_TEST, CMD_TRANSMIT, CMD_TRANSMIT_LINE, CMD_TRANSMIT_SCREEN, CMD_WORKSTATION_MODE, COLOR_BG_BLACK, COLOR_BG_BLUE, COLOR_BG_DEFAULT, COLOR_BG_DK_BLUE, COLOR_BG_DK_GREEN, COLOR_BG_DK_MAGENTA, COLOR_BG_DK_RED, COLOR_BG_DK_TURQUOISE, COLOR_BG_DK_YELLOW, COLOR_BG_GRAY, COLOR_BG_GREEN, COLOR_BG_LT_GRAY, COLOR_BG_MAGENTA, COLOR_BG_MASK, COLOR_BG_RED, COLOR_BG_TURQUOISE, COLOR_BG_WHITE, COLOR_BG_YELLOW, COLOR_FG_BLACK, COLOR_FG_BLUE, COLOR_FG_DEFAULT, COLOR_FG_DK_BLUE, COLOR_FG_DK_GREEN, COLOR_FG_DK_MAGENTA, COLOR_FG_DK_RED, COLOR_FG_DK_TURQUOISE, COLOR_FG_DK_YELLOW, COLOR_FG_GRAY, COLOR_FG_GREEN, COLOR_FG_LT_GRAY, COLOR_FG_MAGENTA, COLOR_FG_MASK, COLOR_FG_RED, COLOR_FG_TURQUOISE, COLOR_FG_WHITE, COLOR_FG_YELLOW, ERROR_CODE_FATAL, ERROR_CODE_INPUT_INHIBITED_EXCEPTION, ERROR_CODE_KEYLOCK, ERROR_CODE_PROTECTED_FIELD_EXCEPTION, ERROR_CODE_SCREEN_CHANGED, ERROR_CODE_TIMEOUT, ERROR_CODE_TRUNCATED_EXCEPTION, ERROR_CODE_UNKNOWN, ERROR_CODE_UNKNOWN_KEYLOCK, FIELD_ALPHA_ONLY, FIELD_ALPHA_SHIFT, FIELD_ATTRIB_SPACE, FIELD_ATTRIBUTE, FIELD_AUTO_ENTER, FIELD_CHECK_MOD_10, FIELD_CHECK_MOD_11, FIELD_DIGITS, FIELD_EXIT_REQ, FIELD_LIGHT_PEN, FIELD_MAGNETIC_STRIP, FIELD_MANDATORY_ENTRY, FIELD_MANDATORY_FILL, FIELD_MARK_DUP, FIELD_MODE_BLOCK, FIELD_MODE_PROTECTED, FIELD_MODIFIED, FIELD_NUMERIC_ONLY, FIELD_NUMERIC_SHIFT, FIELD_RA_BLANKFILL, FIELD_RA_ZEROFILL, FIELD_RIGHT_JUSTIFIED, FIELD_SIGNED_NUMERIC, FIELD_TRIGGER, FIELD_TYPE_MESSAGE, FIELD_TYPE_TABLE, FIELD_TYPE_USER, FIELD_UPPERCASE, STATUS_DATA_CHANGED, STATUS_EOR, STATUS_FORMAT_CHANGED, STATUS_KBD_UNLOCK, STATUS_MESSAGE_WAITING, STATUS_SCREEN_ERASED, STATUS_SIZE_CHANGED, STATUS_TYPE_CHANGED, STR_FATAL_ERROR, STR_SCREEN_CHANGED, STR_WARNING, STR_WARNING_KEYLOCK, STR_WARNING_TIMEOUT, STR_WARNING_UNKNOWN, USE_SYSTEM_DEFAULT
 
Fields inherited from interface com.attachmate.tasks.ITask
PRESERVE_ALWAYS, PRESERVE_NEVER, PRESERVE_ON_ERROR
 
Method Summary
 void addHostUpdateListener(IHostUpdateListener listener)
          Register a class for host update events.
 long getFieldAttr(java.lang.String fieldName)
          Gets the attribute bit of the desired field.
 int getFieldEndColumn(java.lang.String fieldName)
          Gets the ending column of the desired field.
 int getFieldEndRow(java.lang.String fieldName)
          Gets the ending row of the desired field.
 int getFieldIndex(java.lang.String fieldName)
          Gets the field index for the named field.
 java.lang.String getFieldInputText(java.lang.String fieldName)
          Gets the field input text from the desired field.
 int getFieldLength(java.lang.String fieldName)
          Gets the length of the desired field.
 java.lang.String getFieldName(int fieldIndex)
          Gets the name of the field from the index.
 java.lang.String[] getFieldNames()
          Gets an array containing all the field anmes.
 int getFieldPage(java.lang.String fieldName)
          Gets the screen page of the desired field.
 int getFieldStartColumn(java.lang.String fieldName)
          Gets the starting column of the desired field's text.
 int getFieldStartRow(java.lang.String fieldName)
          Gets the starting row of the desired field's text.
 java.lang.String getFieldText(java.lang.String fieldName)
          Gets the visible text from the desired field.
 int getScreenCount()
          Gets the number of screen changes (TN3270 EORs) before the screen is returned.
 void removeHostUpdateListener()
          Deprecated. As of 7.1, replaced by removeHostUpdateListener( listener )
 boolean removeHostUpdateListener(IHostUpdateListener listener)
          Unregisters the supplied listener
 void setFieldInputText(java.lang.String fieldName, java.lang.String fieldText)
          Sets the text in the desired input field.
 void setHostUpdateListenerHostAddress(java.lang.String strOverridingHostAddress)
          Sets the host address that overrides value(s) retrieved from the system.
 void setHostUpdateListenerPort(int iDefaultPort)
          Changes the default port the socket will listen on.
 void setHostUpdateListenerTimeout(long lDefaultTimeout)
          Changes the default timeout on socket connections and reads.
 void setScreenCount(int count)
          Sets the number of screen changes (TN3270 EORs) processed before the screen is returned.
 
Methods inherited from interface com.attachmate.common.eai.tasks.INativeAccess
getCharacterAttr, getColumns, getCommand, getCurrentPage, getCursorColumn, getCursorRow, getFieldAttr, getFieldAttr, getFieldCount, getFieldEndColumn, getFieldEndColumn, getFieldEndRow, getFieldEndRow, getFieldInputText, getFieldInputText, getFieldLength, getFieldLength, getFieldPage, getFieldPage, getFieldStartColumn, getFieldStartColumn, getFieldStartRow, getFieldStartRow, getFieldText, getFieldText, getHostFlags, getHostMessage, getHostType, getPageCount, getPoolName, getRows, getScreenName, getSettleTime, getShare, setCommand, setCurrentPage, setCursorColumn, setCursorRow, setFieldInputText, setFieldInputText, setSettleTime, setShare
 
Methods inherited from interface com.attachmate.tasks.ITask
addTaskListener, cancel, clearContext, copyContext, executeAsync, executeSync, getInstanceName, getJobName, getLocale, getPreserveContext, getResourceName, getStatus, getTimeout, getVersion, removeTaskListener, setInstanceName, setJobName, setLocale, setPreserveContext, setResourceName, setTimeout, transferContext
 

Method Detail

getScreenCount

public int getScreenCount()
Gets the number of screen changes (TN3270 EORs) before the screen is returned.

Returns:
the EOR count

setScreenCount

public void setScreenCount(int count)
Sets the number of screen changes (TN3270 EORs) processed before the screen is returned.

Parameters:
count - the screen count

getFieldText

public java.lang.String getFieldText(java.lang.String fieldName)
Gets the visible text from the desired field.

Parameters:
fieldName - the name of the field to retrieve text from
Returns:
the visible text from the field

getFieldPage

public int getFieldPage(java.lang.String fieldName)
Gets the screen page of the desired field.

Parameters:
fieldName - the name of the field to retrieve page from
Returns:
screen page of the field

getFieldInputText

public java.lang.String getFieldInputText(java.lang.String fieldName)
Gets the field input text from the desired field.

Parameters:
fieldName - the name of the field to retrieve text from
Returns:
the field input text from the field

setFieldInputText

public void setFieldInputText(java.lang.String fieldName,
                              java.lang.String fieldText)
Sets the text in the desired input field.

Parameters:
fieldName - the name of the field to write to
fieldText - the text to write to the desired field

getFieldAttr

public long getFieldAttr(java.lang.String fieldName)
Gets the attribute bit of the desired field.

Parameters:
fieldName - name of the desired field
Returns:
long representing the field's attributes
See Also:
INativeAccessConstants

getFieldStartRow

public int getFieldStartRow(java.lang.String fieldName)
Gets the starting row of the desired field's text.

Parameters:
fieldName - name of the desired field
Returns:
the row that the field begins on

getFieldStartColumn

public int getFieldStartColumn(java.lang.String fieldName)
Gets the starting column of the desired field's text.

Parameters:
fieldName - name of the desired field
Returns:
the column that the field starts on

getFieldEndRow

public int getFieldEndRow(java.lang.String fieldName)
Gets the ending row of the desired field.

Parameters:
fieldName - name of the desired field
Returns:
the row that the field ends on

getFieldEndColumn

public int getFieldEndColumn(java.lang.String fieldName)
Gets the ending column of the desired field.

Parameters:
fieldName - name of the desired field
Returns:
the column that the field ends on

getFieldLength

public int getFieldLength(java.lang.String fieldName)
Gets the length of the desired field.

Parameters:
fieldName - name of the desired field
Returns:
the length of the desired field

getFieldName

public java.lang.String getFieldName(int fieldIndex)
Gets the name of the field from the index.

Parameters:
fieldIndex - index of the field
Returns:
the name of the field

getFieldNames

public java.lang.String[] getFieldNames()
Gets an array containing all the field anmes.

Returns:
a String array containing all the fields' names

getFieldIndex

public int getFieldIndex(java.lang.String fieldName)
Gets the field index for the named field.

Returns:
the field index or -1 if not found

setHostUpdateListenerTimeout

public void setHostUpdateListenerTimeout(long lDefaultTimeout)
Changes the default timeout on socket connections and reads.

Parameters:
lDefaultTimeout - timeout in milliseconds, 0 for infinite

setHostUpdateListenerPort

public void setHostUpdateListenerPort(int iDefaultPort)
Changes the default port the socket will listen on.

Parameters:
iDefaultPort - port, 0 for any free port. Note: ports < 1024 are reserved

setHostUpdateListenerHostAddress

public void setHostUpdateListenerHostAddress(java.lang.String strOverridingHostAddress)
Sets the host address that overrides value(s) retrieved from the system. Use if your machine has multiple network cards.

Parameters:
strOverridingHostAddress - only host address to use

addHostUpdateListener

public void addHostUpdateListener(IHostUpdateListener listener)
                           throws java.lang.Exception
Register a class for host update events.

Parameters:
listener - class that implements the host update listener interface
java.lang.Exception
See Also:
ScreenShapeChangeEvent ScreenTypeChangeEvent

removeHostUpdateListener

public void removeHostUpdateListener()
Deprecated. As of 7.1, replaced by removeHostUpdateListener( listener )

Unregisters all host update listeners.


removeHostUpdateListener

public boolean removeHostUpdateListener(IHostUpdateListener listener)
Unregisters the supplied listener

Parameters:
listener - the listener to remove from the list
Returns:
true if the listener was removed successfully, false otherwise

Services Builder for Screens