Packagefeathers.controls.renderers
Interfacepublic interface IListItemRenderer extends IToggle, IFeathersControl, IValidating, IMeasureDisplayObject
Implementors DefaultListItemRenderer, LayoutGroupListItemRenderer

Product Version : Feathers 1.0.0

Interface to implement a renderer for a list item.



Public Properties
 PropertyDefined By
 Inheritedalpha : Number
The opacity of the display object.
IFeathersDisplayObject
 Inheritedbase : DisplayObject
[read-only] The top-most object of the display tree that the display object is connected to.
IFeathersDisplayObject
 InheritedblendMode : String
The blend mode used when rendering the display object.
IFeathersDisplayObject
 Inheritedbounds : Rectangle
[read-only] The bounds of the display object in its local coordinate space.
IFeathersDisplayObject
  data : Object
An item from the list's data provider.
IListItemRenderer
 Inheriteddepth : int
[read-only] The component's depth in the display list, relative to the stage.
IValidating
 InheritedexplicitHeight : Number
[read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.
IMeasureDisplayObject
 InheritedexplicitMaxHeight : Number
[read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.
IMeasureDisplayObject
 InheritedexplicitMaxWidth : Number
[read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.
IMeasureDisplayObject
 InheritedexplicitMinHeight : Number
[read-only] The minimum height value explicitly set by passing a value to the minHeight setter.
IMeasureDisplayObject
 InheritedexplicitMinWidth : Number
[read-only] The minimum width value explicitly set by passing a value to the minWidth setter.
IMeasureDisplayObject
 InheritedexplicitWidth : Number
[read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.
IMeasureDisplayObject
  factoryID : String
The ID of the factory used to create this item renderer.
IListItemRenderer
 Inheritedfilter : FragmentFilter
The filter used when rendering the display object.
IFeathersDisplayObject
 Inheritedheight : Number
The height of the display object in the parent's coordinate space.
IFeathersDisplayObject
  index : int
The index (numeric position, starting from zero) of the item within the list's data provider.
IListItemRenderer
 InheritedisCreated : Boolean
[read-only] Determines if the component has been initialized and validated for the first time.
IFeathersControl
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
IFeathersControl
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
IFeathersControl
 InheritedisSelected : Boolean
Indicates if the IToggle is selected or not.
IToggle
 Inheritedmask : DisplayObject
The display object's mask.
IFeathersDisplayObject
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
IMeasureDisplayObject
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
IMeasureDisplayObject
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
IMeasureDisplayObject
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
IMeasureDisplayObject
 Inheritedname : String
The name of the display object.
IFeathersDisplayObject
  owner : List
The list that contains this item renderer.
IListItemRenderer
 Inheritedparent : DisplayObjectContainer
[read-only] The display object's parent, or null if it doesn't have a parent.
IFeathersDisplayObject
 InheritedpivotX : Number
The x coordinate of the display object's origin in its own coordinate space.
IFeathersDisplayObject
 InheritedpivotY : Number
The y coordinate of the display object's origin in its own coordinate space.
IFeathersDisplayObject
 Inheritedroot : DisplayObject
[read-only]
IFeathersDisplayObject
 Inheritedrotation : Number
The rotation of the display object, in radians.
IFeathersDisplayObject
 InheritedscaleX : Number
This horizontal scale factor.
IFeathersDisplayObject
 InheritedscaleY : Number
The vertical scale factor.
IFeathersDisplayObject
 InheritedskewX : Number
The horizontal skew, in radians.
IFeathersDisplayObject
 InheritedskewY : Number
The vertical skew, in radians.
IFeathersDisplayObject
 Inheritedstage : Stage
[read-only] The stage that the display object is connected to, or null if it is not connected to a stage.
IFeathersDisplayObject
 InheritedstyleName : String
The concatenated styleNameList, with values separated by spaces.
IFeathersControl
 InheritedstyleNameList : TokenList
[read-only] Contains a list of all "styles" assigned to this control.
IFeathersControl
 InheritedstyleProvider : IStyleProvider
When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.
IFeathersControl
 InheritedtoolTip : String
Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.
IFeathersControl
 Inheritedtouchable : Boolean
Determines if the display object may be touched.
IFeathersDisplayObject
 InheritedtransformationMatrix : Matrix
[read-only] The transformation matrix of the display object, relative to its parent.
IFeathersDisplayObject
 InheriteduseHandCursor : Boolean
Determines if the mouse cursor should turn into a hand when the mouse is over the display object.
IFeathersDisplayObject
 Inheritedvisible : Boolean
Determines the visibility of the display object.
IFeathersDisplayObject
 Inheritedwidth : Number
The width of the display object in the parent's coordinate space.
IFeathersDisplayObject
 Inheritedx : Number
The x, or horizontal, position of the display object in the parent's coordinate space.
IFeathersDisplayObject
 Inheritedy : Number
The y, or vertical, position of the display object in the parent's coordinate space.
IFeathersDisplayObject
Public Methods
 MethodDefined By
 Inherited
addEventListener(type:String, listener:Function):void
Adds a listener for an event type.
IFeathersEventDispatcher
 Inherited
dispatchEvent(event:Event):void
Dispatches an event to all listeners added for the specified event type.
IFeathersEventDispatcher
 Inherited
dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void
Dispatches an event from the pool with the specified to all listeners for the specified event type.
IFeathersEventDispatcher
 Inherited
dispose():void
Disposes the display object.
IFeathersDisplayObject
 Inherited
getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle
Gets the display object's bounds in the target coordinate space.
IFeathersDisplayObject
 Inherited
getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix
Calculates a transformation matrix to convert values from the display object's coordinate space to a target coordinate space.
IFeathersDisplayObject
 Inherited
globalToLocal(globalPoint:Point, resultPoint:Point = null):Point
Converts a point from the stage's coordinate space to the display object's coordinate space.
IFeathersDisplayObject
 Inherited
hasEventListener(type:String, listener:Function = null):Boolean
Checks if a listener has been added for the specified event type.
IFeathersEventDispatcher
 Inherited
hitTest(localPoint:Point):DisplayObject
Determines if a point exists within the display object's bounds.
IFeathersDisplayObject
 Inherited
If the component has not yet initialized, initializes immediately.
IFeathersControl
 Inherited
localToGlobal(localPoint:Point, resultPoint:Point = null):Point
Converts a point from the display object's coordinate space to the stage's coordinate space.
IFeathersDisplayObject
 Inherited
move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single function call.
IFeathersControl
 Inherited
removeEventListener(type:String, listener:Function):void
Removes a listener for an event type.
IFeathersEventDispatcher
 Inherited
removeEventListeners(type:String = null):void
Removes all listeners for an event type.
IFeathersEventDispatcher
 Inherited
removeFromParent(dispose:Boolean = false):void
Removes a display object from its parent.
IFeathersDisplayObject
 Inherited
render(painter:Painter):void
Renders the display object.
IFeathersDisplayObject
 Inherited
Resets the styleProvider property to its default value, which is usually the global style provider for the component.
IFeathersControl
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
IFeathersControl
 Inherited
validate():void
Immediately validates the display object, if it is invalid.
IValidating
Events
 Event Summary Defined By
  Dispatched when the the user taps or clicks the item renderer.IListItemRenderer
Property Detail
dataproperty
data:Object

An item from the list's data provider. The data may change if this item renderer is reused for a new item because it's no longer needed for the original item.

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


Implementation
    public function get data():Object
    public function set data(value:Object):void
factoryIDproperty 
factoryID:String

The ID of the factory used to create this item renderer.

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


Implementation
    public function get factoryID():String
    public function set factoryID(value:String):void
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
Event Detail
triggered Event
Event Object Type: starling.events.Event
Event.type property = starling.events.Event.TRIGGERED

Dispatched when the the user taps or clicks the item renderer. The touch must remain within the bounds of the item renderer on release to register as a tap or a click.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
datanull
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.