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

java.lang.Object
  com.ibm.as400.ui.framework.java.HandlerTask

public class HandlerTask
extends 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:

• A DataBean is found to be incapable of supporting a particular data attribute.
• A user selects one of the predefined values for an attribute, as displayed in a combo box or radio button group.
• A user selects one of the items displayed in a list, table or tree component.

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

Since:

v4r2m0

Version:

1.0, 04/15/98

Author:

D. Petty

See Also:

Capabilities, ChoiceDescriptor, ItemDescriptor, NodeDescriptor

Field Summary

Modifier and Type	Field and Description
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 and Description

HandlerTask(int type)
Constructs a HandlerTask of the specified type.

Method Summary

Modifier and Type	Method and Description
String[]	getComponents() Returns the list of the UI components affected by this object.
int	getType() Returns this object's type.
void	setComponents(String[] names) Sets the list of UI components affected by this object.
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.

See Also:

Constant Field Values

DISABLE

public static final int DISABLE

Indicates that this object should disable UI components.

See Also:

Constant Field Values

REFRESH

public static final int REFRESH

Indicates that this object should refresh UI components.

See Also:

Constant Field Values

SHOW

public static final int SHOW

Indicates that this object should display UI components.

See Also:

Constant Field Values

HIDE

public static final int HIDE

Indicates that this object should hide UI components.

See Also:

Constant Field Values

DISPLAY

public static final int DISPLAY

Indicates that this object should display a particular pane on a subpanel.

See Also:

Constant Field Values

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 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(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 String toString()

Returns a string representation of this object.

Overrides:

toString in class Object

Returns:

this object as a string

Since:

v4r2m0