|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.as400.opnav.TaskDescriptor
A data entity which describes a task associated with a system component
that a user may choose to perform. A TaskDescriptor
provides
the name of the task, information on how it should be presented, and an
identifier which is passed to the component when a user requests that
a task be performed.
A TaskDescriptor
may serve to identify a group
of logically related subtasks. For example, a CREATE task may
have associated subtasks which identify the types of objects the
user may create. The subtasks are displayed as having a logical
relationship to the main task, usually displayed as a list under
the main task.
TasksManager
Constructor Summary | |
TaskDescriptor(int ID)
Constructs a task descriptor. |
Method Summary | |
java.lang.String |
getDescription()
Returns the task's description. |
javax.swing.Icon |
getIcon()
Returns the task's icon. |
int |
getID()
Returns the task's identifier. |
java.lang.String |
getName()
Returns the task's name. |
TaskDescriptor[] |
getSubtasks()
Returns the task's subtasks. |
java.lang.String |
getVerb()
Returns the task's verb. |
boolean |
isEnabled()
Indicates whether the task is enabled. |
void |
setDescription(java.lang.String description)
Sets the task's description. |
void |
setEnabled(boolean enabled)
Enables or disables the task. |
void |
setIcon(java.lang.String icon)
Sets the task's icon. |
void |
setID(int ID)
Sets the task's identifier. |
void |
setName(java.lang.String name)
Sets the task's name. |
void |
setSubtasks(TaskDescriptor[] subtasks)
Sets the task's subtasks. |
void |
setVerb(java.lang.String verb)
Sets the task's verb. |
java.lang.String |
toString()
Returns a string representation of the object. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Constructor Detail |
public TaskDescriptor(int ID)
TasksManager
implementation should use
the settor methods to completely describe the task.ID
- the identifier which will be used to determine what
task the user has requested.Method Detail |
public java.lang.String getName()
setName(java.lang.String)
public void setName(java.lang.String name)
name
- the name in a form suitable for displaying to the user.getName()
public java.lang.String getDescription()
setDescription(java.lang.String)
public void setDescription(java.lang.String description)
description
- the description string in a form suitable for displaying as hover help.getDescription()
public java.lang.String getVerb()
setVerb(java.lang.String)
public void setVerb(java.lang.String verb)
verb
- the verb string which identifies the task. This string is never
displayed to the user and should not be translated.getVerb()
public javax.swing.Icon getIcon()
setIcon(java.lang.String)
public void setIcon(java.lang.String icon)
String
- the qualified path and name of the icon
associated with the task. Note: file paths must NOT begin with
a leading slash and must be of the format "xxx/yyy/zzz/aaa.gif"getIcon()
public boolean isEnabled()
setEnabled(boolean)
public void setEnabled(boolean enabled)
enabled
- true if the task should enabled; false otherwise.isEnabled()
public int getID()
setID(int)
public void setID(int ID)
ID
- the identifier which will be used to determine what
task the user has requested.getID()
public TaskDescriptor[] getSubtasks()
TaskDescriptor
s which identify
this task group's subtasks.setSubtasks(com.ibm.as400.opnav.TaskDescriptor[])
public void setSubtasks(TaskDescriptor[] subtasks)
subtasks
- the array of TaskDescriptor
s which identify
this task group's subtasks.getSubtasks()
public java.lang.String toString()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |