DesktopModel

(Beta)

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

The 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

lc.procmgmt.ui.layout.Desktop

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
		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

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		DesktopModel() 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
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		displayHelp():void Displays context-sensitive help to a user.	DesktopModel
		doLogout():void Logs out of the current Workspace ES2 session.	DesktopModel
		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 [override] Initializes the user preferences and displays the appropriate view depending on the user's start location.	DesktopModel
		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
		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
		showHeader(openHeader:Boolean):void 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
		showWelcomePage():void Shows the Welcome component.	DesktopModel
		showWorkspace(tabName:String = null):void Displays the Workspace component.	DesktopModel
		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
		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

Property Detail

headerPaneModel

property

headerPaneModel:HeaderPaneModel

Implementation
public function get headerPaneModel():HeaderPaneModel
public function set headerPaneModel(value:HeaderPaneModel):void

isHeaderOpen

property

isHeaderOpen:Boolean

Implementation
public function get isHeaderOpen():Boolean
public function set isHeaderOpen(value:Boolean):void

Constructor Detail

Method Detail

Constant Detail

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

DesktopModel - AS3 ADEP Document Services

Packagesx

Language Elements

Appendixes

Package lc.procmgmt.ui.layout

headerPaneModel

isHeaderOpen

toastFadeTimeMilliseconds

toastViewTimeMilliseconds

welcomeModel

workspaceModel

displayHelp

doLogout

initialize

showHeader

showWelcomePage

showWorkspace

ACROBAT_DETECT

STATE_WELCOME

STATE_WORKSPACE