| Package | lc.layout |
| Class | public class DesktopModel |
DesktopModel class provides the model implementation for the
Desktop component.
| Property | Defined By | ||
|---|---|---|---|
| headerPaneModel : HeaderPaneModel
An instance of the headerPane component's model.
| DesktopModel | ||
| toastFadeTimeMilliseconds : Number = 5000
The fade time (in milliseconds) for the toast window.The default is 5000 milliseconds.
| DesktopModel | ||
| toastViewTimeMilliseconds : Number = 5000
The amount of time (in milliseconds) the toast window is visible.
| DesktopModel | ||
| welcomeModel : WelcomeModel
An instance of the Welcome component's model.
| DesktopModel | ||
| workspaceModel : WorkspaceModel
An instance of the Workspace component's model.
| DesktopModel | ||
| Method | Defined By | ||
|---|---|---|---|
|
Constructor.
| DesktopModel | ||
|
Displays context-sensitive help to a user.
| DesktopModel | ||
|
Logs out of the current Workspace ES session.
| DesktopModel | ||
|
Initializes the user preferences and displays the appropriate view depending on
the user's start location.
| DesktopModel | ||
|
Modifies the display for the Header component to a maximized or
minimized state, and hence adjusts the state of the Welcome or
Workspace component appropriately.
| DesktopModel | ||
|
Shows the Welcome component.
| DesktopModel | ||
|
Displays the Workspace component.
| DesktopModel | ||
| Constant | Defined By | ||
|---|---|---|---|
| STATE_WELCOME : String = "welcomeState" [static]
The model is set into this state to first display the Welcome page.
| DesktopModel | ||
| STATE_WORKSPACE : String = "workspaceState" [static]
The model is set into this state to first display Workpace page.
| DesktopModel | ||
| headerPaneModel | property |
public var headerPaneModel:HeaderPaneModel
An instance of the headerPane component's model.
| toastFadeTimeMilliseconds | property |
public var toastFadeTimeMilliseconds:Number = 5000
The fade time (in milliseconds) for the toast window.The default is 5000 milliseconds.
| toastViewTimeMilliseconds | property |
public var toastViewTimeMilliseconds:Number = 5000
The amount of time (in milliseconds) the toast window is visible. The default is 5000 milliseconds.
| welcomeModel | property |
public var welcomeModel:WelcomeModel
An instance of the Welcome component's model.
| workspaceModel | property |
public var workspaceModel:WorkspaceModel
An instance of the Workspace component's model.
| DesktopModel | () | Constructor |
public function DesktopModel()
Constructor.
| displayHelp | () | method |
public function displayHelp():void
Displays context-sensitive help to a user.
| doLogout | () | method |
public function doLogout():void
Logs out of the current Workspace ES session.
| initialize | () | method |
public override function initialize():void
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 LiveCycle Workspace ES API.
| showHeader | () | method |
public function showHeader(openHeader:Boolean):void
Modifies the display for the Header component to a maximized or
minimized state, and hence adjusts the state of the Welcome or
Workspace component appropriately.
Parameters
openHeader:Boolean — Specifies a flag to specify whether to display the header. A value of
true indicates to display the header.
|
| showWelcomePage | () | method |
public function showWelcomePage():void
Shows the Welcome component.
Sets the state to STATE_WELCOME and calls showHeader method
false as a parameter.
| showWorkspace | () | method |
public function showWorkspace(tabName:String = null):void
Displays the Workspace component.
Parameters
tabName:String (default = null)WorkspaceModel class
to specify the tab that is displayed to users after they log in to Workspace ES.
|
See also
| STATE_WELCOME | Constant |
public static const STATE_WELCOME:String = "welcomeState"
The model is set into this state to first display the Welcome page.
| STATE_WORKSPACE | Constant |
public static const STATE_WORKSPACE:String = "workspaceState"
The model is set into this state to first display Workpace page.
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/lc/layout/DesktopModel.html