com.ibm.as400.ui.framework.java
Class HandlerTask

java.lang.Object
  |
  +--com.ibm.as400.ui.framework.java.HandlerTask

public class HandlerTask
extends java.lang.Object

Defines an action to be performed on one or more user interface components on behalf of an application. HandlerTasks describe changes to a panel's state which should occur in the following situations:

HandlerTasks are always encapsulated within a Capabilities, ChoiceDescriptor, ItemDescriptor or NodeDescriptor object.

Since:
v4r2m0
See Also:
Capabilities, ChoiceDescriptor, ItemDescriptor, NodeDescriptor

Field Summary
static int DISABLE
          Indicates that this object should disable UI components.
static int DISPLAY
          Indicates that this object should display a particular pane on a subpanel.
static int ENABLE
          Indicates that this object should enable UI components.
static int HIDE
          Indicates that this object should hide UI components.
static int REFRESH
          Indicates that this object should refresh UI components.
static int SHOW
          Indicates that this object should display UI components.
 
Constructor Summary
HandlerTask(int type)
          Constructs a HandlerTask of the specified type.
 
Method Summary
 java.lang.String[] getComponents()
          Returns the list of the UI components affected by this object.
 int getType()
          Returns this object's type.
 void setComponents(java.lang.String[] names)
          Sets the list of UI components affected by this object.
 java.lang.String toString()
          Returns a string representation of this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ENABLE

public static final int ENABLE
Indicates that this object should enable UI components.

DISABLE

public static final int DISABLE
Indicates that this object should disable UI components.

REFRESH

public static final int REFRESH
Indicates that this object should refresh UI components.

SHOW

public static final int SHOW
Indicates that this object should display UI components.

HIDE

public static final int HIDE
Indicates that this object should hide UI components.

DISPLAY

public static final int DISPLAY
Indicates that this object should display a particular pane on a subpanel.
Constructor Detail

HandlerTask

public HandlerTask(int type)
Constructs a HandlerTask of the specified type.
Parameters:
type - one of the integer constants which indicates the type of action that this object should perform.
Since:
v4r2m0
Method Detail

getType

public int getType()
Returns this object's type.
Returns:
one of the integer constants which indicates the type of action that this object should perform
Since:
v4r2m0

getComponents

public java.lang.String[] getComponents()
Returns the list of the UI components affected by this object.
Returns:
an array of component names
Since:
v4r2m0
See Also:
setComponents(java.lang.String[])

setComponents

public void setComponents(java.lang.String[] names)
Sets the list of UI components affected by this object.
Parameters:
names - an array of component names
Since:
v4r2m0
See Also:
getComponents()

toString

public java.lang.String toString()
Returns a string representation of this object.
Overrides:
toString in class java.lang.Object
Returns:
this object as a string
Since:
v4r2m0