spark.skins.spark

# DefaultGridItemRenderer - AS3 Flex

Package | spark.skins.spark
Class | public class DefaultGridItemRenderer
Inheritance | DefaultGridItemRenderer UIFTETextField FTETextField Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher 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

Using the predefined item renderers

Related API Elements

spark.components.DataGrid
spark.components.gridClasses.GridItemRenderer
spark.skins.spark.UITextFieldGridItemRenderer

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | accessibilityImplementation : AccessibilityImplementation The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance. | InteractiveObject
|  | accessibilityProperties : AccessibilityProperties The current accessibility options for this display object. | DisplayObject
|  | alpha : Number Indicates the alpha transparency value of the object specified. | DisplayObject
|  | alwaysShowSelection : Boolean This property is not implemented in FTETextField because FTETextField does not support selection. | FTETextField
|  | antiAliasType : String This property has no effect in FTETextField because FTE uses a newer font renderer than TextField. | FTETextField
|  | automationDelegate : Object The delegate object which is handling the automation related functionality. | UIFTETextField
|  | automationEnabled : Boolean [read-only] True if this component is enabled for automation, false otherwise. | UIFTETextField
|  | automationName : String Name that can be used as an identifier for this object. | UIFTETextField
|  | automationOwner : DisplayObjectContainer [read-only] The owner of this component for automation purposes. | UIFTETextField
|  | automationParent : DisplayObjectContainer [read-only] The parent of this component for automation purposes. | UIFTETextField
|  | automationValue : Array [read-only] This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application. | UIFTETextField
|  | automationVisible : Boolean [read-only] True if this component is visible for automation, false otherwise. | UIFTETextField
|  | autoSize : String Controls automatic sizing and alignment of text fields. | FTETextField
|  | background : Boolean Specifies whether the text field has a background fill. | FTETextField
|  | backgroundColor : uint The color of the text field background. | FTETextField
|  | baselinePosition : Number [read-only] The y-coordinate of the baseline of the first line of text. | UIFTETextField
|  | blendMode : String A value from the BlendMode class that specifies which blend mode to use. | DisplayObject
|  | blendShader : Shader [write-only] Sets a shader that is used for blending the foreground and background. | DisplayObject
|  | border : Boolean Specifies whether the text field has a border. | FTETextField
|  | borderColor : uint The color of the text field border. | FTETextField
|  | bottomScrollV : int [read-only] This property has not been implemented in FTETextField because FTETextField does not support scrolling. | FTETextField
|  | buttonMode : Boolean Specifies the button mode of this sprite. | Sprite
|  | cacheAsBitmap : Boolean If set to true, Flash runtimes cache an internal bitmap representation of the display object. | DisplayObject
|  | cacheAsBitmapMatrix : Matrix If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true. | DisplayObject
|  | caretIndex : int [read-only] This property has not been implemented in FTETextField because FTETextField does not support editing. | FTETextField
|  | className : 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
|  | condenseWhite : 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
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | contextMenu : 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
|  | defaultTextFormat : 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
|  | displayAsPassword : Boolean This property has not been implemented in FTETextField because FTETextField does not support editing. | FTETextField
|  | document : Object A reference to the document object associated with this UITextField object. | UIFTETextField
|  | doubleClickEnabled : 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
|  | dropTarget : DisplayObject [read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped. | Sprite
|  | embedFonts : Boolean Specifies whether to render by using embedded font outlines. | FTETextField
|  | enabled : Boolean A Boolean value that indicates whether the component is enabled. | UIFTETextField
|  | enableIME : Boolean [read-only] A flag that indicates whether the IME should be enabled when the component receives focus. | UIFTETextField
|  | explicitHeight : Number Number that specifies the explicit height of the component, in pixels, in the component's coordinates. | UIFTETextField
|  | explicitMaxHeight : 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
|  | explicitMaxWidth : 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
|  | explicitMinHeight : Number [read-only] The minimum recommended height of the component to be considered by the parent during layout. | UIFTETextField
|  | explicitMinWidth : Number [read-only] The minimum recommended width of the component to be considered by the parent during layout. | UIFTETextField
|  | explicitWidth : Number Number that specifies the explicit width of the component, in pixels, in the component's coordinates. | UIFTETextField
|  | filters : Array An indexed array that contains each filter object currently associated with the display object. | DisplayObject
|  | focusPane : Sprite A single Sprite object that is shared among components and used as an overlay for drawing the focus indicator. | UIFTETextField
|  | focusRect : Object Specifies whether this object displays a focus rectangle. | InteractiveObject
|  | fontContext : IFlexModuleFactory The IFlexModuleFactory instance that FTETextField uses for creating TextLine objects. | FTETextField
|  | graphics : 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
|  | gridFitType : String This property has no effect in FTETextField because FTE uses a newer font renderer than TextField. | FTETextField
|  | height : Number Indicates the height of the display object, in pixels. | DisplayObject
|  | hitArea : 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
|  | htmlText : String Contains the HTML representation of the text field contents. | FTETextField
|  | ignorePadding : Boolean If true, the paddingLeft and paddingRight styles will not add space around the text of the component. | UIFTETextField
|  | imeMode : String Specifies the IME (input method editor) mode. | UIFTETextField
|  | includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container. | UIFTETextField
|  | inheritingStyles : Object The beginning of this UITextField's chain of inheriting styles. | UIFTETextField
|  | initialized : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required). | UIFTETextField
|  | isPopUp : 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
|  | length : int [read-only] The number of characters in a text field. | FTETextField
|  | loaderInfo : LoaderInfo [read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs. | DisplayObject
|  | mask : DisplayObject The calling display object is masked by the specified mask object. | DisplayObject
|  | maxChars : int This property has not been implemented in FTETextField because FTETextField does not support editing. | FTETextField
|  | maxHeight : Number [read-only] The maximum recommended height of the component to be considered by the parent during layout. | UIFTETextField
|  | maxScrollH : int [read-only] This property has not been implemented in FTETextField because FTETextField does not support scrolling. | FTETextField
|  | maxScrollV : int [read-only] This property has not been implemented in FTETextField because FTETextField does not support scrolling. | FTETextField
|  | maxWidth : Number [read-only] The maximum recommended width of the component to be considered by the parent during layout. | UIFTETextField
|  | measuredHeight : Number [read-only] The default height of the component, in pixels. | UIFTETextField
|  | measuredMinHeight : Number The default minimum height of the component, in pixels. | UIFTETextField
|  | measuredMinWidth : Number The default minimum width of the component, in pixels. | UIFTETextField
|  | measuredWidth : Number [read-only] The default width of the component, in pixels. | UIFTETextField
|  | metaData : Object Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the the instance of this DisplayObject in the SWF file through a PlaceObject4 tag. | DisplayObject
|  | minHeight : Number [read-only] The minimum recommended height of the component to be considered by the parent during layout. | UIFTETextField
|  | minWidth : Number [read-only] The minimum recommended width of the component to be considered by the parent during layout. | UIFTETextField
|  | moduleFactory : IFlexModuleFactory The moduleFactory that is used to create TextFields in the correct SWF context. | UIFTETextField
|  | mouseChildren : Boolean Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer
|  | mouseEnabled : Boolean Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject
|  | mouseWheelEnabled : Boolean This property has not been implemented in FTETextField because FTETextField does not support scrolling. | FTETextField
|  | mouseX : Number [read-only] Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject
|  | mouseY : Number [read-only] Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject
|  | multiline : Boolean This property has no effect in FTETextField because FTETextField does not support editing. | FTETextField
|  | name : String Indicates the instance name of the DisplayObject. | DisplayObject
|  | needsSoftKeyboard : Boolean Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus. | InteractiveObject
|  | nestLevel : int Depth of this object in the containment hierarchy. | UIFTETextField
|  | nonInheritingStyles : Object The beginning of this UITextField's chain of non-inheriting styles. | UIFTETextField
|  | nonZeroTextHeight : Number [read-only] The height of the text, in pixels. | UIFTETextField
|  | numChildren : int [read-only] Returns the number of children of this object. | DisplayObjectContainer
|  | numLines : int [read-only] Defines the number of text lines in a multiline text field. | FTETextField
|  | opaqueBackground : Object Specifies whether the display object is opaque with a certain background color. | DisplayObject
|  | owner : DisplayObjectContainer By default, set to the parent container of this object. | UIFTETextField
|  | parent : DisplayObjectContainer [override] [read-only] The parent container or component for this component. | UIFTETextField
|  | percentHeight : Number Specifies the height of a component as a percentage of its parent's size. | UIFTETextField
|  | percentWidth : Number Specifies the width of a component as a percentage of its parent's size. | UIFTETextField
|  | processedDescriptors : Boolean Set to true after the createChildren() method creates any internal component children. | UIFTETextField
|  | restrict : String This property has not been implemented in FTETextField because FTETextField does not support scrolling. | FTETextField
|  | root : DisplayObject [read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject
|  | rotation : Number Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | DisplayObject
|  | rotationX : Number Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject
|  | rotationY : Number Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject
|  | rotationZ : 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
|  | scale9Grid : Rectangle The current scaling grid that is in effect. | DisplayObject
|  | scaleX : Number Indicates the horizontal scale (percentage) of the object as applied from the registration point. | DisplayObject
|  | scaleY : Number Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. | DisplayObject
|  | scaleZ : Number Indicates the depth scale (percentage) of an object as applied from the registration point of the object. | DisplayObject
|  | scrollH : int This property has not been implemented in FTETextField because FTETextField does not support scrolling. | FTETextField
|  | scrollRect : Rectangle The scroll rectangle bounds of the display object. | DisplayObject
|  | scrollV : int This property has not been implemented in FTETextField because FTETextField does not support scrolling. | FTETextField
|  | selectable : 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
|  | selectionBeginIndex : int [read-only] This property has not been implemented in FTETextField because FTETextField does not support selection. | FTETextField
|  | selectionEndIndex : int [read-only] This property has not been implemented in FTETextField because FTETextField does not support selection. | FTETextField
|  | sharpness : Number This property has no effect in FTETextField. | FTETextField
|  | showsCaret : Boolean The grid control's updateDisplayList() method sets this property before calling preprare(). | DefaultGridItemRenderer
|  | softKeyboard : String Controls the appearance of the soft keyboard. | InteractiveObject
|  | softKeyboardInputAreaOfInterest : Rectangle Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). | InteractiveObject
|  | soundTransform : flash.media:SoundTransform Controls sound within this sprite. | Sprite
|  | stage : Stage [read-only] The Stage of the display object. | DisplayObject
|  | styleName : Object The class style used by this component. | UIFTETextField
|  | styleSheet : StyleSheet Attaches a style sheet to the text field. | FTETextField
|  | systemManager : ISystemManager Returns the SystemManager object used by this component. | UIFTETextField
|  | tabChildren : Boolean Determines whether the children of the object are tab enabled. | DisplayObjectContainer
|  | tabEnabled : Boolean Specifies whether this object is in the tab order. | InteractiveObject
|  | tabIndex : int Specifies the tab ordering of objects in a SWF file. | InteractiveObject
|  | text : String A string that is the current text in the text field. | FTETextField
|  | textColor : uint The color of the text in a text field, in hexadecimal format. | FTETextField
|  | textHeight : Number [read-only] The height of the text in pixels. | FTETextField
|  | textSnapshot : flash.text:TextSnapshot [read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer
|  | textWidth : Number [read-only] The width of the text in pixels. | FTETextField
|  | thickness : Number This property has no effect in FTETextField because FTE uses a newer font renderer than TextField. | FTETextField
|  | toolTip : String Text to display in the ToolTip. | UIFTETextField
|  | transform : flash.geom:Transform An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | DisplayObject
|  | tweeningProperties : Array Array of properties that are currently being tweened on this object. | UIFTETextField
|  | type : String The type of the text field. | FTETextField
|  | updateCompletePendingFlag : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required) | UIFTETextField
|  | useHandCursor : Boolean A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls over a sprite in which the buttonMode property is set to true. | Sprite
|  | useRichTextClipboard : Boolean This property is not implemented in FTETextField because FTETextField does not support selection or clipboard operations. | FTETextField
|  | visible : Boolean Whether or not the display object is visible. | DisplayObject
|  | width : Number Indicates the width of the display object, in pixels. | DisplayObject
|  | wordWrap : Boolean A Boolean value that indicates whether the text field has word wrap. | FTETextField
|  | x : Number Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. | DisplayObject
|  | y : Number Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. | DisplayObject
|  | z : Number Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container. | DisplayObject

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | DefaultGridItemRenderer() Constructor. | DefaultGridItemRenderer
|  | addChild(child:DisplayObject):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer
|  | addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer
|  | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. | EventDispatcher
|  | appendText(newText:String):void This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | areInaccessibleObjectsUnderPoint(point:Point):Boolean 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
|  | contains(child:DisplayObject):Boolean 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
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | EventDispatcher
|  | 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
|  | getCharBoundaries(charIndex:int):Rectangle This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | getCharIndexAtPoint(x:Number, y:Number):int This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | getChildAt(index:int):DisplayObject Returns the child display object instance that exists at the specified index. | DisplayObjectContainer
|  | getChildByName(name:String):DisplayObject Returns the child display object that exists with the specified name. | DisplayObjectContainer
|  | getChildIndex(child:DisplayObject):int Returns the index position of a child DisplayObject instance. | DisplayObjectContainer
|  | getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height | UIFTETextField
|  | getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width | UIFTETextField
|  | getFirstCharInParagraph(charIndex:int):int This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | getImageReference(id:String):DisplayObject This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | getLineIndexAtPoint(x:Number, y:Number):int This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | getLineIndexOfChar(charIndex:int):int This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | getLineLength(lineIndex:int):int This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | getLineMetrics(lineIndex:int):flash.text:TextLineMetrics Returns metrics information about a given text line. | FTETextField
|  | getLineOffset(lineIndex:int):int This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | getLineText(lineIndex:int):String This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | getObjectsUnderPoint(point:Point):Array Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer
|  | getParagraphLength(charIndex:int):int This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | 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):* Gets a style property that has been set anywhere in this component's style lookup chain. | UIFTETextField
|  | 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
|  | getTextStyles():flash.text:TextFormat Returns the TextFormat object that represents character formatting information for this UITextField object. | UIFTETextField
|  | getUITextFormat():mx.core:UITextFormat Returns a UITextFormat object that contains formatting information for this component. | UIFTETextField
|  | globalToLocal(point:Point):Point Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates. | DisplayObject
|  | globalToLocal3D(point:Point):Vector3D Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates. | DisplayObject
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | EventDispatcher
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | hitTestObject(obj:DisplayObject):Boolean 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
|  | 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
|  | initialize():void Initializes this component. | UIFTETextField
|  | invalidateDisplayList():void Marks a component so that its updateDisplayList() method gets called during a later screen update. | UIFTETextField
|  | invalidateProperties():void Marks a component so that its commitProperties() method gets called during a later screen update. | UIFTETextField
|  | invalidateSize():void Marks a component so that its measure() method gets called during a later screen update. | UIFTETextField
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | local3DToGlobal(point3d:Vector3D):Point 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
|  | localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates. | DisplayObject
|  | move(x:Number, y:Number):void Moves the component to a specified position within its parent. | UIFTETextField
|  | owns(child:DisplayObject):Boolean Returns true if the child is parented or owned by this object. | UIFTETextField
|  | parentChanged(p:DisplayObjectContainer):void 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
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | removeChild(child:DisplayObject):DisplayObject Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer
|  | removeChildAt(index:int):DisplayObject Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer. | DisplayObjectContainer
|  | removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | EventDispatcher
|  | replaceSelectedText(value:String):void This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | 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
|  | replayAutomatableEvent(event:Event):Boolean Replays the specified event. | UIFTETextField
|  | requestSoftKeyboard():Boolean Raises a virtual keyboard. | InteractiveObject
|  | setActualSize(w:Number, h:Number):void Sizes the object. | UIFTETextField
|  | setChildIndex(child:DisplayObject, index:int):void Changes the position of an existing child in the display object container. | DisplayObjectContainer
|  | setColor(color:uint):void Sets the font color of the text. | UIFTETextField
|  | setFocus():void Sets the focus to this component. | UIFTETextField
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | setSelection(beginIndex:int, endIndex:int):void This method has not been implemented in FTETextField because FTETextField does not support selection. | FTETextField
|  | setStyle(styleProp:String, value:*):void Does nothing. | UIFTETextField
|  | 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
|  | setVisible(visible:Boolean, noEvent:Boolean = false):void Sets the visible property of this UITextField object. | UIFTETextField
|  | startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite. | Sprite
|  | startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite on a touch-enabled device. | Sprite
|  | stopAllMovieClips():void Recursively stops the timeline execution of all MovieClips rooted at this object. | DisplayObjectContainer
|  | stopDrag():void Ends the startDrag() method. | Sprite
|  | stopTouchDrag(touchPointID:int):void Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite
|  | styleChanged(styleProp:String):void Detects changes to style properties. | UIFTETextField
|  | swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer
|  | 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
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | 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
|  | validateNow():void Validate and update the properties and layout of this object and redraw it, if necessary. | UIFTETextField
|  | valueOf():Object Returns the primitive value of the specified object. | Object
|  | willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | EventDispatcher

Events
Click for more information on events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | activate | [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher
|  | added | Dispatched when a display object is added to the display list. | DisplayObject
|  | addedToStage | Dispatched 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
|  | clear | Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu. | InteractiveObject
|  | click | Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | InteractiveObject
|  | contextMenu | Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application. | InteractiveObject
|  | copy | Dispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu. | InteractiveObject
|  | cut | Dispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu. | InteractiveObject
|  | dataChange | Dispatched when the bindable data property changes. | DefaultGridItemRenderer
|  | deactivate | [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher
|  | doubleClick | Dispatched 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
|  | enterFrame | [broadcast event] Dispatched when the playhead is entering a new frame. | DisplayObject
|  | exitFrame | [broadcast event] Dispatched when the playhead is exiting the current frame. | DisplayObject
|  | focusIn | Dispatched after a display object gains focus. | InteractiveObject
|  | focusOut | Dispatched after a display object loses focus. | InteractiveObject
|  | frameConstructed | [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run. | DisplayObject
|  | gestureDirectionalTap | Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) Some devices might also interpret this contact as a combination of several touch events, as well. | InteractiveObject
|  | gestureLongPress | Dispatched 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
|  | gesturePan | Dispatched 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
|  | gestureRotate | Dispatched 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
|  | gestureSwipe | Dispatched 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
|  | gestureTap | Dispatched 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
|  | gestureZoom | Dispatched 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
|  | imeStartComposition | This event is dispatched to any client app that supports inline input with an IME | InteractiveObject
|  | keyDown | Dispatched when the user presses a key. | InteractiveObject
|  | keyFocusChange | Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject
|  | keyUp | Dispatched when the user releases a key. | InteractiveObject
|  | middleClick | Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject. | InteractiveObject
|  | middleMouseDown | Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. | InteractiveObject
|  | middleMouseUp | Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject
|  | mouseDown | Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject
|  | mouseFocusChange | Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject
|  | mouseMove | Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject
|  | mouseOut | Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject
|  | mouseOver | Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject
|  | mouseUp | Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject
|  | mouseWheel | Dispatched when a mouse wheel is spun over an InteractiveObject instance. | InteractiveObject
|  | nativeDragComplete | Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture. | InteractiveObject
|  | nativeDragDrop | Dispatched 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
|  | nativeDragEnter | Dispatched by an InteractiveObject when a drag gesture enters its boundary. | InteractiveObject
|  | nativeDragExit | Dispatched by an InteractiveObject when a drag gesture leaves its boundary. | InteractiveObject
|  | nativeDragOver | Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary. | InteractiveObject
|  | nativeDragStart | Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject
|  | nativeDragUpdate | Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject
|  | paste | Dispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu. | InteractiveObject
|  | proximityBegin | Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen. | InteractiveObject
|  | proximityEnd | Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen. | InteractiveObject
|  | proximityMove | Dispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold. | InteractiveObject
|  | proximityOut | Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject
|  | proximityOver | Dispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject
|  | proximityRollOut | Dispatched 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
|  | proximityRollOver | Dispatched 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
|  | releaseOutside | Dispatched 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
|  | removed | Dispatched when a display object is about to be removed from the display list. | DisplayObject
|  | removedFromStage | Dispatched 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
|  | render | [broadcast event] Dispatched when the display list is about to be updated and rendered. | DisplayObject
|  | rightClick | Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject. | InteractiveObject
|  | rightMouseDown | Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject
|  | rightMouseUp | Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject
|  | rollOut | Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject
|  | rollOver | Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject
|  | selectAll | Dispatched 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
|  | softKeyboardActivate | Dispatched immediately after the soft keyboard is raised. | InteractiveObject
|  | softKeyboardActivating | Dispatched immediately before the soft keyboard is raised. | InteractiveObject
|  | softKeyboardDeactivate | Dispatched immediately after the soft keyboard is lowered. | InteractiveObject
|  | tabChildrenChange | Dispatched when the value of the object's tabChildren flag changes. | InteractiveObject
|  | tabEnabledChange | Dispatched when the object's tabEnabled flag changes. | InteractiveObject
|  | tabIndexChange | Dispatched when the value of the object's tabIndex property changes. | InteractiveObject
|  | textInput | Dispatched when a user enters one or more characters of text. | InteractiveObject
|  | touchBegin | Dispatched 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
|  | touchEnd | Dispatched 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
|  | touchMove | Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed. | InteractiveObject
|  | touchOut | Dispatched 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
|  | touchOver | Dispatched 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
|  | touchRollOut | Dispatched 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
|  | touchRollOver | Dispatched 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
|  | touchTap | Dispatched 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
Click for more information on 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

flashx.textLayout.formats.ITextLayoutFormat.color
spark.components.supportClasses.StyleableTextField.color
spark.components.supportClasses.StyleableStageText.color
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

flashx.textLayout.formats.ITextLayoutFormat.direction
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

flashx.textLayout.formats.ITextLayoutFormat.fontFamily
spark.components.supportClasses.StyleableStageText.fontFamily
spark.components.supportClasses.StyleableTextField.fontFamily
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

flashx.textLayout.formats.ITextLayoutFormat.fontSize
spark.components.supportClasses.StyleableStageText.fontSize
spark.components.supportClasses.StyleableTextField.fontSize
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

flashx.textLayout.formats.ITextLayoutFormat.fontStyle
spark.components.supportClasses.StyleableStageText.fontStyle
spark.components.supportClasses.StyleableTextField.fontStyle
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

flashx.textLayout.formats.ITextLayoutFormat.fontWeight
spark.components.supportClasses.StyleableStageText.fontWeight
spark.components.supportClasses.StyleableTextField.fontWeight
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

flashx.textLayout.formats.ITextLayoutFormat.kerning
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

flashx.textLayout.formats.ITextLayoutFormat.lineBreak
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

http://www.unicode.org/reports/tr35/
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

flashx.textLayout.formats.ITextLayoutFormat.paddingLeft
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

flashx.textLayout.formats.ITextLayoutFormat.paddingRight
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

flashx.textLayout.formats.ITextLayoutFormat.textAlign
spark.components.supportClasses.StyleableStageText.textAlign
spark.components.supportClasses.StyleableTextField.textAlign
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

flashx.textLayout.formats.ITextLayoutFormat.textDecoration
spark.components.supportClasses.StyleableTextField.textDecoration
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
Click for more information on 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

spark.components.supportClasses.StyleableTextField.letterSpacing
trackingLeft
trackingRight
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:Boolean` — `true` 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:Boolean` — `true` 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:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The 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`.
`target` | The 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.

Examples How to use this example
DefaultGridItemRendererExample.mxml
Copy

    <?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>

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00