com.ibm.hi.customizer.beans.event
Class CustomEvent

com.ibm.hi.customizer.beans.event.CustomEvent
Direct Known Subclasses:
CustomMacroEvent, CustomScreenEvent, CustomStatusEvent

public class CustomEvent

This event is fired by CustomTerminal to indicate that a screen, status, or macro event has occurred.

See Also:
CustomListener

Field Summary
static int MACRO_EVENT
          Static base value for macro event types
static int MACRO_EVENT_MASK
          Static value for macro event mask
static int SCREEN_EVENT
          Static base value for screen event types
static int SCREEN_EVENT_MASK
          Static value for screen event mask
static int STATUS_EVENT
          Static base value for status event types
static int STATUS_EVENT_MASK
          Static value for status event mask
 
Constructor Summary
CustomEvent(java.lang.Object source, int type, java.lang.String id, com.ibm.hi.customizer.beans.scci.SCCustomComponent comp)
          Constructs a new CustomEvent with the specified source and type.
CustomEvent(java.lang.Object source, int type, java.lang.String id, com.ibm.hi.customizer.beans.scci.SCCustomComponent comp, java.lang.String string, java.lang.Object data)
          Constructs a new CustomEvent with the specified source and type.
 
Method Summary
 com.ibm.hi.customizer.beans.scci.SCCustomComponent getComponent()
          Returns the Custom Component associated with this event.
 java.lang.Object getData()
          Returns any custom data associated with this event.
 java.lang.String getScreenID()
          Returns the screen ID associated with this event.
 int getType()
          Returns the event type.
 

Field Detail

SCREEN_EVENT

public static final int SCREEN_EVENT
Static base value for screen event types

STATUS_EVENT

public static final int STATUS_EVENT
Static base value for status event types

MACRO_EVENT

public static final int MACRO_EVENT
Static base value for macro event types

SCREEN_EVENT_MASK

public static final int SCREEN_EVENT_MASK
Static value for screen event mask

STATUS_EVENT_MASK

public static final int STATUS_EVENT_MASK
Static value for status event mask

MACRO_EVENT_MASK

public static final int MACRO_EVENT_MASK
Static value for macro event mask
Constructor Detail

CustomEvent

public CustomEvent(java.lang.Object source,
                   int type,
                   java.lang.String id,
                   com.ibm.hi.customizer.beans.scci.SCCustomComponent comp,
                   java.lang.String string,
                   java.lang.Object data)
Constructs a new CustomEvent with the specified source and type.

CustomEvent

public CustomEvent(java.lang.Object source,
                   int type,
                   java.lang.String id,
                   com.ibm.hi.customizer.beans.scci.SCCustomComponent comp)
Constructs a new CustomEvent with the specified source and type.
Method Detail

getType

public int getType()
Returns the event type.

getScreenID

public java.lang.String getScreenID()
Returns the screen ID associated with this event. If no screen ID exists, then null is returned.

getComponent

public com.ibm.hi.customizer.beans.scci.SCCustomComponent getComponent()
Returns the Custom Component associated with this event.

getData

public java.lang.Object getData()
Returns any custom data associated with this event. The data can be null.