GODPAPER | All Packages | All Classes | Index | Frames No Frames |
Header

Package | feathers.controls
Class | public class Header
Inheritance | Header FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object

A header that displays an optional title along with a horizontal regions on the sides for additional UI controls. The left side is typically for navigation (to display a back button, for example) and the right for additional actions. The title is displayed in the center by default, but it may be aligned to the left or right if there are no items on the desired side.

See also

http://wiki.starling-framework.org/feathers/header

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | alpha : Number The opacity of the object. | DisplayObject
|  | backgroundDisabledSkin : DisplayObject A background to display when the header is disabled. | Header
|  | backgroundSkin : DisplayObject A display object displayed behind the header's content. | Header
|  | base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject
|  | blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject
|  | bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject
|  | clipRect : Rectangle [override] | FeathersControl
|  | defaultTextEditorFactory : Function [static] A function used by all UI controls that support text editor to create an ITextEditor instance. | FeathersControl
|  | defaultTextRendererFactory : Function [static] A function used by all UI controls that support text renderers to create an ITextRenderer instance. | FeathersControl
|  | filter : FragmentFilter The filter that is attached to the display object. | DisplayObject
|  | focusManager : IFocusManager The current focus manager for this component. | FeathersControl
|  | gap : Number Space, in pixels, between items. | Header
|  | hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area. | DisplayObject
|  | height : Number [override] The height of the component, in pixels. | FeathersControl
|  | includeInLayout : Boolean Determines if the ILayout should use this object or ignore it. | FeathersControl
|  | isEnabled : Boolean Indicates whether the control is interactive or not. | FeathersControl
|  | isFlattened : Boolean [read-only] Indicates if the sprite was flattened. | Sprite
|  | isFocusEnabled : Boolean Determines if this component can receive focus. | FeathersControl
|  | isInitialized : Boolean [read-only] Determines if the component has been initialized yet. | FeathersControl
|  | isQuickHitAreaEnabled : Boolean Similar to mouseChildren on the classic display list. | FeathersControl
|  | layoutData : ILayoutData Extra parameters associated with this display object that will be used by the layout algorithm. | FeathersControl
|  | leftItems : Vector.<DisplayObject> The UI controls that appear in the left region of the header. | Header
|  | maxHeight : Number The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component. | FeathersControl
|  | maxWidth : Number The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component. | FeathersControl
|  | minHeight : Number The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component. | FeathersControl
|  | minTouchHeight : Number If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded. | FeathersControl
|  | minTouchWidth : Number If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded. | FeathersControl
|  | minWidth : Number The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component. | FeathersControl
|  | name : String [override] The concatenated nameList, with each name separated by spaces. | FeathersControl
|  | nameList : TokenList [read-only] Contains a list of all "names" assigned to this control. | FeathersControl
|  | nextTabFocus : IFocusDisplayObject The next object that will receive focus when the tab key is pressed. | FeathersControl
|  | numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer
|  | padding : Number Quickly sets all padding properties to the same value. | Header
|  | paddingBottom : Number The minimum space, in pixels, between the header's bottom edge and the header's content. | Header
|  | paddingLeft : Number The minimum space, in pixels, between the header's left edge and the header's content. | Header
|  | paddingRight : Number The minimum space, in pixels, between the header's right edge and the header's content. | Header
|  | paddingTop : Number The minimum space, in pixels, between the header's top edge and the header's content. | Header
|  | parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject
|  | pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject
|  | pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject
|  | rightItems : Vector.<DisplayObject> The UI controls that appear in the right region of the header. | Header
|  | root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject
|  | rotation : Number The rotation of the object in radians. | DisplayObject
|  | scaleX : Number The horizontal scale factor. | DisplayObject
|  | scaleY : Number The vertical scale factor. | DisplayObject
|  | skewX : Number The horizontal skew angle in radians. | DisplayObject
|  | skewY : Number The vertical skew angle in radians. | DisplayObject
|  | stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected to the stage. | DisplayObject
|  | title : String The text displayed for the header's title. | Header
|  | titleAlign : String The preferred position of the title. | Header
|  | titleFactory : Function A function used to instantiate the header's title subcomponent. | Header
|  | titleGap : Number Space, in pixels, between the title and the left or right groups of items. | Header
|  | titleProperties : Object A set of key/value pairs to be passed down to the headers's title instance. | Header
|  | touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject
|  | transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject
|  | useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject
|  | verticalAlign : String The alignment of the items vertically, on the y-axis. | Header
|  | visible : Boolean The visibility of the object. | DisplayObject
|  | width : Number [override] The width of the component, in pixels. | FeathersControl
|  | x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject
|  | y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | actualHeight : Number = 0 The final height value that should be used for layout. | FeathersControl
|  | actualWidth : Number = 0 The final width value that should be used for layout. | FeathersControl
|  | explicitHeight : Number = NaN The height value explicitly set by calling the height setter or setSize(). | FeathersControl
|  | explicitWidth : Number = NaN The width value explicitly set by calling the width setter or setSize(). | FeathersControl
|  | itemName : String = feathers-header-item The value added to the nameList of the header's items. | Header
|  | titleName : String = feathers-header-title The value added to the nameList of the header's title. | Header

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | Header() Constructor. | Header
|  | addChild(child:DisplayObject):DisplayObject Adds a child to the container. | DisplayObjectContainer
|  | addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child to the container at a certain index. | DisplayObjectContainer
|  | addEventListener(type:String, listener:Function):void [override] | DisplayObject
|  | alignPivot(hAlign:String = center, vAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system of the object. | DisplayObject
|  | broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer
|  | broadcastEventWith(type:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer
|  | contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer
|  | dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher
|  | dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered listeners for the given type. | EventDispatcher
|  | dispose():void [override] Disposes the resources of all children. | Sprite
|  | flatten():void Optimizes the sprite for optimal rendering performance. | Sprite
|  | getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another coordinate system. | Sprite
|  | getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer
|  | getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer
|  | getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer
|  | getClipRect(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle Returns the bounds of the container's clipRect in the given coordinate space, or null if the sprite doens't have a clipRect. | Sprite
|  | getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system to another. | DisplayObject
|  | globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject
|  | hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type. | EventDispatcher
|  | hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil if the test fails. | Sprite
|  | invalidate(flag:String):void Call this function to tell the UI control that a redraw is pending. | FeathersControl
|  | isInvalid(flag:String = null):Boolean Indicates whether the control is pending validation or not. | FeathersControl
|  | localToGlobal(localPoint:Point, resultPoint:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject
|  | removeChild(child:DisplayObject, dispose:Boolean = false):DisplayObject Removes a child from the container. | DisplayObjectContainer
|  | removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer
|  | removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer
|  | removeEventListener(type:String, listener:Function):void [override] | DisplayObject
|  | removeEventListeners(type:String = null):void [override] | DisplayObject
|  | removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject
|  | render(support:RenderSupport, parentAlpha:Number):void [override] Renders the display object with the help of a support object. | Sprite
|  | setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer
|  | setSize(width:Number, height:Number):void Sets both the width and the height of the control. | FeathersControl
|  | sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function of the Vector class). | DisplayObjectContainer
|  | swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the indexes of two children. | DisplayObjectContainer
|  | swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer
|  | unflatten():void Removes the rendering optimizations that were created when flattening the sprite. | Sprite
|  | validate():void Immediately validates the control, which triggers a redraw, if one is pending. | FeathersControl

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | draw():void Override to customize layout and to adjust properties of children. | FeathersControl
|  | initialize():void Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process. | FeathersControl
|  | setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean Sets the width and height of the control, with the option of invalidating or not. | FeathersControl

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | added | Dispatched when an object is added to a parent. | DisplayObject
|  | addedToStage | Dispatched when an object is connected to the stage (directly or indirectly). | DisplayObject
|  | enterFrame | Dispatched once every frame on every object that is connected to the stage. | DisplayObject
|  | flatten | Dispatched on all children when the object is flattened. | Sprite
|  | initialize | Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl
|  | keyDown | Dispatched when a key on the keyboard is pressed. | DisplayObject
|  | keyUp | Dispatched when a key on the keyboard is released. | DisplayObject
|  | removed | Dispatched when an object is removed from its parent. | DisplayObject
|  | removedFromStage | Dispatched when an object is removed from the stage and won't be rendered any longer. | DisplayObject
|  | resize | Dispatched when the width or height of the control changes. | FeathersControl
|  | touch | Dispatched when an object is touched. | DisplayObject

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | DEFAULT_CHILD_NAME_ITEM : String = feathers-header-item [static] The default value added to the nameList of the header's items. | Header
|  | DEFAULT_CHILD_NAME_TITLE : String = feathers-header-title [static] The default value added to the nameList of the header's title. | Header
|  | INVALIDATION_FLAG_ALL : String = all [static] Flag to indicate that everything is invalid and should be redrawn. | FeathersControl
|  | INVALIDATION_FLAG_DATA : String = data [static] Invalidation flag to indicate that the primary data displayed by the UI control has changed. | FeathersControl
|  | INVALIDATION_FLAG_LAYOUT : String = layout [static] Invalidation flag to indicate that the layout of the UI control has changed. | FeathersControl
|  | INVALIDATION_FLAG_SCROLL : String = scroll [static] Invalidation flag to indicate that the scroll position of the UI control has changed. | FeathersControl
|  | INVALIDATION_FLAG_SELECTED : String = selected [static] Invalidation flag to indicate that the selection of the UI control has changed. | FeathersControl
|  | INVALIDATION_FLAG_SIZE : String = size [static] Invalidation flag to indicate that the dimensions of the UI control have changed. | FeathersControl
|  | INVALIDATION_FLAG_SKIN : String = skin [static] Invalidation flag to indicate that the skin of the UI control has changed. | FeathersControl
|  | INVALIDATION_FLAG_STATE : String = state [static] Invalidation flag to indicate that the state has changed. | FeathersControl
|  | INVALIDATION_FLAG_STYLES : String = styles [static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed. | FeathersControl
|  | TITLE_ALIGN_CENTER : String = center [static] The title will appear in the center of the header. | Header
|  | TITLE_ALIGN_PREFER_LEFT : String = preferLeft [static] The title will appear on the left of the header, if there is no other content on that side. | Header
|  | TITLE_ALIGN_PREFER_RIGHT : String = preferRight [static] The title will appear on the right of the header, if there is no other content on that side. | Header
|  | VERTICAL_ALIGN_BOTTOM : String = bottom [static] The items will be aligned to the bottom of the bounds. | Header
|  | VERTICAL_ALIGN_MIDDLE : String = middle [static] The items will be aligned to the middle of the bounds. | Header
|  | VERTICAL_ALIGN_TOP : String = top [static] The items will be aligned to the top of the bounds. | Header

Property Detail

backgroundDisabledSkin | property

`backgroundDisabledSkin:DisplayObject`

A background to display when the header is disabled.

Implementation
`public function get backgroundDisabledSkin():DisplayObject`
`public function set backgroundDisabledSkin(value:DisplayObject):void`

backgroundSkin | property |

`backgroundSkin:DisplayObject`

A display object displayed behind the header's content.

Implementation
`public function get backgroundSkin():DisplayObject`
`public function set backgroundSkin(value:DisplayObject):void`

gap | property |

`gap:Number`

Space, in pixels, between items.

Implementation
`public function get gap():Number`
`public function set gap(value:Number):void`

itemName | property |

`protected var itemName:String = feathers-header-item`

The value added to the `nameList` of the header's items.

leftItems | property |

`leftItems:Vector.<DisplayObject>`

The UI controls that appear in the left region of the header.

Implementation
`public function get leftItems():Vector.<DisplayObject>`
`public function set leftItems(value:Vector.<DisplayObject>):void`

padding | property |

`padding:Number`

Quickly sets all padding properties to the same value. The `padding` getter always returns the value of `paddingTop`, but the other padding values may be different.

Implementation
`public function get padding():Number`
`public function set padding(value:Number):void`

paddingBottom | property |

`paddingBottom:Number`

The minimum space, in pixels, between the header's bottom edge and the header's content.

Implementation
`public function get paddingBottom():Number`
`public function set paddingBottom(value:Number):void`

paddingLeft | property |

`paddingLeft:Number`

The minimum space, in pixels, between the header's left edge and the header's content.

Implementation
`public function get paddingLeft():Number`
`public function set paddingLeft(value:Number):void`

paddingRight | property |

`paddingRight:Number`

The minimum space, in pixels, between the header's right edge and the header's content.

Implementation
`public function get paddingRight():Number`
`public function set paddingRight(value:Number):void`

paddingTop | property |

`paddingTop:Number`

The minimum space, in pixels, between the header's top edge and the header's content.

Implementation
`public function get paddingTop():Number`
`public function set paddingTop(value:Number):void`

rightItems | property |

`rightItems:Vector.<DisplayObject>`

The UI controls that appear in the right region of the header.

Implementation
`public function get rightItems():Vector.<DisplayObject>`
`public function set rightItems(value:Vector.<DisplayObject>):void`

title | property |

`title:String`

The text displayed for the header's title.

Implementation
`public function get title():String`
`public function set title(value:String):void`

titleAlign | property |

`titleAlign:String`

The preferred position of the title. If leftItems and/or rightItems is defined, the title may be forced to the center even if the preferred position is on the left or right.

The default value is `TITLE_ALIGN_CENTER`.

Implementation
`public function get titleAlign():String`
`public function set titleAlign(value:String):void`

See also

TITLE_ALIGN_CENTER
TITLE_ALIGN_PREFER_LEFT
TITLE_ALIGN_PREFER_RIGHT

titleFactory | property |

`titleFactory:Function`

A function used to instantiate the header's title subcomponent.

The factory should have the following function signature:

    function():ITextRenderer

Implementation
`public function get titleFactory():Function`
`public function set titleFactory(value:Function):void`

See also

feathers.core.ITextRenderer
feathers.core.FeathersControl.defaultTextRendererFactory

titleGap | property |

`titleGap:Number`

Space, in pixels, between the title and the left or right groups of items. If `NaN` (the default), the regular `gap` property is used instead.

Implementation
`public function get titleGap():Number`
`public function set titleGap(value:Number):void`

titleName | property |

`protected var titleName:String = feathers-header-title`

The value added to the `nameList` of the header's title.

titleProperties | property |

`titleProperties:Object`

A set of key/value pairs to be passed down to the headers's title instance.

If the subcomponent has its own subcomponents, their properties can be set too, using attribute `@` notation. For example, to set the skin on the thumb of a `SimpleScrollBar` which is in a `Scroller` which is in a `List`, you can use the following syntax:

    list.scrollerProperties.@verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);

Implementation
`public function get titleProperties():Object`
`public function set titleProperties(value:Object):void`

See also

feathers.core.ITextRenderer

verticalAlign | property |

`verticalAlign:String`

The alignment of the items vertically, on the y-axis.

Implementation
`public function get verticalAlign():String`
`public function set verticalAlign(value:String):void`
Constructor Detail

Header | () | Constructor

`public function Header()`

Constructor.

Constant Detail

DEFAULT_CHILD_NAME_ITEM | Constant

`public static const DEFAULT_CHILD_NAME_ITEM:String = feathers-header-item`

The default value added to the `nameList` of the header's items.

DEFAULT_CHILD_NAME_TITLE | Constant |

`public static const DEFAULT_CHILD_NAME_TITLE:String = feathers-header-title`

The default value added to the `nameList` of the header's title.

TITLE_ALIGN_CENTER | Constant |

`public static const TITLE_ALIGN_CENTER:String = center`

The title will appear in the center of the header.

TITLE_ALIGN_PREFER_LEFT | Constant |

`public static const TITLE_ALIGN_PREFER_LEFT:String = preferLeft`

The title will appear on the left of the header, if there is no other content on that side. If there is content, the title will appear in the center.

TITLE_ALIGN_PREFER_RIGHT | Constant |

`public static const TITLE_ALIGN_PREFER_RIGHT:String = preferRight`

The title will appear on the right of the header, if there is no other content on that side. If there is content, the title will appear in the center.

VERTICAL_ALIGN_BOTTOM | Constant |

`public static const VERTICAL_ALIGN_BOTTOM:String = bottom`

The items will be aligned to the bottom of the bounds.

VERTICAL_ALIGN_MIDDLE | Constant |

`public static const VERTICAL_ALIGN_MIDDLE:String = middle`

The items will be aligned to the middle of the bounds.

VERTICAL_ALIGN_TOP | Constant |

`public static const VERTICAL_ALIGN_TOP:String = top`

The items will be aligned to the top of the bounds.

Thu Jan 16 2014, 01:11 PM +08:00