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

com.ibm.hi.customizer.beans.event.CustomEvent
  |
  +--com.ibm.hi.customizer.beans.event.CustomMacroEvent

public class CustomMacroEvent
extends CustomEvent

This event is fired by CustomTerminal to indicate that a macro event has occurred. Macro events may be assigned to buttons in customized screens.

See Also:
CustomListener

Field Summary
static int CLONE_SESSION
          Static macro type to clone the current session
static int CLOSE_WINDOW
          Static macro type to close the current window
static int RECEIVE_FILE
          Static macro type to receive a file from the host
static int RUN_APPLET
          Static macro type to run an applet
static int SEND_FILE
          Static macro type to send a file to the host
static int TRANSFER_DEFAULTS
          Static macro type to display the file transfer defaults
 
Fields inherited from class com.ibm.hi.customizer.beans.event.CustomEvent
MACRO_EVENT, MACRO_EVENT_MASK, SCREEN_EVENT, SCREEN_EVENT_MASK, STATUS_EVENT, STATUS_EVENT_MASK
 
Constructor Summary
CustomMacroEvent(java.lang.Object source, int type, java.lang.String id)
          Constructs a new CustomEvent with the specified source, type and screen ID.
CustomMacroEvent(java.lang.Object source, int type, java.lang.String id, java.lang.Object data)
          Constructs a new CustomEvent with the specified source, type, id, and data object.
CustomMacroEvent(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 CustomMacroEvent with the specified source, type, screen ID, custom component, string, and data object.
 
Method Summary
 java.lang.String getClassName()
          Returns the class name associated with this event.
 int getMacroType()
          Returns the macro type for this macro event.
 
Methods inherited from class com.ibm.hi.customizer.beans.event.CustomEvent
getComponent, getData, getScreenID, getType
 

Field Detail

CLOSE_WINDOW

public static final int CLOSE_WINDOW
Static macro type to close the current window

RUN_APPLET

public static final int RUN_APPLET
Static macro type to run an applet

CLONE_SESSION

public static final int CLONE_SESSION
Static macro type to clone the current session

SEND_FILE

public static final int SEND_FILE
Static macro type to send a file to the host

RECEIVE_FILE

public static final int RECEIVE_FILE
Static macro type to receive a file from the host

TRANSFER_DEFAULTS

public static final int TRANSFER_DEFAULTS
Static macro type to display the file transfer defaults
Constructor Detail

CustomMacroEvent

public CustomMacroEvent(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 CustomMacroEvent with the specified source, type, screen ID, custom component, string, and data object.

CustomMacroEvent

public CustomMacroEvent(java.lang.Object source,
                        int type,
                        java.lang.String id)
Constructs a new CustomEvent with the specified source, type and screen ID.

CustomMacroEvent

public CustomMacroEvent(java.lang.Object source,
                        int type,
                        java.lang.String id,
                        java.lang.Object data)
Constructs a new CustomEvent with the specified source, type, id, and data object.
Method Detail

getClassName

public java.lang.String getClassName()
Returns the class name associated with this event. If there is no class name, an empty string is returned. This is only valid for the RUN_APPLET macro type. If you call this method on any other type of CustomMacroEvent, null is returned.

getMacroType

public int getMacroType()
Returns the macro type for this macro event.