| Package | lc.procmgmt.ui.layout |
| Class | public class HeaderPaneModel |
| Inheritance | HeaderPaneModel  PresentationModel EventDispatcher Object |
| Implements | 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 |
HeaderPane class provides the model implementation for the
HeaderPane component.
Related API Elements
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
The name of the state the current view is in. | HeaderPaneModel | ||
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 | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Returns the corresponding cascading style sheet (CSS) property to use based on the specified parameters. | PresentationModel | |
[override]
Get the help topic string used in the url to reference help. | HeaderPaneModel | ||
|
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 | |
|
Initializes the presentation model after the view bindings
are processed to prevent view bindings from overriding the initial model state. | PresentationModel | |
|
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 | |
|
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 | |
Protected Methods
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| STATE_MESSAGES : String = "messagesState" [static]
A special value that specifies that the help was clicked in the header pane. | HeaderPaneModel | ||
| STATE_NORMAL : String = "normalState" [static]
A special value that specifies to set the header pane is in a normal state. | HeaderPaneModel | ||
| STATE_PREFERENCES : String = "preferencesState" [static]
A special value that specifies that the preferences link was clicked in the header pane. | HeaderPaneModel | ||
Property Detail
state | property |
state:String| 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. This property is only for read-only use.
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 public function set state(value:String):voidMethod Detail
getHelpTopic | () | method |
override public function getHelpTopic():String| 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 |
Get the help topic string used in the url to reference help.
ReturnsString — The help topic.
|
Constant Detail
STATE_MESSAGES | Constant |
public static const STATE_MESSAGES:String = "messagesState"| 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 that the help was clicked in the header pane.
STATE_NORMAL | Constant |
public static const STATE_NORMAL:String = "normalState"| 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 header pane is in a normal state.
STATE_PREFERENCES | Constant |
public static const STATE_PREFERENCES:String = "preferencesState"| 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 that the preferences link was clicked in the header pane.
Mon Apr 10 2017, 12:28 PM -07:00