Packagespark.skins.spark
Classpublic class DefaultGridItemRenderer
InheritanceDefaultGridItemRenderer Inheritance UIFTETextField Inheritance FTETextField Inheritance flash.display.Sprite
Implements IGridItemRenderer, IStyleClient

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

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

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

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

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

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

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

View the examples

See also

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


Public Properties
 PropertyDefined By
 InheritedalwaysShowSelection : Boolean
This property is not implemented in FTETextField because FTETextField does not support selection.
FTETextField
 InheritedantiAliasType : String
This property has no effect in FTETextField because FTE uses a newer font renderer than TextField.
FTETextField
 InheritedautomationDelegate : Object
The delegate object which is handling the automation related functionality.
UIFTETextField
 InheritedautomationEnabled : Boolean
[read-only] True if this component is enabled for automation, false otherwise.
UIFTETextField
 InheritedautomationName : String
Name that can be used as an identifier for this object.
UIFTETextField
 InheritedautomationOwner : DisplayObjectContainer
[read-only] The owner of this component for automation purposes.
UIFTETextField
 InheritedautomationParent : DisplayObjectContainer
[read-only] The parent of this component for automation purposes.
UIFTETextField
 InheritedautomationValue : Array
[read-only] This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application.
UIFTETextField
 InheritedautomationVisible : Boolean
[read-only] True if this component is visible for automation, false otherwise.
UIFTETextField
 InheritedautoSize : String
FTETextField
 Inheritedbackground : Boolean
FTETextField
 InheritedbackgroundColor : uint
FTETextField
 InheritedbaselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text.
UIFTETextField
 Inheritedborder : Boolean
FTETextField
 InheritedborderColor : uint
FTETextField
 InheritedbottomScrollV : int
[read-only] This property has not been implemented in FTETextField because FTETextField does not support scrolling.
FTETextField
 InheritedcaretIndex : int
[read-only] This property has not been implemented in FTETextField because FTETextField does not support editing.
FTETextField
 InheritedclassName : String
[read-only] The name of this instance's class, such as "DataGridItemRenderer".
UIFTETextField
  column : GridColumn
The GridColumn object representing the column associated with this item renderer.
DefaultGridItemRenderer
  columnIndex : int
[read-only] The column index for this item renderer's cell.
DefaultGridItemRenderer
 InheritedcondenseWhite : Boolean
FTETextField
  data : Object
The value of the data provider item for the entire row of the grid control.
DefaultGridItemRenderer
 InheriteddefaultTextFormat : TextFormat
FTETextField
 InheriteddisplayAsPassword : Boolean
This property has not been implemented in FTETextField because FTETextField does not support editing.
FTETextField
 Inheriteddocument : Object
A reference to the document object associated with this UITextField object.
UIFTETextField
  down : Boolean
The grid control's updateDisplayList() method sets this property before calling prepare().
DefaultGridItemRenderer
  dragging : Boolean
Contains true if the item renderer is being dragged, typically as part of a drag and drop operation.
DefaultGridItemRenderer
 InheritedembedFonts : Boolean
FTETextField
 Inheritedenabled : Boolean
A Boolean value that indicates whether the component is enabled.
UIFTETextField
 InheritedenableIME : Boolean
[read-only] A flag that indicates whether the IME should be enabled when the component receives focus.
UIFTETextField
 InheritedexplicitHeight : Number
Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
UIFTETextField
 InheritedexplicitMaxHeight : Number
[read-only] Number that specifies the maximum height of the component, in pixels, in the component's coordinates, if the maxHeight property is set.
UIFTETextField
 InheritedexplicitMaxWidth : Number
[read-only] Number that specifies the maximum width of the component, in pixels, in the component's coordinates, if the maxWidth property is set.
UIFTETextField
 InheritedexplicitMinHeight : Number
[read-only] The minimum recommended height of the component to be considered by the parent during layout.
UIFTETextField
 InheritedexplicitMinWidth : Number
[read-only] The minimum recommended width of the component to be considered by the parent during layout.
UIFTETextField
 InheritedexplicitWidth : Number
Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
UIFTETextField
 InheritedfocusPane : Sprite
A single Sprite object that is shared among components and used as an overlay for drawing the focus indicator.
UIFTETextField
 InheritedfontContext : IFlexModuleFactory
The IFlexModuleFactory instance that FTETextField uses for creating TextLine objects.
FTETextField
  grid : Grid
[read-only] The grid control associated with this item renderer.
DefaultGridItemRenderer
 InheritedgridFitType : String
This property has no effect in FTETextField because FTE uses a newer font renderer than TextField.
FTETextField
  hovered : Boolean
Set to true when the mouse is hovered over the item renderer.
DefaultGridItemRenderer
 InheritedhtmlText : String
FTETextField
 InheritedignorePadding : Boolean
If true, the paddingLeft and paddingRight styles will not add space around the text of the component.
UIFTETextField
 InheritedimeMode : String
Specifies the IME (input method editor) mode.
UIFTETextField
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
UIFTETextField
 InheritedinheritingStyles : Object
The beginning of this UITextField's chain of inheriting styles.
UIFTETextField
 Inheritedinitialized : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required).
UIFTETextField
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIFTETextField
  label : String
The grid control sets this property to the value of the column's itemToLabel() method, before calling preprare(). The String to display in the item renderer.
DefaultGridItemRenderer
 Inheritedlength : int
[read-only]
FTETextField
 InheritedmaxChars : int
This property has not been implemented in FTETextField because FTETextField does not support editing.
FTETextField
 InheritedmaxHeight : Number
[read-only] The maximum recommended height of the component to be considered by the parent during layout.
UIFTETextField
 InheritedmaxScrollH : int
[read-only] This property has not been implemented in FTETextField because FTETextField does not support scrolling.
FTETextField
 InheritedmaxScrollV : int
[read-only] This property has not been implemented in FTETextField because FTETextField does not support scrolling.
FTETextField
 InheritedmaxWidth : Number
[read-only] The maximum recommended width of the component to be considered by the parent during layout.
UIFTETextField
 InheritedmeasuredHeight : Number
[read-only] The default height of the component, in pixels.
UIFTETextField
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
UIFTETextField
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
UIFTETextField
 InheritedmeasuredWidth : Number
[read-only] The default width of the component, in pixels.
UIFTETextField
 InheritedminHeight : Number
[read-only] The minimum recommended height of the component to be considered by the parent during layout.
UIFTETextField
 InheritedminWidth : Number
[read-only] The minimum recommended width of the component to be considered by the parent during layout.
UIFTETextField
 InheritedmoduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
UIFTETextField
 InheritedmouseWheelEnabled : Boolean
This property has not been implemented in FTETextField because FTETextField does not support scrolling.
FTETextField
 Inheritedmultiline : Boolean
This property has no effect in FTETextField because FTETextField does not support editing.
FTETextField
 InheritednestLevel : int
Depth of this object in the containment hierarchy.
UIFTETextField
 InheritednonInheritingStyles : Object
The beginning of this UITextField's chain of non-inheriting styles.
UIFTETextField
 InheritednonZeroTextHeight : Number
[read-only] The height of the text, in pixels.
UIFTETextField
 InheritednumLines : int
[read-only]
FTETextField
 Inheritedowner : DisplayObjectContainer
By default, set to the parent container of this object.
UIFTETextField
 Inheritedparent : DisplayObjectContainer
[override] [read-only] The parent container or component for this component.
UIFTETextField
 InheritedpercentHeight : Number
Specifies the height of a component as a percentage of its parent's size.
UIFTETextField
 InheritedpercentWidth : Number
Specifies the width of a component as a percentage of its parent's size.
UIFTETextField
 InheritedprocessedDescriptors : Boolean
Set to true after the createChildren() method creates any internal component children.
UIFTETextField
 Inheritedrestrict : String
This property has not been implemented in FTETextField because FTETextField does not support scrolling.
FTETextField
  rowIndex : int
The grid control's updateDisplayList() method sets this property before calling prepare(). The zero-based index of the row of the cell being rendered.
DefaultGridItemRenderer
 InheritedscrollH : int
This property has not been implemented in FTETextField because FTETextField does not support scrolling.
FTETextField
 InheritedscrollV : int
This property has not been implemented in FTETextField because FTETextField does not support scrolling.
FTETextField
 Inheritedselectable : Boolean
Setting this property has no effect in FTETextField because FTETextField does not support selection.
FTETextField
  selected : Boolean
The grid control's updateDisplayList() method sets this property before calling prepare(). Contains true if the item renderer's cell is part of the current selection.
DefaultGridItemRenderer
 InheritedselectionBeginIndex : int
[read-only] This property has not been implemented in FTETextField because FTETextField does not support selection.
FTETextField
 InheritedselectionEndIndex : int
[read-only] This property has not been implemented in FTETextField because FTETextField does not support selection.
FTETextField
 Inheritedsharpness : Number
This property has no effect in FTETextField.
FTETextField
  showsCaret : Boolean
The grid control's updateDisplayList() method sets this property before calling preprare().
DefaultGridItemRenderer
 InheritedstyleName : Object
The class style used by this component.
UIFTETextField
 InheritedstyleSheet : StyleSheet
FTETextField
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIFTETextField
 Inheritedtext : String
FTETextField
 InheritedtextColor : uint
FTETextField
 InheritedtextHeight : Number
[read-only]
FTETextField
 InheritedtextWidth : Number
[read-only]
FTETextField
 Inheritedthickness : Number
This property has no effect in FTETextField because FTE uses a newer font renderer than TextField.
FTETextField
 InheritedtoolTip : String
Text to display in the ToolTip.
UIFTETextField
 InheritedtweeningProperties : Array
Array of properties that are currently being tweened on this object.
UIFTETextField
 Inheritedtype : String
FTETextField
 InheritedupdateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required)
UIFTETextField
 InheriteduseRichTextClipboard : Boolean
This property is not implemented in FTETextField because FTETextField does not support selection or clipboard operations.
FTETextField
 InheritedwordWrap : Boolean
FTETextField
Public Methods
 MethodDefined By
  
Constructor.
DefaultGridItemRenderer
 Inherited
appendText(newText:String):void
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
  
discard(hasBeenRecycled:Boolean):void
Called from the item renderer parent's updateDisplayList() method when it has been determined that this renderer will no longer be visible.
DefaultGridItemRenderer
 Inherited
getCharBoundaries(charIndex:int):Rectangle
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
getCharIndexAtPoint(x:Number, y:Number):int
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
A convenience method for determining whether to use the explicit or measured height
UIFTETextField
 Inherited
A convenience method for determining whether to use the explicit or measured width
UIFTETextField
 Inherited
getFirstCharInParagraph(charIndex:int):int
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
getImageReference(id:String):DisplayObject
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
getLineIndexAtPoint(x:Number, y:Number):int
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
getLineIndexOfChar(charIndex:int):int
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
getLineLength(lineIndex:int):int
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
getLineMetrics(lineIndex:int):TextLineMetrics
FTETextField
 Inherited
getLineOffset(lineIndex:int):int
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
getLineText(lineIndex:int):String
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
getParagraphLength(charIndex:int):int
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this component's style lookup chain.
UIFTETextField
 Inherited
getTextFormat(beginIndex:int = -1, endIndex:int = -1):TextFormat
This method has been implemented in FTETextField to simply return a copy of the defaultTextFormat, because FTETextField does not support formatting a range.
FTETextField
 Inherited
getTextStyles():TextFormat
Returns the TextFormat object that represents character formatting information for this UITextField object.
UIFTETextField
 Inherited
Returns a UITextFormat object that contains formatting information for this component.
UIFTETextField
 Inherited
initialize():void
Initializes this component.
UIFTETextField
 Inherited
Marks a component so that its updateDisplayList() method gets called during a later screen update.
UIFTETextField
 Inherited
Marks a component so that its commitProperties() method gets called during a later screen update.
UIFTETextField
 Inherited
Marks a component so that its measure() method gets called during a later screen update.
UIFTETextField
 Inherited
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
UIFTETextField
 Inherited
owns(child:DisplayObject):Boolean
Returns true if the child is parented or owned by this object.
UIFTETextField
 Inherited
parentChanged(p:DisplayObjectContainer):void
This function is called when a UITextField object is assigned a parent.
UIFTETextField
  
prepare(willBeRecycled:Boolean):void
Called from the item renderer parent's updateDisplayList() method after all of the renderer's properties have been set.
DefaultGridItemRenderer
 Inherited
replaceSelectedText(value:String):void
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
replaceText(beginIndex:int, endIndex:int, newText:String):void
This method has not been implemented in FTETextField because very few components use it in TextField.
FTETextField
 Inherited
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
UIFTETextField
 Inherited
setActualSize(w:Number, h:Number):void
Sizes the object.
UIFTETextField
 Inherited
setColor(color:uint):void
Sets the font color of the text.
UIFTETextField
 Inherited
setFocus():void
Sets the focus to this component.
UIFTETextField
 Inherited
setSelection(beginIndex:int, endIndex:int):void
This method has not been implemented in FTETextField because FTETextField does not support selection.
FTETextField
 Inherited
setStyle(styleProp:String, value:*):void
Does nothing.
UIFTETextField
 Inherited
setTextFormat(format:TextFormat, beginIndex:int = -1, endIndex:int = -1):void
This method has no effect on a FTETextField if beginIndex or endIndex does not equal -1 because FTETextField does not support formatting a range.
FTETextField
 Inherited
setVisible(visible:Boolean, noEvent:Boolean = false):void
Sets the visible property of this UITextField object.
UIFTETextField
 Inherited
styleChanged(styleProp:String):void
Detects changes to style properties.
UIFTETextField
 Inherited
truncateToFit(truncationIndicator:String = null):Boolean
Truncate text to make it fit horizontally in the area defined for the control, and append an ellipsis, three periods (...), to the text.
UIFTETextField
 Inherited
Validate and update the properties and layout of this object and redraw it, if necessary.
UIFTETextField
Events
 Event Summary Defined By
  Dispatched when the bindable data property changes.DefaultGridItemRenderer
Styles
 Style Description Defined By
  
color
Type: uint Format: Color CSS Inheritance: yes
Color of the text.

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

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

The default value is 0x000000.

See also

DefaultGridItemRenderer
  
direction
Type: String CSS Inheritance: yes
Specifies the default bidirectional embedding level of the text.

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

For the Mobile theme, this is not supported.

See also

DefaultGridItemRenderer
  
fontFamily
Type: String CSS Inheritance: yes
The name of the font to use, or a comma-separated list of font names.

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

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

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

See also

DefaultGridItemRenderer
  
fontSize
Type: Number Format: Length CSS Inheritance: yes
Height of the text, in pixels.

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

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

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

See also

DefaultGridItemRenderer
  
fontStyle
Type: String CSS Inheritance: yes
Determines whether the text is italic font.

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

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

See also

DefaultGridItemRenderer
  
fontWeight
Type: String CSS Inheritance: yes
Determines whether the text is boldface.

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

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

See also

DefaultGridItemRenderer
  
kerning
Type: String CSS Inheritance: yes
The style used for justification of the paragraph.

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

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

For the Mobile theme, this is not supported.

See also

DefaultGridItemRenderer
  
letterSpacing
Type: Number CSS Inheritance: yes Theme: mobile
The number of additional pixels to appear between each character.

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

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

See also

DefaultGridItemRenderer
  
lineBreak
Type: String CSS Inheritance: no
Controls word wrapping within the container.

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

For the Mobile theme, this is not supported.

See also

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

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

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

The default value is undefined.

See also

DefaultGridItemRenderer
  
paddingLeft
Type: Number Format: Length CSS Inheritance: no
Left inset, in pixels.

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

For the Mobile theme, this is not supported.

See also

DefaultGridItemRenderer
  
paddingRight
Type: Number Format: Length CSS Inheritance: no
Right inset, in pixels.

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

For the Mobile theme, this is not supported.

See also

DefaultGridItemRenderer
  
textAlign
Type: String CSS Inheritance: yes
Alignment of text within a container.

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

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

See also

DefaultGridItemRenderer
  
textDecoration
Type: String CSS Inheritance: yes
Determines whether the text is underlined.

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

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

See also

DefaultGridItemRenderer
  
textIndent
Type: Number Format: Length CSS Inheritance: yes
A Number that specifies, in pixels, the amount to indent the first line of the paragraph. A negative indent will push the line into the margin, and possibly out of the container.

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

Default value is undefined indicating not set.

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

DefaultGridItemRenderer
Property Detail
columnproperty
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
columnIndexproperty 
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
dataproperty 
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
downproperty 
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
draggingproperty 
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
gridproperty 
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
hoveredproperty 
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
labelproperty 
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
rowIndexproperty 
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
selectedproperty 
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
showsCaretproperty 
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
DefaultGridItemRenderer()Constructor
public function DefaultGridItemRenderer()

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

Constructor.

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

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

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

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

Parameters

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

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

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

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

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

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

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

Parameters

willBeRecycled:Booleantrue if this renderer is being reused.

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

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

Dispatched when the bindable data property changes.

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

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
Examples
DefaultGridItemRendererExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!--

  Licensed to the Apache Software Foundation (ASF) under one or more
  contributor license agreements.  See the NOTICE file distributed with
  this work for additional information regarding copyright ownership.
  The ASF licenses this file to You under the Apache License, Version 2.0
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

-->

<!--

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

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

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

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

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

-->

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