Packagemx.controls.listClasses
Interfacepublic interface IListItemRenderer extends IDataRenderer, flash.events.IEventDispatcher, IFlexDisplayObject, ILayoutManagerClient, ISimpleStyleClient, IUIComponent, flash.display.IBitmapDrawable
Implementors AdvancedDataGridGroupItemRenderer, AdvancedDataGridHeaderRenderer, AdvancedDataGridItemRenderer, AdvancedListBase, Button, ComboBox, Container, DataGridItemRenderer, DateField, FTEAdvancedDataGridItemRenderer, FTEDataGridItemRenderer, HTML, Image, Label, ListBase, ListItemRenderer, MXAdvancedDataGridItemRenderer, MXItemRenderer, MenuItemRenderer, NumericStepper, OLAPDataGridGroupRenderer, TextArea, TileListItemRenderer, TreeItemRenderer

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Item renderers and item editors for list components must implement the IListItemRenderer interface. The IListItemRenderer interface is a set of several other interfaces. It does not define any new class methods or properties.

The set of interfaces includes the following: IDataRenderer, IFlexDisplayObject, ILayoutManagerClient, ISimpleStyleClient, IUIComponent. The UIComponent class implements all of these interfaces, except the IDataRenderer interface. Therefore, if you create a custom item renderer or item editor as a subclass of the UIComponent class, you only have to implement the IDataRenderer interface and then you can add to the class definition that the class implements IDataRenderer and IListItemRenderer.

IListItemRenderers are generally dedicated to displaying a particular field from the data provider item and cannot be re-used in other DataGrid columns or in other lists with different fields. If you want to create a renderer that can be re-used you can also implement IDropInListItemRenderer, and the list will pass more data to the renderer that allows the renderer to be re-used with different data fields.

Item renderers and item editors are passed data from a list class' data provider using the IDataRenderer interface. Renderers and editors that implement the IDropInListItemRenderer interface get other information from the list class. The item renderer or item editor uses one or both pieces of information to display the data.

The renderers and editors are often recycled. Once they are created, they may be used again simply by being given a new data and optional listData property. Therefore in your implementation you must make sure that component properties are not assumed to contain their initial, or default values.



Public Properties
 PropertyDefined By
 InheritedaccessibilityProperties : AccessibilityProperties
IFlexDisplayObject
 Inheritedalpha : Number
IFlexDisplayObject
 InheritedbaselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text of the component.
IUIComponent
 InheritedblendMode : String
IFlexDisplayObject
 InheritedcacheAsBitmap : Boolean
IFlexDisplayObject
 Inheriteddata : Object
The data to render or edit.
IDataRenderer
 Inheriteddocument : Object
A reference to the document object associated with this component.
IUIComponent
 Inheritedenabled : Boolean
Whether the component can accept user interaction.
IUIComponent
 InheritedexplicitHeight : Number
The explicitly specified height for the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMaxHeight : Number
[read-only] Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMaxWidth : Number
[read-only] Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMinHeight : Number
[read-only] Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMinWidth : Number
[read-only] Number that specifies the minimum width of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitWidth : Number
The explicitly specified width for the component, in pixels, as the component's coordinates.
IUIComponent
 Inheritedfilters : Array
IFlexDisplayObject
 InheritedfocusPane : Sprite
A single Sprite object that is shared among components and used as an overlay for drawing the focus indicator.
IUIComponent
 Inheritedheight : Number
IFlexDisplayObject
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
IUIComponent
 Inheritedinitialized : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required) This flag should only be modified by the LayoutManager.
ILayoutManagerClient
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
IUIComponent
 InheritedloaderInfo : LoaderInfo
[read-only]
IFlexDisplayObject
 Inheritedmask : DisplayObject
IFlexDisplayObject
 InheritedmaxHeight : Number
[read-only] Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedmaxWidth : Number
[read-only] Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedmeasuredHeight : Number
[read-only] The measured height of this object.
IFlexDisplayObject
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
IUIComponent
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
IUIComponent
 InheritedmeasuredWidth : Number
[read-only] The measured width of this object.
IFlexDisplayObject
 InheritedminHeight : Number
[read-only] Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedminWidth : Number
[read-only] Number that specifies the minimum width of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedmouseX : Number
[read-only]
IFlexDisplayObject
 InheritedmouseY : Number
[read-only]
IFlexDisplayObject
 Inheritedname : String
IFlexDisplayObject
 InheritednestLevel : int
The top-level SystemManager has a nestLevel of 1.
ILayoutManagerClient
 InheritedopaqueBackground : Object
IFlexDisplayObject
 Inheritedowner : DisplayObjectContainer
The owner of this IVisualElement object.
IUIComponent
 Inheritedparent : DisplayObjectContainer
[read-only]
IFlexDisplayObject
 InheritedpercentHeight : Number
Number that specifies the height of a component as a percentage of its parent's size.
IUIComponent
 InheritedpercentWidth : Number
Number that specifies the width of a component as a percentage of its parent's size.
IUIComponent
 InheritedprocessedDescriptors : Boolean
Set to true after immediate or deferred child creation, depending on which one happens.
ILayoutManagerClient
 Inheritedroot : DisplayObject
[read-only]
IFlexDisplayObject
 Inheritedrotation : Number
IFlexDisplayObject
 Inheritedscale9Grid : Rectangle
IFlexDisplayObject
 InheritedscaleX : Number
IFlexDisplayObject
 InheritedscaleY : Number
IFlexDisplayObject
 InheritedscrollRect : Rectangle
IFlexDisplayObject
 Inheritedstage : Stage
[read-only]
IFlexDisplayObject
 InheritedstyleName : Object
The source of this object's style values.
ISimpleStyleClient
 InheritedsystemManager : ISystemManager
A reference to the SystemManager object for this component.
IUIComponent
 Inheritedtransform : Transform
IFlexDisplayObject
 InheritedtweeningProperties : Array
Used by EffectManager.
IUIComponent
 InheritedupdateCompletePendingFlag : Boolean
A flag that determines if an object is waiting to have its updateComplete event dispatched.
ILayoutManagerClient
 Inheritedvisible : Boolean
IFlexDisplayObject
 Inheritedwidth : Number
IFlexDisplayObject
 Inheritedx : Number
IFlexDisplayObject
 Inheritedy : Number
IFlexDisplayObject
Public Methods
 MethodDefined By
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
IFlexDisplayObject
 Inherited
A convenience method for determining whether to use the explicit or measured height
IUIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured width
IUIComponent
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
IFlexDisplayObject
 Inherited
globalToLocal(point:Point):Point
IFlexDisplayObject
 Inherited
hitTestObject(obj:DisplayObject):Boolean
IFlexDisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
IFlexDisplayObject
 Inherited
initialize():void
Initialize the object.
IUIComponent
 Inherited
localToGlobal(point:Point):Point
IFlexDisplayObject
 Inherited
move(x:Number, y:Number):void
Moves this object to the specified x and y coordinates.
IFlexDisplayObject
 Inherited
owns(displayObject:DisplayObject):Boolean
Returns true if the chain of owner properties points from child to this UIComponent.
IUIComponent
 Inherited
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
IUIComponent
 Inherited
setActualSize(newWidth:Number, newHeight:Number):void
Sets the actual size of this object.
IFlexDisplayObject
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes.
IUIComponent
 Inherited
styleChanged(styleProp:String):void
Called when the value of a style property is changed.
ISimpleStyleClient
 Inherited
Validates the position and size of children and draws other visuals.
ILayoutManagerClient
 Inherited
Validates the properties of a component.
ILayoutManagerClient
 Inherited
validateSize(recursive:Boolean = false):void
Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements.
ILayoutManagerClient