ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
lc.procmgmt.ui.layout 

WorkspaceModel  - AS3 ADEP Workspace
Packagelc.procmgmt.ui.layout
Classpublic class WorkspaceModel
InheritanceWorkspaceModel Inheritance MinMaxModel
Implements IBookmarkTarget, IHelpSource

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), 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
 PropertyDefined By
  startProcessModel : StartProcessModel
An instance of the StartProcessModel class.
WorkspaceModel
  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
 MethodDefined By
  
openTab(tabName:String, force:Boolean = false):void
Opens a particular tab of the Workspace component by the tab name.
WorkspaceModel
Public Constants
 ConstantDefined 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 Document Services - Workspace 9
Runtime Versions: AIR (unsupported), 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 Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

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

In earlier releases of Workspace, 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 Document Services - Workspace 9
Runtime Versions: AIR (unsupported), 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 Document Services - Workspace 9
Runtime Versions: AIR (unsupported), 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 Document Services - Workspace 9
Runtime Versions: AIR (unsupported), 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) — Indicates if this request should be done regardless of whether an document may of changed or not.
    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 Document Services - Workspace 9
    Runtime Versions: AIR (unsupported), 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 Document Services - Workspace 9
    Runtime Versions: AIR (unsupported), 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 Document Services - Workspace 9
    Runtime Versions: AIR (unsupported), 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 Document Services - Workspace 9
    Runtime Versions: AIR (unsupported), 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 Document Services - Workspace 9
    Runtime Versions: AIR (unsupported), 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 Document Services - Workspace 9
    Runtime Versions: AIR (unsupported), 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 Document Services - Workspace 9
    Runtime Versions: AIR (unsupported), 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?startStartpoint=MyApp/MyService.MyStartpoint where:

    • MyService is the name of the application and the process in the deployed application separated by a slash
    • MyStartpoint is the name of the Workspace start point configured in Adobe Digital Enterprise Platform Document Services - Workbench or configured in Adobe Digital Enterprise Platform Document Services - Administration Console > Services > Applications and Services > Startpoint 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 startpoint is named Start Process, then the URL encoded value to type in a web browser is: http://localhost:8080/workspace?startStartpoint=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 Document Services - Workspace 9
    Runtime Versions: AIR (unsupported), 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 Document Services - Workspace 9
    Runtime Versions: AIR (unsupported), 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.




    © 2014 Adobe Systems Incorporated. All rights reserved.
    Thu Dec 4 2014, 05:50 PM -08:00
     

     

    Legal Notices | Online Privacy Policy