Package com.rs.seagull.emulator.api

Interface Screen

All Superinterfaces:

BareScreen, Defined

public interface Screen
extends BareScreen, Defined

A Screen represents a host screen. Next to being a rectangular shape, as defined by BareScreen, it also has host application definitions, as defined by Defined.

Method Summary

Modifier and Type	Method	Description
com.seagullsw.common.identification.model.Identifiable	getDefinition()	Returns the identification information for the screen.
Field	getField(String fieldName)	Returns the user-defined field with the given name.
List<Field>	getFields()	Returns a list of all the user-defined fields.
Table	getTable(String tableName)	Returns the user-defined table with the given name.

Methods inherited from interface com.rs.seagull.emulator.api.BareScreen

createScreenShot, createScreenShot, getAllText, getCell, getCell, getCell, getCellList, getCellList, getCellList, getCellList, getChangeCount, getCursor, getCursorList, getEmulatorName, getEmulatorState, getHostField, getHostFields, getKeyboard, getKeyboardRestoreCount, getSize, getSnapshot, getText, getText, getText, getTextLine, getTextLines, getTextLines, isInputInhibit, isReverse, isSnapshot, toDebugString, toOffset, toPoint

Methods inherited from interface com.rs.seagull.emulator.api.Defined

getName

Method Details

getField

Field getField(String fieldName)
        throws NoSuchFieldException

Returns the user-defined field with the given name.

Parameters:

fieldName - The name of the field.

Returns:

the user-defined field with the given name.

Throws:

NoSuchFieldException - if the field does not exist.

getFields

List<Field> getFields()

Returns a list of all the user-defined fields.

Returns:

a list of all the user-defined fields.

getTable

Table getTable(String tableName)
        throws NoSuchFieldException

Returns the user-defined table with the given name.

Parameters:

tableName - The name of the table.

Returns:

the user-defined table with the given name.

Throws:

NoSuchFieldException - if the table does not exist.

getDefinition

com.seagullsw.common.identification.model.Identifiable getDefinition()

Returns the identification information for the screen.

Returns:

the identification information for the screen.