| Package | lc.procmgmt.ui.layout |
| Class | public class DesktopModel |
| Inheritance | DesktopModel  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 |
DesktopModel class provides the model implementation for the
Desktop component.
For information on using this component to customize LiveCycle Workspace ES2, see Customizing the LiveCycle Workspace ES2 User Interface .
Related API Elements
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 | |
| headerPaneModel : HeaderPaneModel | DesktopModel | ||
| isHeaderOpen : Boolean | DesktopModel | ||
| session : SessionMap
A SessionMap object that stores information relating to the server session. | PresentationModel | |
| state : String [read-only]
The name of the state the current view is in. | PresentationModel | |
| toastFadeTimeMilliseconds : Number
Deprecated Since LiveCycle ES Update 1 (8.2): Toast is no longer used. | DesktopModel | ||
| toastViewTimeMilliseconds : Number
Deprecated Since LiveCycle ES Update 1 (8.2): Toast is no longer used. | DesktopModel | ||
| welcomeModel : WelcomeModel
An instance of the WelcomeModel component. | DesktopModel | ||
| workspaceModel : WorkspaceModel
An instance of the Workspace component. | DesktopModel | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | DesktopModel | ||
| 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 | |
|
Dispatches an event into the event flow. | EventDispatcher | |
Displays context-sensitive help to a user. | DesktopModel | ||
Logs out of the current Workspace ES2 session. | DesktopModel | ||
|
Returns the corresponding cascading style sheet (CSS) property to use based on the specified parameters. | PresentationModel | |
|
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 | |
[override]
Initializes the user preferences and displays the appropriate view depending on
the user's start location. | DesktopModel | ||
|
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 | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
Modifies the display for the Header component to a maximized or
minimized state, and modifies the state of the Welcome or
Workspace component appropriately. | DesktopModel | ||
Shows the Welcome component. | DesktopModel | ||
Displays the Workspace component. | DesktopModel | ||
|
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 | |
| Constant | Defined By | ||
|---|---|---|---|
| ACROBAT_DETECT : String = "acrobatDetect" [static]
A special value that specifies to set the state to for detecting Adobe Acrobat or Adobe Reader version
installed on the computer of the user. | DesktopModel | ||
| STATE_WELCOME : String = "welcomeState" [static]
A special value that specifies to set the state to display the Welcome page first. | DesktopModel | ||
| STATE_WORKSPACE : String = "workspaceState" [static]
A special value that specifies to set the state to display the Workspace page first. | DesktopModel | ||
headerPaneModel | property |
headerPaneModel:HeaderPaneModelImplementation
public function get headerPaneModel():HeaderPaneModel public function set headerPaneModel(value:HeaderPaneModel):voidisHeaderOpen | property |
toastFadeTimeMilliseconds | property |
toastFadeTimeMilliseconds:Number| 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): Toast is no longer used.
Toast is no longer used in Workspace ES2. It remains exposed so that you can compile applications using earlier versions of the API.
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 toastFadeTimeMilliseconds():Number public function set toastFadeTimeMilliseconds(value:Number):voidtoastViewTimeMilliseconds | property |
toastViewTimeMilliseconds:Number| 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): Toast is no longer used.
Toast is no longer used in Workspace ES2. It remains exposed so that you can compile applications using earlier versions of the API.
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 toastViewTimeMilliseconds():Number public function set toastViewTimeMilliseconds(value:Number):voidwelcomeModel | property |
welcomeModel:WelcomeModel| 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 WelcomeModel component.
Implementation
public function get welcomeModel():WelcomeModel public function set welcomeModel(value:WelcomeModel):voidworkspaceModel | property |
workspaceModel:WorkspaceModel| 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 Workspace component.
Implementation
public function get workspaceModel():WorkspaceModel public function set workspaceModel(value:WorkspaceModel):voidDesktopModel | () | Constructor |
public function DesktopModel()| 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 |
Constructor.
displayHelp | () | method |
public function displayHelp():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 |
Displays context-sensitive help to a user.
doLogout | () | method |
public function doLogout():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 |
Logs out of the current Workspace ES2 session.
initialize | () | method |
override public function initialize():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 |
Initializes the user preferences and displays the appropriate view depending on the user's start location. If the user did not specify a startup location in their preferences, a default component is provided by the Workspace API.
showHeader | () | method |
public function showHeader(openHeader:Boolean):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 |
Modifies the display for the Header component to a maximized or
minimized state, and modifies the state of the Welcome or
Workspace component appropriately.
Parameters
openHeader:Boolean — Specifies whether to display the header. A value of
true indicates to display the header.
|
showWelcomePage | () | method |
public function showWelcomePage():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 |
Shows the Welcome component.
Sets the state to STATE_WELCOME and invokes the showHeader method with
false as a parameter.
showWorkspace | () | method |
public function showWorkspace(tabName:String = null):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 |
Displays the Workspace component.
Parameters
tabName:String (default = null)string value
that represents one of the tabs as defined in the WorkspaceModel class
to specify the tab that is displayed to users after they log in to Workspace ES2.
|
Related API Elements
ACROBAT_DETECT | Constant |
public static const ACROBAT_DETECT:String = "acrobatDetect"| 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 |
A special value that specifies to set the state to for detecting Adobe Acrobat or Adobe Reader version installed on the computer of the user.
STATE_WELCOME | Constant |
public static const STATE_WELCOME:String = "welcomeState"| 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 |
A special value that specifies to set the state to display the Welcome page first.
STATE_WORKSPACE | Constant |
public static const STATE_WORKSPACE:String = "workspaceState"| 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 |
A special value that specifies to set the state to display the Workspace page first.
Wed Nov 21 2018, 06:34 AM -08:00