(Beta)
| Package | lc.procmgmt.ui.task |
| Class | public class TaskRouteCommandBarModel |
| Inheritance | TaskRouteCommandBarModel  CommandBarModel EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
TaskRouteCommandBarModel class acts as the model for the
TaskCommandBar component to handle when a user clicks a button to complete a task.
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | commandButtonModels : ListCollectionView
The collection of CommandButtonModel presentation models
for the command button. | CommandBarModel | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| enabled : Boolean
A special flag that indicates whether the route buttons are enabled. | TaskRouteCommandBarModel | ||
| includeSpecialRoutesOnly : Boolean
A special flag that indicates whether to display special route buttons, such as Approve and Deny. | TaskRouteCommandBarModel | ||
| newButtonName : Array [read-only]
An array that stores the names of the buttons. | TaskRouteCommandBarModel | ||
| newRouteButtonTooltip : Array [read-only]
An array that stores the tooltips for the buttons. | TaskRouteCommandBarModel | ||
| routeButtonEnablement : Array [read-only]
An array that stores whether buttons are enabled. | TaskRouteCommandBarModel | ||
| routeButtonVisibility : Array [read-only]
An array that stores whether buttons are to be displayed. | TaskRouteCommandBarModel | ||
| task : lc.procmgmt.domain:Task
A Task object that stores the task. | TaskRouteCommandBarModel | ||
| taskForm : lc.procmgmt.ui.task.form:TaskForm
A TaskForm object representing the form used to complete a task. | TaskRouteCommandBarModel | ||
| visible : Boolean
A special flag that indicates whether all routes are visible. | TaskRouteCommandBarModel | ||
| visibleLabels : Boolean
A special flag that indicates whether to display the labels. | TaskRouteCommandBarModel | ||
| visibleRoutes : Boolean
A special flag that indicates whether the route buttons are visible. | TaskRouteCommandBarModel | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Constructor. | TaskRouteCommandBarModel | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
Reinitializes the model. | TaskRouteCommandBarModel | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
Events
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when a user clicks a button to complete a task. | TaskRouteCommandBarModel | |||
Property Detail
enabled | property |
enabled:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A special flag that indicates whether the route buttons are enabled.
Implementation
public function get enabled():Boolean public function set enabled(value:Boolean):voidincludeSpecialRoutesOnly | property |
includeSpecialRoutesOnly:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A special flag that indicates whether to display special route buttons, such as Approve and Deny.
Implementation
public function get includeSpecialRoutesOnly():Boolean public function set includeSpecialRoutesOnly(value:Boolean):voidnewButtonName | property |
newButtonName:Array [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
An array that stores the names of the buttons.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get newButtonName():ArraynewRouteButtonTooltip | property |
newRouteButtonTooltip:Array [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
An array that stores the tooltips for the buttons.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get newRouteButtonTooltip():ArrayrouteButtonEnablement | property |
routeButtonEnablement:Array [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
An array that stores whether buttons are enabled.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get routeButtonEnablement():ArrayrouteButtonVisibility | property |
routeButtonVisibility:Array [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
An array that stores whether buttons are to be displayed.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get routeButtonVisibility():Arraytask | property |
task:lc.procmgmt.domain:Task| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A Task object that stores the task.
Implementation
public function get task():lc.procmgmt.domain:Task public function set task(value:lc.procmgmt.domain:Task):voidtaskForm | property |
taskForm:lc.procmgmt.ui.task.form:TaskForm| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A TaskForm object representing the form used to complete a task.
Implementation
public function get taskForm():lc.procmgmt.ui.task.form:TaskForm public function set taskForm(value:lc.procmgmt.ui.task.form:TaskForm):voidvisible | property |
visible:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A special flag that indicates whether all routes are visible.
Implementation
public function get visible():Boolean public function set visible(value:Boolean):voidvisibleLabels | property |
visibleLabels:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A special flag that indicates whether to display the labels.
Implementation
public function get visibleLabels():Boolean public function set visibleLabels(value:Boolean):voidvisibleRoutes | property |
visibleRoutes:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A special flag that indicates whether the route buttons are visible.
Implementation
public function get visibleRoutes():Boolean public function set visibleRoutes(value:Boolean):voidConstructor Detail
TaskRouteCommandBarModel | () | Constructor |
public function TaskRouteCommandBarModel()| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Constructor.
Method Detail
reset | () | method |
public function reset():void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Reinitializes the model.
Event Detail
taskCommandEvent | Event |
Event Object Type:
property TaskCommandEvent.type =
lc.procmgmt.ui.task.TaskCommandEventproperty TaskCommandEvent.type =
lc.procmgmt.ui.task.TaskCommandEvent.TASK_COMMAND_EVENT| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Dispatched when a user clicks a button to complete a task.
Wed Nov 21 2018, 06:34 AM -08:00