Packagecom.jwopitz.containers
Classpublic class Pod
InheritancePod Inheritance mx.containers.Panel

Pod is an extension of the <mx:Panel> allowing children to be added to the header area as well as triggering unique mouse events for the purposes of window's based interactions. 

   <jwo_lib:Pod
     Styles
     headerVerticalAlign="top|middle|bottom"
     headerHorizontalGap="2"
     >
     ...
       child tags
     ...
   </jwo_lib:Pod>

See also

mx.containers.Panel

Public Properties
 PropertyDefined by
  defaultTitleBarComponentClass : Class
The default class to be used when calling addTitleBarComponent() with no parameter.
Pod
  headerHeight : Number
A convenience method for retrieving the header height.
Pod
  titleBarChildren : Array
Exposed for declaritive instantiation of title bar assets.
Pod
Public Methods
 MethodDefined by
  
addTitleBarComponent(child:UIComponent = null):UIComponent
Adds new children to the title bar area and registers default mouse event handlers.
Pod
Protected Methods
 MethodDefined by
  
assignTitleBarListeners():void
Assigns default mouse event handlers to the tilte bar area.
Pod
  
createTitleBarMouseEvent(type:String, targetEvt:MouseEvent):MouseEvent
Clones a target mouse event but allows for the type to be set prior to cloning.
Pod
  
repositionHeaderElements():void
Repositions the child elements of the header.
Pod
Events
 EventSummaryDefined by
  
gripClick
Dispatched when the user clicks on the header area.Pod
  
gripMouseDown
Dispatched when the user presses the mouse button on the header area.Pod
  
gripMouseMove
Dispatched when the user moves the mouse over the header area.Pod
  
gripMouseOut
Dispatched when the user moves the mouse out of the header area.Pod
  
gripMouseOver
Dispatched when the user clicks on the header area.Pod
  
gripMouseUp
Dispatched when the user releases the mouse button above the header area.Pod
  
gripRollOut
Dispatched when the user rolls out of the header area.Pod
  
gripRollOver
Dispatched when the user rolls over the header area.Pod
Styles
 StyleDescriptionDefined by
  
headerHorizontalAlign
Type: String   CSS Inheritance: no
Sets the horizontal alignment of the header children added with addTitleBarComponent and the titleTextField. Values are "left" and "right". The default value is right.		Pod
  
headerHorizontalGap
Type: Number   CSS Inheritance: no
Sets the horizontal gap of the header children added with addTitleBarComponent. If no value is set, then the value of horizontalGap will be used for the gap. The default value is 6.		Pod
  
headerVerticalAlign
Type: String   CSS Inheritance: no
Sets the vertical alignment of the header children added with addTitleBarComponent and the titleTextField. Values are "top, "middle" and "bottom". The default value is middle.		Pod
Property detail
defaultTitleBarComponentClassproperty
public var defaultTitleBarComponentClass:Class

The default class to be used when calling addTitleBarComponent() with no parameter.

headerHeightproperty 
headerHeight:Number  [read-write]

A convenience method for retrieving the header height.

This property can be used as the source for data binding.

Implementation
    public function get headerHeight():Number
    public function set headerHeight(value:Number):void
titleBarChildrenproperty 
public var titleBarChildren:Array

Exposed for declaritive instantiation of title bar assets. For MXML use only.

Method detail
addTitleBarComponent()method
public function addTitleBarComponent(child:UIComponent = null):UIComponent

Adds new children to the title bar area and registers default mouse event handlers. For most cases, title bar components should be added declaritively via MXML using titleBarChildren which calls this on the creation complete event. If however, assets are needing to be added dynamically at runtime, the developer can add them via this method.

Parameters
child:UIComponent (default = null) — The UIComponent to be added.

Returns
UIComponent — The UIComponent to be added.

See also

titleBarChildren
assignTitleBarListeners()method 
protected function assignTitleBarListeners():void

Assigns default mouse event handlers to the tilte bar area.

createTitleBarMouseEvent()method 
protected function createTitleBarMouseEvent(type:String, targetEvt:MouseEvent):MouseEvent

Clones a target mouse event but allows for the type to be set prior to cloning. This method should be used only for capturing events fired from the titleBar area which do not originate from any of its children.

Parameters
type:String — The mouseEvent type of the target mouseEvent to be cloned.
 
targetEvt:MouseEvent — The mouseEvent to be cloned.

Returns
MouseEvent — The cloned mouseEvent.
repositionHeaderElements()method 
protected function repositionHeaderElements():void

Repositions the child elements of the header.

Event detail
gripClickevent 
Event object type: flash.events.MouseEvent

Dispatched when the user clicks on the header area.

gripMouseDownevent  
Event object type: flash.events.MouseEvent

Dispatched when the user presses the mouse button on the header area.

gripMouseMoveevent  
Event object type: flash.events.MouseEvent

Dispatched when the user moves the mouse over the header area.

gripMouseOutevent  
Event object type: flash.events.MouseEvent

Dispatched when the user moves the mouse out of the header area.

gripMouseOverevent  
Event object type: flash.events.MouseEvent

Dispatched when the user clicks on the header area.

gripMouseUpevent  
Event object type: flash.events.MouseEvent

Dispatched when the user releases the mouse button above the header area.

gripRollOutevent  
Event object type: flash.events.MouseEvent

Dispatched when the user rolls out of the header area.

gripRollOverevent  
Event object type: flash.events.MouseEvent

Dispatched when the user rolls over the header area.