| Package | lc.procmgmt.ui.layout |
| Class | public class DesktopModel |
| Inheritance | DesktopModel  NavigationSupervisorModel |
| 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 |
DesktopModel class provides the model implementation for the
Desktop component.
For information on using this component to customize Workspace, see Customizing the Adobe Digital Enterprise Platform Document Services - Workspace 10.0 User Interface .
Related API Elements
| Property | Defined By | ||
|---|---|---|---|
| headerPaneModel : HeaderPaneModel | DesktopModel | ||
| isHeaderOpen : Boolean | DesktopModel | ||
| 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 | ||
Displays context-sensitive help to a user. | DesktopModel | ||
Logs out of the current Workspace session. | DesktopModel | ||
[override]
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 modifies the state of the Welcome or
Workspace component appropriately. | DesktopModel | ||
Shows the Welcome component. | DesktopModel | ||
Displays the Workspace component. | DesktopModel | ||
| 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 Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), 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. 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 Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), 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. 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 Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), 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 Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), 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 Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Constructor.
displayHelp | () | method |
public function displayHelp():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 |
Displays context-sensitive help to a user.
doLogout | () | method |
public function doLogout():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 |
Logs out of the current Workspace session.
initialize | () | method |
override public function initialize():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 |
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 Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), 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 Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), 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 Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), 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.
|
Related API Elements
ACROBAT_DETECT | Constant |
public static const ACROBAT_DETECT:String = "acrobatDetect"| 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 |
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 Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), 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 Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies to set the state to display the Workspace page first.
Mon Nov 28 2011, 06:48 AM -08:00