ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
spark.skins.spark 

DefaultGridItemRenderer  - AS3 Flex

Packagespark.skins.spark
Classpublic class DefaultGridItemRenderer
InheritanceDefaultGridItemRenderer Inheritance UIFTETextField Inheritance FTETextField Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Implements IGridItemRenderer, IStyleClient

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.5

The DefaultGridItemRenderer class defines simple and efficient item renderer that displays a single text label. This class is the default value for the DataGrid itemRenderer property. This class extends UIFTETextField and displays the cell data in a text label using the text field. The UIFTETextField control is based on FTE, the FlashTextEngine, which supports high-quality international typography and font embedding in the same way as other Spark controls. Since the UIFTETextField control implements the TextField API, a subset of the Spark text styles are supported. Please see the documentation for this class for the list of supported styles.

You can control the label text wrapping by using the lineBreak style. For example, setting lineBreak="explicit" and variableRowHeight="false" creates fixed height cells whose labels do not wrap. If you do not explicitly set the wordWrap property, wordWrap will be set to the value of the grid's variableRowHeight property.

The multiline property is used by the DataGrid's item editor to interpret input newline characters. If mutliline=false, then entering a newline ends the editing session (as does tab or escape). If multiline=true then a newline character is inserted into the text. If the multiline property is not set explicitly, then it's automatically set to true if lineBreak="explicit" and text includes a newline character.

DefaultGridItemRenderer inherits its layoutDirection property from its parent. It should not be set directly.

The DefaultGridItemRenderer class is not intended to be subclassed or copied. Create custom item renderers based on the GridItemRenderer class.

For the highest performance on Microsoft Windows based applications, use the UITextFieldGridItemRenderer. This renderer is written in ActionScript and optimized for Windows.

View the examples

More examples

Related API Elements



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
This property is not implemented in FTETextField because FTETextField does not support selection.
FTETextField
 InheritedantiAliasType : String
This property has no effect in FTETextField because FTE uses a newer font renderer than TextField.
FTETextField
 InheritedautomationDelegate : Object
The delegate object which is handling the automation related functionality.
UIFTETextField
 InheritedautomationEnabled : Boolean
[read-only] True if this component is enabled for automation, false otherwise.
UIFTETextField
 InheritedautomationName : String
Name that can be used as an identifier for this object.
UIFTETextField
 InheritedautomationOwner : DisplayObjectContainer
[read-only] The owner of this component for automation purposes.
UIFTETextField
 InheritedautomationParent : DisplayObjectContainer
[read-only] The parent of this component for automation purposes.
UIFTETextField
 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.
UIFTETextField
 InheritedautomationVisible : Boolean
[read-only] True if this component is visible for automation, false otherwise.
UIFTETextField
 InheritedautoSize : String
Controls automatic sizing and alignment of text fields.
FTETextField
 Inheritedbackground : Boolean
Specifies whether the text field has a background fill.
FTETextField
 InheritedbackgroundColor : uint
The color of the text field background.
FTETextField
 InheritedbaselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text.
UIFTETextField
 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.
FTETextField
 InheritedborderColor : uint
The color of the text field border.
FTETextField
 InheritedbottomScrollV : int
[read-only] This property has not been implemented in FTETextField because FTETextField does not support scrolling.
FTETextField
 InheritedbuttonMode : Boolean
Specifies the button mode of this sprite.
Sprite
 InheritedcacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the display object.
DisplayObject
 Inherited    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] This property has not been implemented in FTETextField because FTETextField does not support editing.
FTETextField
 InheritedclassName : String
[read-only] The name of this instance's class, such as "DataGridItemRenderer".
UIFTETextField
  column : GridColumn
The GridColumn object representing the column associated with this item renderer.
DefaultGridItemRenderer
  columnIndex : int
[read-only] The column index for this item renderer's cell.
DefaultGridItemRenderer
 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.
FTETextField
 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 value of the data provider item for the entire row of the grid control.
DefaultGridItemRenderer
 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.
FTETextField
 InheriteddisplayAsPassword : Boolean
This property has not been implemented in FTETextField because FTETextField does not support editing.
FTETextField
 Inheriteddocument : Object
A reference to the document object associated with this UITextField object.
UIFTETextField
 InheriteddoubleClickEnabled : Boolean
Specifies whether the object receives doubleClick events.
InteractiveObject
  down : Boolean
The grid control's updateDisplayList() method sets this property before calling prepare().
DefaultGridItemRenderer
  dragging : Boolean
Contains true if the item renderer is being dragged, typically as part of a drag and drop operation.
DefaultGridItemRenderer
 InheriteddropTarget : DisplayObject
[read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.
Sprite
 InheritedembedFonts : Boolean
Specifies whether to render by using embedded font outlines.
FTETextField
 Inheritedenabled : Boolean
A Boolean value that indicates whether the component is enabled.
UIFTETextField
 InheritedenableIME : Boolean
[read-only] A flag that indicates whether the IME should be enabled when the component receives focus.
UIFTETextField
 InheritedexplicitHeight : Number
Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
UIFTETextField
 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.
UIFTETextField
 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.
UIFTETextField
 InheritedexplicitMinHeight : Number
[read-only] The minimum recommended height of the component to be considered by the parent during layout.
UIFTETextField
 InheritedexplicitMinWidth : Number
[read-only] The minimum recommended width of the component to be considered by the parent during layout.
UIFTETextField
 InheritedexplicitWidth : Number
Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
UIFTETextField
 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.
UIFTETextField
 InheritedfocusRect : Object
Specifies whether this object displays a focus rectangle.
InteractiveObject
 InheritedfontContext : IFlexModuleFactory
The IFlexModuleFactory instance that FTETextField uses for creating TextLine objects.
FTETextField
 Inheritedgraphics : Graphics
[read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.
Sprite
  grid : Grid
[read-only] The grid control associated with this item renderer.
DefaultGridItemRenderer
 InheritedgridFitType : String
This property has no effect in FTETextField because FTE uses a newer font renderer than TextField.
FTETextField
 Inheritedheight : Number
Indicates the height of the display object, in pixels.
DisplayObject
 InheritedhitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
Sprite
  hovered : Boolean
Set to true when the mouse is hovered over the item renderer.
DefaultGridItemRenderer
 InheritedhtmlText : String
Contains the HTML representation of the text field contents.
FTETextField
 InheritedignorePadding : Boolean
If true, the paddingLeft and paddingRight styles will not add space around the text of the component.
UIFTETextField
 InheritedimeMode : String
Specifies the IME (input method editor) mode.
UIFTETextField
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
UIFTETextField
 InheritedinheritingStyles : Object
The beginning of this UITextField's chain of inheriting styles.
UIFTETextField
 Inheritedinitialized : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required).
UIFTETextField
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIFTETextField
  label : String
The grid control sets this property to the value of the column's itemToLabel() method, before calling preprare(). The String to display in the item renderer.
DefaultGridItemRenderer
 Inheritedlength : int
[read-only] The number of characters in a text field.
FTETextField
 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
This property has not been implemented in FTETextField because FTETextField does not support editing.
FTETextField
 InheritedmaxHeight : Number
[read-only] The maximum recommended height of the component to be considered by the parent during layout.
UIFTETextField
 InheritedmaxScrollH : int
[read-only] This property has not been implemented in FTETextField because FTETextField does not support scrolling.
FTETextField
 InheritedmaxScrollV : int
[read-only] This property has not been implemented in FTETextField because FTETextField does not support scrolling.
FTETextField
 InheritedmaxWidth : Number
[read-only] The maximum recommended width of the component to be considered by the parent during layout.
UIFTETextField
 InheritedmeasuredHeight : Number
[read-only] The default height of the component, in pixels.
UIFTETextField
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
UIFTETextField
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
UIFTETextField
 InheritedmeasuredWidth : Number
[read-only] The default width of the component, in pixels.
UIFTETextField
 InheritedmetaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
DisplayObject
 InheritedminHeight : Number
[read-only] The minimum recommended height of the component to be considered by the parent during layout.
UIFTETextField
 InheritedminWidth : Number
[read-only] The minimum recommended width of the component to be considered by the parent during layout.
UIFTETextField
 InheritedmoduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
UIFTETextField
 InheritedmouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled.
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages.
InteractiveObject
 InheritedmouseWheelEnabled : Boolean
This property has not been implemented in FTETextField because FTETextField does not support scrolling.
FTETextField
 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
This property has no effect in FTETextField because FTETextField does not support editing.
FTETextField
 Inheritedname : String
Indicates the instance name of the DisplayObject.
DisplayObject
 InheritedneedsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus.
InteractiveObject
 InheritednestLevel : int
Depth of this object in the containment hierarchy.
UIFTETextField
 InheritednonInheritingStyles : Object
The beginning of this UITextField's chain of non-inheriting styles.
UIFTETextField
 InheritednonZeroTextHeight : Number
[read-only] The height of the text, in pixels.
UIFTETextField
 InheritednumChildren : int
[read-only] Returns the number of children of this object.
DisplayObjectContainer
 InheritednumLines : int
[read-only] Defines the number of text lines in a multiline text field.
FTETextField
 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.
UIFTETextField
 Inheritedparent : DisplayObjectContainer
[override] [read-only] The parent container or component for this component.
UIFTETextField
 InheritedpercentHeight : Number
Specifies the height of a component as a percentage of its parent's size.
UIFTETextField
 InheritedpercentWidth : Number
Specifies the width of a component as a percentage of its parent's size.
UIFTETextField
 InheritedprocessedDescriptors : Boolean
Set to true after the createChildren() method creates any internal component children.
UIFTETextField
 Inheritedrestrict : String
This property has not been implemented in FTETextField because FTETextField does not support scrolling.
FTETextField
 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
  rowIndex : int
The grid control's updateDisplayList() method sets this property before calling prepare(). The zero-based index of the row of the cell being rendered.
DefaultGridItemRenderer
 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
This property has not been implemented in FTETextField because FTETextField does not support scrolling.
FTETextField
 InheritedscrollRect : Rectangle
The scroll rectangle bounds of the display object.
DisplayObject
 InheritedscrollV : int
This property has not been implemented in FTETextField because FTETextField does not support scrolling.
FTETextField
 Inheritedselectable : Boolean
Setting this property has no effect in FTETextField because FTETextField does not support selection.
FTETextField
  selected : Boolean
The grid control's updateDisplayList() method sets this property before calling prepare(). Contains true if the item renderer's cell is part of the current selection.
DefaultGridItemRenderer
 InheritedselectionBeginIndex : int
[read-only] This property has not been implemented in FTETextField because FTETextField does not support selection.
FTETextField
 InheritedselectionEndIndex : int
[read-only] This property has not been implemented in FTETextField because FTETextField does not support selection.
FTETextField
 Inheritedsharpness : Number
This property has no effect in FTETextField.
FTETextField
  showsCaret : Boolean
The grid control's updateDisplayList() method sets this property before calling preprare().
DefaultGridItemRenderer
 InheritedsoftKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).
InteractiveObject
 InheritedsoundTransform : flash.media:SoundTransform
Controls sound within this sprite.
Sprite
 Inheritedstage : Stage
[read-only] The Stage of the display object.
DisplayObject
 InheritedstyleName : Object
The class style used by this component.
UIFTETextField
 InheritedstyleSheet : StyleSheet
Attaches a style sheet to the text field.
FTETextField
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIFTETextField
 InheritedtabChildren : Boolean
Determines whether the children of the object are tab enabled.
DisplayObjectContainer
 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.
FTETextField
 InheritedtextColor : uint
The color of the text in a text field, in hexadecimal format.
FTETextField
 InheritedtextHeight : Number
[read-only] The height of the text in pixels.
FTETextField
 InheritedtextSnapshot : flash.text:TextSnapshot
[read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.
DisplayObjectContainer
 InheritedtextWidth : Number
[read-only] The width of the text in pixels.
FTETextField
 Inheritedthickness : Number
This property has no effect in FTETextField because FTE uses a newer font renderer than TextField.
FTETextField
 InheritedtoolTip : String
Text to display in the ToolTip.
UIFTETextField
 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.
UIFTETextField
 Inheritedtype : String
The type of the text field.
FTETextField
 InheritedupdateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required)
UIFTETextField
 InheriteduseHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls over a sprite in which the buttonMode property is set to true.
Sprite
 InheriteduseRichTextClipboard : Boolean
This property is not implemented in FTETextField because FTETextField does not support selection or clipboard operations.
FTETextField
 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.
FTETextField
 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.
DefaultGridItemRenderer
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 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
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point.
DisplayObjectContainer
 Inherited
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
DisplayObjectContainer
  
discard(hasBeenRecycled:Boolean):void
Called from the item renderer parent's updateDisplayList() method when it has been determined that this renderer will no longer be visible.
DefaultGridItemRenderer
 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
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
Returns the child display object instance that exists at the specified index.
DisplayObjectContainer
 Inherited
Returns the child display object that exists with the specified name.
DisplayObjectContainer
 Inherited
Returns the index position of a child DisplayObject instance.
DisplayObjectContainer
 Inherited
A convenience method for determining whether to use the explicit or measured height
UIFTETextField
 Inherited
A convenience method for determining whether to use the explicit or measured width
UIFTETextField
 Inherited
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
getLineLength(lineIndex:int):int
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
Returns metrics information about a given text line.
FTETextField
 Inherited
getLineOffset(lineIndex:int):int
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 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
 Inherited
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this component's style lookup chain.
UIFTETextField
 Inherited
getTextFormat(beginIndex:int = -1, endIndex:int = -1):flash.text:TextFormat
This method has been implemented in FTETextField to simply return a copy of the defaultTextFormat, because FTETextField does not support formatting a range.
FTETextField
 Inherited
Returns the TextFormat object that represents character formatting information for this UITextField object.
UIFTETextField
 Inherited
Returns a UITextFormat object that contains formatting information for this component.
UIFTETextField
 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.
UIFTETextField
 Inherited
Marks a component so that its updateDisplayList() method gets called during a later screen update.
UIFTETextField
 Inherited
Marks a component so that its commitProperties() method gets called during a later screen update.
UIFTETextField
 Inherited
Marks a component so that its measure() method gets called during a later screen update.
UIFTETextField
 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.
UIFTETextField
 Inherited
Returns true if the child is parented or owned by this object.
UIFTETextField
 Inherited
This function is called when a UITextField object is assigned a parent.
UIFTETextField
  
prepare(willBeRecycled:Boolean):void
Called from the item renderer parent's updateDisplayList() method after all of the renderer's properties have been set.
DefaultGridItemRenderer
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.
DisplayObjectContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
replaceText(beginIndex:int, endIndex:int, newText:String):void
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
Replays the specified event.
UIFTETextField
 Inherited
Raises a virtual keyboard.
InteractiveObject
 Inherited
Sizes the object.
UIFTETextField
 Inherited
Changes the position of an existing child in the display object container.
DisplayObjectContainer
 Inherited
Sets the font color of the text.
UIFTETextField
 Inherited
Sets the focus to this component.
UIFTETextField
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
setSelection(beginIndex:int, endIndex:int):void
This method has not been implemented in FTETextField because FTETextField does not support selection.
FTETextField
 Inherited
setStyle(styleProp:String, value:*):void
Does nothing.
UIFTETextField
 Inherited
setTextFormat(format:flash.text:TextFormat, beginIndex:int = -1, endIndex:int = -1):void
This method has no effect on a FTETextField if beginIndex or endIndex does not equal -1 because FTETextField does not support formatting a range.
FTETextField
 Inherited
setVisible(visible:Boolean, noEvent:Boolean = false):void
Sets the visible property of this UITextField object.
UIFTETextField
 Inherited
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite.
Sprite
 Inherited
startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite on a touch-enabled device.
Sprite
 Inherited
Recursively stops the timeline execution of all MovieClips rooted at this object.
DisplayObjectContainer
 Inherited
Ends the startDrag() method.
Sprite
 Inherited
stopTouchDrag(touchPointID:int):void
Ends the startTouchDrag() method, for use with touch-enabled devices.
Sprite
 Inherited
Detects changes to style properties.
UIFTETextField
 Inherited
Swaps the z-order (front-to-back order) of the two specified child objects.
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.
DisplayObjectContainer
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 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.
UIFTETextField
 Inherited
Validate and update the properties and layout of this object and redraw it, if necessary.
UIFTETextField
 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
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 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
 Inherited
    contextMenu
Dispatched 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 bindable data property changes.DefaultGridItemRenderer
 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 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 moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object 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 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 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 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 the user lowers an active stylus past the proximity detection threshold of the screen.InteractiveObject
 Inherited
    proximityEnd
Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold.InteractiveObject
 Inherited
    proximityOut
Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen).InteractiveObject
 InheritedDispatched when a user releases the button on the pointing device after the user first pressed the button over an InteractiveObject instance and then moved the pointing device off of the InteractiveObject instance.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 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 immediately after the soft keyboard is raised.InteractiveObject
 InheritedDispatched immediately before the soft keyboard is raised.InteractiveObject
 InheritedDispatched immediately after the soft keyboard is lowered.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
 InheritedDispatched when a user enters one or more characters of text.InteractiveObject
 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 touches the device, and is continuously dispatched until the point of contact is removed.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 outside 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
  
color
Type: uint Format: Color CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Color of the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.color.

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style color, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style color.

The default value is 0x000000.

Related API Elements

DefaultGridItemRenderer
  
direction
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Specifies the default bidirectional embedding level of the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.direction.

For the Mobile theme, this is not supported.

Related API Elements

DefaultGridItemRenderer
  
fontFamily
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The name of the font to use, or a comma-separated list of font names.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontFamily.

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style fontFamily, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style fontFamily.

The default value for the Spark theme is Arial. The default value for the Mobile theme is _sans.

Related API Elements

DefaultGridItemRenderer
  
fontSize
Type: Number Format: Length CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Height of the text, in pixels.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontSize

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style fontSize, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style fontSize.

The default value for the Spark theme is 12. The default value for the Mobile theme is 24.

Related API Elements

DefaultGridItemRenderer
  
fontStyle
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Determines whether the text is italic font.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontStyle

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style fontStyle, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style fontStyle.

Related API Elements

DefaultGridItemRenderer
  
fontWeight
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Determines whether the text is boldface.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontWeight

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style fontWeight, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style fontWeight.

Related API Elements

DefaultGridItemRenderer
  
kerning
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The style used for justification of the paragraph.

Kerning is enabled by default for Spark components, but is disabled by default for MX components. Spark components interpret default as auto, while MX components interpret default as false.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.kerning

For the Mobile theme, this is not supported.

Related API Elements

DefaultGridItemRenderer
  
lineBreak
Type: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Controls word wrapping within the container.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.blockProgression.

For the Mobile theme, this is not supported.

Related API Elements

DefaultGridItemRenderer
  
locale
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The locale of the text. Controls case transformations and shaping. Uses standard locale identifiers as described in Unicode Technical Standard #35. For example "en", "en_US" and "en-US" are all English, "ja" is Japanese.

The default value is undefined. This property inherits its value from an ancestor; if still undefined, it inherits from the global locale style. During the application initialization, if the global locale style is undefined, then the default value is set to "en".

When using the Spark formatters and globalization classes, you can set this style on the root application to the value of the LocaleID.DEFAULT constant. Those classes will then use the client operating system's international preferences.

The default value is undefined.

Learn more

DefaultGridItemRenderer
  
paddingLeft
Type: Number Format: Length CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Left inset, in pixels.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paddingLeft.

For the Mobile theme, this is not supported.

Related API Elements

DefaultGridItemRenderer
  
paddingRight
Type: Number Format: Length CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Right inset, in pixels.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paddingRight.

For the Mobile theme, this is not supported.

Related API Elements

DefaultGridItemRenderer
  
textAlign
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Alignment of text within a container.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textAlign

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style textAlign, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style textAlign.

Related API Elements

DefaultGridItemRenderer
  
textDecoration
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

Determines whether the text is underlined.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textDecoration

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style textDecoration, and if using StyleableStageText, this is not supported.

Related API Elements

DefaultGridItemRenderer
  
textIndent
Type: Number Format: Length CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

A Number that specifies, in pixels, the amount to indent the first line of the paragraph. A negative indent will push the line into the margin, and possibly out of the container.

Legal values are numbers from -8000 to 8000 and FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.

DefaultGridItemRenderer
Mobile Theme Styles
 Style Description Defined By
  
letterSpacing
Type: Number CSS Inheritance: Yes Theme: mobile
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10.1, AIR 2.0

The number of additional pixels to appear between each character.

For the Spark theme, this is not supported. See trackingLeft and trackingRight.

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField.letterSpacing and if using StyleableStageText, this is not supported.

Related API Elements

DefaultGridItemRenderer
Property Detail

column

property
column:GridColumn

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.5

The GridColumn object representing the column associated with this item renderer.

The default value is null.

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



Implementation
    public function get column():GridColumn
    public function set column(value:GridColumn):void

columnIndex

property 
columnIndex:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.5

The column index for this item renderer's cell. This is the same value as column.columnIndex.



Implementation
    public function get columnIndex():int

data

property 
data:Object

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.5

The value of the data provider item for the entire row of the grid control. Item renderers often bind visual element attributes to properties of this object.

The default value is null.

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

down

property 
down:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.5

The grid control's updateDisplayList() method sets this property before calling prepare().

This property is set to true when one of two input gestures occurs within a grid cell: either the mouse button or the touch screen is pressed. The down property is reset to false when the mouse button goes up, the user lifts off the touch screen, or the mouse/touch is dragged out of the grid cell.

Unlike a List item renderer, grid item renderers do not have exclusive responsibility for displaying the down indicator. The Grid itself renders the down indicator for the selected row or cell. The item renderer can also change its visual properties to emphasize that it's being pressed.

The default value is false.

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



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

dragging

property 
dragging:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.5

Contains true if the item renderer is being dragged, typically as part of a drag and drop operation. Currently, drag and drop is not supported by the Spark DataGrid control.

The default value is false.

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



Implementation
    public function get dragging():Boolean
    public function set dragging(value:Boolean):void

grid

property 
grid:Grid  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.0

The grid control associated with this item renderer.



Implementation
    public function get grid():Grid

hovered

property 
hovered:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.0

Set to true when the mouse is hovered over the item renderer.

The default value is false.

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



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

label

property 
label:String

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.0

The grid control sets this property to the value of the column's itemToLabel() method, before calling preprare().

The String to display in the item renderer.

The GridItemRenderer class automatically copies the value of this property to the text property of its labelDisplay element, if that element was specified. The Grid sets the label to the value returned by the column's itemToLabel() method.

The default value is "".

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



Implementation
    public function get label():String
    public function set label(value:String):void

rowIndex

property 
rowIndex:int

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.0

The grid control's updateDisplayList() method sets this property before calling prepare().

The zero-based index of the row of the cell being rendered.

The default value is -1.

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



Implementation
    public function get rowIndex():int
    public function set rowIndex(value:int):void

selected

property 
selected:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.0

The grid control's updateDisplayList() method sets this property before calling prepare().

Contains true if the item renderer's cell is part of the current selection.

Unlike a List item renderer, grid item renderers do not have exclusive responsibility for displaying something to indicate that they're part of the selection. The Grid itself automatically displays the selectionIndicator skin part for the selected rows or cells. The item renderer can also change its visual properties to emphasize that it's part of the selection.

The default value is false.

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



Implementation
    public function get selected():Boolean
    public function set selected(value:Boolean):void

showsCaret

property 
showsCaret:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.0

The grid control's updateDisplayList() method sets this property before calling preprare().

Contains true if the item renderer's cell is indicated by the caret.

Unlike a List item renderer, grid item renderers do not have exclusive responsibility for displaying something to indicate their cell or row has the caret. The Grid itself automatically displays the caretIndicator skin part for the caret row or cell. The item renderer can also change its visual properties to emphasize that it has the caret.

The default value is false.

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



Implementation
    public function get showsCaret():Boolean
    public function set showsCaret(value:Boolean):void
Constructor Detail

DefaultGridItemRenderer

()Constructor
public function DefaultGridItemRenderer()

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 1.5

Constructor.

Method Detail

discard

()method
public function discard(hasBeenRecycled:Boolean):void

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.5

Called from the item renderer parent's updateDisplayList() method when it has been determined that this renderer will no longer be visible. If the willBeRecycled parameter is true, then the owner adds this renderer to its internal free list for reuse. Implementations can use this method to clear any renderer properties that are no longer needed.

This method is not intended to be called directly. It is called by the DataGrid implementation.

Parameters

hasBeenRecycled:Booleantrue if this renderer is going to be added to the owner's internal free list for reuse.

prepare

()method 
public function prepare(willBeRecycled:Boolean):void

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.5

Called from the item renderer parent's updateDisplayList() method after all of the renderer's properties have been set. The hasBeenRecycled parameter is false if this renderer has not been used before, meaning it was not recycled. This method is called when a renderer is about to become visible and each time it's redisplayed because of a change in a renderer property, or because a redisplay was explicitly requested.

This method can be used to configure all of a renderer's visual elements and properties. Using this method can be more efficient than binding data properties to visual element properties. Note: Because the prepare() method is called frequently, make sure that it is coded efficiently.

The prepare() method may be called many times before the discard() method is called.

This method is not intended to be called directly. It is called by the DataGrid implementation.

Parameters

willBeRecycled:Booleantrue if this renderer is being reused.
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 4.5
Runtime Versions: Flash Player 10, AIR 1.5

Dispatched when the bindable 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.
DefaultGridItemRendererExample.mxml
<?xml version="1.0" encoding="utf-8"?>

<!--

Demonstate how to control text wrapping in a DataGrid DefaultGridItemRenderer item renderer.

This DataGrid example demonstrates how to control text wrapping with the DefaultGridItemRenderer.
All cells in this example display the same lengthy string which does not contain newlines.  
Note that the Flex text components unconditionally render newline characters that appear in the text.

The first "Implicit wordWrap" column's renderer is DefaultGridItemRenderer.  By default it sets its 
wordWrap property equal to the value of the DataGrid's varaiableRowHeight property. 

The second "Explicit wordWrap" column's DefaultGridItemRenderer overrides the wordWrap property.   
If the wordWrap property's value is set explicitly, the renderer ignores the DataGrid's 
variableRowHeight property.

Note also: this example's column widths and row heights are defined by the DataGrid's typicalItem.  
The typical item uses explicit newlines to create a string that occupies three lines and a 
reasonable column width.

-->

<s:Application 
    xmlns:fx="http://ns.adobe.com/mxml/2009" 
    xmlns:s="library://ns.adobe.com/flex/spark">
    
    <fx:Declarations>
        <fx:String id="sampleText">Lorem Ipsum is the standard dummy text of the typesetting industry.</fx:String>
        <fx:int id="maxDisplayedLines">0</fx:int>        
    </fx:Declarations>    
    
    <s:Panel title="Spark DataGrid Control Example which demonstrates how to control text wrapping in a DefaultGridItemRenderer"
             width="75%" height="75%" 
             horizontalCenter="0" verticalCenter="0">
        
        <s:controlBarContent>
            <s:VGroup>
                <s:CheckBox id="vrh" selected="@{dataGrid.variableRowHeight}" 
                            label="dataGrid.variableRowHeight={vrh.selected}"/>            
                <s:CheckBox id="wordWrapCheckBox" selected="true" 
                            label="defaultRenderer.wordWrap={wordWrapCheckBox.selected}"/>
            </s:VGroup>
        </s:controlBarContent>
        
        <s:DataGrid id="dataGrid" variableRowHeight="false" left="5" right="5" top="5" bottom="5">
            <s:columns>
                <s:ArrayList>
                    <!--
                    DefaultGridItemRenderer doesn't break lines if the DataGrid's variableRowHeight property
                    is false (the default).
                    -->
                    <s:GridColumn dataField="value" headerText="Implicit wordWrap"/>
                    
                    <!--
                    Defeat line breaking in DefaultGridItemRenderer by setting wordWrap="false".
                    If wordWrap is set, the renderer ignores the DataGrid's variableRowHeight property.
                    -->
                    <s:GridColumn dataField="value" headerText="Explicit wordWrap">
                        <s:itemRenderer>
                            <fx:Component>
                                <s:DefaultGridItemRenderer
                                    color="0x1E6913"
                                    wordWrap="{outerDocument.wordWrapCheckBox.selected}"/>
                            </fx:Component>
                        </s:itemRenderer>
                    </s:GridColumn>                
                </s:ArrayList>
            </s:columns>
            
            <!--
            The typicalItem defines column widths and the default row height.  The text
            occpies three lines because we've used data binding to introduce two
            newlines.
            
            Alternatively, we could have used the odd XML '&#10;' escape to introduce 
            two newlines (the value of the newline character is decimal 10).
            
            <s:DataItem value="Lorem Ipsum sample text.&#10;newline&#10;"/>
            -->
            <s:typicalItem>
                <s:DataItem value="{'Lorem Ipsum sample text.\nnewline\n'}"/>
            </s:typicalItem>
            
            <s:ArrayCollection>
                <s:DataItem value="{sampleText}"/>
                <s:DataItem value="{sampleText}"/>
                <s:DataItem value="{sampleText}"/>
            </s:ArrayCollection>
        </s:DataGrid>
    </s:Panel>
</s:Application>