Packagefeathers.controls.renderers
Classpublic class DefaultListItemRenderer
InheritanceDefaultListItemRenderer Inheritance BaseDefaultItemRenderer Inheritance ToggleButton Inheritance Button Inheritance BasicButton Inheritance FeathersControl Inheritance starling.display.Sprite
Implements IListItemRenderer

Product Version : Feathers 1.0.0

The default item renderer for List control. Supports up to three optional sub-views, including a label to display text, an icon to display an image, and an "accessory" to display a UI control or another display object (with shortcuts for including a second image or a second label).

See also

feathers.controls.List


Public Properties
 PropertyDefined By
 InheritedaccessoryField : String
The field in the item that contains a display object to be positioned in the accessory position of the renderer.
BaseDefaultItemRenderer
 InheritedaccessoryFunction : Function
A function that returns a display object to be positioned in the accessory position of the renderer.
BaseDefaultItemRenderer
 InheritedaccessoryLabelFactory : Function
A function that generates ITextRenderer that uses the result of accessoryLabelField or accessoryLabelFunction.
BaseDefaultItemRenderer
 InheritedaccessoryLabelField : 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
 InheritedaccessoryLabelFunction : Function
A function that returns a string to be displayed in a renderer-managed ITextRenderer in the accessory position of the renderer.
BaseDefaultItemRenderer
 InheritedaccessoryLabelProperties : 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
 InheritedaccessoryLoaderFactory : Function
A function that generates an ImageLoader that uses the result of accessorySourceField or accessorySourceFunction.
BaseDefaultItemRenderer
 InheritedaccessorySourceField : 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
 InheritedaccessorySourceFunction : 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
 Inheritedbaseline : Number
[read-only] Returns the text baseline measurement, in pixels.
Button
 InheritedcurrentState : String
[read-only] The current state of the button.
BasicButton
 Inheriteddata : Object
The item displayed by this renderer.
BaseDefaultItemRenderer
 InheriteddefaultAccessory : DisplayObject
The accessory used when no other accessory is defined for the current state.
BaseDefaultItemRenderer
 InheriteddefaultLabelProperties : 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
 InheriteddefaultTextEditorFactory : Function
[static] A function used by all UI controls that support text editor to create an ITextEditor instance.
FeathersControl
 InheriteddefaultTextRendererFactory : Function
[static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.
FeathersControl
 InheriteddelayTextureCreationOnScroll : Boolean
If enabled, automatically manages the delayTextureCreation property on accessory and icon ImageLoader instances when the owner scrolls.
BaseDefaultItemRenderer
 Inheriteddepth : int
[read-only] The component's depth in the display list, relative to the stage.
FeathersControl
 InheritedenabledField : String
The field in the item that determines if the item renderer is enabled, if the list is enabled.
BaseDefaultItemRenderer
 InheritedenabledFunction : Function
A function used to determine if a specific item is enabled.
BaseDefaultItemRenderer
 InheritedexplicitHeight : Number
[read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.
FeathersControl
 InheritedexplicitMaxHeight : Number
[read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.
FeathersControl
 InheritedexplicitMaxWidth : Number
[read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.
FeathersControl
 InheritedexplicitMinHeight : Number
[read-only] The minimum height value explicitly set by passing a value to the minHeight setter.
FeathersControl
 InheritedexplicitMinWidth : Number
[read-only] The minimum width value explicitly set by passing a value to the minWidth setter.
FeathersControl
 InheritedexplicitWidth : Number
[read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.
FeathersControl
 InheritedfactoryID : String
The ID of the factory used to create this item renderer.
BaseDefaultItemRenderer
 InheritedfocusManager : IFocusManager
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The current focus manager for this component.
FeathersControl
 InheritedfocusOwner : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Used for associating focusable display objects that are not direct children with an "owner" focusable display object, such as pop-ups.
FeathersControl
  globalStyleProvider : IStyleProvider
[static] The default IStyleProvider for all DefaultListItemRenderer components.
DefaultListItemRenderer
 Inheritedheight : Number
[override] The height of the component, in pixels.
FeathersControl
 InheritediconField : 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
 InheritediconFunction : Function
A function used to generate an icon for a specific item.
BaseDefaultItemRenderer
 InheritediconLabelFactory : Function
A function that generates ITextRenderer that uses the result of iconLabelField or iconLabelFunction.
BaseDefaultItemRenderer
 InheritediconLabelField : 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
 InheritediconLabelFunction : Function
A function that returns a string to be displayed in a renderer-managed ITextRenderer in the icon position of the renderer.
BaseDefaultItemRenderer
 InheritediconLabelProperties : 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
 InheritediconLoaderFactory : Function
A function that generates an ImageLoader that uses the result of iconSourceField or iconSourceFunction.
BaseDefaultItemRenderer
 InheritediconSourceField : 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
 InheritediconSourceFunction : 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
 InheritedincludeInLayout : Boolean
Determines if the ILayout should use this object or ignore it.
FeathersControl
  index : int
The index (numeric position, starting from zero) of the item within the list's data provider.
DefaultListItemRenderer
 InheritedisChildFocusEnabled : Boolean
Determines if this component's children can receive focus.
BaseDefaultItemRenderer
 InheritedisCreated : Boolean
[read-only] Determines if the component has been initialized and validated for the first time.
FeathersControl
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
FeathersControl
 InheritedisFocusEnabled : Boolean
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Determines if this component can receive focus.
FeathersControl
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
FeathersControl
 InheritedisLongPressEnabled : Boolean
Determines if FeathersEventType.LONG_PRESS will be dispatched.
Button
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
 InheritedisSelectableOnAccessoryTouch : Boolean
If enabled, the item renderer may be selected by touching the accessory.
BaseDefaultItemRenderer
 InheritedisSelected : Boolean
Indicates if the button is selected or not.
ToggleButton
 InheritedisShowingFocus : 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
 InheritedisToggle : Boolean
Determines if the button may be selected or deselected as a result of user interaction.
ToggleButton
 InheriteditemHasAccessory : Boolean
If true, the accessory will come from the renderer's item using the appropriate field or function for the accessory.
BaseDefaultItemRenderer
 InheriteditemHasEnabled : Boolean
If true, the renderer's enabled state will come from the renderer's item using the appropriate field or function for enabled.
BaseDefaultItemRenderer
 InheriteditemHasIcon : Boolean
If true, the icon will come from the renderer's item using the appropriate field or function for the icon.
BaseDefaultItemRenderer
 InheriteditemHasLabel : Boolean
If true, the label will come from the renderer's item using the appropriate field or function for the label.
BaseDefaultItemRenderer
 InheriteditemHasSelectable : 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
 InheriteditemHasSkin : Boolean
If true, the skin will come from the renderer's item using the appropriate field or function for the skin.
BaseDefaultItemRenderer
 Inheritedlabel : String
The text displayed on the button.
Button
 InheritedlabelFactory : Function
A function used to instantiate the button's label text renderer sub-component.
Button
 InheritedlabelField : String
The field in the item that contains the label text to be displayed by the renderer.
BaseDefaultItemRenderer
 InheritedlabelFunction : Function
A function used to generate label text for a specific item.
BaseDefaultItemRenderer
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
FeathersControl
 InheritedlongPressDuration : Number
The duration, in seconds, of a long press.
Button
 InheritedmaintainTouchFocus : 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
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.
FeathersControl
 InheritedminTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.
FeathersControl
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritednextDownFocus : 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
 InheritednextLeftFocus : 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
 InheritednextRightFocus : 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
 InheritednextTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when the tab key is pressed when a focus manager is enabled.
FeathersControl
 InheritednextUpFocus : 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
 InheritednumLines : int
[read-only] The number of text lines displayed by the button.
Button
  owner : List
The list that contains this item renderer.
DefaultListItemRenderer
 InheritedpreviousTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The previous object that will receive focus when the tab key is pressed while holding shift when a focus manager is enabled.
FeathersControl
 InheritedselectableField : String
The field in the item that determines if the item renderer can be selected, if the list allows selection.
BaseDefaultItemRenderer
 InheritedselectableFunction : Function
A function used to determine if a specific item is selectable.
BaseDefaultItemRenderer
 InheritedskinField : String
The field in the item that contains a display object to be displayed as a background skin.
BaseDefaultItemRenderer
 InheritedskinFunction : Function
A function used to generate a background skin for a specific item.
BaseDefaultItemRenderer
 InheritedskinLoaderFactory : Function
A function that generates an ImageLoader that uses the result of skinSourceField or skinSourceFunction.
BaseDefaultItemRenderer
 InheritedskinSourceField : 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
 InheritedskinSourceFunction : 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
 InheritedstopScrollingOnAccessoryTouch : Boolean
If enabled, calls owner.stopScrolling() when TouchEvents are dispatched by the accessory.
BaseDefaultItemRenderer
 InheritedstyleName : String
The concatenated styleNameList, with values separated by spaces.
FeathersControl
 InheritedstyleNameList : TokenList
[read-only] Contains a list of all "styles" assigned to this control.
FeathersControl
 InheritedstyleProvider : IStyleProvider
When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.
FeathersControl
 InheritedtoggleGroup : 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
 InheritedtoolTip : String
Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.
FeathersControl
 Inheritedwidth : Number
[override] The width of the component, in pixels.
FeathersControl
Protected Properties
 PropertyDefined By
 InheritedaccessoryLabelStyleName : String = "feathers-item-renderer-accessory-label"
The value added to the styleNameList of the accessory label text renderer, if it exists.
BaseDefaultItemRenderer
 InheritedaccessoryLoaderStyleName : String = "feathers-item-renderer-accessory-loader"
The value added to the styleNameList of the accessory loader, if it exists.
BaseDefaultItemRenderer
 InheritedactualHeight : Number = 0
The final height value that should be used for layout.
FeathersControl
 InheritedactualMinHeight : Number = 0
The final minimum height value that should be used for layout.
FeathersControl
 InheritedactualMinWidth : Number = 0
The final minimum width value that should be used for layout.
FeathersControl
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
 InheritedcurrentIcon : DisplayObject
The currently visible icon.
Button
 InheritedcurrentSkin : DisplayObject
The currently visible skin.
BasicButton
 InheriteddefaultStyleProvider : IStyleProvider
[read-only] When the FeathersControl constructor is called, the styleProvider property is set to this value.
FeathersControl
 InheritediconLabelStyleName : String = "feathers-item-renderer-icon-label"
The value added to the styleNameList of the icon label text renderer, if it exists.
BaseDefaultItemRenderer
 InheritediconLoaderStyleName : String = "feathers-item-renderer-icon-loader"
The value added to the styleNameList of the icon loader, if it exists.
BaseDefaultItemRenderer
 InheritedisSelectableWithoutToggle : Boolean = true
Determines if the item renderer can be selected even if isToggle is set to false.
BaseDefaultItemRenderer
 InheritedlabelStyleName : String = "feathers-button-label"
The value added to the styleNameList of the label text renderer.
Button
 InheritedlabelTextRenderer : ITextRenderer
The text renderer for the button's label.
Button
Public Methods
 MethodDefined By
  
Constructor.
DefaultListItemRenderer
 Inherited
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
 Inherited
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
 Inherited
getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle
[override] Feathers components use an optimized getBounds() implementation that may sometimes behave differently than regular Starling display objects.
FeathersControl
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
getSkinForState(state:String):DisplayObject
Gets the skin to be used by the button when its currentState property matches the specified state value.
BasicButton
 Inherited
hideFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
If the component has not yet initialized, initializes immediately.
FeathersControl
 Inherited
invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending.
FeathersControl
 Inherited
isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not.
FeathersControl
 Inherited
itemToLabel(item:Object):String
Using labelField and labelFunction, generates a label from the item.
BaseDefaultItemRenderer
 Inherited
move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single function call.
FeathersControl
 Inherited
Resets the styleProvider property to its default value, which is usually the global style provider for the component.
FeathersControl
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
FeathersControl
 Inherited
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
 Inherited
showFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
validate():void
Immediately validates the display object, if it is invalid.
FeathersControl
Protected Methods
 MethodDefined By
 Inherited
[override] If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself.
BaseDefaultItemRenderer
 Inherited
clearInvalidationFlag(flag:String):void
Clears an invalidation flag.
FeathersControl
 Inherited
commitData():void
Updates the renderer to display the item's data.
BaseDefaultItemRenderer
 Inherited
Creates the label text renderer sub-component and removes the old instance, if one exists.
Button
 Inherited
draw():void
Override to customize layout and to adjust properties of children.
FeathersControl
 Inherited
focusInHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_IN that may be overridden in subclasses to perform additional actions when the component receives focus.
FeathersControl
 Inherited
focusOutHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_OUT that may be overridden in subclasses to perform additional actions when the component loses focus.
FeathersControl
 Inherited
The next style that is set will not be restricted.
FeathersControl
 Inherited
initialize():void
Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process.
FeathersControl
 Inherited
itemToAccessory(item:Object):DisplayObject
Uses the accessory fields and functions to generate an accessory for a specific item.
BaseDefaultItemRenderer
 Inherited
itemToEnabled(item:Object):Boolean
Uses the enabled fields and functions to generate a enabled value for a specific item.
BaseDefaultItemRenderer
 Inherited
itemToIcon(item:Object):DisplayObject
Uses the icon fields and functions to generate an icon for a specific item.
BaseDefaultItemRenderer
 Inherited
itemToSelectable(item:Object):Boolean
Uses the selectable fields and functions to generate a selectable value for a specific item.
BaseDefaultItemRenderer
 Inherited
itemToSkin(item:Object):DisplayObject
Uses the skin fields and functions to generate a skin for a specific item.
BaseDefaultItemRenderer
 Inherited
Positions and sizes the button's content.
Button
 Inherited
processStyleRestriction(key:Object):Boolean
Used by setters for properties that are considered "styles" to determine if the setter has been called directly on the component or from a style provider.
FeathersControl
 Inherited
Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.
FeathersControl
 Inherited
Sets the currentIcon property.
Button
 Inherited
Sets the currentSkin property.
BasicButton
 Inherited
saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean
Saves the dimensions and minimum dimensions calculated for the component.
FeathersControl
 Inherited
setInvalidationFlag(flag:String):void
Sets an invalidation flag.
FeathersControl
 Inherited
setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of invalidating or not.
FeathersControl
Events
 Event Summary Defined By
 InheritedDispatched when the button is selected or deselected either programmatically or as a result of user interaction.ToggleButton
 InheritedDispatched after the component has validated for the first time.FeathersControl
 InheritedDispatched after initialize() has been called, but before the first time that draw() has been called.FeathersControl
 InheritedDispatched when the button is pressed for a long time.Button
 InheritedDispatched when the width or height of the control changes.FeathersControl
 InheritedDispatched when the display object's state changes.BasicButton
 InheritedDispatched when the the user taps or clicks the button.BasicButton
Styles
 StyleDefined By
 Inherited
accessoryGap : Number
The space, in pixels, between the accessory and the other child it is positioned relative to.
BaseDefaultItemRenderer
 Inherited
The font styles used to display the item renderer's accessory label text when the item renderer is disabled.
BaseDefaultItemRenderer
 Inherited
The font styles used to display the item renderer's accessory label text.
BaseDefaultItemRenderer
 Inherited
The font styles used to display the item renderer's accessory label text when the item renderer is selected.
BaseDefaultItemRenderer
 Inherited
Offsets the x position of the accessory by a certain number of pixels.
BaseDefaultItemRenderer
 Inherited
Offsets the y position of the accessory by a certain number of pixels.
BaseDefaultItemRenderer
 Inherited
The location of the accessory, relative to one of the other children.
BaseDefaultItemRenderer
 Inherited
A style name to add to the item renderer's accessory label text renderer sub-component.
BaseDefaultItemRenderer
 Inherited
A style name to add to the item renderer's accessory loader sub-component.
BaseDefaultItemRenderer
 Inherited
A style name to add to the item renderer's icon label text renderer sub-component.
BaseDefaultItemRenderer
 Inherited
A style name to add to the item renderer's icon loader sub-component.
BaseDefaultItemRenderer
 Inherited
A style name to add to the button's label text renderer sub-component.
Button
 Inherited
defaultIcon : DisplayObject
The icon used when no other icon is defined for the current state.
Button
 Inherited
defaultSelectedIcon : DisplayObject
The icon used when no other icon is defined for the current state when the button is selected.
ToggleButton
 Inherited
defaultSelectedSkin : DisplayObject
The skin used when no other skin is defined for the current state when the button is selected.
ToggleButton
 Inherited
defaultSkin : DisplayObject
The skin used when no other skin is defined for the current state.
BasicButton
 Inherited
disabledFontStyles : TextFormat
The font styles used to display the button's text when the button is disabled.
Button
 Inherited
disabledIcon : DisplayObject
The icon used for the button's disabled state.
Button
 Inherited
disabledSkin : DisplayObject
The skin used for the button's disabled state.
BasicButton
 Inherited
downIcon : DisplayObject
The icon used for the button's down state.
Button
 Inherited
downSkin : DisplayObject
The skin used for the button's down state.
BasicButton
 Inherited
focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.
FeathersControl
 Inherited
focusPadding : Number
Quickly sets all focus padding properties to the same value.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.
FeathersControl
 Inherited
fontStyles : TextFormat
The font styles used to display the button's text.
Button
 Inherited
gap : Number
The space, in pixels, between the icon and the label.
Button
 Inherited
Determines if the button's label text renderer is created or not.
Button
 Inherited
The location where the button's content is aligned horizontally (on the x-axis).
Button
 Inherited
hoverIcon : DisplayObject
The icon used for the button's hover state.
Button
 Inherited
hoverSkin : DisplayObject
The skin used for the button's hover state.
BasicButton
 Inherited
The font styles used to display the item renderer's icon label text when the item renderer is disabled.
BaseDefaultItemRenderer
 Inherited
iconLabelFontStyles : TextFormat
The font styles used to display the item renderer's icon label text.
BaseDefaultItemRenderer
 Inherited
The font styles used to display the item renderer's icon label text when the item renderer is selected.
BaseDefaultItemRenderer
 Inherited
iconOffsetX : Number
Offsets the x position of the icon by a certain number of pixels.
Button
 Inherited
iconOffsetY : Number
Offsets the y position of the icon by a certain number of pixels.
Button
 Inherited
iconPosition : String
The location of the icon, relative to the label.
Button
 Inherited
Determines if a pressed button should remain in the down state if a touch moves outside of the button's bounds.
BasicButton
 Inherited
labelOffsetX : Number
Offsets the x position of the label by a certain number of pixels.
Button
 Inherited
labelOffsetY : Number
Offsets the y position of the label by a certain number of pixels.
Button
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
padding : Number
Quickly sets all padding properties to the same value.
Button
 Inherited
paddingBottom : Number
The minimum space, in pixels, between the button's bottom edge and the button's content.
Button
 Inherited
paddingLeft : Number
The minimum space, in pixels, between the button's left edge and the button's content.
Button
 Inherited
paddingRight : Number
The minimum space, in pixels, between the button's right edge and the button's content.
Button
 Inherited
paddingTop : Number
The minimum space, in pixels, between the button's top edge and the button's content.
Button
 Inherited
scaleWhenDown : Number
The button renders at this scale in the down state.
Button
 Inherited
The button renders at this scale in the hover state.
Button
 Inherited
If not NaN, the button renders at this scale when selected.
ToggleButton
 Inherited
selectedDisabledIcon : DisplayObject
The icon used for the button's disabled state when the button is selected.
ToggleButton
 Inherited
selectedDisabledSkin : DisplayObject
The skin used for the button's disabled state when the button is selected.
ToggleButton
 Inherited
selectedDownIcon : DisplayObject
The icon used for the button's down state when the button is selected.
ToggleButton
 Inherited
selectedDownSkin : DisplayObject
The skin used for the button's down state when the button is selected.
ToggleButton
 Inherited
selectedFontStyles : TextFormat
The font styles used to display the button's text when the button is selected.
ToggleButton
 Inherited
selectedHoverIcon : DisplayObject
The icon used for the button's hover state when the button is selected.
ToggleButton
 Inherited
selectedHoverSkin : DisplayObject
The skin used for the button's hover state when the button is selected.
ToggleButton
 Inherited
selectedUpIcon : DisplayObject
The icon used for the button's up state when the button is selected.
ToggleButton
 Inherited
selectedUpSkin : DisplayObject
The skin used for the button's up state when the button is selected.
ToggleButton
 Inherited
upIcon : DisplayObject
The icon used for the button's up state.
Button
 Inherited
upSkin : DisplayObject
The skin used for the button's up state.
BasicButton
 Inherited
If true, the down state (and subsequent state changes) will be delayed to improve the user experience when scrolling on a touch screen.
BaseDefaultItemRenderer
 Inherited
verticalAlign : String
The location where the button's content is aligned vertically (on the y-axis).
Button
 Inherited
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
 ConstantDefined By
 InheritedALTERNATE_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
 InheritedALTERNATE_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.
DefaultListItemRenderer
 InheritedALTERNATE_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.
DefaultListItemRenderer
 InheritedALTERNATE_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
 InheritedALTERNATE_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.
DefaultListItemRenderer
 InheritedDEFAULT_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.
DefaultListItemRenderer
 InheritedDEFAULT_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.
DefaultListItemRenderer
 InheritedINVALIDATION_FLAG_ALL : String = "all"
[static] Flag to indicate that everything is invalid and should be redrawn.
FeathersControl
 InheritedINVALIDATION_FLAG_DATA : String = "data"
[static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_FOCUS : String = "focus"
[static] Invalidation flag to indicate that the focus of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_LAYOUT : String = "layout"
[static] Invalidation flag to indicate that the layout of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SCROLL : String = "scroll"
[static] Invalidation flag to indicate that the scroll position of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SELECTED : String = "selected"
[static] Invalidation flag to indicate that the selection of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SIZE : String = "size"
[static] Invalidation flag to indicate that the dimensions of the UI control have changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SKIN : String = "skin"
[static] Invalidation flag to indicate that the skin of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STATE : String = "state"
[static] Invalidation flag to indicate that the state has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STYLES : String = "styles"
[static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.
FeathersControl
Property Detail
globalStyleProviderproperty
public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all DefaultListItemRenderer components.

The default value is null.

See also

indexproperty 
index:int

The index (numeric position, starting from zero) of the item within the list's data provider. Like the data property, this value may change if this item renderer is reused by the list for a different item.

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


Implementation
    public function get index():int
    public function set index(value:int):void
ownerproperty 
owner:List

The list that contains this item renderer.

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


Implementation
    public function get owner():List
    public function set owner(value:List):void
Constructor Detail
DefaultListItemRenderer()Constructor
public function DefaultListItemRenderer()

Constructor.

Constant Detail
ALTERNATE_STYLE_NAME_CHECKConstant
public static const ALTERNATE_STYLE_NAME_CHECK:String = "feathers-check-item-renderer"

An alternate style name to use with the default item renderer to allow a theme to give it a "check" style. If a theme does not provide a style for a check item renderer, the theme will automatically fall back to using the default item renderer style.

An alternate style name should always be added to a component's styleNameList before the component is initialized. If the style name is added later, it will be ignored.

In the following example, the check item renderer style is applied to a list's item renderers:

list.itemRendererFactory = function():IListItemRenderer
{
    var itemRenderer:DefaultListItemRenderer = new DefaultListItemRenderer();
    itemRenderer.styleNameList.add( DefaultListItemRenderer.ALTERNATE_STYLE_NAME_CHECK );
    return itemRenderer;
};

See also

ALTERNATE_STYLE_NAME_DRILL_DOWNConstant 
public static const ALTERNATE_STYLE_NAME_DRILL_DOWN:String = "feathers-drill-down-item-renderer"

An alternate style name to use with the default item renderer to allow a theme to give it a "drill-down" style. If a theme does not provide a style for a drill-down item renderer, the theme will automatically fall back to using the default item renderer style.

An alternate style name should always be added to a component's styleNameList before the component is initialized. If the style name is added later, it will be ignored.

In the following example, the drill-down style is applied to a list's item renderers:

list.itemRendererFactory = function():IListItemRenderer
{
    var itemRenderer:DefaultListItemRenderer = new DefaultListItemRenderer();
    itemRenderer.styleNameList.add( DefaultListItemRenderer.ALTERNATE_STYLE_NAME_DRILL_DOWN );
    return itemRenderer;
};

See also

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

See also

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

See also

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

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

See also