Class adf.Task
Extends
adf.Control.
Defined in: Task.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
adf.Task(id, mapId)
A task is primarily a server side control with actions, tools and ui components, with the processing performed mostly on the server.
|
| Field Attributes | Field Name and Description |
|---|---|
|
The array of scripts loaded through Task Framework by the server when the task is initialized
|
|
|
The id of the map the task is attached
|
- Fields borrowed from class adf.Control:
- bounds, divId, divObject, id, type, updateListenerNames, updateListeners
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
adf.Task.addValidationRules(ToolId, rules)
|
| <static> |
adf.Task.initTask(taskId, container, windowTitle, closed)
Initializes the Task
|
| <static> |
adf.Task.initTaskGlobals(form)
Initializes the Task Parameters
|
| <static> |
adf.Task.initTaskWindow(taskCellId, peId, displayName, winId, fittable, mapId, resize, closed)
Initializes the Task and creates adf.Window| for displaying UI components required by the task
|
| <static> |
adf.Task.loadTask(taskId, mapId, configs)
Creates and loads the Task
this method creates a new instance of adf.Task object.
|
|
updateAsync(xml, eventSources)
Postback tag handler function which is responsible for updating task control during postback
|
|
| <static> |
adf.Task.validateTask(toolId)
|
- Methods borrowed from class adf.Control:
- addUpdateListener, removeUpdateListener
- Methods borrowed from class adf.PageElement:
- hide, resize, show
Class Detail
adf.Task(id, mapId)
A task is primarily a server side control with actions, tools and ui components, with the processing performed mostly on the server.
The Task class in the client side provides a window based UI for the configured Task Control of the server
The contents in the task window are set through the Server Task framework
A Task is identified by its unique id and map id of the map on which it executes on
adf.Task has a set of static methods which is used in the creation and configuration of Tasks in the clientside
- Parameters:
- {String id of the Task} id
- Unique Id of the Task being created
- mapId
- Id of the map on which the task executes
Field Detail
loadedScripts
The array of scripts loaded through Task Framework by the server when the task is initialized
mapId
The id of the map the task is attached
Method Detail
<static>
adf.Task.addValidationRules(ToolId, rules)
- Parameters:
- {String} ToolId
- {Array} rules
<static>
adf.Task.initTask(taskId, container, windowTitle, closed)
Initializes the Task
- Parameters:
- {String} taskId
- This maps to the attribute id of the task provided in the JSF a:Task
- {DOMNode} container
- The DOM Node on which to render the task
- {String} windowTitle
- The title of the task window, if this argument is present the task will be rendered with a window UI
- {Boolean} closed
- this boolean value specifies whether the window is to be closed state or opened when this task initialisation happens
<static>
adf.Task.initTaskGlobals(form)
Initializes the Task Parameters
- Parameters:
- {HTMLInputForm} form
<static>
adf.Task.initTaskWindow(taskCellId, peId, displayName, winId, fittable, mapId, resize, closed)
Initializes the Task and creates adf.Window| for displaying UI components required by the task
- Parameters:
- {String} taskCellId
- Task Container Id
- {String} peId
- Page Element Id of the Task Window , the task cell is added to this page element div
- {String} displayName
- display name of the task
- {String} winId
- The div Id on which the task window is added to
- {Boolean} fittable
- should the task window is to be fittable or not
- {String} mapId
- The id of the map on which the task is executed
- {Boolean} resize
- whether the task window is to resized or not
- {Boolean} closed
- whether the task window is to be closed or opened during the task creation
<static>
adf.Task.loadTask(taskId, mapId, configs)
Creates and loads the Task
this method creates a new instance of adf.Task object.
- Parameters:
- {String} taskId
- Unique Id of the Task being created
- {String} mapId
- Id of the map on which the task executes
- configs
- Configuration Array, which has information about the container the task is initialized
updateAsync(xml, eventSources)
Postback tag handler function which is responsible for updating task control during postback
- Parameters:
- {XMLNode} xml
- {Array} eventSources
<static>
adf.Task.validateTask(toolId)
- Parameters:
- {String} toolId