| Package | feathers.controls.renderers |
| Class | public class LayoutGroupTreeItemRenderer |
| Inheritance | LayoutGroupTreeItemRenderer  LayoutGroup FeathersControl starling.display.Sprite |
| Implements | ITreeItemRenderer |
| Product Version : | Feathers 1.2.0 |
LayoutGroup, this component is meant as a base
class for creating a custom item renderer for a Tree
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 | ||
|---|---|---|---|
 | 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
An item from the tree's data provider. | LayoutGroupTreeItemRenderer | ||
| 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 item renderer. | LayoutGroupTreeItemRenderer | ||
| 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 LayoutGroupTreeItemRenderer
components. | LayoutGroupTreeItemRenderer | ||
| 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 | |
| isBranch : Boolean
Indicates if the data is a branch or a leaf. | LayoutGroupTreeItemRenderer | ||
| 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 | |
| isOpen : Boolean
Indicates if a branch is open or closed. | LayoutGroupTreeItemRenderer | ||
| isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
| isSelected : Boolean
Indicates if the IToggle is selected or not. | LayoutGroupTreeItemRenderer | ||
| 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 the item within the layout. | LayoutGroupTreeItemRenderer | ||
| location : Vector.<int>
The location (a vector of numeric indices, starting from zero) of
the item within the tree's data provider. | LayoutGroupTreeItemRenderer | ||
| 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 : Tree
The tree that contains this item renderer. | LayoutGroupTreeItemRenderer | ||
| 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 | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | LayoutGroupTreeItemRenderer | ||
| 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 | |
| Method | Defined By | ||
|---|---|---|---|
| clearInvalidationFlag(flag:String):void
Clears an invalidation flag. | FeathersControl | |
commitData():void
Updates the renderer to display the item's data. | LayoutGroupTreeItemRenderer | ||
| 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. | LayoutGroupTreeItemRenderer | ||
preLayout():void
Makes final changes to the layout before it updates the item
renderer's children. | LayoutGroupTreeItemRenderer | ||
| 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 | |
| Style | Defined By | ||
|---|---|---|---|
| backgroundDisabledSkin : DisplayObject The background to display behind all content when the layout group is disabled. | LayoutGroup | |
backgroundSelectedSkin : DisplayObject The background to display behind all content when the item renderer is selected. | LayoutGroupTreeItemRenderer | ||
| 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 | |
| data | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesdata:ObjectAn item from the tree'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 tree, and it should not be set manually.
public function get data():Object public function set data(value:Object):void| factoryID | property |
factoryID:StringThe ID of the factory used to create this item renderer.
This property is set by the tree, and it should not be set manually.
public function get factoryID():String public function set factoryID(value:String):void| globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider for all LayoutGroupTreeItemRenderer
components.
The default value is null.
See also
| isBranch | property |
isBranch:BooleanIndicates if the data is a branch or a leaf.
This property is set by the tree, and it should not be set manually.
public function get isBranch():Boolean public function set isBranch(value:Boolean):void| isOpen | property |
isOpen:Boolean
Indicates if a branch is open or closed. An item that is not a
branch will always return false.
This property is set by the tree, and it should not be set manually.
public function get isOpen():Boolean public function set isOpen(value:Boolean):void| isSelected | property |
isSelected:BooleanIndicates if the IToggle is selected or not.
public function get isSelected():Boolean public function set isSelected(value:Boolean):void| layoutIndex | property |
layoutIndex:intThe index of the item within the layout.
This property is set by the tree, and should not be set manually.
public function get layoutIndex():int public function set layoutIndex(value:int):void| location | property |
location:Vector.<int>
The location (a vector of numeric indices, starting from zero) of
the item within the tree's data provider. Like the data
property, this value may change if this item renderer is reused by
the tree for a different item.
This property is set by the tree, and it should not be set manually.
public function get location():Vector.<int> public function set location(value:Vector.<int>):void| owner | property |
owner:TreeThe tree that contains this item renderer.
This property is set by the tree, and it should not be set manually.
public function get owner():Tree public function set owner(value:Tree):void| LayoutGroupTreeItemRenderer | () | Constructor |
public function LayoutGroupTreeItemRenderer()Constructor.
| commitData | () | method |
protected function commitData():voidUpdates 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
| backgroundSelectedSkin | style |
backgroundSelectedSkin:DisplayObjectThe background to display behind all content when the item renderer is selected. The background skin is resized to fill the full width and height of the layout group.
In the following example, the group is given a selected background skin:
group.backgroundSelectedSkin = new Image( texture );
The default value is null.