feathers.controls.renderers.DefaultTreeItemRenderer

Public Properties

	Property		Defined By
		accessoryField : String The field in the item that contains a display object to be positioned in the accessory position of the renderer.	BaseDefaultItemRenderer
		accessoryFunction : Function A function that returns a display object to be positioned in the accessory position of the renderer.	BaseDefaultItemRenderer
		accessoryLabelFactory : Function A function that generates ITextRenderer that uses the result of accessoryLabelField or accessoryLabelFunction.	BaseDefaultItemRenderer
		accessoryLabelField : String The field in the item that contains a string to be displayed in a renderer-managed ITextRenderer in the accessory position of the renderer.	BaseDefaultItemRenderer
		accessoryLabelFunction : Function A function that returns a string to be displayed in a renderer-managed ITextRenderer in the accessory position of the renderer.	BaseDefaultItemRenderer
		accessoryLabelProperties : Object An object that stores properties for the accessory label text renderer sub-component (if using accessoryLabelField or accessoryLabelFunction), and the properties will be passed down to the text renderer when this component validates.	BaseDefaultItemRenderer
		accessoryLoaderFactory : Function A function that generates an ImageLoader that uses the result of accessorySourceField or accessorySourceFunction.	BaseDefaultItemRenderer
		accessorySourceField : String A field in the item that contains a starling.textures.Texture or a URL that points to a bitmap to be used as the item renderer's accessory.	BaseDefaultItemRenderer
		accessorySourceFunction : Function A function that generates a starling.textures.Texture or a URL that points to a bitmap to be used as the item renderer's accessory.	BaseDefaultItemRenderer
		addedEffect : Function An optional effect that is activated when the component is added to the stage.	FeathersControl
		baseline : Number [read-only] Returns the text baseline measurement, in pixels.	Button
		currentState : String [read-only] The current state of the button.	BasicButton
		data : Object The item displayed by this renderer.	BaseDefaultItemRenderer
		defaultAccessory : DisplayObject The accessory used when no other accessory is defined for the current state.	BaseDefaultItemRenderer
		defaultLabelProperties : Object An object that stores properties for the button's label text renderer when no specific properties are defined for the button's current state, and the properties will be passed down to the label text renderer when the button validates.	Button
		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
		delayTextureCreationOnScroll : Boolean If enabled, automatically manages the delayTextureCreation property on accessory and icon ImageLoader instances when the owner scrolls.	BaseDefaultItemRenderer
		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
		enabledField : String The field in the item that determines if the item renderer is enabled, if the list is enabled.	BaseDefaultItemRenderer
		enabledFunction : Function A function used to determine if a specific item is enabled.	BaseDefaultItemRenderer
		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.	BaseDefaultItemRenderer
		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 DefaultTreeItemRenderer components.	DefaultTreeItemRenderer
		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
		iconField : String The field in the item that contains a display object to be displayed as an icon or other graphic next to the label in the renderer.	BaseDefaultItemRenderer
		iconFunction : Function A function used to generate an icon for a specific item.	BaseDefaultItemRenderer
		iconLabelFactory : Function A function that generates ITextRenderer that uses the result of iconLabelField or iconLabelFunction.	BaseDefaultItemRenderer
		iconLabelField : String The field in the item that contains a string to be displayed in a renderer-managed ITextRenderer in the icon position of the renderer.	BaseDefaultItemRenderer
		iconLabelFunction : Function A function that returns a string to be displayed in a renderer-managed ITextRenderer in the icon position of the renderer.	BaseDefaultItemRenderer
		iconLabelProperties : Object An object that stores properties for the icon label text renderer sub-component (if using iconLabelField or iconLabelFunction), and the properties will be passed down to the text renderer when this component validates.	BaseDefaultItemRenderer
		iconLoaderFactory : Function A function that generates an ImageLoader that uses the result of iconSourceField or iconSourceFunction.	BaseDefaultItemRenderer
		iconSourceField : String The field in the item that contains a starling.textures.Texture or a URL that points to a bitmap to be used as the item renderer's icon.	BaseDefaultItemRenderer
		iconSourceFunction : Function A function used to generate a starling.textures.Texture or a URL that points to a bitmap to be used as the item renderer's icon.	BaseDefaultItemRenderer
		includeInLayout : Boolean Determines if the ILayout should use this object or ignore it.	FeathersControl
		isChildFocusEnabled : Boolean Determines if this component's children can receive focus.	BaseDefaultItemRenderer
		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
		isLongPressEnabled : Boolean Determines if FeathersEventType.LONG_PRESS will be dispatched.	Button
		isQuickHitAreaEnabled : Boolean Similar to mouseChildren on the classic display list.	FeathersControl
		isSelectableOnAccessoryTouch : Boolean If enabled, the item renderer may be selected by touching the accessory.	BaseDefaultItemRenderer
		isSelected : Boolean Indicates if the button is selected or not.	ToggleButton
		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
		isToggle : Boolean Determines if the button may be selected or deselected as a result of user interaction.	ToggleButton
		itemHasAccessory : Boolean If true, the accessory will come from the renderer's item using the appropriate field or function for the accessory.	BaseDefaultItemRenderer
		itemHasEnabled : Boolean If true, the renderer's enabled state will come from the renderer's item using the appropriate field or function for enabled.	BaseDefaultItemRenderer
		itemHasIcon : Boolean If true, the icon will come from the renderer's item using the appropriate field or function for the icon.	BaseDefaultItemRenderer
		itemHasLabel : Boolean If true, the label will come from the renderer's item using the appropriate field or function for the label.	BaseDefaultItemRenderer
		itemHasSelectable : Boolean If true, the ability to select the renderer will come from the renderer's item using the appropriate field or function for selectable.	BaseDefaultItemRenderer
		itemHasSkin : Boolean If true, the skin will come from the renderer's item using the appropriate field or function for the skin.	BaseDefaultItemRenderer
		label : String The text displayed on the button.	Button
		labelFactory : Function A function used to instantiate the button's label text renderer sub-component.	Button
		labelField : String The field in the item that contains the label text to be displayed by the renderer.	BaseDefaultItemRenderer
		labelFunction : Function A function used to generate label text for a specific item.	BaseDefaultItemRenderer
		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.	DefaultTreeItemRenderer
		location : Vector.<int> The location (a vector of numeric indices, starting from zero) of the item within the tree's data provider.	DefaultTreeItemRenderer
		longPressDuration : Number The duration, in seconds, of a long press.	Button
		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
		numLines : int [read-only] The number of text lines displayed by the button.	Button
		owner : Tree The tree that contains this item renderer.	DefaultTreeItemRenderer
		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
		selectableField : String The field in the item that determines if the item renderer can be selected, if the list allows selection.	BaseDefaultItemRenderer
		selectableFunction : Function A function used to determine if a specific item is selectable.	BaseDefaultItemRenderer
		showEffect : Function An optional effect that is activated when the component is shown.	FeathersControl
		skinField : String The field in the item that contains a display object to be displayed as a background skin.	BaseDefaultItemRenderer
		skinFunction : Function A function used to generate a background skin for a specific item.	BaseDefaultItemRenderer
		skinLoaderFactory : Function A function that generates an ImageLoader that uses the result of skinSourceField or skinSourceFunction.	BaseDefaultItemRenderer
		skinSourceField : String The field in the item that contains a starling.textures.Texture or a URL that points to a bitmap to be used as the item renderer's skin.	BaseDefaultItemRenderer
		skinSourceFunction : Function A function used to generate a starling.textures.Texture or a URL that points to a bitmap to be used as the item renderer's skin.	BaseDefaultItemRenderer
		stopScrollingOnAccessoryTouch : Boolean If enabled, calls owner.stopScrolling() when TouchEvents are dispatched by the accessory.	BaseDefaultItemRenderer
		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
		toggleGroup : ToggleGroup When the toggle is added to a ToggleGroup, the group will manage the entire group's selection when one of the toggles in the group changes.	ToggleButton
		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

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined By
		accessoryLabelStyleName : String = "feathers-item-renderer-accessory-label" The value added to the styleNameList of the accessory label text renderer, if it exists.	BaseDefaultItemRenderer
		accessoryLoaderStyleName : String = "feathers-item-renderer-accessory-loader" The value added to the styleNameList of the accessory loader, if it exists.	BaseDefaultItemRenderer
		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
		currentIcon : DisplayObject The currently visible icon.	Button
		currentSkin : DisplayObject The currently visible skin.	BasicButton
		defaultStyleProvider : IStyleProvider [read-only] When the FeathersControl constructor is called, the styleProvider property is set to this value.	FeathersControl
		iconLabelStyleName : String = "feathers-item-renderer-icon-label" The value added to the styleNameList of the icon label text renderer, if it exists.	BaseDefaultItemRenderer
		iconLoaderStyleName : String = "feathers-item-renderer-icon-loader" The value added to the styleNameList of the icon loader, if it exists.	BaseDefaultItemRenderer
		isSelectableWithoutToggle : Boolean = true Determines if the item renderer can be selected even if isToggle is set to false.	BaseDefaultItemRenderer
		labelStyleName : String = "feathers-button-label" The value added to the styleNameList of the label text renderer.	Button
		labelTextRenderer : ITextRenderer The text renderer for the button's label.	Button

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		DefaultTreeItemRenderer() Constructor.	DefaultTreeItemRenderer
		getAccessoryForState(state:String):DisplayObject Gets the accessory to be used by the item renderer when the item renderer's currentState property matches the specified state value.	BaseDefaultItemRenderer
		getAccessoryLabelFontStylesForState(state:String):TextFormat Gets the font styles to be used to display the item renderer's accessory label text when the item renderer's currentState property matches the specified state value.	BaseDefaultItemRenderer
		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
		getFontStylesForState(state:String):TextFormat Gets the font styles to be used to display the button's text when the button's currentState property matches the specified state value.	Button
		getIconForState(state:String):DisplayObject Gets the icon to be used by the button when the button's currentState property matches the specified state value.	Button
		getIconLabelFontStylesForState(state:String):TextFormat Gets the font styles to be used to display the item renderer's icon label text when the item renderer's currentState property matches the specified state value.	BaseDefaultItemRenderer
		getScaleForState(state:String):Number Gets the scale to be used by the button when the button's currentState property matches the specified state value.	Button
		getSkinForState(state:String):DisplayObject Gets the skin to be used by the button when its currentState property matches the specified state value.	BasicButton
		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
		itemToLabel(item:Object):String Using labelField and labelFunction, generates a label from the item.	BaseDefaultItemRenderer
		move(x:Number, y:Number):void Sets both the x and the y positions of the control in a single function call.	FeathersControl
		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
		setAccessoryForState(state:String, accessory:DisplayObject):void Sets the accessory to be used by the item renderer when the item renderer's currentState property matches the specified state value.	BaseDefaultItemRenderer
		setAccessoryLabelFontStylesForState(state:String, format:TextFormat):void Sets the font styles to be used to display the accessory label's text when the item renderer's currentState property matches the specified state value.	BaseDefaultItemRenderer
		setFontStylesForState(state:String, format:TextFormat):void Sets the font styles to be used to display the button's text when the button's currentState property matches the specified state value.	Button
		setIconForState(state:String, icon:DisplayObject):void Sets the icon to be used by the button when the button's currentState property matches the specified state value.	Button
		setIconLabelFontStylesForState(state:String, format:TextFormat):void Sets the font styles to be used to display the icon label's text when the item renderer's currentState property matches the specified state value.	BaseDefaultItemRenderer
		setScaleForState(state:String, scale:Number):void Sets the scale to be used by the button when the button's currentState property matches the specified state value.	Button
		setSize(width:Number, height:Number):void Sets both the width and the height of the control in a single function call.	FeathersControl
		setSkinForState(state:String, skin:DisplayObject):void Sets the skin to be used by the button when its currentState property matches the specified state value.	BasicButton
		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
		autoSizeIfNeeded():Boolean [override] If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself.	BaseDefaultItemRenderer
		clearInvalidationFlag(flag:String):void Clears an invalidation flag.	FeathersControl
		commitData():void Updates the renderer to display the item's data.	BaseDefaultItemRenderer
		createLabel():void Creates the label text renderer sub-component and removes the old instance, if one exists.	Button
		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
		itemToAccessory(item:Object):DisplayObject Uses the accessory fields and functions to generate an accessory for a specific item.	BaseDefaultItemRenderer
		itemToEnabled(item:Object):Boolean Uses the enabled fields and functions to generate a enabled value for a specific item.	BaseDefaultItemRenderer
		itemToIcon(item:Object):DisplayObject Uses the icon fields and functions to generate an icon for a specific item.	BaseDefaultItemRenderer
		itemToSelectable(item:Object):Boolean Uses the selectable fields and functions to generate a selectable value for a specific item.	BaseDefaultItemRenderer
		itemToSkin(item:Object):DisplayObject Uses the skin fields and functions to generate a skin for a specific item.	BaseDefaultItemRenderer
		layoutContent():void Positions and sizes the button's content.	Button
		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
		refreshFocusIndicator():void Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.	FeathersControl
		refreshIcon():void Sets the currentIcon property.	Button
		refreshSkin():void Sets the currentSkin property.	BasicButton
		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

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
change	Dispatched when the button is selected or deselected either programmatically or as a result of user interaction.	ToggleButton
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
longPress	Dispatched when the button is pressed for a long time.	Button
resize	Dispatched when the width or height of the control changes.	FeathersControl
stateChange	Dispatched when the display object's state changes.	BasicButton
triggered	Dispatched when the the user taps or clicks the button.	BasicButton

Styles

Hide Inherited Styles

Show Inherited Styles

	Style		Defined By
		accessoryGap : Number The space, in pixels, between the accessory and the other child it is positioned relative to.	BaseDefaultItemRenderer
		accessoryLabelDisabledFontStyles : TextFormat The font styles used to display the item renderer's accessory label text when the item renderer is disabled.	BaseDefaultItemRenderer
		accessoryLabelFontStyles : TextFormat The font styles used to display the item renderer's accessory label text.	BaseDefaultItemRenderer
		accessoryLabelSelectedFontStyles : TextFormat The font styles used to display the item renderer's accessory label text when the item renderer is selected.	BaseDefaultItemRenderer
		accessoryOffsetX : Number Offsets the x position of the accessory by a certain number of pixels.	BaseDefaultItemRenderer
		accessoryOffsetY : Number Offsets the y position of the accessory by a certain number of pixels.	BaseDefaultItemRenderer
		accessoryPosition : String The location of the accessory, relative to one of the other children.	BaseDefaultItemRenderer
		branchClosedIcon : DisplayObject The icon used to indicate if the tree item is a closed branch.	DefaultTreeItemRenderer
		branchIcon : DisplayObject The icon used to indicate if the tree item is a branch.	DefaultTreeItemRenderer
		branchOpenIcon : DisplayObject The icon used to indicate if the tree item is an open branch.	DefaultTreeItemRenderer
		customAccessoryLabelStyleName : String A style name to add to the item renderer's accessory label text renderer sub-component.	BaseDefaultItemRenderer
		customAccessoryLoaderStyleName : String A style name to add to the item renderer's accessory loader sub-component.	BaseDefaultItemRenderer
		customIconLabelStyleName : String A style name to add to the item renderer's icon label text renderer sub-component.	BaseDefaultItemRenderer
		customIconLoaderStyleName : String A style name to add to the item renderer's icon loader sub-component.	BaseDefaultItemRenderer
		customLabelStyleName : String A style name to add to the button's label text renderer sub-component.	Button
		defaultIcon : DisplayObject The icon used when no other icon is defined for the current state.	Button
		defaultSelectedIcon : DisplayObject The icon used when no other icon is defined for the current state when the button is selected.	ToggleButton
		defaultSelectedSkin : DisplayObject The skin used when no other skin is defined for the current state when the button is selected.	ToggleButton
		defaultSkin : DisplayObject The skin used when no other skin is defined for the current state.	BasicButton
		disabledFontStyles : TextFormat The font styles used to display the button's text when the button is disabled.	Button
		disabledIcon : DisplayObject The icon used for the button's disabled state.	Button
		disabledSkin : DisplayObject The skin used for the button's disabled state.	BasicButton
		disclosureClosedIcon : DisplayObject The icon used to indicate if the tree item is closed.	DefaultTreeItemRenderer
		disclosureGap : Number The space, in pixels, between the disclosure icon and left edge of the other children in the item renderer.	DefaultTreeItemRenderer
		disclosureIcon : DisplayObject The icon used to indicate if the tree item is open or closed.	DefaultTreeItemRenderer
		disclosureOpenIcon : DisplayObject The icon used to indicate if the tree item is open.	DefaultTreeItemRenderer
		downIcon : DisplayObject The icon used for the button's down state.	Button
		downSkin : DisplayObject The skin used for the button's down state.	BasicButton
		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
		fontStyles : TextFormat The font styles used to display the button's text.	Button
		gap : Number The space, in pixels, between the icon and the label.	Button
		hasLabelTextRenderer : Boolean Determines if the button's label text renderer is created or not.	Button
		horizontalAlign : String The location where the button's content is aligned horizontally (on the x-axis).	Button
		hoverIcon : DisplayObject The icon used for the button's hover state.	Button
		hoverSkin : DisplayObject The skin used for the button's hover state.	BasicButton
		iconLabelDisabledFontStyles : TextFormat The font styles used to display the item renderer's icon label text when the item renderer is disabled.	BaseDefaultItemRenderer
		iconLabelFontStyles : TextFormat The font styles used to display the item renderer's icon label text.	BaseDefaultItemRenderer
		iconLabelSelectedFontStyles : TextFormat The font styles used to display the item renderer's icon label text when the item renderer is selected.	BaseDefaultItemRenderer
		iconOffsetX : Number Offsets the x position of the icon by a certain number of pixels.	Button
		iconOffsetY : Number Offsets the y position of the icon by a certain number of pixels.	Button
		iconPosition : String The location of the icon, relative to the label.	Button
		indentation : Number The size, in pixels, of the indentation when an item is a child of a branch.	DefaultTreeItemRenderer
		keepDownStateOnRollOut : Boolean Determines if a pressed button should remain in the down state if a touch moves outside of the button's bounds.	BasicButton
		labelOffsetX : Number Offsets the x position of the label by a certain number of pixels.	Button
		labelOffsetY : Number Offsets the y position of the label by a certain number of pixels.	Button
		layoutOrder : String The accessory's position will be based on which other child (the label or the icon) the accessory should be relative to.	BaseDefaultItemRenderer
		leafIcon : DisplayObject The icon used to indicate if the tree item is a leaf.	DefaultTreeItemRenderer
		minAccessoryGap : Number If the value of the accessoryGap property is Number.POSITIVE_INFINITY, meaning that the gap will fill as much space as possible, the final calculated value will not be smaller than the value of the minAccessoryGap property.	BaseDefaultItemRenderer
		minGap : Number If the value of the gap property is Number.POSITIVE_INFINITY, meaning that the gap will fill as much space as possible, the final calculated value will not be smaller than the value of the minGap property.	Button
		padding : Number Quickly sets all padding properties to the same value.	Button
		paddingBottom : Number The minimum space, in pixels, between the button's bottom edge and the button's content.	Button
		paddingLeft : Number The minimum space, in pixels, between the button's left edge and the button's content.	Button
		paddingRight : Number The minimum space, in pixels, between the button's right edge and the button's content.	Button
		paddingTop : Number The minimum space, in pixels, between the button's top edge and the button's content.	Button
		scaleWhenDown : Number The button renders at this scale in the down state.	Button
		scaleWhenHovering : Number The button renders at this scale in the hover state.	Button
		scaleWhenSelected : Number If not NaN, the button renders at this scale when selected.	ToggleButton
		selectedDisabledIcon : DisplayObject The icon used for the button's disabled state when the button is selected.	ToggleButton
		selectedDisabledSkin : DisplayObject The skin used for the button's disabled state when the button is selected.	ToggleButton
		selectedDownIcon : DisplayObject The icon used for the button's down state when the button is selected.	ToggleButton
		selectedDownSkin : DisplayObject The skin used for the button's down state when the button is selected.	ToggleButton
		selectedFontStyles : TextFormat The font styles used to display the button's text when the button is selected.	ToggleButton
		selectedHoverIcon : DisplayObject The icon used for the button's hover state when the button is selected.	ToggleButton
		selectedHoverSkin : DisplayObject The skin used for the button's hover state when the button is selected.	ToggleButton
		selectedUpIcon : DisplayObject The icon used for the button's up state when the button is selected.	ToggleButton
		selectedUpSkin : DisplayObject The skin used for the button's up state when the button is selected.	ToggleButton
		upIcon : DisplayObject The icon used for the button's up state.	Button
		upSkin : DisplayObject The skin used for the button's up state.	BasicButton
		useStateDelayTimer : Boolean If true, the down state (and subsequent state changes) will be delayed to improve the user experience when scrolling on a touch screen.	BaseDefaultItemRenderer
		verticalAlign : String The location where the button's content is aligned vertically (on the y-axis).	Button
		wordWrap : Boolean Determines if the text wraps to the next line when it reaches the width (or max width) of the component.	Button

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		ALTERNATE_STYLE_NAME_BACK_BUTTON : String = "feathers-back-button" [static] An alternate style name to use with Button to allow a theme to give it a "back button" style, perhaps with an arrow pointing backward.	Button
		ALTERNATE_STYLE_NAME_CALL_TO_ACTION_BUTTON : String = "feathers-call-to-action-button" [static] An alternate style name to use with Button to allow a theme to give it a more prominent, "call-to-action" style.	Button
		ALTERNATE_STYLE_NAME_CHECK : String = "feathers-check-item-renderer" [static] An alternate style name to use with the default item renderer to allow a theme to give it a "check" style.	BaseDefaultItemRenderer
		ALTERNATE_STYLE_NAME_DANGER_BUTTON : String = "feathers-danger-button" [static] An alternate style name to use with Button to allow a theme to give it a highly prominent, "danger" style.	Button
		ALTERNATE_STYLE_NAME_DRILL_DOWN : String = "feathers-drill-down-item-renderer" [static] An alternate style name to use with the default item renderer to allow a theme to give it a "drill-down" style.	BaseDefaultItemRenderer
		ALTERNATE_STYLE_NAME_FORWARD_BUTTON : String = "feathers-forward-button" [static] An alternate style name to use with Button to allow a theme to give it a "forward" button style, perhaps with an arrow pointing forward.	Button
		ALTERNATE_STYLE_NAME_QUIET_BUTTON : String = "feathers-quiet-button" [static] An alternate style name to use with Button to allow a theme to give it a less prominent, "quiet" style.	Button
		DEFAULT_CHILD_STYLE_NAME_ACCESSORY_LABEL : String = "feathers-item-renderer-accessory-label" [static] The default value added to the styleNameList of the accessory label, if it exists.	DefaultTreeItemRenderer
		DEFAULT_CHILD_STYLE_NAME_ACCESSORY_LOADER : String = "feathers-item-renderer-accessory-loader" [static] The default value added to the styleNameList of the accessory loader, if it exists.	BaseDefaultItemRenderer
		DEFAULT_CHILD_STYLE_NAME_ICON_LABEL : String = "feathers-item-renderer-icon-label" [static] The default value added to the styleNameList of the icon label, if it exists.	DefaultTreeItemRenderer
		DEFAULT_CHILD_STYLE_NAME_ICON_LOADER : String = "feathers-item-renderer-icon-loader" [static] The default value added to the styleNameList of the icon loader, if it exists.	BaseDefaultItemRenderer
		DEFAULT_CHILD_STYLE_NAME_LABEL : String = "feathers-item-renderer-label" [static] The default value added to the styleNameList of the primary label.	DefaultTreeItemRenderer
		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

Property Detail

globalStyleProvider

property

public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all DefaultTreeItemRenderer components.

The default value is null.

layoutIndex

property

layoutIndex:int

The index of the item within the layout.

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

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

Implementation
public function get location():Vector.<int>
public function set location(value:Vector.<int>):void

owner

property

owner:Tree

The tree that contains this item renderer.

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

Implementation
public function get owner():Tree
public function set owner(value:Tree):void

Constructor Detail

DefaultTreeItemRenderer

()

Constructor

public function DefaultTreeItemRenderer()

Constructor.

Style Detail

leafIcon

style

leafIcon:DisplayObject

The icon used to indicate if the tree item is a leaf.

The following example gives the item renderer a leaf icon:

itemRenderer.leafIcon = new Image( texture );

The default value is null.

indentation

style

indentation:Number

The size, in pixels, of the indentation when an item is a child of a branch.

In the following example, the indentation is set to 15 pixels:

itemRenderer.indentation = 15;

The default value is 10.

disclosureClosedIcon

style

disclosureClosedIcon:DisplayObject

The icon used to indicate if the tree item is closed. If null, the disclosureIcon will be used instead.

The following example gives the item renderer a disclosure closed icon:

itemRenderer.disclosureClosedIcon = new Image( texture );

The default value is null.

See also

disclosureOpenIcon

style

disclosureOpenIcon:DisplayObject

The icon used to indicate if the tree item is open. If null, the disclosureIcon will be used instead.

The following example gives the item renderer a disclosure open icon:

itemRenderer.disclosureOpenIcon = new Image( texture );

The default value is null.

See also

disclosureClosedIcon

disclosureIcon

style

disclosureIcon:DisplayObject

The icon used to indicate if the tree item is open or closed.

The following example gives the item renderer a disclosure icon:

itemRenderer.disclosureIcon = new Image( texture );

The default value is null.

See also

disclosureOpenIcon
disclosureClosedIcon

disclosureGap

style

disclosureGap:Number

The space, in pixels, between the disclosure icon and left edge of the other children in the item renderer. If the value is NaN, the value of the gap property will be used instead.

In the following example, the disclosure gap is set to 20 pixels:

itemRenderer.disclosureGap = 20;

The default value is NaN.

See also

gap

branchClosedIcon

style

branchClosedIcon:DisplayObject

The icon used to indicate if the tree item is a closed branch. If null, the branchIcon will be used instead.

The following example gives the item renderer a branch closed icon:

itemRenderer.branchClosedIcon = new Image( texture );

The default value is null.

See also

branchOpenIcon

style

branchOpenIcon:DisplayObject

The icon used to indicate if the tree item is an open branch. If null, the branchIcon will be used instead.

The following example gives the item renderer a branch open icon:

itemRenderer.branchOpenIcon = new Image( texture );

The default value is null.

See also

branchClosedIcon

branchIcon

style

branchIcon:DisplayObject

The icon used to indicate if the tree item is a branch.

The following example gives the item renderer a branch icon:

itemRenderer.branchIcon = new Image( texture );

The default value is null.

See also

branchOpenIcon
branchClosedIcon

Constant Detail

DEFAULT_CHILD_STYLE_NAME_ACCESSORY_LABEL

Constant

public static const DEFAULT_CHILD_STYLE_NAME_ACCESSORY_LABEL:String = "feathers-item-renderer-accessory-label"

The default value added to the styleNameList of the accessory label, if it exists.

DEFAULT_CHILD_STYLE_NAME_ICON_LABEL

Constant

public static const DEFAULT_CHILD_STYLE_NAME_ICON_LABEL:String = "feathers-item-renderer-icon-label"

The default value added to the styleNameList of the icon label, if it exists.

DEFAULT_CHILD_STYLE_NAME_LABEL

Constant

public static const DEFAULT_CHILD_STYLE_NAME_LABEL:String = "feathers-item-renderer-label"

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

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

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

Package	feathers.controls.renderers
Class	public class DefaultTreeItemRenderer
Inheritance	DefaultTreeItemRenderer BaseDefaultItemRenderer ToggleButton Button BasicButton FeathersControl starling.display.Sprite
Implements	ITreeItemRenderer