GXIScreen (ApplinX API Specification)

All Superinterfaces:

Serializable

All Known Subinterfaces:

GXINaturalDataTransferScreen, GXIScreenWithPrintData
```
public interface GXIScreen
extends Serializable
```
Interface for objects representing a screen entity that wraps an emulation screen. This class represents one instance of a host screen. It is a snapshot of a screen as it was received from the host. You cannot set contents to it. Setting contents to the host is done through the session object (using requests).

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`GXScreenBuffers`	`getBuffers()` Deprecated. use `getBuffers(boolean)` instead.
`GXScreenBuffers`	`getBuffers(boolean onlyWindowBuffer)` Returns the buffers from the current screen.
`int`	`getColumns()`
`GXPosition`	`getCursorPosition()`
`GXIField`	`getFieldByCursorPosition()` Gets the field which the cursor position is located at
`String`	`getFieldContent(String fieldName)`
`String`	`getFieldContent(String fieldName, int fieldIndex)`
`GXIField`	`getFieldInstance(String fieldName, int fieldIndex)`
`GXIFieldCollection`	`getFields()`
`GXIFieldCollection`	`getFields(GXIFieldCollectionQuery query)`
`GXIFieldCollection`	`getFields(GXIScreenCollectionFieldsQuery query)` Deprecated. this method is deprecated and is replaced by `getFields(GXIFieldCollectionQuery query)`
`GXIFieldCollection`	`getFields(String fieldName)`
`String`	`getFolderPath()`
`GXIHostKey[]`	`getHostKeys()` Gets the host keys associated with this screen.
`String`	`getName()`
`int`	`getRows()`
`String[]`	`getScreenGroupNames()`
`int`	`getSeqNumber()`
`GXITable`	`getTable()` Deprecated. As of release 8.2.2 HF3, replaced by `getTables()`
`GXITable[]`	`getTables()` Gets the tables associated with this screen.
`GXIWindow`	`getWindow()` Gets the window associated with this screen.
`GXPosition`	`getWindowLowerRight()` Deprecated. use @see GXIScreen#getWindow() , @see GXIWindow#getBounds()
`GXIWindow[]`	`getWindows()` Gets an array of the windows associated with this screen, or null if none exist.
`GXPosition`	`getWindowUpperLeft()` Deprecated. use @see GXIScreen#getWindow() , @see GXIWindow#getBounds()
`boolean`	`hasAlarm()`
`boolean`	`isDirectionRTL()`
`boolean`	`isDisplayChanged()`
`boolean`	`isLocked()`
`boolean`	`isMemberOf(String screenGroupName)` Checks whether the current screen belongs to the specified screen group.
`boolean`	`isTabbingRTL()`
`boolean`	`isTypingRTL()`
`boolean`	`isWindow()`

- Method Detail
  - getName
```
String getName()
```
    Returns:
    
    the name (ID) of the screen as it was identified by ApplinX.
  - getScreenGroupNames
```
String[] getScreenGroupNames()
```
    Returns:
    
    a name array of the screens screen groups.
  - isWindow
```
boolean isWindow()
```
    Returns:
    
    whether the current screen was identified by ApplinX as a host window.
  - getWindowUpperLeft
```
GXPosition getWindowUpperLeft()
```
    Deprecated. use @see GXIScreen#getWindow() , @see GXIWindow#getBounds()
    
    Returns:
    
    the upper left coordinate of the identified host window.
  - getWindowLowerRight
```
GXPosition getWindowLowerRight()
```
    Deprecated. use @see GXIScreen#getWindow() , @see GXIWindow#getBounds()
    
    Returns:
    
    the lower right coordinate of the identified host window.
  - getSeqNumber
```
int getSeqNumber()
```
    Returns:
    
    the sequential number of the screen (since the session started).
  - isDisplayChanged
```
boolean isDisplayChanged()
```
    Returns:
    
    whether the current screen reflects display changes that were received from the host since the last time ApplinX Server sent content.
  - getCursorPosition
```
GXPosition getCursorPosition()
```
    Returns:
    
    the position of the cursor on the screen.
  - getFolderPath
```
String getFolderPath()
```
    Returns:
    
    the screen ID's folder path.
  - getRows
```
int getRows()
```
    Returns:
    
    the number of rows in the current screen. If the current screen is a host window the number of rows is the height of the window.
  - getColumns
```
int getColumns()
```
    Returns:
    
    the number of columns in the current screen. If the current screen is a host window, the number of columns is the width of the window.
  - getBuffers
```
GXScreenBuffers getBuffers(boolean onlyWindowBuffer)
```
    Returns the buffers from the current screen. Buffers will be returned only if the variable GXBaseObjectConstants.GX_VAR_RETURN_SCREEN_BUFFERS was set in the GXGetScreenRequest to GXBaseObjectConstants.GX_VAR_VAL_BUFFERS_SCREEN_DATA. By default buffers will not be available.
    
    Parameters:
    
    onlyWindowBuffer - when there is a window, only returns the window buffer and not the entire screen buffer.
    
    Returns:
    
    the screen buffers object.
  - getBuffers
```
GXScreenBuffers getBuffers()
```
    Deprecated. use getBuffers(boolean) instead.
    
    Backward compatability. Equivalent to getBuffers(true).
    
    Returns:
    
    the screen buffers object.
  - isDirectionRTL
```
boolean isDirectionRTL()
```
    Returns:
    
    whether the direction of the current screen is RTL.
  - isTabbingRTL
```
boolean isTabbingRTL()
```
    Returns:
    
    whether the tabbing direction of the current screen is RTL.
  - isTypingRTL
```
boolean isTypingRTL()
```
  - isLocked
```
boolean isLocked()
```
    Returns:
    
    whether the system was locked upon the creation of the screen or not. In normal situations, the system is NOT locked upon screen creation.
    
    See Also:
    
    for more details on this feature.
  - hasAlarm
```
boolean hasAlarm()
```
    Returns:
    
    whether the screen should sound an alarm
  - getFields
```
GXIFieldCollection getFields()
```
    Returns:
    
    a field collection holding application fields in the screen. To collect both the host fields and the application fields set the GXBaseObjectConstants.GX_VAR_INCLUDE_HOST_FIELDS variable in the GXGetScreenRequest to "true".
  - getFields
```
GXIFieldCollection getFields(GXIScreenCollectionFieldsQuery query)
```
    Deprecated. this method is deprecated and is replaced by getFields(GXIFieldCollectionQuery query)
    
    Parameters:
    
    query - a query that creates GXIFieldCollection from GXIScreenCollection
    
    Returns:
    
    the collection returned by the query
  - getFields
```
GXIFieldCollection getFields(GXIFieldCollectionQuery query)
```
    Parameters:
    
    query - a query that creates GXIFieldCollection from a field collection query
    
    Returns:
    
    the collection returned by the query
  - getFields
```
GXIFieldCollection getFields(String fieldName)
```
    Parameters:
    
    fieldName - name of an application field
    
    Returns:
    
    a collection holding all the instances of the application field.
  - getFieldInstance
```
GXIField getFieldInstance(String fieldName,
                          int fieldIndex)
```
    Parameters:
    
    fieldName - multiple application field name
    
    fieldIndex - index within the multiple application field.
    
    Returns:
    
    the instance of the field at the given index.
  - getFieldContent
```
String getFieldContent(String fieldName,
                       int fieldIndex)
```
    Parameters:
    
    fieldName - a name of an application field.
    
    fieldIndex - an index of a multiple application field.
    
    Returns:
    
    the content of the given instance of the application field.
  - getFieldContent
```
String getFieldContent(String fieldName)
```
    Parameters:
    
    fieldName - a name of an application field.
    
    Returns:
    
    the content of the first instance of the application field.
  - isMemberOf
```
boolean isMemberOf(String screenGroupName)
```
    Checks whether the current screen belongs to the specified screen group.
    The specified screen group name may contain a full name including folder path, or the screen group name only.
    The function is not case sensitive.
    
    Parameters:
    
    screenGroupName - the screen group name
    
    Returns:
    
    whether the current screen is a member of the specified screen group.
  - getWindow
```
GXIWindow getWindow()
```
    Gets the window associated with this screen.
  - getTable
```
GXITable getTable()
```
    Deprecated. As of release 8.2.2 HF3, replaced by getTables()
    
    Gets the table associated with this screen.
  - getTables
```
GXITable[] getTables()
```
    Gets the tables associated with this screen.
  - getWindows
```
GXIWindow[] getWindows()
```
    Gets an array of the windows associated with this screen, or null if none exist.
    The windows in this array are sorted accoridng to the order of arrival from the host. The last element in the array is the last window received.
  - getHostKeys
```
GXIHostKey[] getHostKeys()
```
    Gets the host keys associated with this screen.
  - getFieldByCursorPosition
```
GXIField getFieldByCursorPosition()
```
    Gets the field which the cursor position is located at
    
    Returns:
    
    the field which the cursor position is located at

Interface GXIScreen

Method Summary

Method Detail

getName

getScreenGroupNames

isWindow

getWindowUpperLeft

getWindowLowerRight

getSeqNumber

isDisplayChanged

getCursorPosition

getFolderPath

getRows

getColumns

getBuffers

getBuffers

isDirectionRTL

isTabbingRTL

isTypingRTL

isLocked

hasAlarm

getFields

getFields

getFields

getFields

getFieldInstance

getFieldContent

getFieldContent

isMemberOf

getWindow

getTable

getTables

getWindows

getHostKeys

getFieldByCursorPosition