Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.controls.dataGridClasses 
DataGridItemRenderer 
Packagemx.controls.dataGridClasses
Classpublic class DataGridItemRenderer
InheritanceDataGridItemRenderer Inheritance UITextField Inheritance FlexTextField Inheritance TextField Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Implements IDataRenderer, IDropInListItemRenderer, ILayoutManagerClient, IListItemRenderer, IStyleClient

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

The DataGridItemRenderer class defines the default item renderer for a DataGrid control. By default, the item renderer draws the text associated with each item in the grid.

You can override the default item renderer by creating a custom item renderer.

See also



Public Properties
 PropertyDefined By
 InheritedaccessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance.
InteractiveObject
 InheritedaccessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
DisplayObject
 Inheritedalpha : Number
Indicates the alpha transparency value of the object specified.
DisplayObject
 InheritedalwaysShowSelection : Boolean
When set to true and the text field is not in focus, Flash Player highlights the selection in the text field in gray.
TextField
 InheritedantiAliasType : String
The type of anti-aliasing used for this text field.
TextField
 InheritedautomationDelegate : Object
The delegate object which is handling the automation related functionality.
UITextField
 InheritedautomationEnabled : Boolean
[read-only] True if this component is enabled for automation, false otherwise.
UITextField
 InheritedautomationName : String
Name that can be used as an identifier for this object.
UITextField
 InheritedautomationOwner : DisplayObjectContainer
[read-only] The owner of this component for automation purposes.
UITextField
 InheritedautomationParent : DisplayObjectContainer
[read-only] The parent of this component for automation purposes.
UITextField
 InheritedautomationValue : 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.
UITextField
 InheritedautomationVisible : Boolean
[read-only] True if this component is visible for automation, false otherwise.
UITextField
 InheritedautoSize : String
Controls automatic sizing and alignment of text fields.
TextField
 Inheritedbackground : Boolean
Specifies whether the text field has a background fill.
TextField
 InheritedbackgroundColor : uint
The color of the text field background.
TextField
 InheritedbaselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text.
UITextField
 InheritedblendMode : String
A value from the BlendMode class that specifies which blend mode to use.
DisplayObject
 InheritedblendShader : Shader
[write-only] Sets a shader that is used for blending the foreground and background.
DisplayObject
 Inheritedborder : Boolean
Specifies whether the text field has a border.
TextField
 InheritedborderColor : uint
The color of the text field border.
TextField
 InheritedbottomScrollV : int
[read-only] An integer (1-based index) that indicates the bottommost line that is currently visible in the specified text field.
TextField
 InheritedcacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the display object.
DisplayObject
 InheritedAIR-only cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true.
DisplayObject
 InheritedcaretIndex : int
[read-only] The index of the insertion point (caret) position.
TextField
 InheritedclassName : String
[read-only] The name of this instance's class, such as "DataGridItemRenderer".
UITextField
 InheritedcondenseWhite : Boolean
A Boolean value that specifies whether extra white space (spaces, line breaks, and so on) in a text field with HTML text is removed.
TextField
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcontextMenu : NativeMenu
Specifies the context menu associated with this object.
InteractiveObject
  data : Object
The implementation of the data property as defined by the IDataRenderer interface.
DataGridItemRenderer
 InheriteddefaultTextFormat : flash.text:TextFormat
Specifies the format applied to newly inserted text, such as text entered by a user or text inserted with the replaceSelectedText() method.
TextField
 InheriteddisplayAsPassword : Boolean
Specifies whether the text field is a password text field.
TextField
 Inheriteddocument : Object
A reference to the document object associated with this UITextField object.
UITextField
 InheriteddoubleClickEnabled : Boolean
Specifies whether the object receives doubleClick events.
InteractiveObject
 InheritedembedFonts : Boolean
Specifies whether to render by using embedded font outlines.
TextField
 Inheritedenabled : Boolean
A Boolean value that indicates whether the component is enabled.
UITextField
 InheritedenableIME : Boolean
[read-only] A flag that indicates whether the IME should be enabled when the component receives focus.
UITextField
 InheritedexplicitHeight : Number
Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
UITextField
 InheritedexplicitMaxHeight : Number
[read-only] Number that specifies the maximum height of the component, in pixels, in the component's coordinates, if the maxHeight property is set.
UITextField
 InheritedexplicitMaxWidth : Number
[read-only] Number that specifies the maximum width of the component, in pixels, in the component's coordinates, if the maxWidth property is set.
UITextField
 InheritedexplicitMinHeight : Number
[read-only] The minimum recommended height of the component to be considered by the parent during layout.
UITextField
 InheritedexplicitMinWidth : Number
[read-only] The minimum recommended width of the component to be considered by the parent during layout.
UITextField
 InheritedexplicitWidth : Number
Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
UITextField
 Inheritedfilters : Array
An indexed array that contains each filter object currently associated with the display object.
DisplayObject
 InheritedfocusPane : Sprite
A single Sprite object that is shared among components and used as an overlay for drawing the focus indicator.
UITextField
 InheritedfocusRect : Object
Specifies whether this object displays a focus rectangle.
InteractiveObject
 InheritedgridFitType : String
The type of grid fitting used for this text field.
TextField
 Inheritedheight : Number
Indicates the height of the display object, in pixels.
DisplayObject
 InheritedhtmlText : String
Contains the HTML representation of the text field contents.
TextField
 InheritedignorePadding : Boolean
If true, the paddingLeft and paddingRight styles will not add space around the text of the component.
UITextField
 InheritedimeMode : String
Specifies the IME (input method editor) mode.
UITextField
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
UITextField
 InheritedinheritingStyles : Object
The beginning of this UITextField's chain of inheriting styles.
UITextField
 Inheritedinitialized : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required)
UITextField
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UITextField
 Inheritedlength : int
[read-only] The number of characters in a text field.
TextField
  listData : BaseListData
The implementation of the listData property as defined by the IDropInListItemRenderer interface.
DataGridItemRenderer
 InheritedloaderInfo : LoaderInfo
[read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.
DisplayObject
 Inheritedmask : DisplayObject
The calling display object is masked by the specified mask object.
DisplayObject
 InheritedmaxChars : int
The maximum number of characters that the text field can contain, as entered by a user.
TextField
 InheritedmaxHeight : Number
[read-only] The maximum recommended height of the component to be considered by the parent during layout.
UITextField
 InheritedmaxScrollH : int
[read-only] The maximum value of scrollH.
TextField
 InheritedmaxScrollV : int
[read-only] The maximum value of scrollV.
TextField
 InheritedmaxWidth : Number
[read-only] The maximum recommended width of the component to be considered by the parent during layout.
UITextField
 InheritedmeasuredHeight : Number
[read-only] The default height of the component, in pixels.
UITextField
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
UITextField
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
UITextField
 InheritedmeasuredWidth : Number
[read-only] The default width of the component, in pixels.
UITextField
 InheritedminHeight : Number
[read-only] The minimum recommended height of the component to be considered by the parent during layout.
UITextField
 InheritedminWidth : Number
[read-only] The minimum recommended width of the component to be considered by the parent during layout.
UITextField
 InheritedmoduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
UITextField
 InheritedmouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages.
InteractiveObject
 InheritedmouseWheelEnabled : Boolean
A Boolean value that indicates whether Flash Player automatically scrolls multiline text fields when the user clicks a text field and rolls the mouse wheel.
TextField
 InheritedmouseX : Number
[read-only] Indicates the x coordinate of the mouse or user input device position, in pixels.
DisplayObject
 InheritedmouseY : Number
[read-only] Indicates the y coordinate of the mouse or user input device position, in pixels.
DisplayObject
 Inheritedmultiline : Boolean
Indicates whether field is a multiline text field.
TextField
 Inheritedname : String
Indicates the instance name of the DisplayObject.
DisplayObject
 InheritednestLevel : int
Depth of this object in the containment hierarchy.
UITextField
 InheritednonInheritingStyles : Object
The beginning of this UITextField's chain of non-inheriting styles.
UITextField
 InheritednonZeroTextHeight : Number
[read-only] Unlike textHeight, this returns a non-zero value even when the text is empty.
UITextField
 InheritednumLines : int
[read-only] Defines the number of text lines in a multiline text field.
TextField
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
DisplayObject
 Inheritedowner : DisplayObjectContainer
By default, set to the parent container of this object.
UITextField
 Inheritedparent : DisplayObjectContainer
[override] [read-only] The parent container or component for this component.
UITextField
 InheritedpercentHeight : Number
Specifies the height of a component as a percentage of its parent's size.
UITextField
 InheritedpercentWidth : Number
Specifies the width of a component as a percentage of its parent's size.
UITextField
 InheritedprocessedDescriptors : Boolean
Set to true after the createChildren() method creates any internal component children.
UITextField
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedrestrict : String
Indicates the set of characters that a user can enter into the text field.
TextField
 Inheritedroot : 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
 Inheritedrotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
DisplayObject
 InheritedrotationX : Number
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
DisplayObject
 InheritedrotationY : Number
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
DisplayObject
 InheritedrotationZ : Number
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
DisplayObject
 Inheritedscale9Grid : Rectangle
The current scaling grid that is in effect.
DisplayObject
 InheritedscaleX : Number
Indicates the horizontal scale (percentage) of the object as applied from the registration point.
DisplayObject
 InheritedscaleY : Number
Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
DisplayObject
 InheritedscaleZ : Number
Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
DisplayObject
 InheritedscrollH : int
The current horizontal scrolling position.
TextField
 InheritedscrollRect : Rectangle
The scroll rectangle bounds of the display object.
DisplayObject
 InheritedscrollV : int
The vertical position of text in a text field.
TextField
 Inheritedselectable : Boolean
A Boolean value that indicates whether the text field is selectable.
TextField
 InheritedselectionBeginIndex : int
[read-only] The zero-based character index value of the first character in the current selection.
TextField
 InheritedselectionEndIndex : int
[read-only] The zero-based character index value of the last character in the current selection.
TextField
 Inheritedsharpness : Number
The sharpness of the glyph edges in this text field.
TextField
 Inheritedstage : Stage
[read-only] The Stage of the display object.
DisplayObject
  styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
DataGridItemRenderer
 InheritedstyleName : Object
The class style used by this component.
UITextField
 InheritedstyleSheet : StyleSheet
Attaches a style sheet to the text field.
TextField
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UITextField
 InheritedtabEnabled : Boolean
Specifies whether this object is in the tab order.
InteractiveObject
 InheritedtabIndex : int
Specifies the tab ordering of objects in a SWF file.
InteractiveObject
 Inheritedtext : String
A string that is the current text in the text field.
TextField
 InheritedtextColor : uint
The color of the text in a text field, in hexadecimal format.
TextField
 InheritedtextHeight : Number
[read-only] The height of the text in pixels.
TextField
 InheritedtextWidth : Number
[read-only] The width of the text in pixels.
TextField
 Inheritedthickness : Number
The thickness of the glyph edges in this text field.
TextField
 InheritedtoolTip : String
Text to display in the ToolTip.
UITextField
 Inheritedtransform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
DisplayObject
 InheritedtweeningProperties : Array
Array of properties that are currently being tweened on this object.
UITextField
 Inheritedtype : String
The type of the text field.
TextField
 InheritedupdateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required)
UITextField
 InheriteduseRichTextClipboard : Boolean
Specifies whether to copy and paste the text formatting along with the text.
TextField
 Inheritedvisible : Boolean
Whether or not the display object is visible.
DisplayObject
 Inheritedwidth : Number
Indicates the width of the display object, in pixels.
DisplayObject
 InheritedwordWrap : Boolean
A Boolean value that indicates whether the text field has word wrap.
TextField
 Inheritedx : Number
Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer.
DisplayObject
 Inheritedy : Number
Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer.
DisplayObject
 Inheritedz : Number
Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.
DisplayObject
Public Methods
 MethodDefined By
  
Constructor.
DataGridItemRenderer
 Inherited
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
 Inherited
Appends the string specified by the newText parameter to the end of the text of the text field.
TextField
  
Deletes a style property from this component instance.
DataGridItemRenderer
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.
DisplayObject
 Inherited
Returns a rectangle that is the bounding box of the character.
TextField
 Inherited
Returns the zero-based index value of the character at the point specified by the x and y parameters.
TextField
  
Returns an Array of CSSStyleDeclaration objects for the type selector that applies to this component, or null if none exist.
DataGridItemRenderer
 Inherited
A convenience method for determining whether to use the explicit or measured height
UITextField
 Inherited
A convenience method for determining whether to use the explicit or measured width
UITextField
 Inherited
Given a character index, returns the index of the first character in the same paragraph.
TextField
 Inherited
Returns a DisplayObject reference for the given id, for an image or SWF file that has been added to an HTML-formatted text field by using an <img> tag.
TextField
 Inherited
Returns the zero-based index value of the line at the point specified by the x and y parameters.
TextField
 Inherited
Returns the zero-based index value of the line containing the character specified by the charIndex parameter.
TextField
 Inherited
getLineLength(lineIndex:int):int
Returns the number of characters in a specific text line.
TextField
 Inherited
Returns metrics information about a given text line.
TextField
 Inherited
getLineOffset(lineIndex:int):int
Returns the character index of the first character in the line that the lineIndex parameter specifies.
TextField
 Inherited
Returns the text of the line specified by the lineIndex parameter.
TextField
 Inherited
Given a character index, returns the length of the paragraph containing the given character.
TextField
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
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
  
getStyle(styleProp:String):*
[override] Gets a style property that has been set anywhere in this component's style lookup chain.
DataGridItemRenderer
 Inherited
getTextFormat(beginIndex:int = -1, endIndex:int = -1):flash.text:TextFormat
Returns a TextFormat object that contains formatting information for the range of text that the beginIndex and endIndex parameters specify.
TextField
 Inherited
Returns the TextFormat object that represents character formatting information for this UITextField object.
UITextField
 Inherited
Returns a UITextFormat object that contains formatting information for this component.
UITextField
 Inherited
Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.
DisplayObject
 Inherited
Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.
DisplayObject
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
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
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.
DisplayObject
 Inherited
Initializes this component.
UITextField
  
Sets up the inheritingStyles and nonInheritingStyles objects and their proto chains so that the getStyle() method can work.
DataGridItemRenderer
 Inherited
Marks a component so that its updateDisplayList() method gets called during a later screen update.
UITextField
 Inherited
Marks a component so that its commitProperties() method gets called during a later screen update.
UITextField
 Inherited
Marks a component so that its measure() method gets called during a later screen update.
UITextField
 Inherited
isFontCompatible(fontName:String, fontStyle:String):Boolean
[static] Returns true if an embedded font is available with the specified fontName and fontStyle where Font.fontType is flash.text.FontType.EMBEDDED.
TextField
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
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
 Inherited
Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.
DisplayObject
 Inherited
Moves the component to a specified position within its parent.
UITextField
  
Propagates style changes to the children of this component.
DataGridItemRenderer
 Inherited
Returns true if the child is parented or owned by this object.
UITextField
 Inherited
This function is called when a UITextField object is assigned a parent.
UITextField
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
  
Sets up the internal style cache values so that the getStyle() method functions.
DataGridItemRenderer
  
Registers the EffectManager as one of the event listeners for each effect event.
DataGridItemRenderer
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Replaces the current selection with the contents of the value parameter.
TextField
 Inherited
replaceText(beginIndex:int, endIndex:int, newText:String):void
Replaces the range of characters that the beginIndex and endIndex parameters specify with the contents of the newText parameter.
TextField
 Inherited
Replays the specified event.
UITextField
 Inherited
Sizes the object.
UITextField
 Inherited
Sets the font color of the text.
UITextField
 Inherited
Sets the focus to this component.
UITextField
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
setSelection(beginIndex:int, endIndex:int):void
Sets as selected the text designated by the index values of the first and last characters, which are specified with the beginIndex and endIndex parameters.
TextField
  
setStyle(styleProp:String, newValue:*):void
[override] Sets a style property on this component instance.
DataGridItemRenderer
 Inherited
setTextFormat(format:flash.text:TextFormat, beginIndex:int = -1, endIndex:int = -1):void
Applies the text formatting that the format parameter specifies to the specified text in a text field.
TextField
 Inherited
setVisible(visible:Boolean, noEvent:Boolean = false):void
Sets the visible property of this UITextField object.
UITextField
 Inherited
Detects changes to style properties.
UITextField
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
[override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.
FlexTextField
 Inherited
truncateToFit(truncationIndicator:String = null):Boolean
Truncate text to make it fit horizontally in the area defined for the control, and append an ellipsis, three periods (...), to the text.
UITextField
  
If Flex calls LayoutManager.invalidateDisplayList() method on this ILayoutManagerClient, then this function is called when it's time to update the display list.
DataGridItemRenderer
 Inherited
Validate and update the properties and layout of this object and redraw it, if necessary.
UITextField
  
If Flex calls the LayoutManager.invalidateProperties() method on this ILayoutManagerClient, then this function is called when it's time to commit property values.
DataGridItemRenderer
  
validateSize(recursive:Boolean = false):void
If Flex calls the LayoutManager.invalidateSize() method on this ILayoutManagerClient, then this function is called when it's time to do measurements.
DataGridItemRenderer
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
  
The event handler to position the tooltip.
DataGridItemRenderer
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 InheritedDispatched when a display object is added to the display list.DisplayObject
 InheritedDispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 InheritedDispatched after a control value is modified, unlike the textInput event, which is dispatched before the value is modified.TextField
 InheritedDispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 InheritedDispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.InteractiveObject
 InheritedDispatched when the user activates the platform specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.InteractiveObject
 InheritedDispatched when the user activates the platform specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.InteractiveObject
  Dispatched when the data property changes.DataGridItemRenderer
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 InheritedDispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.InteractiveObject
 Inherited[broadcast event] Dispatched when the playhead is entering a new frame.DisplayObject
 Inherited[broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 InheritedDispatched after a display object gains focus.InteractiveObject
 InheritedDispatched after a display object loses focus.InteractiveObject
 Inherited[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 InheritedDispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a fingers from left to right over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedThis event is dispatched to any client app that supports inline input with an IMEInteractiveObject
 InheritedDispatched when the user presses a key.InteractiveObject
 InheritedDispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 InheritedDispatched when the user releases a key.InteractiveObject
 InheritedDispatched when a user clicks a hyperlink in an HTML-enabled text field, where the URL begins with "event:".TextField
 InheritedDispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 InheritedDispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 InheritedDispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 InheritedDispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop().InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject continually while a drag gesture remains within its boundary.InteractiveObject
 InheritedDispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched when the user activates the platform specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.InteractiveObject
 InheritedDispatched when a display object is about to be removed from the display list.DisplayObject
 InheritedDispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited[broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
 InheritedDispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched by a TextField object after the user scrolls.TextField
 InheritedDispatched when the user activates the platform specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu.InteractiveObject
 InheritedDispatched when the value of the object's tabChildren flag changes.InteractiveObject
 InheritedDispatched when the object's tabEnabled flag changes.InteractiveObject
 InheritedDispatched when the value of the object's tabIndex property changes.InteractiveObject
 InheritedFlash Player dispatches the textInput event when a user enters one or more characters of text.TextField
 InheritedDispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact with a touch-enabled device (such as drags a finger across a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outisde the display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
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
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of text in the component, including the component label.
UITextField
 InheritedType: String CSS Inheritance: yes
The directionality of the text displayed by the component.
UITextField
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of text in the component if it is disabled.
UITextField
 InheritedType: String CSS Inheritance: yes
Sets the antiAliasType property of internal TextFields.
UITextField
 InheritedType: String CSS Inheritance: yes
Name of the font to use.
UITextField
 InheritedType: String CSS Inheritance: yes
Sets the gridFitType property of internal TextFields that represent text in Flex controls.
UITextField
 InheritedType: Number CSS Inheritance: yes
Sets the sharpness property of internal TextFields that represent text in Flex controls.
UITextField
 InheritedType: Number Format: Length CSS Inheritance: yes
Height of the text, in pixels.
UITextField
 InheritedType: String CSS Inheritance: yes
Determines whether the text is italic font.
UITextField
 InheritedType: Number CSS Inheritance: yes
Sets the thickness property of internal TextFields that represent text in Flex controls.
UITextField
 InheritedType: String CSS Inheritance: yes
Determines whether the text is boldface.
UITextField
 InheritedType: Boolean CSS Inheritance: yes
A Boolean value that indicates whether kerning is enabled (true) or disabled (false).
UITextField
 InheritedType: Number Format: Length CSS Inheritance: yes
Additional vertical space between lines of text.
UITextField
 InheritedType: Number CSS Inheritance: yes
The number of additional pixels to appear between each character.
UITextField
 InheritedType: String CSS Inheritance: yes
The locale of the text displayed by this component.
UITextField
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between the component's left border and the left edge of its content area.
UITextField
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between the component's right border and the right edge of its content area.
UITextField
 InheritedType: String CSS Inheritance: yes
Alignment of text within a container.
UITextField
 InheritedType: String CSS Inheritance: yes
Determines whether the text is underlined.
UITextField
 InheritedType: Class CSS Inheritance: no
The class implementing IUITextField that is used by this component to render text.
UITextField
 InheritedType: Number Format: Length CSS Inheritance: yes
Offset of first line of text from the left side of the container, in pixels.
UITextField
Property Detail

data

property
data:Object

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

The implementation of the data property as defined by the IDataRenderer interface. The value is ignored. Only the listData property is used.

This property can be used as the source for data binding. When this property is modified, it dispatches the dataChange event.



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

See also

listData

property 
listData:BaseListData

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

The implementation of the listData property as defined by the IDropInListItemRenderer interface. The text of the renderer is set to the label property of the listData.

This property can be used as the source for data binding. When this property is modified, it dispatches the dataChange event.



Implementation
    public function get listData():BaseListData
    public function set listData(value:BaseListData):void

See also

styleDeclaration

property 
styleDeclaration:CSSStyleDeclaration

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

Storage for the inline inheriting styles on this object. This CSSStyleDeclaration is created the first time that setStyle() is called on this component to set an inheriting style.



Implementation
    public function get styleDeclaration():CSSStyleDeclaration
    public function set styleDeclaration(value:CSSStyleDeclaration):void
Constructor Detail

DataGridItemRenderer

()Constructor
public function DataGridItemRenderer()

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

Constructor.

Method Detail

clearStyle

()method
public function clearStyle(styleProp:String):void

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

Deletes a style property from this component instance.

This does not necessarily cause the getStyle() method to return undefined.

Parameters

styleProp:String — The name of the style property.

getClassStyleDeclarations

()method 
public function getClassStyleDeclarations():Array

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

Returns an Array of CSSStyleDeclaration objects for the type selector that applies to this component, or null if none exist.

For example, suppose that component MyButton extends Button. This method first looks for a MyButton selector; then, it looks for a Button type selector; finally, it looks for a UIComponent type selector.

Returns
Array — Array of CSSStyleDeclaration objects.

getStyle

()method 
override public function getStyle(styleProp:String):*

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

Gets a style property that has been set anywhere in this component's style lookup chain.

This same method is used to get any kind of style property, so the value returned can be a Boolean, String, Number, int, uint (for an RGB color), Class (for a skin), or any kind of object. Therefore the return type is simply specified as *.

If you are getting a particular style property, you know its type and often want to store the result in a variable of that type. No casting from * to that type is necessary.

var backgroundColor:uint = getStyle("backgroundColor");

If the style property has not been set anywhere in the style lookup chain, the value returned by getStyle() is undefined. Note that undefined is a special value that is not the same as false, "", NaN, 0, or null. No valid style value is ever undefined. You can use the method IStyleManager2.isValidStyleValue() to test whether the value was set.

Parameters

styleProp:String — Name of the style property.

Returns
* — Style value.

initProtoChain

()method 
public function initProtoChain():void

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

Sets up the inheritingStyles and nonInheritingStyles objects and their proto chains so that the getStyle() method can work.

notifyStyleChangeInChildren

()method 
public function notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void

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

Propagates style changes to the children of this component.

Parameters

styleProp:String — Name of the style property.
 
recursive:Boolean — Whether to propagate the style changes to the children's children.

regenerateStyleCache

()method 
public function regenerateStyleCache(recursive:Boolean):void

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

Sets up the internal style cache values so that the getStyle() method functions. If this object already has children, then reinitialize the children's style caches.

Parameters

recursive:Boolean — Regenerate the proto chains of the children.

registerEffects

()method 
public function registerEffects(effects:Array):void

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

Registers the EffectManager as one of the event listeners for each effect event.

Parameters

effects:Array — An Array of Strings of effect names.

setStyle

()method 
override public function setStyle(styleProp:String, newValue:*):void

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

Sets a style property on this component instance.

This can override a style that was set globally.

Calling the setStyle() method can result in decreased performance. Use it only when necessary.

Parameters

styleProp:String — Name of the style property.
 
newValue:* — New value for the style.

toolTipShowHandler

()method 
protected function toolTipShowHandler(event:mx.events:ToolTipEvent):void

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

The event handler to position the tooltip.

Parameters

event:mx.events:ToolTipEvent — The event object.

validateDisplayList

()method 
public function validateDisplayList():void

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

If Flex calls LayoutManager.invalidateDisplayList() method on this ILayoutManagerClient, then this function is called when it's time to update the display list.

validateProperties

()method 
public function validateProperties():void

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

If Flex calls the LayoutManager.invalidateProperties() method on this ILayoutManagerClient, then this function is called when it's time to commit property values.

validateSize

()method 
public function validateSize(recursive:Boolean = false):void

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

If Flex calls the LayoutManager.invalidateSize() method on this ILayoutManagerClient, then this function is called when it's time to do measurements.

Parameters

recursive:Boolean (default = false) — If true, call this method on the object's children.

Event Detail

dataChange

Event
Event Object Type: mx.events.FlexEvent
property FlexEvent.type = mx.events.FlexEvent.DATA_CHANGE

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

Dispatched when the data property changes.

When you use a component as an item renderer, the data property contains the data to display. You can listen for this event and update the component when the data property changes.

The FlexEvent.DATA_CHANGE constant defines the value of the type property of the event object for a dataChange event.

The properties of the event object have the following values:

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