Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
FTEDataGridItemRenderer

Package | mx.controls.dataGridClasses
Class | public class FTEDataGridItemRenderer
Inheritance | FTEDataGridItemRenderer UIFTETextField FTETextField flash.display.Sprite
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.

See also

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

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | 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 | FTETextField
|  | background : Boolean | FTETextField
|  | backgroundColor : uint | FTETextField
|  | baselinePosition : Number [read-only] The y-coordinate of the baseline of the first line of text. | UIFTETextField
|  | border : Boolean | FTETextField
|  | borderColor : uint | FTETextField
|  | bottomScrollV : int [read-only] This property has not been implemented in FTETextField because FTETextField does not support scrolling. | FTETextField
|  | 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 | FTETextField
|  | data : Object The implementation of the data property as defined by the IDataRenderer interface. | FTEDataGridItemRenderer
|  | defaultTextFormat : TextFormat | 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
|  | embedFonts : Boolean | 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
|  | focusPane : Sprite A single Sprite object that is shared among components and used as an overlay for drawing the focus indicator. | UIFTETextField
|  | fontContext : IFlexModuleFactory The IFlexModuleFactory instance that FTETextField uses for creating TextLine objects. | FTETextField
|  | gridFitType : String This property has no effect in FTETextField because FTE uses a newer font renderer than TextField. | FTETextField
|  | htmlText : String | 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] | FTETextField
|  | listData : BaseListData The implementation of the listData property as defined by the IDropInListItemRenderer interface. | FTEDataGridItemRenderer
|  | locale : String The locale of the text displayed by FTETextField. | FTETextField
|  | 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
|  | 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
|  | mouseWheelEnabled : Boolean This property has not been implemented in FTETextField because FTETextField does not support scrolling. | FTETextField
|  | multiline : Boolean This property has no effect in FTETextField because FTETextField does not support editing. | FTETextField
|  | 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
|  | numLines : int [read-only] | FTETextField
|  | 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
|  | scrollH : int This property has not been implemented in FTETextField because FTETextField does not support scrolling. | FTETextField
|  | 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
|  | styleDeclaration : CSSStyleDeclaration Storage for the inline inheriting styles on this object. | FTEDataGridItemRenderer
|  | styleName : Object The class style used by this component. | UIFTETextField
|  | styleSheet : StyleSheet | FTETextField
|  | systemManager : ISystemManager Returns the SystemManager object used by this component. | UIFTETextField
|  | text : String | FTETextField
|  | textColor : uint | FTETextField
|  | textHeight : Number [read-only] | FTETextField
|  | textWidth : Number [read-only] | 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
|  | tweeningProperties : Array Array of properties that are currently being tweened on this object. | UIFTETextField
|  | type : String | 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
|  | useRichTextClipboard : Boolean This property is not implemented in FTETextField because FTETextField does not support selection or clipboard operations. | FTETextField
|  | wordWrap : Boolean | FTETextField

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | FTEDataGridItemRenderer() Constructor. | FTEDataGridItemRenderer
|  | appendText(newText:String):void This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | clearStyle(styleProp:String):void Deletes a style property from this component instance. | FTEDataGridItemRenderer
|  | 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
|  | 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):TextLineMetrics | 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
|  | getParagraphLength(charIndex:int):int This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | 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):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():TextFormat Returns the TextFormat object that represents character formatting information for this UITextField object. | UIFTETextField
|  | getUITextFormat():UITextFormat Returns a UITextFormat object that contains formatting information for this component. | UIFTETextField
|  | 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
|  | 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
|  | 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
|  | 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
|  | setActualSize(w:Number, h:Number):void Sizes the object. | UIFTETextField
|  | setColor(color:uint):void Sets the font color of the text. | UIFTETextField
|  | setFocus():void Sets the focus to this component. | UIFTETextField
|  | 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: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
|  | styleChanged(styleProp:String):void Detects changes to style properties. | UIFTETextField
|  | 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

Protected Methods

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

Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | dataChange | Dispatched when the data property changes. | FTEDataGridItemRenderer

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.

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

See also

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.

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

See also

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: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: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`
FlexEvent.type property = `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.

Sun Mar 5 2017, 03:42 PM +11:00