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

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

public class CustomStatusEvent
extends CustomEvent

This event is fired by CustomTerminal when a custom component sends status. Status events, such as hover help, font enablement, color enablement, etc., can be generated by a template, map, or components on the map.

See Also:
CustomListener

Field Summary
static int ENABLE_COLOR
          Static macro type to enable/disable Color from the menubar/toolbar
static int ENABLE_FONT
          Static macro type to enable/disable font from the menubar
static int ENABLE_FONT_DECREASE
          Static macro type to enable/disable font decrease from the toolbar
static int ENABLE_FONT_INCREASE
          Static macro type to enable/disable font increase from the toolbar
static int ENABLE_IMAGEBUTTONS
          Static macro type to enable/disable image button style from the menubar
static int ENABLE_LIGHTPEN
          Static macro type to enable/disable lightpen selection from the menubar
static int ENABLE_MENUBUTTONS
          Static macro type to enable/disable menubuttons style from the menubar
static int ENABLE_VVBUTTONS
          Static macro type to enable/disable valid value style from the menubar
static int ENABLE_WEBLINKBUTTONS
          Static macro type to enable/disable weblink style from the menubar
static int STATUS_UPDATE
          Static status type for status (hover help) update
static int TOGGLE_LIGHTPEN
          Static macro type to toggle the state of the lightpen mode
 
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
CustomStatusEvent(java.lang.Object source, int type, java.lang.String id, java.lang.Object data)
          Constructs a new CustomStatusEvent with the specified source and type.
CustomStatusEvent(java.lang.Object source, java.lang.String id, com.ibm.hi.customizer.beans.scci.SCCustomComponent comp, java.lang.String string)
          Constructs a new CustomStatusEvent with the specified source and type.
 
Method Summary
 boolean getBooleanValue()
          Returns the boolean value of the object data for this event.
 java.lang.String getStatus()
          Returns the string associated with this event, if one is available.
 int getStatusType()
          Returns the status type for this event.
 
Methods inherited from class com.ibm.hi.customizer.beans.event.CustomEvent
getComponent, getData, getScreenID, getType
 

Field Detail

STATUS_UPDATE

public static final int STATUS_UPDATE
Static status type for status (hover help) update

ENABLE_FONT_INCREASE

public static final int ENABLE_FONT_INCREASE
Static macro type to enable/disable font increase from the toolbar

ENABLE_FONT_DECREASE

public static final int ENABLE_FONT_DECREASE
Static macro type to enable/disable font decrease from the toolbar

ENABLE_FONT

public static final int ENABLE_FONT
Static macro type to enable/disable font from the menubar

ENABLE_COLOR

public static final int ENABLE_COLOR
Static macro type to enable/disable Color from the menubar/toolbar

ENABLE_LIGHTPEN

public static final int ENABLE_LIGHTPEN
Static macro type to enable/disable lightpen selection from the menubar

ENABLE_MENUBUTTONS

public static final int ENABLE_MENUBUTTONS
Static macro type to enable/disable menubuttons style from the menubar

ENABLE_VVBUTTONS

public static final int ENABLE_VVBUTTONS
Static macro type to enable/disable valid value style from the menubar

ENABLE_WEBLINKBUTTONS

public static final int ENABLE_WEBLINKBUTTONS
Static macro type to enable/disable weblink style from the menubar

ENABLE_IMAGEBUTTONS

public static final int ENABLE_IMAGEBUTTONS
Static macro type to enable/disable image button style from the menubar

TOGGLE_LIGHTPEN

public static final int TOGGLE_LIGHTPEN
Static macro type to toggle the state of the lightpen mode
Constructor Detail

CustomStatusEvent

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

CustomStatusEvent

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

getStatusType

public int getStatusType()
Returns the status type for this event.

getStatus

public java.lang.String getStatus()
Returns the string associated with this event, if one is available.

getBooleanValue

public boolean getBooleanValue()
Returns the boolean value of the object data for this event. This is used for events types like ENABLE_FONT, ENABLE_COLOR, etc., to know if that type is enabled or disabled by the current map.