ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
lc.procmgmt.ui.layout 

HeaderPaneModel  - AS3 ADEP Workspace

Packagelc.procmgmt.ui.layout
Classpublic class HeaderPaneModel
InheritanceHeaderPaneModel Inheritance PresentationModel Inheritance EventDispatcher Inheritance 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

The HeaderPane class provides the model implementation for the HeaderPane component.

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedsession : 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
 MethodDefined By
 Inherited
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
 Inherited
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
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
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
  
[override] Get the help topic string used in the url to reference help.
HeaderPaneModel
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Initializes the presentation model after the view bindings are processed to prevent view bindings from overriding the initial model state.
PresentationModel
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
 Inherited
setState(newState:String):void
Sets the state property to a new value and causes a PropertyChangeEvent event.
PresentationModel
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
Public Constants
 ConstantDefined 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):void
Method 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.

Returns
String — 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.