com.ibm.as400.ui.framework.java
Class HelpEvent
java.lang.Object
|
+--java.util.EventObject
|
+--java.awt.AWTEvent
|
+--com.ibm.as400.ui.framework.java.HelpEvent
- All Implemented Interfaces:
- java.io.Serializable
- public class HelpEvent
- extends java.awt.AWTEvent
An event that indicates that help has been requested for a PDML panel.
The event may represent a request for panel help, or context help for
a single control on the panel.
- Since:
- v5r1m0
- See Also:
PanelManager
,
HelpListener
, Serialized Form
Field Summary |
static int |
CONTEXT_HELP_REQUESTED
This event id indicates that context help was requested for a component. |
static int |
HELP_FIRST
The first number in the range of ids used for help events. |
static int |
HELP_LAST
The last number in the range of ids used for help events. |
static int |
PANEL_HELP_REQUESTED
This event id indicates that help was requested for the entire panel. |
Fields inherited from class java.awt.AWTEvent |
ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK |
Fields inherited from class java.util.EventObject |
source |
Constructor Summary |
HelpEvent(java.lang.Object source,
int id,
java.lang.String panelName,
java.lang.String controlName)
Constructs a HelpEvent object. |
Method Summary |
java.lang.String |
getControlName()
Returns the name of the component that generated this help event. |
java.lang.String |
getPanelName()
Returns the name of the panel that generated this help event. |
void |
setControlName(java.lang.String controlName)
Sets the name of the component that generated this help event. |
void |
setPanelName(java.lang.String panelName)
Sets the name of the panel that generated this help event. |
java.lang.String |
toString()
|
Methods inherited from class java.awt.AWTEvent |
consume, finalize, getID, isConsumed, paramString |
Methods inherited from class java.util.EventObject |
getSource |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
PANEL_HELP_REQUESTED
public static final int PANEL_HELP_REQUESTED
- This event id indicates that help was requested for the entire panel.
CONTEXT_HELP_REQUESTED
public static final int CONTEXT_HELP_REQUESTED
- This event id indicates that context help was requested for a component.
HELP_FIRST
public static final int HELP_FIRST
- The first number in the range of ids used for help events.
HELP_LAST
public static final int HELP_LAST
- The last number in the range of ids used for help events.
HelpEvent
public HelpEvent(java.lang.Object source,
int id,
java.lang.String panelName,
java.lang.String controlName)
- Constructs a
HelpEvent
object.
- Parameters:
source
- The object that originated the event.id
- An integer that identifies the event.panelName
- The name of the panel, as specified on the PANEL
tag in the PDML.controlName
- The name of the component as specified in the panel definition.
setPanelName
public void setPanelName(java.lang.String panelName)
- Sets the name of the panel that generated this help event.
- Parameters:
panelName
- The name of the panel, as specified on the PANEL
tag in the PDML.
setControlName
public void setControlName(java.lang.String controlName)
- Sets the name of the component that generated this help event.
- Parameters:
controlName
- The name of the component, as specified in the panel definition.
getPanelName
public java.lang.String getPanelName()
- Returns the name of the panel that generated this help event.
- Returns:
- A string identifying the panel, as specified on the
PANEL
tag in the PDML.
getControlName
public java.lang.String getControlName()
- Returns the name of the component that generated this help event.
If a help alias has been defined for the component, the alias is returned.
- Returns:
- A string identifying the component, as specified in the panel definition.
If this is a
PANEL_HELP_REQUESTED
event, null
will be returned.
toString
public java.lang.String toString()
- Overrides:
toString
in class java.awt.AWTEvent