(Preview)
| Package | spark.components |
| Class | public class IconItemRenderer |
| Inheritance | IconItemRenderer  LabelItemRenderer UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IGraphicElementContainer, ISharedDisplayObject |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
- An icon on the left defined by the
iconFieldoriconFunctionproperty. - A single-line text label next to the icon defined by the
labelFieldorlabelFunctionproperty. - A multi-line message below the text label defined by the
messageFieldormessageFunctionproperty. - A decorator icon on the right defined by the
decoratorproperty.
To apply CSS styles to the single-line text label, such as font size and color,
set the styles on the IconItemRenderer class.
To set styles on the multi-line message, use the messageStyleNameM style property.
The following example sets the text styles for both the text label and message:
<fx:Style>
.myFontStyle {
fontSize: 15;
color: #9933FF;
}
</fx:Style>
<s:List id="myList"
width="100%" height="100%"
labelField="firstName">
<s:itemRenderer>
<fx:Component>
<s:IconItemRenderer messageStyleName="myFontStyle" fontSize="25"
labelField="firstName"
messageField="lastName"
decorator="@Embed(source='assets/logo_small.jpg')"/>
</fx:Component>
</s:itemRenderer>
<s:ArrayCollection>
<fx:Object firstName="Dave" lastName="Duncam" company="Adobe" phone="413-555-1212"/>
<fx:Object firstName="Sally" lastName="Smith" company="Acme" phone="617-555-1491"/>
<fx:Object firstName="Jim" lastName="Jackson" company="Beta" phone="413-555-2345"/>
<fx:Object firstName="Mary" lastName="Moore" company="Gamma" phone="617-555-1899"/>
</s:ArrayCollection>
</s:List>
MXML Syntax
Show MXML Syntax
Hide MXML SyntaxThe <s:IconItemRenderer> tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
<s:IconItemRenderer
Properties
decorator=""
iconContentLoader="See property description"
iconField="null"
iconFillMode=""scale
iconFunction="null"
iconHeight="NaN"
iconPlaceholder="null"
iconScaleMode="stretch"
iconWidth="NaN"
label=""
labelField="null"
labelFunction="null"
messageField="null"
messageFunction="null"
Common Styles
horizontalGap="8"
iconDelay="500"
messageStyleName="iconItemRendererMessageStyle"
verticalGap="6"
>
More examples
Related API Elements
spark.components.List
mx.core.IDataRenderer
spark.components.IItemRenderer
spark.components.supportClasses.ItemRenderer
spark.components.LabelItemRenderer
mx.core.IDataRenderer
spark.components.IItemRenderer
spark.components.supportClasses.ItemRenderer
spark.components.LabelItemRenderer
Public Properties
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| applicationDPI : Number [read-only]
Returns the DPI of the application. | LabelItemRenderer | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | |
| automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | |
| automationName : String
Name that can be used as an identifier for this object. | UIComponent | |
| automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | |
| automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UIComponent | |
| automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array [read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application. | UIComponent | |
| automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIComponent | |
| baseline : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | UIComponent | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | |
| blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | |
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | |
| cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | |
| contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| currentState : String
The current view state of the component. | UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | |
| data : Object
The implementation of the data property
as defined by the IDataRenderer interface. | LabelItemRenderer | |
| decorator : Object
The decorator icon that appears on the right side
of this item renderer. | IconItemRenderer | ||
| depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | |
| document : Object
A reference to the document object associated with this UIComponent. | UIComponent | |
| doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | |
| dragging : Boolean
Contains true if the item renderer is being dragged. | LabelItemRenderer | |
| dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | |
| enabled : Boolean
Whether the component can accept user interaction. | UIComponent | |
| errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | UIComponent | |
| focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | |
| graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | |
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| iconContentLoader : IContentLoader
Optional custom image loader, such as an image cache or queue, to
associate with content loader client. | IconItemRenderer | ||
| iconField : String
The name of the field in the data item to display as the icon. | IconItemRenderer | ||
| iconFillMode : String
Determines how the bitmap fills in the dimensions. | IconItemRenderer | ||
| iconFunction : Function
A user-supplied function to run on each item to determine its icon. | IconItemRenderer | ||
| iconHeight : Number
The height of the icon. | IconItemRenderer | ||
| iconPlaceholder : Object
The icon asset to use while an externally loaded asset is
being downloaded. | IconItemRenderer | ||
| iconScaleMode : String
Determines how the image is scaled when fillMode is set to
mx.graphics.BitmapFillMode.SCALE. | IconItemRenderer | ||
| iconWidth : Number
The width of the icon. | IconItemRenderer | ||
| id : String
ID of the component. | UIComponent | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles. | UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required). | UIComponent | |
| instanceIndex : int [read-only]
The index of a repeated component. | UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document. | UIComponent | |
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIComponent | |
| isDocument : Boolean [read-only]
Contains true if this UIComponent instance is a document object. | UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| itemIndex : int
The index of the item in the data provider
of the host component of the item renderer. | LabelItemRenderer | |
| label : String [override]
If labelFunction = labelField = null,
then use the label property that gets
pushed in from the list control. | IconItemRenderer | ||
| labelField : String
The name of the field in the data provider items to display
as the label. | IconItemRenderer | ||
| labelFunction : Function
A user-supplied function to run on each item to determine its label. | IconItemRenderer | ||
| layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | |
| left : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels. | UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels. | UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels. | UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels. | UIComponent | |
| messageField : String
The name of the field in the data items to display
as the message. | IconItemRenderer | ||
| messageFunction : Function
A user-supplied function to run on each item to determine its message. | IconItemRenderer | ||
| metaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the
the instance of this DisplayObject in the SWF file through a PlaceObject4 tag. | DisplayObject | |
| minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| moduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for
finding the style manager that controls the styles for this
component. | UIComponent | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | |
| nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | |
| numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | |
| numChildren : int [read-only]
Returns the number of children of this object. | DisplayObjectContainer | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | |
| parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | |
| parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | |
| parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | |
| percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UIComponent | |
| postLayoutTransformOffsets : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | UIComponent | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| redrawRequested : Boolean
Contains true when any of the IGraphicElement objects that share
this DisplayObject need to redraw. | IconItemRenderer | ||
| repeater : IRepeater [read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent. | UIComponent | |
| repeaterIndex : int [read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent. | UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent. | UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent. | UIComponent | |
| right : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
| rotation : Number [override]
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| selected : Boolean
Contains true if the item renderer
can show itself as selected. | LabelItemRenderer | |
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| showsCaret : Boolean
Contains true if the item renderer
can show itself as focused. | LabelItemRenderer | |
| softKeyboard : String
Controls the appearance of the soft keyboard. | InteractiveObject | |
| softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). | InteractiveObject | |
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| stage : Stage [read-only]
The Stage of the display object. | DisplayObject | |
| states : Array
The view states that are defined for this component. | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | |
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | |
| tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| transform : flash.geom:Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | |
| uid : String
A unique identifier for the object. | UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | UIComponent | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| verticalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| visible : Boolean [override]
Whether or not the display object is visible. | UIComponent | |
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | |
| y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | |
| z : Number [override]
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | UIComponent | |
Protected Properties
| Property | Defined By | ||
|---|---|---|---|
| currentCSSState : String [read-only]
The state to be used when matching CSS pseudo-selectors. | UIComponent | |
| decoratorDisplay : BitmapImage
The display object component used to
display the decorator for this item renderer. | IconItemRenderer | ||
| down : Boolean
Set to true when the user is pressing down on an item renderer. | LabelItemRenderer | |
| hasComplexLayoutMatrix : Boolean [read-only]
Returns true if the UIComponent has any non-translation (x,y) transform properties. | UIComponent | |
| hovered : Boolean
Set to true when the user is hovered over the item renderer. | LabelItemRenderer | |
| iconDisplay : BitmapImage
The bitmap image component used to
display the icon data of the item renderer. | IconItemRenderer | ||
| labelDisplay : spark.components.supportClasses:StyleableTextField
The text component used to
display the label data of the item renderer. | LabelItemRenderer | |
| messageDisplay : spark.components.supportClasses:StyleableTextField
The text component used to
display the message data of the item renderer. | IconItemRenderer | ||
| resourceManager : IResourceManager [read-only]
A reference to the object which manages
all of the application's localized resources. | UIComponent | |
| unscaledHeight : Number [read-only]
A convenience method for determining the unscaled height
of the component. | UIComponent | |
| unscaledWidth : Number [read-only]
A convenience method for determining the unscaled width
of the component
All of a component's drawing and child layout should be done
within a bounding rectangle of this width, which is also passed
as an argument to updateDisplayList(). | UIComponent | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Constructor. | IconItemRenderer | ||
|
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | DisplayObjectContainer | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Adds a non-visual style client to this component instance. | UIComponent | |
|
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | |
|
Queues a function to be called later. | UIComponent | |
|
Deletes a style property from this component instance. | UIComponent | |
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
|
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
|
Converts a Point object from content to local coordinates. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
|
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | |
|
Called by the effect instance when it stops playing on the component. | UIComponent | |
|
Called by the effect instance when it starts playing on the component. | UIComponent | |
|
Ends all currently playing effects on the component. | UIComponent | |
|
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
|
Called after printing is complete. | UIComponent | |
|
Provides the automation object at the specified index. | UIComponent | |
|
Provides the automation object list . | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance. | UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Gets the object that currently has focus. | UIComponent | |
|
Returns the element's layout height. | UIComponent | |
|
Returns the element's layout width. | UIComponent | |
|
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
|
Returns the layout transform Matrix3D for this element. | UIComponent | |
|
Returns the element's maximum height. | UIComponent | |
|
Returns the element's maximum width. | UIComponent | |
|
Returns the element's minimum height. | UIComponent | |
|
Returns the element's minimum width. | UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Returns the element's preferred height. | UIComponent | |
|
Returns the element's preferred width. | UIComponent | |
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
|
Converts a Point object from global to content coordinates. | UIComponent | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
|
Returns true if currentCSSState is not null. | UIComponent | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
|
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
Initializes the internal structure of this component. | UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
Notify the host component that an element has changed and needs to be redrawn. | IconItemRenderer | ||
Notify the host component that an element changed and needs to validate properties. | IconItemRenderer | ||
Notify the host that an element layer has changed. | IconItemRenderer | ||
Notify the host component that an element size has changed. | IconItemRenderer | ||
|
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
|
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | |
|
Converts a Point object from local to content coordinates. | UIComponent | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Returns true if cssState matches currentCSSState. | UIComponent | |
|
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
|
Measures the specified HTML text, which can contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Moves the component to a specified position within its parent. | UIComponent | |
|
Propagates style changes to the children. | UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
|
Prepares an IFlexDisplayObject for printing. | UIComponent | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
|
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | |
|
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Removes a non-visual style client from this component instance. | UIComponent | |
|
Replays the specified event. | UIComponent | |
|
Raises a virtual keyboard. | InteractiveObject | |
|
Resolves a child by using the id provided. | UIComponent | |
| [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
|
Sizes the object. | UIComponent | |
|
Changes the position of an existing child in the display object container. | DisplayObjectContainer | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
|
Set the current state. | UIComponent | |
|
Sets the focus to this component. | UIComponent | |
|
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
|
Sets the layout size of the element. | UIComponent | |
|
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets a style property on this component instance. | UIComponent | |
|
Called when the visible property changes. | UIComponent | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | |
|
Recursively stops the timeline execution of all MovieClips rooted at this object. | DisplayObjectContainer | |
|
Ends the startDrag() method. | Sprite | |
|
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | |
|
Detects changes to style properties. | UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | |
|
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | |
|
Validates the position and size of children and draws other
visuals. | UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
|
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. | UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
Styles
Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.
Common Styles
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, Color of text in the component, including the component label. | LabelItemRenderer | ||
| Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of the component highlight when validation fails. | UIComponent | ||
| Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Skin used to draw the focus rectangle. | UIComponent | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, Name of the font to use. | LabelItemRenderer | ||
| Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, Height of the text, in pixels. | LabelItemRenderer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, Determines whether the text is italic font. | LabelItemRenderer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, Determines whether the text is boldface. | LabelItemRenderer | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
horizontalGap | Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, Number of pixels between children in the horizontal direction. The default value depends on the component class; if not overridden for the class, the default value is 8. | IconItemRenderer | ||
iconDelay | Type: Number Format: Time CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, The delay value before attempting to load the icon's source if it has not been cached already. The reason a delay is useful is while scrolling around, you don't necessarily want the image to load up immediately. Instead, you should wait a certain delay period to make sure the user actually wants to see this item renderer. The default value is 500. | IconItemRenderer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 2.5 The primary interaction mode for this component. | UIComponent | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.1 Runtime Versions: Flash10, AIR 1.5 Specifies the desired layout direction of a component. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, Additional vertical space between lines of text. | LabelItemRenderer | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent | ||
| Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, The number of additional pixels to appear between each character. | LabelItemRenderer | ||
messageStyleName | Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, Name of the CSS Style declaration to use for the styles for the message component. The default value is iconItemRendererMessageStyle. | IconItemRenderer | ||
| Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, Number of pixels between the bottom border and the text component of the item renderer. | LabelItemRenderer | ||
| Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Number of pixels between the component's left border and the left edge of its content area. | LabelItemRenderer | ||
| Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Number of pixels between the component's right border and the right edge of its content area. | LabelItemRenderer | ||
| Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, Number of pixels between the top border and the text component of the item renderer. | LabelItemRenderer | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, Color of the highlights when the mouse is over the component. | LabelItemRenderer | ||
| Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, The color of the background of a renderer when the user selects it. | LabelItemRenderer | ||
| Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 1.5 Show the error border or skin when this component is invalid | UIComponent | ||
| Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 1.5 Show the error tip when this component is invalid and the user rolls over it | UIComponent | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, Alignment of text within a container. | LabelItemRenderer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, Determines whether the text is underlined. | LabelItemRenderer | ||
| Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, Offset of first line of text from the left side of the container, in pixels. | LabelItemRenderer | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, The vertical alignment of the content when it does not have a one-to-one aspect ratio. | LabelItemRenderer | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
verticalGap | Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, Number of pixels between children in the vertical direction. The default value depends on the component class; if not overridden for the class, the default value is 6. | IconItemRenderer | ||
Spark Theme Styles
Halo Theme Styles
Mobile Theme Styles
Public Constants
Property Detail
decorator | property |
decorator:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
The decorator icon that appears on the right side of this item renderer.
The decorator icon ignores the verticalAlign style
and is always centered vertically.
The decorator icon is expected to be an embedded asset. There can be performance degradation if using external assets.
The default value is "".
Implementation
public function get decorator():Object public function set decorator(value:Object):void decoratorDisplay | property |
protected var decoratorDisplay:BitmapImage| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
The display object component used to display the decorator for this item renderer.
The default value is null.
iconContentLoader | property |
iconContentLoader:IContentLoader| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
Optional custom image loader, such as an image cache or queue, to associate with content loader client.
The default value is a static content cache defined on IconItemRenderer that allows up to 100 entries.
Implementation
public function get iconContentLoader():IContentLoader public function set iconContentLoader(value:IContentLoader):void iconDisplay | property |
protected var iconDisplay:BitmapImage| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
The bitmap image component used to display the icon data of the item renderer.
iconField | property |
iconField:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
The name of the field in the data item to display as the icon.
By default iconField is null, and the item renderer
does not display an icon.
The default value is null.
Implementation
public function get iconField():String public function set iconField(value:String):void iconFillMode | property |
iconFillMode:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
Determines how the bitmap fills in the dimensions. If you set the value
of this property in a tag, use the string (such as "repeat"). If you set the value of
this property in ActionScript, use the constant (such as mx.graphics.BitmapFillMode.CLIP).
When set to BitmapFillMode.CLIP ("clip"), the bitmap
ends at the edge of the region.
When set to BitmapFillMode.REPEAT ("repeat"), the bitmap
repeats to fill the region.
When set to BitmapFillMode.SCALE ("scale"), the bitmap
stretches to fill the region.
The default value is mx.graphics.BitmapFillMode.SCALE.
Implementation
public function get iconFillMode():String public function set iconFillMode(value:String):voidRelated API Elements
iconFunction | property |
iconFunction:Function| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
A user-supplied function to run on each item to determine its icon.
The iconFunction property overrides
the iconField property.
You can supply an iconFunction that finds the
appropriate fields and returns a valid URL or object to be used as
the icon.
The icon function takes a single argument which is the item in
the data provider and returns an Object that gets passed to a
spark.primitives.BitmapImage object as the source
property. Icon function can return a valid URL pointing to an image
or a Class file that represents an image. To see what other types
of objects can be returned from the icon
function, see the BitmapImage's documentation
myIconFunction(item:Object):Object
The default value is null.
Implementation
public function get iconFunction():Function public function set iconFunction(value:Function):voidRelated API Elements
iconHeight | property |
iconHeight:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
The height of the icon. If unspecified, the intrinsic height of the image is used.
The default value is NaN.
Implementation
public function get iconHeight():Number public function set iconHeight(value:Number):void iconPlaceholder | property |
iconPlaceholder:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
The icon asset to use while an externally loaded asset is being downloaded.
This asset should be an embedded image and not an externally loaded image.
The default value is null.
Implementation
public function get iconPlaceholder():Object public function set iconPlaceholder(value:Object):void iconScaleMode | property |
iconScaleMode:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
Determines how the image is scaled when fillMode is set to
mx.graphics.BitmapFillMode.SCALE.
When set to mx.graphics.BitmapScaleMode.STRETCH ("stretch"),
the image is stretched to fit.
When set to BitmapScaleMode.LETTERBOX ("letterbox"),
the image is scaled with respect to the original unscaled image's
aspect ratio.
When set to BitmapScaleMode.ZOOM ("zoom"),
the image is scaled to fit with respect to the original unscaled image's
aspect ratio. This results in cropping on one axis.
The default value is mx.graphics.BitmapScaleMode.STRETCH.
Implementation
public function get iconScaleMode():String public function set iconScaleMode(value:String):voidRelated API Elements
iconWidth | property |
iconWidth:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
The width of the icon. If unspecified, the intrinsic width of the image is used.
The default value is NaN.
Implementation
public function get iconWidth():Number public function set iconWidth(value:Number):void label | property |
label:String[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
If labelFunction = labelField = null,
then use the label property that gets
pushed in from the list control.
However if labelField is explicitly set to
"" (the empty string), then no label appears.
The host component of the item renderer can use the
itemToLabel() method to convert the data item
to a String for display by the item renderer.
For controls like List and ButtonBar, you can use the
labelField or labelFunction properties
to specify the field of the data item that contains the String.
Otherwise the host component uses the toString() method
to convert the data item to a String.
Implementation
override public function get label():String override public function set label(value:String):voidRelated API Elements
labelField | property |
labelField:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
The name of the field in the data provider items to display
as the label.
The labelFunction property overrides this property.
If labelFunction = labelField = null,
then use the label property that gets
pushed in from the list-based control.
However if labelField is explicitly set to
"" (the empty string),
then no label appears.
The default value is null.
Implementation
public function get labelField():String public function set labelField(value:String):voidRelated API Elements
labelFunction | property |
labelFunction:Function| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
A user-supplied function to run on each item to determine its label.
The labelFunction property overrides
the labelField property.
You can supply a labelFunction that finds the
appropriate fields and returns a displayable string. The
labelFunction is also good for handling formatting and
localization.
The label function takes a single argument which is the item in the data provider and returns a String.
myLabelFunction(item:Object):String
If labelFunction = labelField = null,
then use the label property that gets
pushed in from the list-based control.
However if labelField is explicitly set to
"" (the empty string),
then no label appears.
The default value is null.
Implementation
public function get labelFunction():Function public function set labelFunction(value:Function):voidRelated API Elements
messageDisplay | property |
protected var messageDisplay:spark.components.supportClasses:StyleableTextField| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
The text component used to display the message data of the item renderer.
messageField | property |
messageField:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
The name of the field in the data items to display
as the message.
The messageFunction property overrides this property.
Use the messageStyleName style to control the
appearance of the text.
The default value is null.
Implementation
public function get messageField():String public function set messageField(value:String):void messageFunction | property |
messageFunction:Function| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
A user-supplied function to run on each item to determine its message.
The messageFunction property overrides
the messageField property.
You can supply a messageFunction that finds the
appropriate fields and returns a displayable string. The
messageFunction is also good for handling formatting and
localization.
The message function takes a single argument which is the item in the data provider and returns a String.
myMessageFunction(item:Object):String
The default value is null.
Implementation
public function get messageFunction():Function public function set messageFunction(value:Function):void redrawRequested | property |
redrawRequested:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Contains true when any of the IGraphicElement objects that share
this DisplayObject need to redraw.
This property is used internally by the Group class
and you do not typically use it.
The Group class sets and reads back this property to
determine which graphic elements to validate.
Implementation
public function get redrawRequested():Boolean public function set redrawRequested(value:Boolean):voidConstructor Detail
IconItemRenderer | () | Constructor |
public function IconItemRenderer()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
Constructor.
Method Detail
invalidateGraphicElementDisplayList | () | method |
public function invalidateGraphicElementDisplayList(element:IGraphicElement):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
Notify the host component that an element has changed and needs to be redrawn.
The IGraphicElementHost must call the validateDisplayList()
method on the IGraphicElement to give it a chance to redraw.
Typically the host will validate the elements' display lists in its
validateDisplayList() method.
Parameters
element:IGraphicElement — The element that has changed.
|
invalidateGraphicElementProperties | () | method |
public function invalidateGraphicElementProperties(element:IGraphicElement):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
Notify the host component that an element changed and needs to validate properties.
The IGraphicElementHost must call the validateProperties()
method on the IGraphicElement to give it a chance to commit its properties.
Typically the host will validate the elements' properties in its
validateProperties() method.
Parameters
element:IGraphicElement — The element that has changed.
|
invalidateGraphicElementSharing | () | method |
public function invalidateGraphicElementSharing(element:IGraphicElement):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
Notify the host that an element layer has changed.
The IGraphicElementHost must re-evaluates the sequences of
graphic elements with shared DisplayObjects and may need to re-assign the
DisplayObjects and redraw the sequences as a result.
Typically the host will perform this in its
validateProperties() method.
Parameters
element:IGraphicElement — The element that has changed size.
|
invalidateGraphicElementSize | () | method |
public function invalidateGraphicElementSize(element:IGraphicElement):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
Notify the host component that an element size has changed.
The IGraphicElementHost must call the validateSize()
method on the IGraphicElement to give it a chance to validate its size.
Typically the host will validate the elements' size in its
validateSize() method.
Parameters
element:IGraphicElement — The element that has changed size.
|
Examples How to use this example
IconItemRendererExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the spark IconItemRenderer component -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:s="library://ns.adobe.com/flex/spark">
<s:List width="100%"
height="100%"
alternatingItemColors="0xE3E3E3"
contentBackgroundColor="0xF9F9F9"
downColor="0x70B2EE"
selectionColor="0x70B2EE"
labelField="productName">
<s:itemRenderer>
<fx:Component>
<s:IconItemRenderer
decorator="@Embed('assets/decoratorImage.png')"
iconPlaceholder="@Embed('assets/loadingImage.png')"
iconField="productIcon"
iconWidth="125"
iconHeight="125"
messageField="productDesc" />
</fx:Component>
</s:itemRenderer>
<s:dataProvider>
<s:ArrayList>
<fx:Object productIcon="assets/fx.jpg" productName="Flex SDK"
productDesc="A highly productive, free, open source framework."/>
<fx:Object productIcon="assets/fb.jpg" productName="Flash Builder"
productDesc="Designed to help developers rapidly develop RIAs."/>
<fx:Object productIcon="assets/fc.jpg" productName="Flash Catalyst"
productDesc="An approachable new interaction design tool."/>
</s:ArrayList>
</s:dataProvider>
</s:List>
</s:Application>
Wed Nov 21 2018, 06:34 AM -08:00