A C F G I M O P R S T W

A

addIScreenListener(IScreenListener) - Method in interface com.attachmate.UPG.common.IScreenUPG
Adds the ScreenListener, which allows your application to receive various screen event notifications, to the Screen object.

C

clearCapturedData() - Method in interface com.attachmate.UPG.common.IScreenUPG
Clears information from the captured data buffer by setting it to null.
Close() - Method in interface com.attachmate.UPG.common.IScreenUPG
Closes the current host session.
CursorPositionException - exception com.attachmate.emulation.exception.CursorPositionException.
Indicates that either the setCursor, setCursorColumn, or setCursorRow method was not able to complete successfully because an invalid cursor position was specified.
CursorPositionException() - Constructor for class com.attachmate.emulation.exception.CursorPositionException
 
CursorPositionException(String) - Constructor for class com.attachmate.emulation.exception.CursorPositionException
 

F

fieldCount(int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the number of fields of the specified type.
findField(int, int, int, int, int, MutableInt, MutableInt, MutableInt, MutableInt) - Method in interface com.attachmate.UPG.common.IScreenUPG
Searches the screen for the specified field, beginning from the row and column position specified.
findFieldEx(int, int, int, int, MutableInt, MutableInt, MutableInt, MutableInt) - Method in interface com.attachmate.UPG.common.IScreenUPG
Searches the screen for the specified field, beginning from the index (field number) specified.
findString(String, int, int, MutableInt, MutableInt) - Method in interface com.attachmate.UPG.common.IScreenUPG
Searches the screen for the specified text string, starting at the specified position.
findStringEx(String, int, int, int, int, int, int, int, MutableInt, MutableInt) - Method in interface com.attachmate.UPG.common.IScreenUPG
Searches the screen for the specified text string, from the specified start position to the specified end position.

G

getCapturedData() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the currently captured data.
getColumns() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the number of columns in the current presentation space (PS).
getConfigurationIPAddress() - Method in class com.attachmate.UPG.SessionLoader.SessionLoader
Gets the Server Address to be used by all subsequent calls to requestScreen()
getCursor(MutableInt, MutableInt) - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the current cursor position.
getCursorColumn() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the column of the current cursor position.
getCursorRow() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the row of the current cursor position.
getDataCapture() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the current state of the data capture facility: true if on; false if off.
getDescription() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns a custom description for the Screen object, if a description was created previously using setDescription.
getExtPS(int, int, int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the specified portion of the presentation space in a string format.
getgetText_Display() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the current setting of the getText_Display property.
getKeyboardLocked() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the current state of the keyboard: true if locked; false if unlocked.
getLastError() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns a description of the most recent error that occurred.
getMaxDataCaptureLength() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the current maximum buffer size for data captured using the data capture facility.
getObjectVersion() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the version number of the specified Screen object; for example, 3001000 is equivalent to version 3.1.00.
getOIAContents() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the data displayed in the OIA portion (status line) of the screen.
getOIAText() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the text of the OIA portion (status line) of the screen in a string format.
getRows() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the number of rows in the presentation space (PS).
getScreenType() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the current host type.
getString(int, int, int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the visible text from the specified location.
getStringEx(int, int, int, int, int, int, int, int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns text from the specified location, for attributes matching those specified by inAttr.
getTerminalType() - Method in class com.attachmate.UPG.SessionLoader.SessionLoader
Gets the default Screen Type to be used for retrieving Screen Objects.
getText() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the text contents of the presentation space (PS) as a string.

I

InputInhibitedException - exception com.attachmate.emulation.exception.InputInhibitedException.
Indicates that the putString or putStringEx method was not able to complete successfully because a field with the input inhibited attribute was encountered.
InputInhibitedException() - Constructor for class com.attachmate.emulation.exception.InputInhibitedException
 
InputInhibitedException(String) - Constructor for class com.attachmate.emulation.exception.InputInhibitedException
 
isConnected() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the state of the Mainframe connection: true if connected; false if unconnected.
IScreenListener - interface com.attachmate.UPG.screen.IScreenListener.
Provides programmatic access to events generated by the host presentation space.
IScreenUPG - interface com.attachmate.UPG.common.IScreenUPG.
 
isKeyboardLocked() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the state of the keyboard: true if locked; false if unlocked.

M

MutableInt - class com.attachmate.common.types.MutableInt.
Wrapper class for fundamental type int.
MutableInt() - Constructor for class com.attachmate.common.types.MutableInt
Constructor to initialize the instance of the class.
MutableInt(int) - Constructor for class com.attachmate.common.types.MutableInt
Constructor to initialize the instance of the class.

O

onConnectionLost() - Method in interface com.attachmate.UPG.screen.IScreenListener
Event generated when the connection to the host is broken.
onError(ErrorEvent) - Method in interface com.attachmate.UPG.screen.IScreenListener
Event generated when an error occurs.
onLostRemoteWindow() - Method in interface com.attachmate.UPG.screen.IScreenListener
Reserved for internal use.
onScreenChanged(ScreenChangedEvent) - Method in interface com.attachmate.UPG.screen.IScreenListener
Event generated when any part of the host screen changes.
onScreenShapeChanged(ScreenShapeChangeEvent) - Method in interface com.attachmate.UPG.screen.IScreenListener
Event generated when the host screen shape (number of rows and/or columns) changes.
Open() - Method in interface com.attachmate.UPG.common.IScreenUPG
Opens a host session.

P

ProtectedFieldException - exception com.attachmate.emulation.exception.ProtectedFieldException.
Indicates that the putString or putStringEx method was not able to complete successfully because a protected field was encountered.
ProtectedFieldException() - Constructor for class com.attachmate.emulation.exception.ProtectedFieldException
 
ProtectedFieldException(String) - Constructor for class com.attachmate.emulation.exception.ProtectedFieldException
 
putString(String, int, int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Copies a string of text to the specified position, returning the number of characters written.
putStringEx(String, int, int, int, int, int, int, int, boolean) - Method in interface com.attachmate.UPG.common.IScreenUPG
Copies a string of text to the specified position, returning the number of characters written.

R

removeIScreenListener(IScreenListener) - Method in interface com.attachmate.UPG.common.IScreenUPG
Removes the ScreenListener from the Screen object.
requestScreen(String, String, String) - Method in class com.attachmate.UPG.SessionLoader.SessionLoader
Gets a Screen object for the specified WebView, instantiated with the specified user and password, as well as the configuration specified by the WebView.
requestScreenEx(String, String, String, int) - Method in class com.attachmate.UPG.SessionLoader.SessionLoader
Gets a Screen object, instantiated with the specified user and password, as well as the configuration specified by the XML Data.

S

sendKeys(String, int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Sends characters and special keys to the host session.
SessionException - exception com.attachmate.UPG.SessionLoader.SessionException.
Describes possible reasons why the SessionLoader class can fail.
SessionException() - Constructor for class com.attachmate.UPG.SessionLoader.SessionException
 
SessionException(String) - Constructor for class com.attachmate.UPG.SessionLoader.SessionException
 
SessionLoader - class com.attachmate.UPG.SessionLoader.SessionLoader.
Initializes the specified host session.
SessionLoader() - Constructor for class com.attachmate.UPG.SessionLoader.SessionLoader
 
setConfigurationIPAddress(String) - Method in class com.attachmate.UPG.SessionLoader.SessionLoader
Sets a Server Address to be used by all subsequent calls to requestScreen()
setCursor(int, int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Sets the cursor position on the presentation space (PS).
setCursorColumn(int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Sets the column of the cursor position.
setCursorRow(int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Sets the row of the cursor position.
setDataCapture(boolean) - Method in interface com.attachmate.UPG.common.IScreenUPG
Turns the data capture facility on or off.
setDescription(String) - Method in interface com.attachmate.UPG.common.IScreenUPG
Creates a custom description for the Screen object.
setgetText_Display(boolean) - Method in interface com.attachmate.UPG.common.IScreenUPG
Turns the getText_Display property on or off.
setMaxDataCaptureLength(int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Sets the maximum buffer size for data captured using the data capture facility.
setResourceManagerOptions(int, int, String) - Method in class com.attachmate.UPG.SessionLoader.SessionLoader
Specifies the initial number of terminal or session IDs that are allocated to the application from e-Vantage ID Manager, as well as the increment in which additional IDs will be obtained when all allocated IDs are already in use.
setTerminalType(int) - Method in class com.attachmate.UPG.SessionLoader.SessionLoader
Sets a default Screen Type to be used for retrieving Screen Objects.
Shutdown() - Method in class com.attachmate.UPG.SessionLoader.SessionLoader
Ensures that all IDs defined with a Lease Timeout (from e-Vantage ID Manager) are properly retained by the SDK for future use, once your application no longer requires them.

T

TimedOutException - exception com.attachmate.emulation.exception.TimedOutException.
Indicates that a wait method has timed out before the wait condition was satisfied.
TimedOutException() - Constructor for class com.attachmate.emulation.exception.TimedOutException
 
TimedOutException(String) - Constructor for class com.attachmate.emulation.exception.TimedOutException
 
TruncatedException - exception com.attachmate.emulation.exception.TruncatedException.
Indicates that there is not enough room in the presentation space to write all of the data specified by the putString or putStringEx method.
TruncatedException() - Constructor for class com.attachmate.emulation.exception.TruncatedException
 
TruncatedException(String) - Constructor for class com.attachmate.emulation.exception.TruncatedException
 

W

waitForCursor(int, int, int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Waits for the cursor to appear at the specified position, for a specified period of time.
waitForString(String, int, int, int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Waits for the specified text to appear at the specified position, for a specified period of time.
waitHostQuiet(int, int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Waits for the host session to be idle for a specified period of time (in milliseconds).

A C F G I M O P R S T W