All Packages  Class Hierarchy  This Package  Previous  Next  Index

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

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

public class ChoiceDescriptor
extends Object
Describes a predefined value associated with a data attribute. An attribute's predefined values are often displayed as choices on a user interface panel, for example as a radio button group or a combo box.


Constructor Index

 o ChoiceDescriptor()
Constructs a ChoiceDescriptor.
 o ChoiceDescriptor(String, String)
Constructs a ChoiceDescriptor with the specified name and title.
 o ChoiceDescriptor(String, String, HandlerTask[])
Constructs a ChoiceDescriptor with the specified name, title, and HandlerTask list.

Method Index

 o addHandlerTask(HandlerTask)
Adds a HandlerTask to the choice.
 o getName()
Returns the choice name.
 o getTitle()
Returns the choice title.
 o removeHandlerTask(HandlerTask)
Removes a HandlerTask from the choice.
 o setName(String)
Sets the choice name.
 o setTitle(String)
Sets the choice title.
 o toString()
Returns a string representation of the choice.

Constructors

 o ChoiceDescriptor
 public ChoiceDescriptor()
Constructs a ChoiceDescriptor.

 o ChoiceDescriptor
 public ChoiceDescriptor(String name,
                         String title)
Constructs a ChoiceDescriptor with the specified name and title.

Parameters:
name - the name that is used to identify the choice programmatically.
title - the title of the choice in a form suitable for displaying to the user.
 o ChoiceDescriptor
 public ChoiceDescriptor(String name,
                         String title,
                         HandlerTask handlerTasks[])
Constructs a ChoiceDescriptor with the specified name, title, and HandlerTask list.

Parameters:
name - the name that is used to identify the choice programmatically
title - the title of the choice in a form suitable for displaying to the user
handlerTasks - a list of HandlerTasks which describe to the UI framework actions which should be carried out when the choice is selected
See Also:
HandlerTask

Methods

 o getName
 public String getName()
Returns the choice name.

Returns:
a string which is used to identify the choice programmatically
See Also:
setName
 o setName
 public void setName(String name)
Sets the choice name.

Parameters:
name - a string which is used to identify the choice programmatically
See Also:
getName
 o getTitle
 public String getTitle()
Returns the choice title.

Returns:
the string which is displayed to the user
See Also:
setTitle
 o setTitle
 public void setTitle(String title)
Sets the choice title.

Parameters:
title - the string which is used displayed to the user
See Also:
getTitle
 o addHandlerTask
 public void addHandlerTask(HandlerTask task)
Adds a HandlerTask to the choice. A HandlerTask is an action that should be performed by the UI framework when the choice is selected.

Parameters:
task - the task to be performed
See Also:
removeHandlerTask, HandlerTask
 o removeHandlerTask
 public void removeHandlerTask(HandlerTask task)
Removes a HandlerTask from the choice. If the specified HandlerTask is not associated with the choice, no action occurs.

Parameters:
task - the task to be removed
See Also:
addHandlerTask, HandlerTask
 o toString
 public String toString()
Returns a string representation of the choice. The string is in a form suitable for displaying to the user.

Returns:
the choice as a string
Overrides:
toString in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index