feathers.controls.renderers.LayoutGroupGroupedListHeaderOrFooterRenderer

Package	feathers.controls.renderers
Class	public class LayoutGroupGroupedListHeaderOrFooterRenderer
Inheritance	LayoutGroupGroupedListHeaderOrFooterRenderer LayoutGroup FeathersControl starling.display.Sprite
Implements	IGroupedListHeaderRenderer, IGroupedListFooterRenderer

Product Version :

Feathers 1.2.0

Based on LayoutGroup, this component is meant as a base class for creating a custom header or footer renderer for a GroupedList component.

Sub-components may be created and added inside initialize(). This is a good place to add event listeners and to set the layout.

The data property may be parsed inside commitData(). Use this function to change properties in your sub-components.

Sub-components may be positioned manually, but a layout may be provided as well. An AnchorLayout is recommended for fluid layouts that can automatically adjust positions when the list resizes. Create AnchorLayoutData objects to define the constraints.

See also

feathers.controls.GroupedList

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		addedEffect : Function An optional effect that is activated when the component is added to the stage.	FeathersControl
		autoSizeMode : String Determines how the layout group will set its own size when its dimensions (width and height) aren't set explicitly.	LayoutGroup
		data : Object Data for a footer renderer from the grouped list's data provider.	LayoutGroupGroupedListHeaderOrFooterRenderer
		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
		depth : int [read-only] The component's depth in the display list, relative to the stage.	FeathersControl
		effectsSuspended : Boolean [read-only] Indicates if effects have been suspended.	FeathersControl
		explicitHeight : Number [read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.	FeathersControl
		explicitMaxHeight : Number [read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.	FeathersControl
		explicitMaxWidth : Number [read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.	FeathersControl
		explicitMinHeight : Number [read-only] The minimum height value explicitly set by passing a value to the minHeight setter.	FeathersControl
		explicitMinWidth : Number [read-only] The minimum width value explicitly set by passing a value to the minWidth setter.	FeathersControl
		explicitWidth : 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.	LayoutGroupGroupedListHeaderOrFooterRenderer
		focusInEffect : Function An optional effect that is activated when the component receives focus.	FeathersControl
		focusManager : 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
		focusOutEffect : Function An optional effect that is activated when the component loses focus.	FeathersControl
		focusOwner : 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 LayoutGroupGroupedListHeaderOrFooterRenderer components.	LayoutGroupGroupedListHeaderOrFooterRenderer
		groupIndex : int The index of the group within the data provider of the grouped list.	LayoutGroupGroupedListHeaderOrFooterRenderer
		height : Number [override] The height of the component, in pixels.	FeathersControl
		hideEffect : Function An optional effect that is activated when the component is hidden.	FeathersControl
		includeInLayout : Boolean Determines if the ILayout should use this object or ignore it.	FeathersControl
		isCreated : Boolean [read-only] Determines if the component has been initialized and validated for the first time.	FeathersControl
		isEnabled : Boolean Indicates whether the control is interactive or not.	FeathersControl
		isFocusEnabled : 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
		isInitialized : Boolean [read-only] Determines if the component has been initialized yet.	FeathersControl
		isQuickHitAreaEnabled : Boolean Similar to mouseChildren on the classic display list.	FeathersControl
		isSelected : Boolean	LayoutGroupGroupedListHeaderOrFooterRenderer
		isShowingFocus : Boolean [read-only] The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Indicates if the showFocus() method has been called on the object when it has focus.	FeathersControl
		layoutData : 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.	LayoutGroupGroupedListHeaderOrFooterRenderer
		maintainTouchFocus : Boolean [read-only] The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. If true, the display object should remain in focus, even if something else is touched.	FeathersControl
		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
		moveEffect : Function An optional effect that is activated when the component is moved to a new position.	FeathersControl
		nextDownFocus : 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 Keyboard.DOWN is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		nextLeftFocus : 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 Keyboard.LEFT is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		nextRightFocus : 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 Keyboard.RIGHT is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		nextTabFocus : 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
		nextUpFocus : 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 Keyboard.UP is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		owner : GroupedList The grouped list that contains this footer renderer.	LayoutGroupGroupedListHeaderOrFooterRenderer
		previousTabFocus : 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
		resizeEffect : Function An optional effect that is activated when the component is resized with new dimensions.	FeathersControl
		showEffect : Function An optional effect that is activated when the component is shown.	FeathersControl
		styleName : String The concatenated styleNameList, with values separated by spaces.	FeathersControl
		styleNameList : TokenList [read-only] Contains a list of all "styles" assigned to this control.	FeathersControl
		styleProvider : IStyleProvider When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.	FeathersControl
		toolTip : String Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.	FeathersControl
		width : Number [override] The width of the component, in pixels.	FeathersControl

	Property	Defined By
		actualHeight : Number = 0 The final height value that should be used for layout.	FeathersControl
		actualMinHeight : Number = 0 The final minimum height value that should be used for layout.	FeathersControl
		actualMinWidth : Number = 0 The final minimum width value that should be used for layout.	FeathersControl
		actualWidth : Number = 0 The final width value that should be used for layout.	FeathersControl
		defaultStyleProvider : IStyleProvider [read-only] When the FeathersControl constructor is called, the styleProvider property is set to this value.	FeathersControl
		items : Vector.<DisplayObject> The items added to the group.	LayoutGroup
		viewPortBounds : ViewPortBounds The view port bounds result object passed to the layout.	LayoutGroup

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		LayoutGroupGroupedListHeaderOrFooterRenderer() Constructor.	LayoutGroupGroupedListHeaderOrFooterRenderer
		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
		hideFocus():void The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.	FeathersControl
		initializeNow():void If the component has not yet initialized, initializes immediately.	FeathersControl
		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
		move(x:Number, y:Number):void Sets both the x and the y positions of the control in a single function call.	FeathersControl
		readjustLayout():void Readjusts the layout of the group according to its current content.	LayoutGroup
		removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void Plays an effect before removing the component from its parent.	FeathersControl
		resetStyleProvider():void Resets the styleProvider property to its default value, which is usually the global style provider for the component.	FeathersControl
		resumeEffects():void Indicates that effects should be re-activated after being suspended.	FeathersControl
		setSize(width:Number, height:Number):void Sets both the width and the height of the control in a single function call.	FeathersControl
		showFocus():void The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.	FeathersControl
		suspendEffects():void Indicates that effects should not be activated temporarily.	FeathersControl
		validate():void Immediately validates the display object, if it is invalid.	FeathersControl

Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		clearInvalidationFlag(flag:String):void Clears an invalidation flag.	FeathersControl
		commitData():void Updates the renderer to display the item's data.	LayoutGroupGroupedListHeaderOrFooterRenderer
		draw():void Override to customize layout and to adjust properties of children.	FeathersControl
		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
		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
		ignoreNextStyleRestriction():void The next style that is set will not be restricted.	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
		postLayout():void Called after the layout updates the item renderer's children.	LayoutGroupGroupedListHeaderOrFooterRenderer
		preLayout():void Makes final changes to the layout before it updates the item renderer's children.	LayoutGroupGroupedListHeaderOrFooterRenderer
		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
		refreshBackgroundSkin():void Choose the appropriate background skin based on the control's current state.	LayoutGroup
		refreshFocusIndicator():void Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.	FeathersControl
		refreshViewPortBounds():void Refreshes the values in the viewPortBounds variable that is passed to the layout.	LayoutGroup
		saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean Saves the dimensions and minimum dimensions calculated for the component.	FeathersControl
		setInvalidationFlag(flag:String):void Sets an invalidation flag.	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

Summary	Defined By
creationComplete	Dispatched after the component has validated for the first time.	FeathersControl
initialize	Dispatched after initialize() has been called, but before the first time that draw() has been called.	FeathersControl
resize	Dispatched when the width or height of the control changes.	FeathersControl

	Style	Defined By
		backgroundDisabledSkin : DisplayObject The background to display behind all content when the layout group is disabled.	LayoutGroup
		backgroundSkin : DisplayObject The default background to display behind all content.	LayoutGroup
		clipContent : Boolean If true, the group will be clipped to its bounds.	LayoutGroup
		focusIndicatorSkin : DisplayObject If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.	FeathersControl
		focusPadding : Number Quickly sets all focus padding properties to the same value.	FeathersControl
		focusPaddingBottom : Number The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.	FeathersControl
		focusPaddingLeft : Number The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.	FeathersControl
		focusPaddingRight : Number The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.	FeathersControl
		focusPaddingTop : Number The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.	FeathersControl
		layout : ILayout Controls the way that the group's children are positioned and sized.	LayoutGroup

	Constant	Defined By
		ALTERNATE_STYLE_NAME_TOOLBAR : String = "feathers-toolbar-layout-group" [static] An alternate style name to use with LayoutGroup to allow a theme to give it a toolbar style.	LayoutGroup
		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_FOCUS : String = "focus" [static] Invalidation flag to indicate that the focus of 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

	Constant	Defined By
		INVALIDATION_FLAG_CLIPPING : String = "clipping" [static] Flag to indicate that the clipping has changed.	LayoutGroup

Property Detail

data

property

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

factoryID

property

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

globalStyleProvider

property

public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all LayoutGroupGroupedListHeaderOrFooterRenderer components.

The default value is null.

groupIndex

property

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

isSelected

property

isSelected:Boolean

Implementation
public function get isSelected():Boolean
public function set isSelected(value:Boolean):void

layoutIndex

property

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

owner

property

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

LayoutGroupGroupedListHeaderOrFooterRenderer

()

Constructor

public function LayoutGroupGroupedListHeaderOrFooterRenderer()

Constructor.

Method Detail

commitData

()

method

protected function commitData():void

Updates the renderer to display the item's data. Override this function to pass data to sub-components and react to data changes.

Don't forget to handle the case where the data is null.

postLayout

()

method

protected function postLayout():void

Called after the layout updates the item renderer's children. If any children are excluded from the layout, you can update them in the postLayout() function if you need to use the final width and height in any calculations.

In subclasses, if you create properties that affect the layout, invalidate using INVALIDATION_FLAG_LAYOUT to trigger a call to the postLayout() function when the component validates.

To make changes to the layout before it updates the item renderer's children, override the preLayout() function instead.

See also

preLayout()

preLayout

()

method

protected function preLayout():void

Makes final changes to the layout before it updates the item renderer's children. If your layout requires changing the layoutData property on the item renderer's sub-components, override the preLayout() function to make those changes.

In subclasses, if you create properties that affect the layout, invalidate using INVALIDATION_FLAG_LAYOUT to trigger a call to the preLayout() function when the component validates.

The final width and height of the item renderer are not yet known when this function is called. It is meant mainly for adjusting values used by fluid layouts, such as constraints or percentages. If you need io access the final width and height of the item renderer, override the postLayout() function instead.

See also

postLayout()

Sat Jun 18 2022, 02:58 PM -07:00

Feathers (Starling) 4.1.1 API Reference	All Packages All Classes Index Frames No Frames
LayoutGroupGroupedListHeaderOrFooterRenderer	Properties Methods Events Styles Constants