lc.procmgmt.ui.presentationmodel

# PresentationModel - AS3 ADEP Workspace

Package | lc.procmgmt.ui.presentationmodel
Class | public class PresentationModel
Inheritance | PresentationModel EventDispatcher Object
Implements | IPresentationModel, IMXMLObject
Subclasses | AttachmentHeaderModel, AttachmentListModel, AttachmentsModel, HeaderPaneModel, ProcessInstanceDataGridModel, ProcessInstanceInfoModel, SearchSelectorModel, StartpointDetailsModel, StartpointGridSelectorModel, TaskDetailsModel, TaskDirectiveModel, TaskImageModel, TaskInfoModel, TitledCardRendererModel

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 `PresentationModel` class is a superclass for all the presentation models. The class holds the common functionality and convenience methods that are needed to implement a presentation model, which is designed to support a specific view. A presentation model separates the behavior of a screen from the user interface controls and events. This separation simplifies the view and allows the view to make data bindings to properties in the presentation model and make simple method calls to the presentation model.

For information on using this component to customize Workspace, see Customizing the Adobe Digital Enterprise Platform Document Services - Workspace 10.0 User Interface .

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

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | 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
|  | 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 Initializes the presentation model after the view bindings are processed to prevent view bindings from overriding the initial model state. | PresentationModel
|  | 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
|  | 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

| 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

Property Detail

### session

property

`session:SessionMap`

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 `SessionMap` object that stores information relating to the server session.

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 session():SessionMap`
`public function set session(value:SessionMap):void`

### state

property

`state:String` [read-only]

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 state the current view is in. The state is typically bound to the `currentState` property of a control.

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 state():String`
Method Detail

### bindProperty

()
method

`public function bindProperty(destination:Object, destinationProperty:String, source:Object, sourceChain:Object, commitOnly:Boolean = false):ChangeWatcher`

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

Binds a public property on the destination object from a property or property chain on the source object. This method simplifies the use of the standard `BindingUtils.bindProperty` method.

Parameters

| `destination:Object` — Specifies the object defining the property to be bound to the value of `sourceChain`.
| `destinationProperty:String` — Specifies the name of the public property defined by the value of the `destination` parameter that is to be bound.
| `source:Object` — Specifies the object that hosts the property or property chain to be watched.
| `sourceChain:Object` — Specifies the property or property chain to be watched.
| `commitOnly:Boolean` (default = `false`)`` — A flag that specifies whether the handler is called for committing and noncommitting change events. A value of `true` specifies that the handler is called only on committing change events. A value of `false` specifies that the handler is called on both committing and noncommitting change events.

Returns

| `ChangeWatcher` — The property or property chain to be watched. At least one property name must specified in the `sourceChain` argument, otherwise, a `null` value is returned.

Related API Elements

mx.binding.utils.ChangeWatcher

### getCSSStyle

()
method

`public function getCSSStyle(declaration:String, styleProperty:String, defaultValue:Object = null):Object`

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

Returns the corresponding cascading style sheet (CSS) property to use based on the specified parameters.

Parameters

| `declaration:String` — Specifies the name of the CSS selector.
| `styleProperty:String` — Specifies the name of the CSS property.
| `defaultValue:Object` (default = `null`)`` — Specifies the CSS property that is used if the CSS property specified by the the `styleProperty` parameter is not found.

Returns

| `Object` — The CSS style.

### initialize

()
method

`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 presentation model after the view bindings are processed to prevent view bindings from overriding the initial model state. Subclasses can override this method, which

### setState

()
method

`protected function setState(newState:String):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

Sets the `state` property to a new value and causes a `PropertyChangeEvent` event.

Parameters

| `newState:String` — Specifies the new state name.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00