Packagefeathers.controls.renderers
Classpublic class DefaultGroupedListHeaderOrFooterRenderer
InheritanceDefaultGroupedListHeaderOrFooterRenderer Inheritance FeathersControl Inheritance starling.display.Sprite
Implements IGroupedListHeaderRenderer, IGroupedListFooterRenderer

Product Version : Feathers 1.0.0

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

See also

feathers.controls.GroupedList


Public Properties
 PropertyDefined By
  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
An object that stores properties for the content label text renderer sub-component, and the properties will be passed down to the text renderer when this component validates.
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 footer renderer from the grouped list's data provider.
DefaultGroupedListHeaderOrFooterRenderer
 InheriteddefaultTextEditorFactory : Function
[static] A function used by all UI controls that support text editor to create an ITextEditor instance.
FeathersControl
 InheriteddefaultTextRendererFactory : Function
[static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.
FeathersControl
 Inheriteddepth : int
[read-only] The component's depth in the display list, relative to the stage.
FeathersControl
 InheritedexplicitHeight : Number
[read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.
FeathersControl
 InheritedexplicitMaxHeight : Number
[read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.
FeathersControl
 InheritedexplicitMaxWidth : Number
[read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.
FeathersControl
 InheritedexplicitMinHeight : Number
[read-only] The minimum height value explicitly set by passing a value to the minHeight setter.
FeathersControl
 InheritedexplicitMinWidth : Number
[read-only] The minimum width value explicitly set by passing a value to the minWidth setter.
FeathersControl
 InheritedexplicitWidth : Number
[read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.
FeathersControl
  factoryID : String
The ID of the factory used to create this footer renderer.
DefaultGroupedListHeaderOrFooterRenderer
 InheritedfocusManager : IFocusManager
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The current focus manager for this component.
FeathersControl
 InheritedfocusOwner : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Used for associating focusable display objects that are not direct children with an "owner" focusable display object, such as pop-ups.
FeathersControl
  globalStyleProvider : IStyleProvider
[static] The default IStyleProvider for all DefaultGroupedListHeaderOrFooterRenderer components.
DefaultGroupedListHeaderOrFooterRenderer
  groupIndex : int
The index of the group within the data provider of the grouped list.
DefaultGroupedListHeaderOrFooterRenderer
 Inheritedheight : Number
[override] The height of the component, in pixels.
FeathersControl
 InheritedincludeInLayout : Boolean
Determines if the ILayout should use this object or ignore it.
FeathersControl
 InheritedisCreated : Boolean
[read-only] Determines if the component has been initialized and validated for the first time.
FeathersControl
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
FeathersControl
 InheritedisFocusEnabled : Boolean
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Determines if this component can receive focus.
FeathersControl
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
FeathersControl
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
FeathersControl
  layoutIndex : int
The index of this display object within the layout.
DefaultGroupedListHeaderOrFooterRenderer
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.
FeathersControl
 InheritedminTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.
FeathersControl
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritednextTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when the tab key is pressed when a focus manager is enabled.
FeathersControl
  numLines : int
[read-only] The number of text lines displayed by the renderer.
DefaultGroupedListHeaderOrFooterRenderer
  owner : GroupedList
The grouped list that contains this footer renderer.
DefaultGroupedListHeaderOrFooterRenderer
 InheritedpreviousTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The previous object that will receive focus when the tab key is pressed while holding shift when a focus manager is enabled.
FeathersControl
 InheritedstyleName : String
The concatenated styleNameList, with values separated by spaces.
FeathersControl
 InheritedstyleNameList : TokenList
[read-only] Contains a list of all "styles" assigned to this control.
FeathersControl
 InheritedstyleProvider : IStyleProvider
When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.
FeathersControl
 InheritedtoolTip : String
Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.
FeathersControl
 Inheritedwidth : Number
[override] The width of the component, in pixels.
FeathersControl
Protected Properties
 PropertyDefined By
 InheritedactualHeight : Number = 0
The final height value that should be used for layout.
FeathersControl
 InheritedactualMinHeight : Number = 0
The final minimum height value that should be used for layout.
FeathersControl
 InheritedactualMinWidth : Number = 0
The final minimum width value that should be used for layout.
FeathersControl
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
  contentLabelStyleName : String = "feathers-header-footer-renderer-content-label"
The value added to the styleNameList of the content label text renderer.
DefaultGroupedListHeaderOrFooterRenderer
 InheriteddefaultStyleProvider : IStyleProvider
[read-only] When the FeathersControl constructor is called, the styleProvider property is set to this value.
FeathersControl
Public Methods
 MethodDefined By
  
Constructor.
DefaultGroupedListHeaderOrFooterRenderer
 Inherited
getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle
[override] Feathers components use an optimized getBounds() implementation that may sometimes behave differently than regular Starling display objects.
FeathersControl
 Inherited
hideFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
If the component has not yet initialized, initializes immediately.
FeathersControl
 Inherited
invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending.
FeathersControl
 Inherited
isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not.
FeathersControl
 Inherited
move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single function call.
FeathersControl
 Inherited
Resets the styleProvider property to its default value, which is usually the global style provider for the component.
FeathersControl
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
FeathersControl
 Inherited
showFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
validate():void
Immediately validates the display object, if it is invalid.
FeathersControl
Protected Methods
 MethodDefined By
  
If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself.
DefaultGroupedListHeaderOrFooterRenderer
 Inherited
clearInvalidationFlag(flag:String):void
Clears an invalidation flag.
FeathersControl
 Inherited
draw():void
Override to customize layout and to adjust properties of children.
FeathersControl
 Inherited
focusInHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_IN that may be overridden in subclasses to perform additional actions when the component receives focus.
FeathersControl
 Inherited
focusOutHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_OUT that may be overridden in subclasses to perform additional actions when the component loses focus.
FeathersControl
 Inherited
The next style that is set will not be restricted.
FeathersControl
 Inherited
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
 Inherited
processStyleRestriction(key:Object):Boolean
Used by setters for properties that are considered "styles" to determine if the setter has been called directly on the component or from a style provider.
FeathersControl
 Inherited
Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.
FeathersControl
 Inherited
saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean
Saves the dimensions and minimum dimensions calculated for the component.
FeathersControl
 Inherited
setInvalidationFlag(flag:String):void
Sets an invalidation flag.
FeathersControl
 Inherited
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
 Event Summary Defined By
 InheritedDispatched after the component has validated for the first time.FeathersControl
 InheritedDispatched after initialize() has been called, but before the first time that draw() has been called.FeathersControl
 InheritedDispatched when the width or height of the control changes.FeathersControl
Styles
 StyleDefined By
  
backgroundDisabledSkin : DisplayObject
A background to display when the component is disabled.
DefaultGroupedListHeaderOrFooterRenderer
  
backgroundSkin : DisplayObject
A background to behind the component's content.
DefaultGroupedListHeaderOrFooterRenderer
  
A style name to add to the renderer's label text renderer sub-component.
DefaultGroupedListHeaderOrFooterRenderer
  
disabledFontStyles : TextFormat
The font styles used to display the content label's text when the component is disabled.
DefaultGroupedListHeaderOrFooterRenderer
 Inherited
focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.
FeathersControl
 Inherited
focusPadding : Number
Quickly sets all focus padding properties to the same value.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.
FeathersControl
  
fontStyles : TextFormat
The font styles used to display the content label's text.
DefaultGroupedListHeaderOrFooterRenderer
  
The location where the renderer's content is aligned horizontally (on the x-axis).
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
  
verticalAlign : String
The location where the renderer's content is aligned vertically (on the y-axis).
DefaultGroupedListHeaderOrFooterRenderer
  
wordWrap : Boolean
Determines if the text wraps to the next line when it reaches the width (or max width) of the component.
DefaultGroupedListHeaderOrFooterRenderer
Public Constants
 ConstantDefined By
  DEFAULT_CHILD_STYLE_NAME_CONTENT_LABEL : String = "feathers-header-footer-renderer-content-label"
[static] The default value added to the styleNameList of the content label.
DefaultGroupedListHeaderOrFooterRenderer
 InheritedINVALIDATION_FLAG_ALL : String = "all"
[static] Flag to indicate that everything is invalid and should be redrawn.
FeathersControl
 InheritedINVALIDATION_FLAG_DATA : String = "data"
[static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_FOCUS : String = "focus"
[static] Invalidation flag to indicate that the focus of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_LAYOUT : String = "layout"
[static] Invalidation flag to indicate that the layout of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SCROLL : String = "scroll"
[static] Invalidation flag to indicate that the scroll position of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SELECTED : String = "selected"
[static] Invalidation flag to indicate that the selection of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SIZE : String = "size"
[static] Invalidation flag to indicate that the dimensions of the UI control have changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SKIN : String = "skin"
[static] Invalidation flag to indicate that the skin of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STATE : String = "state"
[static] Invalidation flag to indicate that the state has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STYLES : String = "styles"
[static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.
FeathersControl
Property Detail
contentFieldproperty
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

In the following example, the content field is customized:

renderer.contentField = "header";

The default value is "content".


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

See also

contentFunctionproperty 
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

In the following example, the content function is customized:

renderer.contentFunction = function( item:Object ):DisplayObject
{
   if(item in cachedContent)
   {
       return cachedContent[item];
   }
   var content:DisplayObject = createContentForHeader( item );
   cachedContent[item] = content;
   return content;
};

The default value is null.


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

See also

contentLabelFactoryproperty 
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.

In the following example, a custom content label factory is passed to the renderer:

renderer.contentLabelFactory = function():ITextRenderer
{
    var renderer:TextFieldTextRenderer = new TextFieldTextRenderer();
    renderer.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
    renderer.embedFonts = true;
    return renderer;
};

The default value is null.


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

See also

contentLabelFieldproperty 
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

In the following example, the content label field is customized:

renderer.contentLabelField = "text";

The default value is "label".


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

See also

contentLabelFunctionproperty 
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

In the following example, the content label function is customized:

renderer.contentLabelFunction = function( item:Object ):String
{
   return item.category + " > " + item.subCategory;
};

The default value is null.


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

See also

contentLabelPropertiesproperty 
contentLabelProperties:Object

An object that stores properties for the content label text renderer sub-component, and the properties will be passed down to the text renderer when this component validates. The available properties depend on which ITextRenderer implementation is returned by contentLabelFactory. Refer to feathers.core.ITextRenderer for a list of available text renderer implementations.

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 which is in a SimpleScrollBar, which is in a List, you can use the following syntax:

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

In the following example, a custom content label properties are customized:

renderer.contentLabelProperties.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
renderer.contentLabelProperties.embedFonts = true;

The default value is null.


Implementation
    public function get contentLabelProperties():Object
    public function set contentLabelProperties(value:Object):void

See also

contentLabelStyleNameproperty 
protected var contentLabelStyleName:String = "feathers-header-footer-renderer-content-label"

The value added to the styleNameList of the content label text renderer. This variable is protected so that sub-classes can customize the label text renderer style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_CONTENT_LABEL.

To customize the content label text renderer style name without subclassing, see customContentLabelStyleName.

See also

contentLoaderFactoryproperty 
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 screen density or apply pixel snapping.

In the following example, a custom content loader factory is passed to the renderer:

renderer.contentLoaderFactory = function():ImageLoader
{
    var loader:ImageLoader = new ImageLoader();
    loader.scaleFactor = 2;
    return loader;
};

The default value is function():ImageLoader { return new ImageLoader(); }.


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

See also

contentSourceFieldproperty 
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. contentSourceField
  3. contentLabelFunction
  4. contentLabelField
  5. contentFunction
  6. contentField

In the following example, the content source field is customized:

renderer.contentSourceField = "texture";

The default value is "source".


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

See also

contentSourceFunctionproperty 
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

In the following example, the content source function is customized:

renderer.contentSourceFunction = function( item:Object ):Object
{
   return "http://www.example.com/thumbs/" + item.name + "-thumb.png";
};

The default value is null.


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

See also

dataproperty 
data:Object

Data for a footer renderer from the grouped list's data provider. A footer renderer should be designed with the assumption that its data will change as the list scrolls.

This property is set automatically by the list, and it should not be set manually.


Implementation
    public function get data():Object
    public function set data(value:Object):void
factoryIDproperty 
factoryID:String

The ID of the factory used to create this footer renderer.

This property is set by the list, and should not be set manually.


Implementation
    public function get factoryID():String
    public function set factoryID(value:String):void
globalStyleProviderproperty 
public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all DefaultGroupedListHeaderOrFooterRenderer components.

The default value is null.

See also

groupIndexproperty 
groupIndex:int

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

This property is set automatically by the list, and it should not be set manually.


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

The index of this display object within the layout.

This property is set automatically by the list, and it should not be set manually.


Implementation
    public function get layoutIndex():int
    public function set layoutIndex(value:int):void
numLinesproperty 
numLines:int  [read-only]

The number of text lines displayed by the renderer. The component may contain multiple text lines if the text contains line breaks or if the wordWrap property is enabled.


Implementation
    public function get numLines():int

See also

ownerproperty 
owner:GroupedList

The grouped list that contains this footer renderer.

This property is set automatically by the list, and it should not be set manually.


Implementation
    public function get owner():GroupedList
    public function set owner(value:GroupedList):void
Constructor Detail
DefaultGroupedListHeaderOrFooterRenderer()Constructor
public function DefaultGroupedListHeaderOrFooterRenderer()

Constructor.

Method Detail
autoSizeIfNeeded()method
protected function autoSizeIfNeeded():Boolean

If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself. If the explicitWidth or explicitHeight member variables are set, those value will be used without additional measurement. If one is set, but not the other, the dimension with the explicit value will not be measured, but the other non-explicit dimension will still need measurement.

Calls saveMeasurements() to set up the actualWidth and actualHeight member variables used for layout.

Meant for internal use, and subclasses may override this function with a custom implementation.

Returns
Boolean
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
Style Detail
wordWrapstyle
wordWrap:Boolean

Determines if the text wraps to the next line when it reaches the width (or max width) of the component.

In the following example, the renderer's text is wrapped:

renderer.wordWrap = true;

The default value is false.

verticalAlignstyle 
verticalAlign:String

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

In the following example, the vertical alignment is changed to bottom:

renderer.verticalAlign = VerticalAlign.BOTTOM;

The default value is feathers.layout.VerticalAlign.MIDDLE.

See also

paddingLeftstyle 
paddingLeft:Number

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

In the following example, the left padding is set to 20 pixels:

renderer.paddingLeft = 20;

The default value is 0.

See also

paddingBottomstyle 
paddingBottom:Number

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

In the following example, the bottom padding is set to 20 pixels:

renderer.paddingBottom = 20;

The default value is 0.

See also

paddingRightstyle 
paddingRight:Number

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

In the following example, the right padding is set to 20 pixels:

renderer.paddingRight = 20;

The default value is 0.

See also

paddingTopstyle 
paddingTop:Number

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

In the following example, the top padding is set to 20 pixels:

renderer.paddingTop = 20;

The default value is 0.

See also

paddingstyle 
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.

In the following example, the padding on all four sides is set to 20 pixels:

renderer.padding = 20;

The default value is 0.

See also

horizontalAlignstyle 
horizontalAlign:String

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

In the following example, the horizontal alignment is changed to right:

renderer.horizontalAlign = HorizontalAlign.RIGHT;

The default value is feathers.layout.HorizontalAlign.LEFT.

See also

fontStylesstyle 
fontStyles:TextFormat

The font styles used to display the content label's text.

In the following example, the font styles are customized:

renderer.fontStyles = new TextFormat( "Helvetica", 20, 0xcc0000 );

Note: The starling.text.TextFormat class defines a number of common font styles, but the text renderer being used may support a larger number of ways to be customized. Use the contentLabelFactory to set more advanced styles.

The default value is null.

See also

disabledFontStylesstyle 
disabledFontStyles:TextFormat

The font styles used to display the content label's text when the component is disabled.

In the following example, the disabled font styles are customized:

renderer.disabledFontStyles = new TextFormat( "Helvetica", 20, 0x999999 );

Note: The starling.text.TextFormat class defines a number of common font styles, but the text renderer being used may support a larger number of ways to be customized. Use the contentLabelFactory to set more advanced styles on the text renderer.

The default value is null.

See also

customContentLabelStyleNamestyle 
customContentLabelStyleName:String

A style name to add to the renderer's label text renderer sub-component. Typically used by a theme to provide different styles to different renderers.

In the following example, a custom label style name is passed to the renderer:

renderer.customContentLabelStyleName = "my-custom-header-or-footer-renderer-label";

In your theme, you can target this sub-component style name to provide different styles than the default:

getStyleProviderForClass( BitmapFontTextRenderer ).setFunctionForStyleName( "my-custom-header-or-footer-label", setCustomHeaderOrFooterLabelStyles );

The default value is null.

See also

backgroundDisabledSkinstyle 
backgroundDisabledSkin:DisplayObject

A background to display when the component is disabled.

In the following example, the header renderers is given a disabled background skin:

renderer.backgroundDisabledSkin = new Image( texture );

The default value is null.

See also

backgroundSkinstyle 
backgroundSkin:DisplayObject

A background to behind the component's content.

In the following example, the header renderers is given a background skin:

renderer.backgroundSkin = new Image( texture );

The default value is null.

See also

Constant Detail
DEFAULT_CHILD_STYLE_NAME_CONTENT_LABELConstant
public static const DEFAULT_CHILD_STYLE_NAME_CONTENT_LABEL:String = "feathers-header-footer-renderer-content-label"

The default value added to the styleNameList of the content label.

See also