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

Package | spark.components.itemRenderers
Class | public class MobileGridTextCellRenderer
Inheritance | MobileGridTextCellRenderer StyleableTextField FlexTextField flash.text.TextField
Implements | IMobileGridTextCellRenderer

Language Version : | ActionScript 3.0

Product Version : | Flex 4.11

Runtime Versions : | AIR 3.8

| This class is experimental, which means it has not been tested or documented as thoroughly as other core Apache Flex classes.

Default lightweight class for rendering formatted text in MobileGrid cells .

You don't have to use this render explicitly as it will be used by default for MobileGrid text cells.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | canSetContentHeight : Boolean [read-only] Flag indicating whether the layout manager can stretch the height of this renderer to match the column's height. | MobileGridTextCellRenderer
|  | canSetContentWidth : Boolean [read-only] Flag indicating whether the layout manager can stretch the width of this renderer to match the column's width. | MobileGridTextCellRenderer
|  | cssStyleName : String [write-only] this property is set with the GridColumn's styleName property. | MobileGridTextCellRenderer
|  | data : Object The data to render or edit. | MobileGridTextCellRenderer
|  | editable : Boolean Specifies whether the text is editable, true, or not, false. | StyleableTextField
|  | enabled : Boolean Whether the component can accept user interaction. | StyleableTextField
|  | focusEnabled : Boolean Indicates whether the component can receive focus when tabbed to. | StyleableTextField
|  | horizontalScrollPosition : Number The horizontal scroll position of the text. | StyleableTextField
|  | isTruncated : Boolean [read-only] Indicates whether the text has been truncated, true, or not, false. | StyleableTextField
|  | labelField : String [write-only] Implement this property so that the renderer can receive the dataField from its MobileGridColumn. | MobileGridTextCellRenderer
|  | labelFunction : Function [write-only] Implement this property so that the renderer can receive the labelFunction its MobileGridColumn | MobileGridTextCellRenderer
|  | lineBreak : String Controls word wrapping within the text. | StyleableTextField
|  | minHeight : Number The minimum recommended height of the component to be considered by the parent during layout. | StyleableTextField
|  | minWidth : Number The minimum recommended width of the component to be considered by the parent during layout. | StyleableTextField
|  | selectionActivePosition : int [read-only] The active, or last clicked position, of the selection. | StyleableTextField
|  | selectionAnchorPosition : int [read-only] The anchor, or first clicked position, of the selection. | StyleableTextField
|  | styleDeclaration : CSSStyleDeclaration Storage for the inline inheriting styles on this object. | StyleableTextField
|  | styleName : Object The class style used by this component. | StyleableTextField
|  | styleProvider : IStyleClient [write-only] | MobileGridTextCellRenderer
|  | text : String [override] The text displayed by this text component. | StyleableTextField
|  | textAlign : String [write-only] Implement this property so that the renderer can receive the textAlign property from the renderers' MobileGridColumn | MobileGridTextCellRenderer
|  | verticalScrollPosition : Number The vertical scroll position of the text. | StyleableTextField

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | MobileGridTextCellRenderer() | MobileGridTextCellRenderer
|  | appendText(text:String):void [override] Appends the specified text to the end of the text component, as if you had clicked at the end and typed. | StyleableTextField
|  | commitStyles():void Commit the styles into the TextField. | StyleableTextField
|  | getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain. | StyleableTextField
|  | insertText(text:String):void Inserts the specified text into the text component as if you had typed it. | StyleableTextField
|  | scrollToRange(anchorPosition:int, activePosition:int):void Scroll so the specified range is in view. | StyleableTextField
|  | selectAll():void Selects all of the text. | StyleableTextField
|  | selectRange(anchorIndex:int, activeIndex:int):void Selects a specified range of characters. | StyleableTextField
|  | setFocus():void Set focus to this text field. | StyleableTextField
|  | setStyle(styleProp:String, value:*):void Sets a style property on this component instance. | StyleableTextField
|  | styleChanged(styleProp:String):void Detects changes to style properties. | StyleableTextField
|  | toString():String [override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application. | FlexTextField
|  | truncateToFit(truncationIndicator:String = ...):Boolean Truncate text to make it fit horizontally in the area defined for the control, and append an ellipsis, three periods (...), to the text. | StyleableTextField

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. | StyleableTextField
|  | fontFamily | Type: String CSS Inheritance: yes Name of the font to use. | StyleableTextField
|  | fontSize | Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | StyleableTextField
|  | fontStyle | Type: String CSS Inheritance: yes Determines whether the text is italic font. | StyleableTextField
|  | fontWeight | Type: String CSS Inheritance: yes Determines whether the text is boldface. | StyleableTextField
|  | leading | Type: Number Format: Length CSS Inheritance: yes Additional vertical space between lines of text. | StyleableTextField
|  | letterSpacing | Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | StyleableTextField
|  | textAlign | Type: String CSS Inheritance: yes Alignment of text within a container. | StyleableTextField
|  | textDecoration | Type: String CSS Inheritance: yes Determines whether the text is underlined. | StyleableTextField
|  | textIndent | Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. | StyleableTextField

Property Detail

canSetContentHeight | property

`canSetContentHeight:Boolean` [read-only]

Flag indicating whether the layout manager can stretch the height of this renderer to match the column's height.

default value is false. Override the getter to return a difference value

Implementation
`public function get canSetContentHeight():Boolean`

canSetContentWidth | property |

`canSetContentWidth:Boolean` [read-only]

Flag indicating whether the layout manager can stretch the width of this renderer to match the column's width.

default value is false. Override the getter to return a difference value

Implementation
`public function get canSetContentWidth():Boolean`

cssStyleName | property |

`cssStyleName:String` [write-only]

this property is set with the GridColumn's styleName property.

you can override it to extract information from the style and pass them to this renderer.

Implementation
`public function set cssStyleName(value:String):void`

data | property |

`data:Object`

The data to render or edit.

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

labelField | property |

`labelField:String` [write-only]

Implement this property so that the renderer can receive the dataField from its MobileGridColumn.

Implementation
`public function set labelField(value:String):void`

labelFunction | property |

`labelFunction:Function` [write-only]

Implement this property so that the renderer can receive the labelFunction its MobileGridColumn

Implementation
`public function set labelFunction(value:Function):void`

styleProvider | property |

`styleProvider:IStyleClient` [write-only]

Implementation
`public function set styleProvider(value:IStyleClient):void`

textAlign | property |

`textAlign:String` [write-only]

Implement this property so that the renderer can receive the textAlign property from the renderers' MobileGridColumn

Implementation
`public function set textAlign(value:String):void`
Constructor Detail

MobileGridTextCellRenderer | () | Constructor

`public function MobileGridTextCellRenderer()`

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