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

Package | feathers.controls.renderers
Class | public class DefaultGroupedListHeaderOrFooterRenderer
Inheritance | DefaultGroupedListHeaderOrFooterRenderer FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object
Implements | IGroupedListHeaderOrFooterRenderer

The default renderer used for headers and footers in a GroupedList control.

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 component is disabled. | DefaultGroupedListHeaderOrFooterRenderer
|  | backgroundSkin : DisplayObject A background to behind the component's content. | DefaultGroupedListHeaderOrFooterRenderer
|  | 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
|  | contentField : String The field in the item that contains a display object to be positioned in the content position of the renderer. | DefaultGroupedListHeaderOrFooterRenderer
|  | contentFunction : Function A function that returns a display object to be positioned in the content position of the renderer. | DefaultGroupedListHeaderOrFooterRenderer
|  | contentLabelFactory : Function A function that generates an ITextRenderer that uses the result of contentLabelField or contentLabelFunction. | DefaultGroupedListHeaderOrFooterRenderer
|  | contentLabelField : String The field in the item that contains a string to be displayed in a renderer-managed Label in the content position of the renderer. | DefaultGroupedListHeaderOrFooterRenderer
|  | contentLabelFunction : Function A function that returns a string to be displayed in a renderer-managed Label in the content position of the renderer. | DefaultGroupedListHeaderOrFooterRenderer
|  | contentLabelProperties : Object A set of key/value pairs to be passed down to a content label. | DefaultGroupedListHeaderOrFooterRenderer
|  | contentLoaderFactory : Function A function that generates an ImageLoader that uses the result of contentSourceField or contentSourceFunction. | DefaultGroupedListHeaderOrFooterRenderer
|  | contentSourceField : String The field in the data that contains a starling.textures.Texture or a URL that points to a bitmap to be used as the renderer's content. | DefaultGroupedListHeaderOrFooterRenderer
|  | contentSourceFunction : Function A function used to generate a starling.textures.Texture or a URL that points to a bitmap to be used as the renderer's content. | DefaultGroupedListHeaderOrFooterRenderer
|  | data : Object Data for a header or footer from the grouped list's data provider. | DefaultGroupedListHeaderOrFooterRenderer
|  | 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
|  | groupIndex : int The index of the group within the data provider of the grouped list. | DefaultGroupedListHeaderOrFooterRenderer
|  | hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area. | DisplayObject
|  | height : Number [override] The height of the component, in pixels. | FeathersControl
|  | horizontalAlign : String The location where the renderer's content is aligned horizontally (on the x-axis). | DefaultGroupedListHeaderOrFooterRenderer
|  | 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
|  | layoutIndex : int The index of the item within the layout. | DefaultGroupedListHeaderOrFooterRenderer
|  | 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
|  | owner : GroupedList The grouped list that contains this header or footer renderer. | DefaultGroupedListHeaderOrFooterRenderer
|  | padding : Number Quickly sets all padding properties to the same value. | DefaultGroupedListHeaderOrFooterRenderer
|  | paddingBottom : Number The minimum space, in pixels, between the component's bottom edge and the component's content. | DefaultGroupedListHeaderOrFooterRenderer
|  | paddingLeft : Number The minimum space, in pixels, between the component's left edge and the component's content. | DefaultGroupedListHeaderOrFooterRenderer
|  | paddingRight : Number The minimum space, in pixels, between the component's right edge and the component's content. | DefaultGroupedListHeaderOrFooterRenderer
|  | paddingTop : Number The minimum space, in pixels, between the component's top edge and the component's content. | DefaultGroupedListHeaderOrFooterRenderer
|  | 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
|  | 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
|  | 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 location where the renderer's content is aligned vertically (on the y-axis). | DefaultGroupedListHeaderOrFooterRenderer
|  | 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
|  | contentLabelName : String = feathers-header-footer-renderer-content-label The value added to the nameList of the content label. | DefaultGroupedListHeaderOrFooterRenderer
|  | 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

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | DefaultGroupedListHeaderOrFooterRenderer() Constructor. | DefaultGroupedListHeaderOrFooterRenderer
|  | 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
|  | itemToContent(item:Object):DisplayObject Uses the content fields and functions to generate content for a specific group header or footer. | DefaultGroupedListHeaderOrFooterRenderer
|  | 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_CONTENT_LABEL : String = feathers-header-footer-renderer-content-label [static] The default value added to the nameList of the content label. | DefaultGroupedListHeaderOrFooterRenderer
|  | HORIZONTAL_ALIGN_CENTER : String = center [static] The content will be aligned horizontally to the center of the renderer. | DefaultGroupedListHeaderOrFooterRenderer
|  | HORIZONTAL_ALIGN_LEFT : String = left [static] The content will be aligned horizontally to the left edge of the renderer. | DefaultGroupedListHeaderOrFooterRenderer
|  | HORIZONTAL_ALIGN_RIGHT : String = right [static] The content will be aligned horizontally to the right edge of the renderer. | DefaultGroupedListHeaderOrFooterRenderer
|  | 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
|  | VERTICAL_ALIGN_BOTTOM : String = bottom [static] The content will be aligned vertically to the bottom edge of the renderer. | DefaultGroupedListHeaderOrFooterRenderer
|  | VERTICAL_ALIGN_MIDDLE : String = middle [static] The content will be aligned vertically to the middle of the renderer. | DefaultGroupedListHeaderOrFooterRenderer
|  | VERTICAL_ALIGN_TOP : String = top [static] The content will be aligned vertically to the top edge of the renderer. | DefaultGroupedListHeaderOrFooterRenderer

Property Detail

backgroundDisabledSkin | property

`backgroundDisabledSkin:DisplayObject`

A background to display when the component is disabled.

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

backgroundSkin | property |

`backgroundSkin:DisplayObject`

A background to behind the component's content.

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

contentField | property |

`contentField:String`

The field in the item that contains a display object to be positioned in the content position of the renderer. If you wish to display a texture in the content position, it's better for performance to use `contentSourceField` instead.

All of the content fields and functions, ordered by priority:

1. `contentSourceFunction`
2. `contentSourceField`
3. `contentLabelFunction`
4. `contentLabelField`
5. `contentFunction`
6. `contentField`

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

See also

contentSourceField
contentFunction
contentSourceFunction
contentLabelField
contentLabelFunction

contentFunction | property |

`contentFunction:Function`

A function that returns a display object to be positioned in the content position of the renderer. If you wish to display a texture in the content position, it's better for performance to use `contentSourceFunction` instead.

The function is expected to have the following signature:

    function( item:Object ):DisplayObject

All of the content fields and functions, ordered by priority:

1. `contentSourceFunction`
2. `contentSourceField`
3. `contentLabelFunction`
4. `contentLabelField`
5. `contentFunction`
6. `contentField`

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

See also

contentField
contentSourceField
contentSourceFunction
contentLabelField
contentLabelFunction

contentLabelFactory | property |

`contentLabelFactory:Function`

A function that generates an `ITextRenderer` that uses the result of `contentLabelField` or `contentLabelFunction`. Can be used to set properties on the `ITextRenderer`.

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

See also

feathers.core.ITextRenderer
feathers.core.FeathersControl.defaultTextRendererFactory
contentLabelField
contentLabelFunction

contentLabelField | property |

`contentLabelField:String`

The field in the item that contains a string to be displayed in a renderer-managed `Label` in the content position of the renderer. The renderer will automatically reuse an internal `Label` and swap the text when the data changes. This `Label` may be skinned by changing the `contentLabelFactory`.

Using an content label will result in better performance than passing in a `Label` through a `contentField` or `contentFunction` because the renderer can avoid costly display list manipulation.

All of the content fields and functions, ordered by priority:

1. `contentTextureFunction`
2. `contentTextureField`
3. `contentLabelFunction`
4. `contentLabelField`
5. `contentFunction`
6. `contentField`

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

See also

contentLabelFactory
contentLabelFunction
contentField
contentFunction
contentSourceField
contentSourceFunction

contentLabelFunction | property |

`contentLabelFunction:Function`

A function that returns a string to be displayed in a renderer-managed `Label` in the content position of the renderer. The renderer will automatically reuse an internal `Label` and swap the text when the data changes. This `Label` may be skinned by changing the `contentLabelFactory`.

Using an content label will result in better performance than passing in a `Label` through a `contentField` or `contentFunction` because the renderer can avoid costly display list manipulation.

The function is expected to have the following signature:

    function( item:Object ):String

All of the content fields and functions, ordered by priority:

1. `contentTextureFunction`
2. `contentTextureField`
3. `contentLabelFunction`
4. `contentLabelField`
5. `contentFunction`
6. `contentField`

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

See also

contentLabelFactory
contentLabelField
contentField
contentFunction
contentSourceField
contentSourceFunction

contentLabelName | property |

`protected var contentLabelName:String = feathers-header-footer-renderer-content-label`

The value added to the `nameList` of the content label.

contentLabelProperties | property |

`contentLabelProperties:Object`

A set of key/value pairs to be passed down to a content label.

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

See also

feathers.core.ITextRenderer
contentLabelField
contentLabelFunction

contentLoaderFactory | property |

`contentLoaderFactory:Function`

A function that generates an `ImageLoader` that uses the result of `contentSourceField` or `contentSourceFunction`. Useful for transforming the `ImageLoader` in some way. For example, you might want to scale it for current DPI or apply pixel snapping.

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

See also

feathers.controls.ImageLoader
contentSourceField
contentSourceFunction

contentSourceField | property |

`contentSourceField:String`

The field in the data that contains a `starling.textures.Texture` or a URL that points to a bitmap to be used as the renderer's content. The renderer will automatically manage and reuse an internal `ImageLoader` sub-component and this value will be passed to the `source` property. The `ImageLoader` may be customized by changing the `contentLoaderFactory`.

Using an content source will result in better performance than passing in an `ImageLoader` or `Image` through `contentField` or `contentFunction` because the renderer can avoid costly display list manipulation.

All of the content fields and functions, ordered by priority:

1. `contentSourceFunction`
2. `contentSourceeField`
3. `contentLabelFunction`
4. `contentLabelField`
5. `contentFunction`
6. `contentField`

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

See also

feathers.controls.ImageLoader.source
contentLoaderFactory
contentSourceFunction
contentField
contentFunction
contentLabelField
contentLabelFunction

contentSourceFunction | property |

`contentSourceFunction:Function`

A function used to generate a `starling.textures.Texture` or a URL that points to a bitmap to be used as the renderer's content. The renderer will automatically manage and reuse an internal `ImageLoader` sub-component and this value will be passed to the `source` property. The `ImageLoader` may be customized by changing the `contentLoaderFactory`.

Using an content source will result in better performance than passing in an `ImageLoader` or `Image` through `contentField` or `contentFunction` because the renderer can avoid costly display list manipulation.

The function is expected to have the following signature:

    function( item:Object ):Object

The return value is a valid value for the `source` property of an `ImageLoader` component.

All of the content fields and functions, ordered by priority:

1. `contentSourceFunction`
2. `contentSourceField`
3. `contentLabelFunction`
4. `contentLabelField`
5. `contentFunction`
6. `contentField`

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

See also

feathers.controls.ImageLoader.source
contentLoaderFactory
contentSourceField
contentField
contentFunction
contentLabelField
contentLabelFunction

data | property |

`data:Object`

Data for a header or footer from the grouped list's data provider. The data may change if this renderer is reused for a new header or footer because it's no longer needed for the original data.

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

groupIndex | property |

`groupIndex:int`

The index of the group within the data provider of the grouped list.

Implementation
`public function get groupIndex():int`
`public function set groupIndex(value:int):void`

horizontalAlign | property |

`horizontalAlign:String`

The location where the renderer's content is aligned horizontally (on the x-axis).

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

layoutIndex | property |

`layoutIndex:int`

The index of the item within the layout.

Implementation
`public function get layoutIndex():int`
`public function set layoutIndex(value:int):void`

owner | property |

`owner:GroupedList`

The grouped list that contains this header or footer renderer.

Implementation
`public function get owner():GroupedList`
`public function set owner(value:GroupedList):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 component's bottom edge and the component'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 component's left edge and the component'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 component's right edge and the component'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 component's top edge and the component's content.

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

verticalAlign | property |

`verticalAlign:String`

The location where the renderer's content is aligned vertically (on the y-axis).

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

DefaultGroupedListHeaderOrFooterRenderer | () | Constructor

`public function DefaultGroupedListHeaderOrFooterRenderer()`

Constructor.

Method Detail

itemToContent | () | method

`protected function itemToContent(item:Object):DisplayObject`

Uses the content fields and functions to generate content for a specific group header or footer.

All of the content fields and functions, ordered by priority:

1. `contentTextureFunction`
2. `contentTextureField`
3. `contentLabelFunction`
4. `contentLabelField`
5. `contentFunction`
6. `contentField`

Parameters

| `item:Object`

Returns

| `DisplayObject`

Constant Detail

DEFAULT_CHILD_NAME_CONTENT_LABEL | Constant

`public static const DEFAULT_CHILD_NAME_CONTENT_LABEL:String = feathers-header-footer-renderer-content-label`

The default value added to the `nameList` of the content label.

HORIZONTAL_ALIGN_CENTER | Constant |

`public static const HORIZONTAL_ALIGN_CENTER:String = center`

The content will be aligned horizontally to the center of the renderer.

HORIZONTAL_ALIGN_LEFT | Constant |

`public static const HORIZONTAL_ALIGN_LEFT:String = left`

The content will be aligned horizontally to the left edge of the renderer.

HORIZONTAL_ALIGN_RIGHT | Constant |

`public static const HORIZONTAL_ALIGN_RIGHT:String = right`

The content will be aligned horizontally to the right edge of the renderer.

VERTICAL_ALIGN_BOTTOM | Constant |

`public static const VERTICAL_ALIGN_BOTTOM:String = bottom`

The content will be aligned vertically to the bottom edge of the renderer.

VERTICAL_ALIGN_MIDDLE | Constant |

`public static const VERTICAL_ALIGN_MIDDLE:String = middle`

The content will be aligned vertically to the middle of the renderer.

VERTICAL_ALIGN_TOP | Constant |

`public static const VERTICAL_ALIGN_TOP:String = top`

The content will be aligned vertically to the top edge of the renderer.

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