Packageorg.apache.flex.html.supportClasses
Classpublic class UIItemRendererBase
InheritanceUIItemRendererBase Inheritance UIBase Inheritance HTMLElementWrapper Inheritance flash.display.Sprite
Implements ISelectableItemRenderer
Subclasses ButtonBarButtonItemRenderer, DataItemRenderer

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

The UIItemRendererBase class is the base class for all itemRenderers. An itemRenderer is used to display a single datum within a collection of data. Components such as a List use itemRenderers to show their dataProviders.

Default MXML PropertymxmlContent



Public Properties
 PropertyDefined By
 Inherited$height : Number
[read-only] Retrieve the low-level bounding box height.
UIBase
 Inherited$width : Number
[read-only] Retrieve the low-level bounding box width.
UIBase
  backgroundColor : uint = 0xFFFFFF
UIItemRendererBase
 Inheritedbeads : Array
The array property that is used to add additional beads to an MXML tag.
UIBase
 InheritedclassName : String
The classname.
UIBase
  data : Object
The data being represented by this itemRenderer.
UIItemRendererBase
  down : Boolean
Whether or not the itemRenderer is in a down (or pre-selected) state.
UIItemRendererBase
  downColor : uint = 0x808080
UIItemRendererBase
 Inheritedelement : IFlexJSElement
[read-only] Each IUIBase has an element that is actually added to the platform's display list DOM.
UIBase
 InheritedexplicitHeight : Number
The explicitly set width (as opposed to measured width or percentage width).
UIBase
 InheritedexplicitWidth : Number
The explicitly set width (as opposed to measured width or percentage width).
UIBase
 Inheritedheight : Number
[override] The height of the component.
UIBase
  highlightColor : uint = 0xCEDBEF
UIItemRendererBase
  hovered : Boolean
Whether or not the itemRenderer is in a hovered state.
UIItemRendererBase
 Inheritedid : String
An id property for MXML documents.
UIBase
  index : int
The position with the dataProvider being shown by the itemRenderer instance.
UIItemRendererBase
  itemRendererParent : Object
The parent container for the itemRenderer instance.
UIItemRendererBase
  labelField : String
The name of the field within the data to use as a label.
UIItemRendererBase
  listData : Object
Additional data about the list structure the itemRenderer may find useful.
UIItemRendererBase
 InheritedmeasurementBead : IMeasurementBead
[read-only] A measurement bead, if one exists.
UIBase
 Inheritedmodel : Object
An IBeadModel that serves as the data model for the component.
UIBase
  mxmlContent : Array
The default property.
UIItemRendererBase
 InheritednumElements : int
[read-only] The number of elements in the parent.
UIBase
 InheritedpercentHeight : Number
The requested percentage height this component should have in the parent container.
UIBase
 InheritedpercentWidth : Number
The requested percentage width this component should have in the parent container.
UIBase
  selected : Boolean
Whether or not the itemRenderer is in a selected state.
UIItemRendererBase
  selectedColor : uint = 0xA8C6EE
UIItemRendererBase
 Inheritedstyle : Object
The object that contains "styles" and other associated name-value pairs.
UIBase
 InheritedtopMostEventDispatcher : IEventDispatcher
[read-only] The top most event dispatcher.
UIBase
 InheritedtypeNames : String
A list of type names.
UIBase
 Inheritedview : IBeadView
An IBeadView that serves as the view for the component.
UIBase
 Inheritedwidth : Number
[override] The width of the component.
UIBase
Protected Properties
 PropertyDefined By
  useColor : uint
UIItemRendererBase
Public Methods
 MethodDefined By
  
constructor.
UIItemRendererBase
 Inherited
addBead(bead:IBead):void
[override] Add a bead to the strand.
UIBase
 Inherited
The method called when added to a parent.
UIBase
 Inherited
addElement(c:Object, dispatchEvent:Boolean = true):void
Add a component to the parent.
UIBase
 Inherited
addElementAt(c:Object, index:int, dispatchEvent:Boolean = true):void
Add a component to the parent.
UIBase
  
adjustSize():void
This function is called whenever the itemRenderer changes size.
UIItemRendererBase
 Inherited
getBeadByType(classOrInterface:Class):IBead
Find a bead on the strand.
UIBase
 Inherited
getElementAt(index:int):Object
Get a component from the parent.
UIBase
 Inherited
getElementIndex(c:Object):int
Gets the index of this subcomponent.
UIBase
 Inherited
UIBase
 Inherited
UIBase
 Inherited
Remove a bead from the strand.
UIBase
 Inherited
removeElement(c:Object, dispatchEvent:Boolean = true):void
Remove a component from the parent.
UIBase
 Inherited
setHeight(value:Number, noEvent:Boolean = false):void
UIBase
 Inherited
setWidth(value:Number, noEvent:Boolean = false):void
UIBase
 Inherited
setWidthAndHeight(newWidth:Number, newHeight:Number, noEvent:Boolean = false):void
UIBase
 Inherited
setX(value:Number):void
UIBase
 Inherited
setY(value:Number):void
UIBase
Protected Methods
 MethodDefined By
 Inherited
Rebroadcast an event from a sub component from the component.
UIBase
Events
 Event Summary Defined By
 InheritedSet a different class for click events so that there aren't dependencies on the flash classes on the JS side.UIBase
 InheritedSet a different class for mouseDown events so that there aren't dependencies on the flash classes on the JS side.UIBase
 InheritedSet a different class for mouseMove events so that there aren't dependencies on the flash classes on the JS side.UIBase
 InheritedSet a different class for mouseOut events so that there aren't dependencies on the flash classes on the JS side.UIBase
 InheritedSet a different class for mouseOver events so that there aren't dependencies on the flash classes on the JS side.UIBase
 InheritedSet a different class for mouseUp events so that there aren't dependencies on the flash classes on the JS side.UIBase
 InheritedSet a different class for rollOut events so that there aren't dependencies on the flash classes on the JS side.UIBase
 InheritedSet a different class for rollOver events so that there aren't dependencies on the flash classes on the JS side.UIBase
Property Detail
backgroundColorproperty
public var backgroundColor:uint = 0xFFFFFF

dataproperty 
data:Object

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

The data being represented by this itemRenderer. This can be something simple like a String or a Number or something very complex.

This property can be used as the source for data binding.


Implementation
    public function get data():Object
    public function set data(value:Object):void
downproperty 
down:Boolean

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

Whether or not the itemRenderer is in a down (or pre-selected) state.


Implementation
    public function get down():Boolean
    public function set down(value:Boolean):void
downColorproperty 
public var downColor:uint = 0x808080

highlightColorproperty 
public var highlightColor:uint = 0xCEDBEF

hoveredproperty 
hovered:Boolean

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

Whether or not the itemRenderer is in a hovered state.


Implementation
    public function get hovered():Boolean
    public function set hovered(value:Boolean):void
indexproperty 
index:int

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

The position with the dataProvider being shown by the itemRenderer instance.


Implementation
    public function get index():int
    public function set index(value:int):void
itemRendererParentproperty 
itemRendererParent:Object

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

The parent container for the itemRenderer instance.


Implementation
    public function get itemRendererParent():Object
    public function set itemRendererParent(value:Object):void
labelFieldproperty 
labelField:String

The name of the field within the data to use as a label. Some itemRenderers use this field to identify the value they should show while other itemRenderers ignore this if they are showing complex information.


Implementation
    public function get labelField():String
    public function set labelField(value:String):void
listDataproperty 
listData:Object

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

Additional data about the list structure the itemRenderer may find useful.

This property can be used as the source for data binding.


Implementation
    public function get listData():Object
    public function set listData(value:Object):void
mxmlContentproperty 
public var mxmlContent:Array

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

The default property. Child tags in MXML documents get assigned to this property, but are actually encoded by the compiler into the MXMLDescriptor array. Therefore, setting this property from ActionScript will have no effect at runtime.

selectedproperty 
selected:Boolean

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

Whether or not the itemRenderer is in a selected state.


Implementation
    public function get selected():Boolean
    public function set selected(value:Boolean):void
selectedColorproperty 
public var selectedColor:uint = 0xA8C6EE

useColorproperty 
protected var useColor:uint

Constructor Detail
UIItemRendererBase()Constructor
public function UIItemRendererBase()

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

constructor.

Method Detail
adjustSize()method
public function adjustSize():void

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

This function is called whenever the itemRenderer changes size. Sub-classes should override this method an handle the size change.