WorkspaceModel - BETA ActionScript® 3 (AS3 ADEP Document Services) Reference for the Adobe® Flash® Platform API Reference

(Beta)

Package	lc.procmgmt.ui.layout
Class	public class WorkspaceModel
Inheritance	WorkspaceModel MinMaxModel NavigationSupervisorModel PresentationModel EventDispatcher Object
Implements	IBookmarkTarget, IHelpSource

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The WorkspaceModel class acts as the model for the Workspace component.

Related API Elements

lc.procmgmt.ui.layout.Workspace

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		session : SessionMap A SessionMap object that stores information relating to the server session.	PresentationModel
		startProcessModel : StartProcessModel An instance of the StartProcessModel class.	WorkspaceModel
		state : String [read-only] The name of the state the current view is in.	PresentationModel
		tabIndex : int Deprecated Since LiveCycle ES Update 1 (8.2): Please use openTab().	WorkspaceModel
		toDoModel : lc.procmgmt.ui.task:ToDoModel An instance of the ToDoModel class.	WorkspaceModel
		trackingModel : lc.procmgmt.ui.tracking:TrackingModel An instance of the TrackingModel class.	WorkspaceModel

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		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
		bindProperty(destination:Object, destinationProperty:String, source:Object, sourceChain:Object, commitOnly:Boolean = false):ChangeWatcher Binds a public property on the destination object from a property or property chain on the source object.	PresentationModel
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		getCSSStyle(declaration:String, styleProperty:String, defaultValue:Object = null):Object Returns the corresponding cascading style sheet (CSS) property to use based on the specified parameters.	PresentationModel
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		initialize():void Initializes the presentation model after the view bindings are processed to prevent view bindings from overriding the initial model state.	PresentationModel
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		openTab(tabName:String, force:Boolean = false):void Opens a particular tab of the Workspace component by the tab name.	WorkspaceModel
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		setState(newState:String):void Sets the state property to a new value and causes a PropertyChangeEvent event.	PresentationModel

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Public Constants

	Constant		Defined By
		START_PROCESS_TAB_NAME : String = "startProcess" [static] The name that is used as an identifier for the Start Process tab.	WorkspaceModel
		TAB_START_PROCESS : int = 0 [static] Deprecated Since LiveCycle ES Update 1 (8.2): Please use START_PROCESS_TAB_NAME.	WorkspaceModel
		TAB_TODO : int = 1 [static] Deprecated Since LiveCycle ES Update 1 (8.2): Please use TODO_TAB_NAME.	WorkspaceModel
		TAB_TRACKING : int = 2 [static] Deprecated Since LiveCycle ES Update 1 (8.2): Please use TRACKING_TAB_NAME.	WorkspaceModel
		TODO_TAB_NAME : String = "toDo" [static] The name that is used as an identifier for the To Do tab.	WorkspaceModel
		TRACKING_TAB_NAME : String = "tracking" [static] The name that is used as an identifier for the Tracking tab.	WorkspaceModel
		URLPARM_STARTENDPOINT : String = "startEndpoint" [static] The name of the parameter in the URL to start a new task directly.	WorkspaceModel
		URLPARM_STARTPAGE : String = "startPage" [static] The name of the parameter used in the URL to select the starting page that is displayed.	WorkspaceModel
		URLPARM_TASKID : String = "taskId" [static] The name of the parameter in the URL to access a ToDo task directly.	WorkspaceModel

Property Detail

startProcessModel

property

startProcessModel:StartProcessModel

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

An instance of the StartProcessModel class.

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 startProcessModel():StartProcessModel
public function set startProcessModel(value:StartProcessModel):void

tabIndex

property

tabIndex:int

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Deprecated Since LiveCycle ES Update 1 (8.2): Please use openTab().

In earlier releases of Workspace ES, this method was used to set the workspace navigator tab.

Implementation
public function get tabIndex():int
public function set tabIndex(value:int):void

Related API Elements

openTab()

toDoModel

property

toDoModel:lc.procmgmt.ui.task:ToDoModel

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

An instance of the ToDoModel class.

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 toDoModel():lc.procmgmt.ui.task:ToDoModel
public function set toDoModel(value:lc.procmgmt.ui.task:ToDoModel):void

trackingModel

property

trackingModel:lc.procmgmt.ui.tracking:TrackingModel

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

An instance of the TrackingModel class.

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 trackingModel():lc.procmgmt.ui.tracking:TrackingModel
public function set trackingModel(value:lc.procmgmt.ui.tracking:TrackingModel):void

Method Detail

openTab

()

method

public function openTab(tabName:String, force:Boolean = false):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Opens a particular tab of the Workspace component by the tab name.

Parameters

	`tabName:String` — Specifies the name of the tab to open that can be one of the following values: TAB_START_PROCESS TAB_TODO TAB_TRACKING

	`force:Boolean` (default = `false`)

Constant Detail

START_PROCESS_TAB_NAME

Constant

public static const START_PROCESS_TAB_NAME:String = "startProcess"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The name that is used as an identifier for the Start Process tab.

TAB_START_PROCESS

Constant

public static const TAB_START_PROCESS:int = 0

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Deprecated Since LiveCycle ES Update 1 (8.2): Please use START_PROCESS_TAB_NAME.

In earlier releases, this constant value represented the Start Process tab.

TAB_TODO

Constant

public static const TAB_TODO:int = 1

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Deprecated Since LiveCycle ES Update 1 (8.2): Please use TODO_TAB_NAME.

In earlier releases, this constant value represented the ToDo tab.

TAB_TRACKING

Constant

public static const TAB_TRACKING:int = 2

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Deprecated Since LiveCycle ES Update 1 (8.2): Please use TRACKING_TAB_NAME.

In earlier releases, this constant value represented the Tracking tab.

TODO_TAB_NAME

Constant

public static const TODO_TAB_NAME:String = "toDo"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The name that is used as an identifier for the To Do tab.

TRACKING_TAB_NAME

Constant

public static const TRACKING_TAB_NAME:String = "tracking"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The name that is used as an identifier for the Tracking tab.

URLPARM_STARTENDPOINT

Constant

public static const URLPARM_STARTENDPOINT:String = "startEndpoint"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The name of the parameter in the URL to start a new task directly. For example, type http://localhost:8080/workspace?startEndpoint=MyApp/MyService.MyEndpoint where:

MyService is the name of the application and the process in the deployed application separated by a slash
MyEndpoint is the name of the Workspace start point configured in LiveCycle Workbench ES2 or configured in LiveCycle Administration Console > Services > Applications and Services > Endpoint Management.

For example, after an application is deployed, an application named MyApp with a process named PreLoan, the service name would be MyApp/PreLoan. If the Workspace endpoint is named Start Process, then the URL encoded value to type in a web browser is: http://localhost:8080/workspace?startEndpoint=MyApp%2FPreLoan.Start%20Process.

URLPARM_STARTPAGE

Constant

public static const URLPARM_STARTPAGE:String = "startPage"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The name of the parameter used in the URL to select the starting page that is displayed. To specify the starting page, use the values specified by START_PROCESS_TAB_NAME, TODO_TAB_NAME, or TRACKING_TAB_NAME constants. For example, type http://localhost:8080/workspace?startPage=toDo to start display the To Do tab.

URLPARM_TASKID

Constant

public static const URLPARM_TASKID:String = "taskId"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The name of the parameter in the URL to access a ToDo task directly. For example, type http://localhost:8080/workspace?taskId=5 in a browser to access a task with a task ID of 5.

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

WorkspaceModel - AS3 ADEP Document Services

Classes x

startProcessModel

tabIndex

toDoModel

trackingModel

openTab

START_PROCESS_TAB_NAME

TAB_START_PROCESS

TAB_TODO

TAB_TRACKING

TODO_TAB_NAME

TRACKING_TAB_NAME

URLPARM_STARTENDPOINT

URLPARM_STARTPAGE

URLPARM_TASKID