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

Package | spark.skins.spark
Class | public class UITextFieldGridItemRenderer
Inheritance | UITextFieldGridItemRenderer UITextField FlexTextField flash.text.TextField
Implements | IGridItemRenderer, IStyleClient

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.5

The UITextFieldGridItemRenderer class defines simple and efficient item renderer that displays a single text label. For applications displaying grid controls with large numbers of visible cells, this renderer provides optimum performance on Microsoft Windows. It is based on TextField, not the Flash Text Engine (FTE), so it lacks support for some Spark text features and it does not support the FTE specific text styles.

You can control the label text wrapping by using the `wordWrap` property. For example, setting `wordWrap="false"` 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.

UITextFieldGridItemRenderer inherits its the value of the `layoutDirection` property from its parent. It should not be set directly on UITextFieldGridItemRenderer.

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

See also

spark.components.DataGrid
spark.components.gridClasses.GridItemRenderer
spark.skins.spark.DefaultGridItemRenderer
mx.core.FTETextField

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | automationDelegate : Object The delegate object which is handling the automation related functionality. | UITextField
|  | automationEnabled : Boolean [read-only] True if this component is enabled for automation, false otherwise. | UITextField
|  | automationName : String Name that can be used as an identifier for this object. | UITextField
|  | automationOwner : DisplayObjectContainer [read-only] The owner of this component for automation purposes. | UITextField
|  | automationParent : DisplayObjectContainer [read-only] The parent of this component for automation purposes. | UITextField
|  | 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. | UITextField
|  | automationVisible : Boolean [read-only] True if this component is visible for automation, false otherwise. | UITextField
|  | baselinePosition : Number [read-only] The y-coordinate of the baseline of the first line of text. | UITextField
|  | className : String [read-only] The name of this instance's class, such as "DataGridItemRenderer". | UITextField
|  | column : GridColumn The GridColumn object representing the column associated with this item renderer. | UITextFieldGridItemRenderer
|  | columnIndex : int [read-only] The column index for this item renderer's cell. | UITextFieldGridItemRenderer
|  | data : Object The value of the data provider item for the entire row of the grid control. | UITextFieldGridItemRenderer
|  | document : Object A reference to the document object associated with this UITextField object. | UITextField
|  | down : Boolean The grid control's updateDisplayList() method sets this property before calling prepare(). | UITextFieldGridItemRenderer
|  | dragging : Boolean Contains true if the item renderer is being dragged, typically as part of a drag and drop operation. | UITextFieldGridItemRenderer
|  | enabled : Boolean A Boolean value that indicates whether the component is enabled. | UITextField
|  | enableIME : Boolean [read-only] A flag that indicates whether the IME should be enabled when the component receives focus. | UITextField
|  | explicitHeight : Number Number that specifies the explicit height of the component, in pixels, in the component's coordinates. | UITextField
|  | 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. | UITextField
|  | 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. | UITextField
|  | explicitMinHeight : Number [read-only] The minimum recommended height of the component to be considered by the parent during layout. | UITextField
|  | explicitMinWidth : Number [read-only] The minimum recommended width of the component to be considered by the parent during layout. | UITextField
|  | explicitWidth : Number Number that specifies the explicit width of the component, in pixels, in the component's coordinates. | UITextField
|  | focusPane : Sprite A single Sprite object that is shared among components and used as an overlay for drawing the focus indicator. | UITextField
|  | grid : Grid [read-only] The grid control associated with this item renderer. | UITextFieldGridItemRenderer
|  | hovered : Boolean Set to true when the mouse is hovered over the item renderer. | UITextFieldGridItemRenderer
|  | ignorePadding : Boolean If true, the paddingLeft and paddingRight styles will not add space around the text of the component. | UITextField
|  | imeMode : String Specifies the IME (input method editor) mode. | UITextField
|  | includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container. | UITextField
|  | inheritingStyles : Object The beginning of this UITextField's chain of inheriting styles. | UITextField
|  | initialized : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required) | UITextField
|  | isPopUp : Boolean Set to true by the PopUpManager to indicate that component has been popped up. | UITextField
|  | 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. | UITextFieldGridItemRenderer
|  | maxHeight : Number [read-only] The maximum recommended height of the component to be considered by the parent during layout. | UITextField
|  | maxWidth : Number [read-only] The maximum recommended width of the component to be considered by the parent during layout. | UITextField
|  | measuredHeight : Number [read-only] The default height of the component, in pixels. | UITextField
|  | measuredMinHeight : Number The default minimum height of the component, in pixels. | UITextField
|  | measuredMinWidth : Number The default minimum width of the component, in pixels. | UITextField
|  | measuredWidth : Number [read-only] The default width of the component, in pixels. | UITextField
|  | minHeight : Number [read-only] The minimum recommended height of the component to be considered by the parent during layout. | UITextField
|  | minWidth : Number [read-only] The minimum recommended width of the component to be considered by the parent during layout. | UITextField
|  | moduleFactory : IFlexModuleFactory The moduleFactory that is used to create TextFields in the correct SWF context. | UITextField
|  | nestLevel : int Depth of this object in the containment hierarchy. | UITextField
|  | nonInheritingStyles : Object The beginning of this UITextField's chain of non-inheriting styles. | UITextField
|  | nonZeroTextHeight : Number [read-only] Unlike textHeight, this returns a non-zero value even when the text is empty. | UITextField
|  | owner : DisplayObjectContainer By default, set to the parent container of this object. | UITextField
|  | parent : DisplayObjectContainer [override] [read-only] The parent container or component for this component. | UITextField
|  | percentHeight : Number Specifies the height of a component as a percentage of its parent's size. | UITextField
|  | percentWidth : Number Specifies the width of a component as a percentage of its parent's size. | UITextField
|  | processedDescriptors : Boolean Set to true after the createChildren() method creates any internal component children. | UITextField
|  | 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. | UITextFieldGridItemRenderer
|  | 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. | UITextFieldGridItemRenderer
|  | showsCaret : Boolean The grid control's updateDisplayList() method sets this property before calling preprare(). | UITextFieldGridItemRenderer
|  | styleName : Object The class style used by this component. | UITextField
|  | systemManager : ISystemManager Returns the SystemManager object used by this component. | UITextField
|  | toolTip : String Text to display in the ToolTip. | UITextField
|  | tweeningProperties : Array Array of properties that are currently being tweened on this object. | UITextField
|  | updateCompletePendingFlag : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required) | UITextField

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | UITextFieldGridItemRenderer() Constructor. | UITextFieldGridItemRenderer
|  | 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. | UITextFieldGridItemRenderer
|  | getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height | UITextField
|  | getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width | UITextField
|  | getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain. | UITextField
|  | getTextStyles():TextFormat Returns the TextFormat object that represents character formatting information for this UITextField object. | UITextField
|  | getUITextFormat():UITextFormat Returns a UITextFormat object that contains formatting information for this component. | UITextField
|  | initialize():void Initializes this component. | UITextField
|  | invalidateDisplayList():void Marks a component so that its updateDisplayList() method gets called during a later screen update. | UITextField
|  | invalidateProperties():void Marks a component so that its commitProperties() method gets called during a later screen update. | UITextField
|  | invalidateSize():void Marks a component so that its measure() method gets called during a later screen update. | UITextField
|  | move(x:Number, y:Number):void Moves the component to a specified position within its parent. | UITextField
|  | owns(child:DisplayObject):Boolean Returns true if the child is parented or owned by this object. | UITextField
|  | parentChanged(p:DisplayObjectContainer):void This function is called when a UITextField object is assigned a parent. | UITextField
|  | prepare(willBeRecycled:Boolean):void Called from the item renderer parent's updateDisplayList() method after all of the renderer's properties have been set. | UITextFieldGridItemRenderer
|  | replayAutomatableEvent(event:Event):Boolean Replays the specified event. | UITextField
|  | setActualSize(w:Number, h:Number):void Sizes the object. | UITextField
|  | setColor(color:uint):void Sets the font color of the text. | UITextField
|  | setFocus():void Sets the focus to this component. | UITextField
|  | setStyle(styleProp:String, value:*):void Does nothing. | UITextField
|  | setVisible(visible:Boolean, noEvent:Boolean = false):void Sets the visible property of this UITextField object. | UITextField
|  | styleChanged(styleProp:String):void Detects changes to style properties. | UITextField
|  | toString():String [override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application. | FlexTextField
|  | truncateToFit(truncationIndicator:String = null):Boolean Truncate text to make it fit horizontally in the area defined for the control, and append an ellipsis, three periods (...), to the text. | UITextField
|  | validateNow():void Validate and update the properties and layout of this object and redraw it, if necessary. | UITextField

Events

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

Styles
Hide Inherited Styles
Show Inherited Styles

| Style | Description | Defined By
--- | --- | --- | ---
|  | color | Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | UITextField
|  | disabledColor | Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. | UITextField
|  | fontAntiAliasType | Type: String CSS Inheritance: yes Sets the `antiAliasType` property of internal TextFields. See also flash.text.TextField flash.text.AntiAliasType | UITextField
|  | fontFamily | Type: String CSS Inheritance: yes Name of the font to use. | UITextField
|  | fontGridFitType | Type: String CSS Inheritance: yes Sets the `gridFitType` property of internal TextFields that represent text in Flex controls. See also flash.text.TextField flash.text.GridFitType | UITextField
|  | fontSharpness | Type: Number CSS Inheritance: yes Sets the `sharpness` property of internal TextFields that represent text in Flex controls. See also flash.text.TextField | UITextField
|  | fontSize | Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | UITextField
|  | fontStyle | Type: String CSS Inheritance: yes Determines whether the text is italic font. | UITextField
|  | fontThickness | Type: Number CSS Inheritance: yes Sets the `thickness` property of internal TextFields that represent text in Flex controls. See also flash.text.TextField | UITextField
|  | fontWeight | Type: String CSS Inheritance: yes Determines whether the text is boldface. | UITextField
|  | kerning | Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled (`true`) or disabled (`false`). | UITextField
|  | leading | Type: Number Format: Length CSS Inheritance: yes Additional vertical space between lines of text. | UITextField
|  | letterSpacing | Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | UITextField
|  | locale | Type: String CSS Inheritance: yes The locale of the text displayed by this component. | UITextField
|  | paddingLeft | Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's left border and the left edge of its content area. | UITextField
|  | paddingRight | Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's right border and the right edge of its content area. | UITextField
|  | textAlign | Type: String CSS Inheritance: yes Alignment of text within a container. | UITextField
|  | textDecoration | Type: String CSS Inheritance: yes Determines whether the text is underlined. | UITextField
|  | textFieldClass | Type: Class CSS Inheritance: no The class implementing IUITextField that is used by this component to render text. | UITextField
|  | textIndent | Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. | UITextField

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

UITextFieldGridItemRenderer | () | Constructor

`public function UITextFieldGridItemRenderer()`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.0

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`
FlexEvent.type property = `mx.events.FlexEvent.DATA_CHANGE`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 2.0

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.

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