Package | feathers.controls.renderers |
Class | public class LayoutGroupGroupedListItemRenderer |
Inheritance | LayoutGroupGroupedListItemRenderer ![]() ![]() ![]() |
Implements | IGroupedListItemRenderer |
LayoutGroup
, this component is meant as a base
class for creating a custom item 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
Property | Defined By | ||
---|---|---|---|
![]() | autoSizeMode : String
Determines how the layout group will set its own size when its
dimensions (width and height) aren't set explicitly. | LayoutGroup | |
![]() | 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 | |
data : Object
An item from the grouped list's data provider. | LayoutGroupGroupedListItemRenderer | ||
![]() | 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 | |
![]() | focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be
displayed above the component when showFocus() is
called. | FeathersControl | |
![]() | focusManager : IFocusManager | FeathersControl | |
![]() | focusOwner : IFocusDisplayObject | 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 | |
globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all LayoutGroupGroupedListItemRenderer
components. | LayoutGroupGroupedListItemRenderer | ||
groupIndex : int
The index of the item's parent group within the data provider of the
grouped list. | LayoutGroupGroupedListItemRenderer | ||
![]() | 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 | |
![]() | 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 | 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
Indicates if the IToggle is selected or not. | LayoutGroupGroupedListItemRenderer | ||
itemIndex : int
The index of the item within its parent group. | LayoutGroupGroupedListItemRenderer | ||
![]() | layout : ILayout
Controls the way that the group's children are positioned and sized. | LayoutGroup | |
![]() | 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. | LayoutGroupGroupedListItemRenderer | ||
![]() | 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 | |
![]() | nextTabFocus : IFocusDisplayObject | FeathersControl | |
owner : GroupedList
The grouped list that contains this item renderer. | LayoutGroupGroupedListItemRenderer | ||
![]() | previousTabFocus : IFocusDisplayObject | 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 | |
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
Constructor. | LayoutGroupGroupedListItemRenderer | ||
![]() | hideFocus():void
If the visual indicator of focus has been displayed by
showFocus(), call this function to hide it. | 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 | |
![]() | setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | |
![]() | showFocus():void
If the object has focus, an additional visual indicator may
optionally be displayed to highlight the object. | FeathersControl | |
![]() | validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
![]() | clearInvalidationFlag(flag:String):void
Clears an invalidation flag. | FeathersControl | |
commitData():void
Updates the renderer to display the item's data. | LayoutGroupGroupedListItemRenderer | ||
![]() | 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 | |
![]() | 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. | LayoutGroupGroupedListItemRenderer | ||
preLayout():void
Makes final changes to the layout before it updates the item
renderer's children. | LayoutGroupGroupedListItemRenderer | ||
![]() | 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 | |
![]() | 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 |
data | property |
data:Object
An item from the grouped list's data provider. The data may change if this item renderer is reused for a new item because it's no longer needed for the original item.
This property is set by the list, and should not be set manually.
public function get data():Object
public function set data(value:Object):void
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all LayoutGroupGroupedListItemRenderer
components.
The default value is null
.
See also
groupIndex | property |
groupIndex:int
The index of the item's parent group within the data provider of the grouped list.
This property is set by the list, and should not be set manually.
public function get groupIndex():int
public function set groupIndex(value:int):void
isSelected | property |
isSelected:Boolean
Indicates if the IToggle is selected or not.
public function get isSelected():Boolean
public function set isSelected(value:Boolean):void
itemIndex | property |
itemIndex:int
The index of the item within its parent group.
This property is set by the list, and should not be set manually.
public function get itemIndex():int
public function set itemIndex(value:int):void
layoutIndex | property |
layoutIndex:int
The index of the item within the layout.
This property is set by the list, and should not be set manually.
public function get layoutIndex():int
public function set layoutIndex(value:int):void
owner | property |
owner:GroupedList
The grouped list that contains this item renderer.
This property is set by the list, and should not be set manually.
public function get owner():GroupedList
public function set owner(value:GroupedList):void
LayoutGroupGroupedListItemRenderer | () | Constructor |
public function LayoutGroupGroupedListItemRenderer()
Constructor.
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 | () | 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