|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.beans.FeatureDescriptor
com.esri.adf.web.data.tasks.TaskDescriptor
public class TaskDescriptor
The TaskDescriptor
class provides metadata for the task class.
The metadata supported includes title text, enabled / disabled and help URLs.
Constructor Summary | |
---|---|
TaskDescriptor(Class taskClass)
Creates a TaskDescriptor . |
|
TaskDescriptor(Class taskClass,
String name,
String displayName)
Creates a TaskDescriptor with the given displayName as the title text. |
Method Summary | |
---|---|
Element |
generateXML(Object task)
Generates the XML content for this task. |
String |
getHelpUrl()
Returns the URL to a help document describing this task. |
Class |
getTaskClass()
Returns the task Class |
boolean |
isDisabled()
If true , the task will be disabled in the UI. |
void |
setDisabled(boolean disabled)
If set to true , the task will be disabled in the UI. |
void |
setHelpUrl(String helpUrl)
Sets the URL to a help document describing this task. |
String |
toString()
|
Methods inherited from class java.beans.FeatureDescriptor |
---|
attributeNames, getDisplayName, getName, getShortDescription, getValue, isExpert, isHidden, isPreferred, setDisplayName, setExpert, setHidden, setName, setPreferred, setShortDescription, setValue |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public TaskDescriptor(Class taskClass, String name, String displayName)
TaskDescriptor
with the given displayName
as the title text.
taskClass
- the task Class
name
- the name of this taskdisplayName
- the title text to be displayed in the task UIpublic TaskDescriptor(Class taskClass)
TaskDescriptor
. The title text is derived from the name of the taskClass
.
taskClass
- the task Class
Method Detail |
---|
public Class getTaskClass()
Class
Class
public boolean isDisabled()
true
, the task will be disabled in the UI. Default is false
.
true
, the task will be disabled in the UI. Default is false
.public void setDisabled(boolean disabled)
true
, the task will be disabled in the UI. Default is false
.
disabled
- if set to true
, the task will be disabled in the UI. Default is false
.public String getHelpUrl()
public void setHelpUrl(String helpUrl)
helpUrl
- the URL to a help document describing this taskpublic Element generateXML(Object task)
Generates the XML content for this task. This XML is then transformed by the XSL used by the task control to generate the appropriate markup.
task
- the task object
Element
public String toString()
toString
in class Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |