spark.components.IconItemRenderer

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
		accessibilityName : String A convenience accessor for the name property in this UIComponent's accessibilityProperties object.	UIComponent
		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
		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
		bottom : Object For components, this layout constraint property is a facade on top of the similarly-named style.	UIComponent
		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
		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
		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
		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
		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
		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
		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
		maintainProjectionCenter : Boolean When true, the component keeps its projection matrix centered on the middle of its bounding box.	UIComponent
		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
		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
		mouseFocusEnabled : Boolean Whether you can receive focus when clicked on.	UIComponent
		MXMLDescriptor : Array [read-only]	UIComponent
		MXMLProperties : Array [read-only]	UIComponent
		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
		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 : 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
		rotation : Number [override]	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]	UIComponent
		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
		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
		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
		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
		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 : 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
		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]	UIComponent

	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 : StyleableTextField The text component used to display the label data of the item renderer.	LabelItemRenderer
		messageDisplay : 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

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		IconItemRenderer() Constructor.	IconItemRenderer
		addStyleClient(styleClient:IAdvancedStyleClient):void Adds a non-visual style client to this component instance.	UIComponent
		callLater(method:Function, args:Array = null):void Queues a function to be called later.	UIComponent
		clearStyle(styleProp:String):void Deletes a style property from this component instance.	UIComponent
		contentToGlobal(point:Point):Point Converts a Point object from content coordinates to global coordinates.	UIComponent
		contentToLocal(point:Point):Point Converts a Point object from content to local coordinates.	UIComponent
		createAutomationIDPart(child:IAutomationObject):Object Returns a set of properties that identify the child within this container.	UIComponent
		createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object Returns a set of properties as automation IDs that identify the child within this container.	UIComponent
		createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Creates an id reference to this IUIComponent object on its parent document object.	UIComponent
		deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Deletes the id reference to this IUIComponent object on its parent document object.	UIComponent
		determineTextFormatFromStyles():UITextFormat Returns a UITextFormat object corresponding to the text styles for this UIComponent.	UIComponent
		dispatchEvent(event:Event):Boolean [override] Dispatches an event into the event flow.	UIComponent
		drawFocus(isFocused:Boolean):void 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
		effectFinished(effectInst:IEffectInstance):void Called by the effect instance when it stops playing on the component.	UIComponent
		effectStarted(effectInst:IEffectInstance):void Called by the effect instance when it starts playing on the component.	UIComponent
		endEffectsStarted():void Ends all currently playing effects on the component.	UIComponent
		executeBindings(recurse:Boolean = false):void Executes all the bindings for which the UIComponent object is the destination.	UIComponent
		finishPrint(obj:Object, target:IFlexDisplayObject):void Called after printing is complete.	UIComponent
		generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array	UIComponent
		generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):*	UIComponent
		getAutomationChildAt(index:int):IAutomationObject Provides the automation object at the specified index.	UIComponent
		getAutomationChildren():Array Provides the automation object list .	UIComponent
		getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the x coordinate of the element's bounds at the specified element size.	UIComponent
		getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the y coordinate of the element's bounds at the specified element size.	UIComponent
		getClassStyleDeclarations():Array Finds the type selectors for this UIComponent instance.	UIComponent
		getConstraintValue(constraintName:String):* Returns a layout constraint value, which is the same as getting the constraint style for this component.	UIComponent
		getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height	UIComponent
		getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width	UIComponent
		getFocus():InteractiveObject Gets the object that currently has focus.	UIComponent
		getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's layout height.	UIComponent
		getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's layout width.	UIComponent
		getLayoutBoundsX(postLayoutTransform:Boolean = true):Number Returns the x coordinate that the element uses to draw on screen.	UIComponent
		getLayoutBoundsY(postLayoutTransform:Boolean = true):Number Returns the y coordinate that the element uses to draw on screen.	UIComponent
		getLayoutMatrix():Matrix Returns the transform matrix that is used to calculate the component's layout relative to its siblings.	UIComponent
		getLayoutMatrix3D():Matrix3D Returns the layout transform Matrix3D for this element.	UIComponent
		getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's maximum height.	UIComponent
		getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's maximum width.	UIComponent
		getMinBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's minimum height.	UIComponent
		getMinBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's minimum width.	UIComponent
		getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's preferred height.	UIComponent
		getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's preferred width.	UIComponent
		getRepeaterItem(whichRepeater:int = -1):Object 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
		getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain.	UIComponent
		getVisibleRect(targetParent:DisplayObject = null):Rectangle Get the bounds of this object that are visible to the user on the screen.	UIComponent
		globalToContent(point:Point):Point Converts a Point object from global to content coordinates.	UIComponent
		hasCSSState():Boolean Returns true if currentCSSState is not null.	UIComponent
		hasState(stateName:String):Boolean Determines whether the specified state has been defined on this UIComponent.	UIComponent
		horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient.	UIComponent
		initialize():void Initializes the internal structure of this component.	UIComponent
		initializeRepeaterArrays(parent:IRepeaterClient):void Initializes various properties which keep track of repeated instances of this component.	UIComponent
		invalidateDisplayList():void Marks a component so that its updateDisplayList() method gets called during a later screen update.	UIComponent
		invalidateGraphicElementDisplayList(element:IGraphicElement):void Notify the host component that an element has changed and needs to be redrawn.	IconItemRenderer
		invalidateGraphicElementProperties(element:IGraphicElement):void Notify the host component that an element changed and needs to validate properties.	IconItemRenderer
		invalidateGraphicElementSharing(element:IGraphicElement):void Notify the host that an element layer has changed.	IconItemRenderer
		invalidateGraphicElementSize(element:IGraphicElement):void Notify the host component that an element size has changed.	IconItemRenderer
		invalidateLayering():void Called by a component's items to indicate that their depth property has changed.	UIComponent
		invalidateLayoutDirection():void An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.	UIComponent
		invalidateProperties():void Marks a component so that its commitProperties() method gets called during a later screen update.	UIComponent
		invalidateSize():void Marks a component so that its measure() method gets called during a later screen update.	UIComponent
		localToContent(point:Point):Point Converts a Point object from local to content coordinates.	UIComponent
		matchesCSSState(cssState:String):Boolean Returns true if cssState matches currentCSSState.	UIComponent
		matchesCSSType(cssType:String):Boolean Determines whether this instance is the same as, or is a subclass of, the given type.	UIComponent
		measureHTMLText(htmlText:String):TextLineMetrics 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
		measureText(text:String):TextLineMetrics 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
		move(x:Number, y:Number):void Moves the component to a specified position within its parent.	UIComponent
		notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propagates style changes to the children.	UIComponent
		owns(child:DisplayObject):Boolean Returns true if the chain of owner properties points from child to this UIComponent.	UIComponent
		parentChanged(p:DisplayObjectContainer):void Called by Flex when a UIComponent object is added to or removed from a parent.	UIComponent
		prepareToPrint(target:IFlexDisplayObject):Object Prepares an IFlexDisplayObject for printing.	UIComponent
		regenerateStyleCache(recursive:Boolean):void 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
		registerEffects(effects:Array):void For each effect event, registers the EffectManager as one of the event listeners.	UIComponent
		removeStyleClient(styleClient:IAdvancedStyleClient):void Removes a non-visual style client from this component instance.	UIComponent
		replayAutomatableEvent(event:Event):Boolean Replays the specified event.	UIComponent
		resolveAutomationIDPart(criteria:Object):Array Resolves a child by using the id provided.	UIComponent
		resumeBackgroundProcessing():void [static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing().	UIComponent
		setActualSize(w:Number, h:Number):void Sizes the object.	UIComponent
		setConstraintValue(constraintName:String, value:*):void Sets a layout constraint value, which is the same as setting the constraint style for this component.	UIComponent
		setCurrentState(stateName:String, playTransition:Boolean = true):void Set the current state.	UIComponent
		setFocus():void Sets the focus to this component.	UIComponent
		setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void Sets the coordinates that the element uses to draw on screen.	UIComponent
		setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void Sets the layout size of the element.	UIComponent
		setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.	UIComponent
		setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.	UIComponent
		setMXMLDescriptor(value:Array):void	UIComponent
		setMXMLProperties(value:Array):void	UIComponent
		setStyle(styleProp:String, newValue:*):void Sets a style property on this component instance.	UIComponent
		setVisible(value:Boolean, noEvent:Boolean = false):void Called when the visible property changes.	UIComponent
		styleChanged(styleProp:String):void Detects changes to style properties.	UIComponent
		stylesInitialized():void Flex calls the stylesInitialized() method when the styles for a component are first initialized.	UIComponent
		suspendBackgroundProcessing():void [static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.	UIComponent
		toString():String [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
		transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void 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
		validateDisplayList():void Validates the position and size of children and draws other visuals.	UIComponent
		validateNow():void Validate and update the properties and layout of this object and redraw it, if necessary.	UIComponent
		validateProperties():void Used by layout logic to validate the properties of a component by calling the commitProperties() method.	UIComponent
		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.	UIComponent
		validationResultHandler(event:ValidationResultEvent):void Handles both the valid and invalid events from a validator assigned to this component.	UIComponent
		verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient.	UIComponent

	Method	Defined By
		addMXMLChildren(comps:Array):void	UIComponent
		adjustFocusRect(obj:DisplayObject = null):void Adjust the focus rectangle.	UIComponent
		applyComputedMatrix():void Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform.	UIComponent
		attachOverlay():void This is an internal method used by the Flex framework to support the Dissolve effect.	UIComponent
		canSkipMeasurement():Boolean Determines if the call to the measure() method can be skipped.	UIComponent
		childrenCreated():void Performs any final processing after child objects are created.	UIComponent
		commitProperties():void Processes the properties set on the component.	UIComponent
		createChildren():void Create child objects of the component.	UIComponent
		createInFontContext(classObj:Class):Object Creates a new object using a context based on the embedded font being used.	UIComponent
		createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object Creates the object using a given moduleFactory.	UIComponent
		createLabelDisplay():void Creates the labelDisplay component	LabelItemRenderer
		destroyLabelDisplay():void Destroys the labelDisplay component	LabelItemRenderer
		dispatchPropertyChangeEvent(prop:String, oldValue:, value:):void Helper method for dispatching a PropertyChangeEvent when a property is updated.	UIComponent
		drawBackground(unscaledWidth:Number, unscaledHeight:Number):void Renders a background for the item renderer.	LabelItemRenderer
		drawBorder(unscaledWidth:Number, unscaledHeight:Number):void Renders the border for the item renderer.	LabelItemRenderer
		focusInHandler(event:FocusEvent):void The event handler called when a UIComponent object gets focus.	UIComponent
		focusOutHandler(event:FocusEvent):void The event handler called when a UIComponent object loses focus.	UIComponent
		generateMXMLAttributes(data:Array):void	UIComponent
		generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void	UIComponent
		generateMXMLObject(document:Object, data:Array):Object	UIComponent
		getElementPreferredHeight(element:Object):Number	LabelItemRenderer
		getElementPreferredWidth(element:Object):Number	LabelItemRenderer
		initAdvancedLayoutFeatures():void Initializes the implementation and storage of some of the less frequently used advanced layout features of a component.	UIComponent
		initializationComplete():void Finalizes the initialization of this component.	UIComponent
		initializeAccessibility():void Initializes this component's accessibility code.	UIComponent
		invalidateParentSizeAndDisplayList():void Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true).	UIComponent
		isOurFocus(target:DisplayObject):Boolean Typically overridden by components containing UITextField objects, where the UITextField object gets focus.	UIComponent
		keyDownHandler(event:KeyboardEvent):void The event handler called for a keyDown event.	UIComponent
		keyUpHandler(event:KeyboardEvent):void The event handler called for a keyUp event.	UIComponent
		layoutContents(unscaledWidth:Number, unscaledHeight:Number):void Positions the children for this item renderer.	LabelItemRenderer
		measure():void Calculates the default size, and optionally the default minimum size, of the component.	UIComponent
		resourcesChanged():void This method is called when a UIComponent is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.	UIComponent
		setElementPosition(element:Object, x:Number, y:Number):void	LabelItemRenderer
		setElementSize(element:Object, width:Number, height:Number):void	LabelItemRenderer
		setStretchXY(stretchX:Number, stretchY:Number):void Specifies a transform stretch factor in the horizontal and vertical direction.	UIComponent
		stateChanged(oldState:String, newState:String, recursive:Boolean):void This method is called when a state changes to check whether state-specific styles apply to this component.	UIComponent
		updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void Draws the object and/or sizes and positions its children.	UIComponent

Summary	Defined By
add	Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method.	UIComponent
creationComplete	Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing.	UIComponent
currentStateChange	Dispatched after the view state has changed.	UIComponent
currentStateChanging	Dispatched after the currentState property changes, but before the view state changes.	UIComponent
dataChange	Dispatched when the data property changes.	LabelItemRenderer
dragComplete	Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop.	UIComponent
dragDrop	Dispatched by the drop target when the user releases the mouse over it.	UIComponent
dragEnter	Dispatched by a component when the user moves the mouse over the component during a drag operation.	UIComponent
dragExit	Dispatched by the component when the user drags outside the component, but does not drop the data onto the target.	UIComponent
dragOver	Dispatched by a component when the user moves the mouse while over the component during a drag operation.	UIComponent
dragStart	Dispatched by the drag initiator when starting a drag operation.	UIComponent
effectEnd	Dispatched after an effect ends.	UIComponent
effectStart	Dispatched just before an effect starts.	UIComponent
effectStop	Dispatched after an effect is stopped, which happens only by a call to stop() on the effect.	UIComponent
enterState	Dispatched after the component has entered a view state.	UIComponent
exitState	Dispatched just before the component exits a view state.	UIComponent
hide	Dispatched when an object's state changes from visible to invisible.	UIComponent
initialize	Dispatched when the component has finished its construction and has all initialization properties set.	UIComponent
invalid	Dispatched when a component is monitored by a Validator and the validation failed.	UIComponent
mouseDownOutside	Dispatched from a component opened using the PopUpManager when the user clicks outside it.	UIComponent
mouseWheelOutside	Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.	UIComponent
move	Dispatched when the object has moved.	UIComponent
preinitialize	Dispatched at the beginning of the component initialization sequence.	UIComponent
remove	Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method.	UIComponent
resize	Dispatched when the component is resized.	UIComponent
show	Dispatched when an object's state changes from invisible to visible.	UIComponent
stateChangeComplete	Dispatched after the component has entered a new state and any state transition animation to that state has finished playing.	UIComponent
stateChangeInterrupted	Dispatched when a component interrupts a transition to its current state in order to switch to a new state.	UIComponent
toolTipCreate	Dispatched by the component when it is time to create a ToolTip.	UIComponent
toolTipEnd	Dispatched by the component when its ToolTip has been hidden and is to be discarded soon.	UIComponent
toolTipHide	Dispatched by the component when its ToolTip is about to be hidden.	UIComponent
toolTipShow	Dispatched by the component when its ToolTip is about to be shown.	UIComponent
toolTipShown	Dispatched by the component when its ToolTip has been shown.	UIComponent
toolTipStart	Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.	UIComponent
touchInteractionEnd	A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture.	UIComponent
touchInteractionStart	A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture.	UIComponent
touchInteractionStarting	A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture.	UIComponent
updateComplete	Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).	UIComponent
valid	Dispatched when a component is monitored by a Validator and the validation succeeded.	UIComponent
valueCommit	Dispatched when values are changed programmatically or by user interaction.	UIComponent

Styles

Hide Inherited Styles

Show Inherited Styles

	Description	Defined By
alternatingItemColors	Type: Array Format: Color CSS Inheritance: yes Theme: spark, mobile The colors to use for the backgrounds of the items in the list.	LabelItemRenderer
baseline	Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position.	UIComponent
bottom	Type: String CSS Inheritance: no The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area.	UIComponent
chromeColor	Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile The main color for a component.	LabelItemRenderer
color	Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label.	LabelItemRenderer
downColor	Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile Color of the background of an item renderer when it is being pressed down If `downColor` is set to `undefined`, `downColor` is not used. The default value for the Spark theme is `undefined`.	LabelItemRenderer
errorColor	Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails.	UIComponent
focusColor	Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile Color of focus ring when the component is in focus.	LabelItemRenderer
focusSkin	Type: Class CSS Inheritance: no Skin used to draw the focus rectangle.	UIComponent
fontFamily	Type: String CSS Inheritance: yes Name of the font to use.	LabelItemRenderer
fontSize	Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels.	LabelItemRenderer
fontStyle	Type: String CSS Inheritance: yes Determines whether the text is italic font.	LabelItemRenderer
fontWeight	Type: String CSS Inheritance: yes Determines whether the text is boldface.	LabelItemRenderer
horizontalCenter	Type: String CSS Inheritance: no 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 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 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
interactionMode	Type: String CSS Inheritance: yes The primary interaction mode for this component. See also mx.core.InteractionMode.MOUSE mx.core.InteractionMode.TOUCH	UIComponent
layoutDirection	Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. See also MXFTEText.css mx.core.ILayoutDirectionElement mx.core.LayoutDirection	UIComponent
leading	Type: Number Format: Length CSS Inheritance: yes Additional vertical space between lines of text.	LabelItemRenderer
left	Type: String CSS Inheritance: no The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area.	UIComponent
letterSpacing	Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character.	LabelItemRenderer
messageStyleName	Type: String CSS Inheritance: no Name of the CSS Style declaration to use for the styles for the message component. The default value is `iconItemRendererMessageStyle`.	IconItemRenderer
paddingBottom	Type: Number Format: Length CSS Inheritance: no Number of pixels between the bottom border and the text component of the item renderer.	LabelItemRenderer
paddingLeft	Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's left border and the left edge of its content area.	LabelItemRenderer
paddingRight	Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's right border and the right edge of its content area.	LabelItemRenderer
paddingTop	Type: Number Format: Length CSS Inheritance: no Number of pixels between the top border and the text component of the item renderer.	LabelItemRenderer
right	Type: String CSS Inheritance: no The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area.	UIComponent
rollOverColor	Type: uint Format: Color CSS Inheritance: yes Color of the highlights when the mouse is over the component.	LabelItemRenderer
selectionColor	Type: uint Format: Color CSS Inheritance: yes The color of the background of a renderer when the user selects it.	LabelItemRenderer
showErrorSkin	Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid.	UIComponent
showErrorTip	Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it.	UIComponent
symbolColor	Type: uint Format: Color CSS Inheritance: yes Theme: spark,mobile Color of any symbol of a component.	LabelItemRenderer
textAlign	Type: String CSS Inheritance: yes Alignment of text within a container.	LabelItemRenderer
textDecoration	Type: String CSS Inheritance: yes Determines whether the text is underlined.	LabelItemRenderer
textIndent	Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels.	LabelItemRenderer
themeColor	Type: uint Format: Color CSS Inheritance: yes Theme: halo Theme color of a component.	UIComponent
top	Type: String CSS Inheritance: no The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area.	UIComponent
useOpaqueBackground	Type: Boolean CSS Inheritance: yes Option to use an opaqueBackground property for this renderer.	LabelItemRenderer
verticalAlign	Type: String CSS Inheritance: no The vertical alignment of the content when it does not have a one-to-one aspect ratio.	LabelItemRenderer
verticalCenter	Type: String CSS Inheritance: no 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 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

Description	Defined By
addedEffect	Triggering Event: added Played when the component is added as a child to a Container.	UIComponent
creationCompleteEffect	Triggering Event: creationComplete Played when the component is created.	UIComponent
focusInEffect	Triggering Event: focusIn Played when the component gains keyboard focus.	UIComponent
focusOutEffect	Triggering Event: focusOut Played when the component loses keyboard focus.	UIComponent
hideEffect	Triggering Event: hide Played when the component becomes invisible.	UIComponent
mouseDownEffect	Triggering Event: mouseDown Played when the user presses the mouse button while over the component.	UIComponent
mouseUpEffect	Triggering Event: mouseUp Played when the user releases the mouse button while over the component.	UIComponent
moveEffect	Triggering Event: move Played when the component is moved.	UIComponent
removedEffect	Triggering Event: removed Played when the component is removed from a Container.	UIComponent
resizeEffect	Triggering Event: resize Played when the component is resized.	UIComponent
rollOutEffect	Triggering Event: rollOut Played when the user rolls the mouse so it is no longer over the component.	UIComponent
rollOverEffect	Triggering Event: rollOver Played when the user rolls the mouse over the component.	UIComponent
showEffect	Triggering Event: show Played when the component becomes visible.	UIComponent

	Constant	Defined By
		DEFAULT_MAX_HEIGHT : Number = 10000 [static] The default value for the maxHeight property.	UIComponent
		DEFAULT_MAX_WIDTH : Number = 10000 [static] The default value for the maxWidth property.	UIComponent
		DEFAULT_MEASURED_HEIGHT : Number = 22 [static] The default value for the measuredHeight property.	UIComponent
		DEFAULT_MEASURED_MIN_HEIGHT : Number = 22 [static] The default value for the measuredMinHeight property.	UIComponent
		DEFAULT_MEASURED_MIN_WIDTH : Number = 40 [static] The default value for the measuredMinWidth property.	UIComponent
		DEFAULT_MEASURED_WIDTH : Number = 160 [static] The default value for the measuredWidth property.	UIComponent

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):void

See also

mx.graphics.BitmapFillMode

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):void

See also

spark.primitives.BitmapImage.source

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):void

See also

mx.graphics.BitmapScaleMode

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 String to display in the item renderer.

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
public function get label():String
public function set label(value:String):void

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):void

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

The default value is null.

Implementation
public function get labelFunction():Function
public function set labelFunction(value:Function):void

messageDisplay

property

protected var messageDisplay: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):void

Constructor 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

IconItemRendererExample.mxml

<?xml version="1.0" encoding="utf-8"?>
<!--

  Licensed to the Apache Software Foundation (ASF) under one or more
  contributor license agreements.  See the NOTICE file distributed with
  this work for additional information regarding copyright ownership.
  The ASF licenses this file to You under the Apache License, Version 2.0
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

-->
<!-- 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/boxx.jpg" productName="Product X" 
                           productDesc="A highly productive, free, open source framework."/>
                <fx:Object productIcon="assets/boxy.jpg" productName="Product Y" 
                           productDesc="Designed to help developers rapidly develop RIAs."/>
                <fx:Object productIcon="assets/boxz.jpg" productName="Product Z" 
                           productDesc="An approachable new interaction design tool."/>
            </s:ArrayList>
        </s:dataProvider>
    </s:List>
    
</s:Application>

Wed Nov 15 2017, 09:50 AM +01:00

Apache Flex 4.16.1 API Reference	All Packages \| All Classes \| Index \| Frames No Frames
IconItemRenderer	Properties \| Methods \| Events \| Styles \| Effects \| Constants \| Examples

Package	spark.components
Class	public class IconItemRenderer
Inheritance	IconItemRenderer LabelItemRenderer UIComponent FlexSprite flash.display.Sprite
Implements	IGraphicElementContainer, ISharedDisplayObject