com.ibm.eNetwork.beans.HOD.event
Class GUIEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.ibm.eNetwork.beans.HOD.event.HODEvent
              |
              +--com.ibm.eNetwork.beans.HOD.event.GUIEvent
All Implemented Interfaces:
java.io.Serializable

public class GUIEvent
extends com.ibm.eNetwork.beans.HOD.event.HODEvent

The GUI event. This event is fired by Session to indicate that a request has been made to update the appearance of Screen. For example, Session will fire a GUIEvent with a type of RULE to cause Screen to display rule lines.

All event types are used by Screen, except for JUMP which must be handled by a separate GUI listener that is responsible for managing multiple Screens.

See Also:
GUIListener, Session, Terminal, Screen, Serialized Form

Field Summary
static java.lang.String ALTCSR
          Alternate Cursor GUI event.
static java.lang.String CLEARRECT
          Clear Rect GUI event.
static java.lang.String COPY
          Copy GUI event.
static java.lang.String COPY_TABLE
          Copy as Table GUI event.
static java.lang.String COPYALL
          Copy All GUI event.
static java.lang.String COPYAPPEND
          Copy Append GUI event.
static java.lang.String CUT
          Cut GUI event.
static java.lang.String DBCSINP
          DBCS Input GUI event.
static java.lang.String JUMP
          Jump GUI event.
static java.lang.String PASTE
          Paste GUI event.
static java.lang.String PASTENEXT
          Paste Next GUI event.
static java.lang.String RULE
          Rule GUI event.
static java.lang.String SELECTALL
          Select All GUI event.
static java.lang.String STARTMACRO
          Start Macro GUI event.
 
Constructor Summary
GUIEvent(java.lang.Object source, java.lang.String type)
          Constructs a new GUI event with the specified source and type.
 
Method Summary
 boolean getOption()
          Returns the option.
 java.lang.String getParam()
          Returns the parameter.
 java.lang.String getType()
          Returns the event type.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ALTCSR

public static java.lang.String ALTCSR
Alternate Cursor GUI event. This event causes the screen to toggle between an underscore cursor and a block cursor.

CUT

public static java.lang.String CUT
Cut GUI event. This event causes the screen contents to be "cut" to the system clipboard.

CLEARRECT

public static java.lang.String CLEARRECT
Clear Rect GUI event. This event causes the screen contents to be "cut" without affecting the clipboard.

COPY

public static java.lang.String COPY
Copy GUI event. This event causes the screen contents to be "copied" to the system clipboard.

COPY_TABLE

public static java.lang.String COPY_TABLE
Copy as Table GUI event. This event causes the screen contents to be "copied" to the system clipboard in a table format.

COPYALL

public static java.lang.String COPYALL
Copy All GUI event. This event causes the entire screen contents to be "copied" to the system clipboard.

COPYAPPEND

public static java.lang.String COPYAPPEND
Copy Append GUI event. This event causes the entire screen contents to be "copied" to the system clipboard appending to whatever is already on the clipboard.

DBCSINP

public static java.lang.String DBCSINP
DBCS Input GUI event. This event causes the screen to display a DBCS input text field (3250 and 5250 DBCS sessions only).

JUMP

public static java.lang.String JUMP
Jump GUI event. This event lets a registered GUI listener know that the user pressed the jump key. The GUI listener must handle displaying the next available screen.

PASTE

public static java.lang.String PASTE
Paste GUI event. This event causes the system clipboard contents to be "pasted" into the screen.

PASTENEXT

public static java.lang.String PASTENEXT
Paste Next GUI event. This event causes the system clipboard contents to be "pasted" into the screen, starting from the last pasted line.

RULE

public static java.lang.String RULE
Rule GUI event. This event causes rule lines to be displayed on the screen.

SELECTALL

public static java.lang.String SELECTALL
Select All GUI event. This event causes the contents of the current text field or label to be selected.

STARTMACRO

public static java.lang.String STARTMACRO
Start Macro GUI event. This event causes execution of macro.
Constructor Detail

GUIEvent

public GUIEvent(java.lang.Object source,
                java.lang.String type)
Constructs a new GUI event with the specified source and type.
Method Detail

getType

public java.lang.String getType()
Returns the event type.

getParam

public java.lang.String getParam()
Returns the parameter.

getOption

public boolean getOption()
Returns the option.