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

Package | flashx.textLayout.compose
Class | public class TextFlowTableBlock
Inheritance | TextFlowTableBlock TextFlowLine Object

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | absoluteStart : int [read-only] The location of the line as an absolute character position in the TextFlow object. | TextFlowLine
|  | ascent : Number [read-only] | TextFlowLine
|  | blockIndex : uint = 0 The index of this block in the table text flow layout | TextFlowTableBlock
|  | columnIndex : int [read-only] The number of the column in which the line has been placed, with the first column being 0. | TextFlowLine
|  | container : TableBlockContainer [read-only] Container that displays this collection of cells | TextFlowTableBlock
|  | controller : ContainerController [read-only] The controller (ContainerController object) for the container in which the line has been placed. | TextFlowLine
|  | descent : Number [read-only] | TextFlowLine
|  | height : Number [override] The height of the line in pixels. | TextFlowTableBlock
|  | lineOffset : Number [read-only] The line's offset in pixels from the appropriate container inset (as dictated by paragraph direction and container block progression), prior to alignment of lines in the paragraph. | TextFlowLine
|  | location : int [read-only] One of the values from TextFlowLineLocation for specifying a line's location within a paragraph. | TextFlowLine
|  | paragraph : ParagraphElement [read-only] The paragraph (ParagraphElement) in which the line resides. | TextFlowLine
|  | parentTable : TableElement The table that owns this table block | TextFlowTableBlock
|  | spaceAfter : Number [read-only] The amount of space to leave after the line. | TextFlowLine
|  | spaceBefore : Number [read-only] The amount of space to leave before the line. | TextFlowLine
|  | textHeight : Number [override] [read-only] | TextFlowTableBlock
|  | textLength : int [read-only] The number of characters to the next line, including trailing spaces. | TextFlowLine
|  | textLineExists : Boolean [read-only] Indicates whether the flash.text.engine.TextLine object for this TextFlowLine exists. | TextFlowLine
|  | unjustifiedTextWidth : Number [read-only] The width of the line if it was not justified. | TextFlowLine
|  | validity : String [read-only] The validity of the line. | TextFlowLine
|  | width : Number Gets the width of the container | TextFlowTableBlock
|  | x : Number [override] Sets the x position of the container | TextFlowTableBlock
|  | y : Number [override] Sets the y value of the container | TextFlowTableBlock

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | _ascent : Number | TextFlowLine
|  | _descent : Number | TextFlowLine
|  | _lineOffset : Number | TextFlowLine

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | TextFlowTableBlock(index:uint) Constructor - creates a new TextFlowTableBlock instance. | TextFlowTableBlock
|  | addCell(cell:CellContainer):void Adds a cell container to table container. | TextFlowTableBlock
|  | clear():void Clears the cells in the table block. | TextFlowTableBlock
|  | clearCells():void Clears the cells in the table block | TextFlowTableBlock
|  | drawBackground(backgroundInfo:*):void | TextFlowTableBlock
|  | getBounds():Rectangle Returns the bounds of the line as a rectangle. | TextFlowLine
|  | getCellsInRange(anchorCoords:CellCoordinates, activeCoords:CellCoordinates):Vector.<TableCellElement> Returns a vector of table cell elements in the given cell range. | TextFlowTableBlock
|  | getTableCells():Vector.<TableCellElement> Returns a vector of table cell elements. | TextFlowTableBlock
|  | getTextLine(forceValid:Boolean = false):TextLine Returns the flash.text.engine.TextLine object for this line, which might be recreated if it does not exist due to garbage collection. | TextFlowLine
|  | updateCompositionShapes():void Triggers drawing of composed cell contents | TextFlowTableBlock

Property Detail

blockIndex | property

`public var blockIndex:uint = 0`

The index of this block in the table text flow layout

container | property |

`container:TableBlockContainer` [read-only]

Container that displays this collection of cells

Implementation
`public function get container():TableBlockContainer`

height | property |

`height:Number`[override]

The height of the line in pixels.

Implementation
`public function get height():Number`
`public function set height(value:Number):void`

parentTable | property |

`public var parentTable:TableElement`

The table that owns this table block

textHeight | property |

`textHeight:Number` [read-only] [override]

Implementation
`public function get textHeight():Number`

width | property |

`width:Number`

Gets the width of the container

Implementation
`public function get width():Number`
`public function set width(value:Number):void`

x | property |

`x:Number`[override]

Sets the x position of the container

Implementation
`public function get x():Number`
`public function set x(value:Number):void`

y | property |

`y:Number`[override]

Sets the y value of the container

Implementation
`public function get y():Number`
`public function set y(value:Number):void`
Constructor Detail

TextFlowTableBlock | () | Constructor

`public function TextFlowTableBlock(index:uint)`

Constructor - creates a new TextFlowTableBlock instance.

Note: No client should call this. It's exposed for writing your own composer.

Parameters

| `index:uint` — The index in the Table text flow.

Method Detail

addCell | () | method

`public function addCell(cell:CellContainer):void`

Adds a cell container to table container. This adds it to the display list. If the cell is already added it does not add it twice.

Parameters

| `cell:CellContainer`

clear | () | method |

`public function clear():void`

Clears the cells in the table block. Wraps clearCells().

clearCells | () | method |

`public function clearCells():void`

Clears the cells in the table block

drawBackground | () | method |

`public function drawBackground(backgroundInfo:*):void`

Parameters

| `backgroundInfo:*`

getCellsInRange | () | method |

`public function getCellsInRange(anchorCoords:CellCoordinates, activeCoords:CellCoordinates):Vector.<TableCellElement>`

Returns a vector of table cell elements in the given cell range.

Parameters

| `anchorCoords:CellCoordinates`
| `activeCoords:CellCoordinates`

Returns

| `Vector.<TableCellElement>`

getTableCells | () | method |

`public function getTableCells():Vector.<TableCellElement>`

Returns a vector of table cell elements.

Returns

| `Vector.<TableCellElement>`

hiliteBlockSelection | () | method |

`override tlf_internal function hiliteBlockSelection(selObj:Shape, selFormat:SelectionFormat, container:DisplayObject, begIdx:int, endIdx:int, prevLine:TextFlowLine, nextLine:TextFlowLine):void`

Parameters

| `selObj:Shape`
| `selFormat:SelectionFormat`
| `container:DisplayObject`
| `begIdx:int`
| `endIdx:int`
| `prevLine:TextFlowLine`
| `nextLine:TextFlowLine`

initialize | () | method |

`override tlf_internal function initialize(paragraph:ParagraphElement, outerTargetWidth:Number = 0, lineOffset:Number = 0, absoluteStart:int = 0, numChars:int = 0, textLine:TextLine = null):void`

Parameters

| `paragraph:ParagraphElement`
| `outerTargetWidth:Number` (default = `0`)``
| `lineOffset:Number` (default = `0`)``
| `absoluteStart:int` (default = `0`)``
| `numChars:int` (default = `0`)``
| `textLine:TextLine` (default = `null`)``

setController | () | method |

`override tlf_internal function setController(cont:ContainerController, colNumber:int):void`

Parameters

| `cont:ContainerController`
| `colNumber:int`

updateCompositionShapes | () | method |

`public function updateCompositionShapes():void`

Triggers drawing of composed cell contents

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