mx.controls.dataGridClasses

# FTEDataGridItemRenderer - AS3 Flex

Package | mx.controls.dataGridClasses
Class | public class FTEDataGridItemRenderer
Inheritance | FTEDataGridItemRenderer UIFTETextField FTETextField Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object
Implements | IDataRenderer, IDropInListItemRenderer, ILayoutManagerClient, IListItemRenderer, IStyleClient

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

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

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

Related API Elements

mx.controls.DataGrid
mx.core.IDataRenderer
mx.controls.listClasses.IDropInListItemRenderer

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
|  | 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 implementation of the data property as defined by the IDataRenderer interface. | FTEDataGridItemRenderer
|  | 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
|  | direction : String The directionality of the text displayed by the FTETextField. | 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
|  | 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
|  | 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
|  | 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
|  | length : int [read-only] The number of characters in a text field. | FTETextField
|  | listData : BaseListData The implementation of the listData property as defined by the IDropInListItemRenderer interface. | FTEDataGridItemRenderer
|  | loaderInfo : LoaderInfo [read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs. | DisplayObject
|  | locale : String The locale of the text displayed by FTETextField. | FTETextField
|  | 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
|  | 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
|  | 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
|  | 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
|  | styleDeclaration : CSSStyleDeclaration Storage for the inline inheriting styles on this object. | FTEDataGridItemRenderer
|  | 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
--- | --- | ---
|  | FTEDataGridItemRenderer() Constructor. | FTEDataGridItemRenderer
|  | 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
|  | clearStyle(styleProp:String):void Deletes a style property from this component instance. | FTEDataGridItemRenderer
|  | contains(child:DisplayObject):Boolean Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself. | DisplayObjectContainer
|  | 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
|  | getClassStyleDeclarations():Array Returns an Array of CSSStyleDeclaration objects for the type selector that applies to this component, or null if none exist. | FTEDataGridItemRenderer
|  | 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):* [override] Gets a style property that has been set anywhere in this component's style lookup chain. | FTEDataGridItemRenderer
|  | 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
|  | initProtoChain():void Sets up the inheritingStyles and nonInheritingStyles objects and their proto chains so that the getStyle() method can work. | FTEDataGridItemRenderer
|  | 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
|  | notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propagates style changes to the children of this component. | FTEDataGridItemRenderer
|  | 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
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | regenerateStyleCache(recursive:Boolean):void Sets up the internal style cache values so that the getStyle() method functions. | FTEDataGridItemRenderer
|  | registerEffects(effects:Array):void Registers the EffectManager as one of the event listeners for each effect event. | FTEDataGridItemRenderer
|  | 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, newValue:*):void [override] Sets a style property on this component instance. | FTEDataGridItemRenderer
|  | 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
|  | validateDisplayList():void If Flex calls LayoutManager.invalidateDisplayList() method on this ILayoutManagerClient, then this function is called when it's time to update the display list. | FTEDataGridItemRenderer
|  | validateNow():void Validate and update the properties and layout of this object and redraw it, if necessary. | UIFTETextField
|  | validateProperties():void If Flex calls the LayoutManager.invalidateProperties() method on this ILayoutManagerClient, then this function is called when it's time to commit property values. | FTEDataGridItemRenderer
|  | validateSize(recursive:Boolean = false):void If Flex calls the LayoutManager.invalidateSize() method on this ILayoutManagerClient, then this function is called when it's time to do measurements. | FTEDataGridItemRenderer
|  | 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

Protected Methods

| Method | Defined By
--- | --- | ---
|  | toolTipShowHandler(event:mx.events:ToolTipEvent):void The event handler to position the tooltip. | FTEDataGridItemRenderer

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 data property changes. | FTEDataGridItemRenderer
|  | 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

Property Detail

### data

property

`data:Object`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The implementation of the `data` property as defined by the IDataRenderer interface.

The value is ignored. Only the `listData` property is used.

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

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

Related API Elements

mx.core.IDataRenderer

### listData

property

`listData:BaseListData`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

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

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

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

Related API Elements

mx.controls.listClasses.IDropInListItemRenderer

### styleDeclaration

property

`styleDeclaration:CSSStyleDeclaration`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

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

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

### FTEDataGridItemRenderer

()
Constructor

`public function FTEDataGridItemRenderer()`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Constructor.

Method Detail

### clearStyle

()
method

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

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Deletes a style property from this component instance.

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

Parameters

| `styleProp:String` — The name of the style property.

### getClassStyleDeclarations

()
method

`public function getClassStyleDeclarations():Array`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

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

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

Returns

| `Array` — Array of CSSStyleDeclaration objects.

### getStyle

()
method

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

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

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

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

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

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

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

Parameters

| `styleProp:String` — Name of the style property.

Returns

| `*` — Style value.

### initProtoChain

()
method

`public function initProtoChain():void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

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

### notifyStyleChangeInChildren

()
method

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

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Propagates style changes to the children of this component.

Parameters

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

### regenerateStyleCache

()
method

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

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

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

Parameters

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

### registerEffects

()
method

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

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

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

Parameters

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

### setStyle

()
method

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

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Sets a style property on this component instance.

This can override a style that was set globally.

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

Parameters

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

### toolTipShowHandler

()
method

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

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The event handler to position the tooltip.

Parameters

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

### validateDisplayList

()
method

`public function validateDisplayList():void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

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

### validateProperties

()
method

`public function validateProperties():void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

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

### validateSize

()
method

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

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

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

Parameters

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

Event Detail

### dataChange

Event

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

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Dispatched when the `data` property changes.

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

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

The properties of the event object have the following values:

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.

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