Package org.tn5250j.framework.tn5250

Class ScreenOIA

java.lang.Object

org.tn5250j.framework.tn5250.ScreenOIA

public class ScreenOIA
extends java.lang.Object

The operator information area of a host session. This area is used to provide status information regarding the state of the host session and location of the cursor. A ScreenOIA object can be obtained using the GetOIA() method on an instance of Screen5250.

Field Summary

Fields

Modifier and Type	Field	Description
static int	INPUTINHIBITED_COMMCHECK
static int	INPUTINHIBITED_MACHINECHECK
static int	INPUTINHIBITED_NOTINHIBITED
static int	INPUTINHIBITED_OTHER
static int	INPUTINHIBITED_PROGCHECK
static int	INPUTINHIBITED_SYSTEM_WAIT
static int	OIA_LEVEL_AUDIBLE_BELL
static int	OIA_LEVEL_CLEAR_SCREEN
static int	OIA_LEVEL_INPUT_ERROR
static int	OIA_LEVEL_INPUT_INHIBITED
static int	OIA_LEVEL_INSERT_MODE
static int	OIA_LEVEL_KEYBOARD
static int	OIA_LEVEL_KEYS_BUFFERED
static int	OIA_LEVEL_MESSAGE_LIGHT_OFF
static int	OIA_LEVEL_MESSAGE_LIGHT_ON
static int	OIA_LEVEL_NOT_INHIBITED
static int	OIA_LEVEL_SCREEN_SIZE
static int	OIA_LEVEL_SCRIPT

Constructor Summary

Constructors

Constructor	Description
ScreenOIA(Screen5250 screen)

Method Summary

Modifier and Type	Method	Description
void	addOIAListener(ScreenOIAListener listener)	Add a ScreenOIAListener to the listener list.
protected void	clearScreen()
int	getCommCheckCode()
java.lang.String	getInhibitedText()
int	getInputInhibited()
int	getLevel()
int	getMachineCheckCode()
int	getOwner()
int	getProgCheckCode()
Screen5250	getSource()
boolean	isInsertMode()
boolean	isKeyBoardLocked()	Is the keyboard locked or not
boolean	isKeysBuffered()
boolean	isMessageWait()
boolean	isScriptActive()
void	removeOIAListener(ScreenOIAListener listener)	Remove a iOhioSessionListener from the listener list.
void	setAudibleBell()
void	setInputInhibited(int inhibit, int whatCode)
void	setInputInhibited(int inhibit, int whatCode, java.lang.String message)
protected void	setInsertMode(boolean mode)
protected void	setKeyBoardLocked(boolean lockIt)
void	setKeysBuffered(boolean kb)
protected void	setMessageLightOff()
protected void	setMessageLightOn()
void	setOwner(int newOwner)
void	setScriptActive(boolean running)
void	setSource(Screen5250 screen)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OIA_LEVEL_INPUT_INHIBITED

public static final int OIA_LEVEL_INPUT_INHIBITED

See Also:

Constant Field Values

OIA_LEVEL_NOT_INHIBITED

public static final int OIA_LEVEL_NOT_INHIBITED

See Also:

Constant Field Values

OIA_LEVEL_MESSAGE_LIGHT_ON

public static final int OIA_LEVEL_MESSAGE_LIGHT_ON

See Also:

Constant Field Values

OIA_LEVEL_MESSAGE_LIGHT_OFF

public static final int OIA_LEVEL_MESSAGE_LIGHT_OFF

See Also:

Constant Field Values

OIA_LEVEL_AUDIBLE_BELL

public static final int OIA_LEVEL_AUDIBLE_BELL

See Also:

Constant Field Values

OIA_LEVEL_INSERT_MODE

public static final int OIA_LEVEL_INSERT_MODE

See Also:

Constant Field Values

OIA_LEVEL_KEYBOARD

public static final int OIA_LEVEL_KEYBOARD

See Also:

Constant Field Values

OIA_LEVEL_CLEAR_SCREEN

public static final int OIA_LEVEL_CLEAR_SCREEN

See Also:

Constant Field Values

OIA_LEVEL_SCREEN_SIZE

public static final int OIA_LEVEL_SCREEN_SIZE

See Also:

Constant Field Values

OIA_LEVEL_INPUT_ERROR

public static final int OIA_LEVEL_INPUT_ERROR

See Also:

Constant Field Values

OIA_LEVEL_KEYS_BUFFERED

public static final int OIA_LEVEL_KEYS_BUFFERED

See Also:

Constant Field Values

OIA_LEVEL_SCRIPT

public static final int OIA_LEVEL_SCRIPT

See Also:

Constant Field Values

INPUTINHIBITED_NOTINHIBITED

public static final int INPUTINHIBITED_NOTINHIBITED

See Also:

Constant Field Values

INPUTINHIBITED_SYSTEM_WAIT

public static final int INPUTINHIBITED_SYSTEM_WAIT

See Also:

Constant Field Values

INPUTINHIBITED_COMMCHECK

public static final int INPUTINHIBITED_COMMCHECK

See Also:

Constant Field Values

INPUTINHIBITED_PROGCHECK

public static final int INPUTINHIBITED_PROGCHECK

See Also:

Constant Field Values

INPUTINHIBITED_MACHINECHECK

public static final int INPUTINHIBITED_MACHINECHECK

See Also:

Constant Field Values

INPUTINHIBITED_OTHER

public static final int INPUTINHIBITED_OTHER

See Also:

Constant Field Values

Constructor Detail

ScreenOIA

public ScreenOIA(Screen5250 screen)

Method Detail

isInsertMode

public boolean isInsertMode()

setInsertMode

protected void setInsertMode(boolean mode)

getCommCheckCode

public int getCommCheckCode()

getInputInhibited

public int getInputInhibited()

getMachineCheckCode

public int getMachineCheckCode()

getOwner

public int getOwner()

getProgCheckCode

public int getProgCheckCode()

isKeyBoardLocked

public boolean isKeyBoardLocked()

Is the keyboard locked or not

Returns:

locked or not

isKeysBuffered

public boolean isKeysBuffered()

setKeysBuffered

public void setKeysBuffered(boolean kb)

setKeyBoardLocked

protected void setKeyBoardLocked(boolean lockIt)

isMessageWait

public boolean isMessageWait()

setMessageLightOn

protected void setMessageLightOn()

setMessageLightOff

protected void setMessageLightOff()

setScriptActive

public void setScriptActive(boolean running)

isScriptActive

public boolean isScriptActive()

setAudibleBell

public void setAudibleBell()

clearScreen

protected void clearScreen()

addOIAListener

public void addOIAListener(ScreenOIAListener listener)

Add a ScreenOIAListener to the listener list.

Parameters:

listener - The ScreenOIAListener to be added

removeOIAListener

public void removeOIAListener(ScreenOIAListener listener)

Remove a iOhioSessionListener from the listener list.

Parameters:

listener - The iOhioSessionListener to be removed

getSource

public Screen5250 getSource()

setSource

public void setSource(Screen5250 screen)

setOwner

public void setOwner(int newOwner)

getLevel

public int getLevel()

getInhibitedText

public java.lang.String getInhibitedText()

setInputInhibited

public void setInputInhibited(int inhibit,
                              int whatCode)

setInputInhibited

public void setInputInhibited(int inhibit,
                              int whatCode,
                              java.lang.String message)