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

Package | flashx.textLayout.elements
Class | public class TableElement
Inheritance | TableElement TableFormattedElement ContainerFormattedElement ParagraphFormattedElement FlowGroupElement FlowElement Object

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The TableElement class is used for grouping together items into a table. A TableElement's children must be of type TableRowElement, TableColElement, TableColGroupElement, TableBodyElement.

Default MXML Property `mxmlChildren`

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | alignmentBaseline : * TextLayoutFormat: Specifies the baseline to which the dominant baseline aligns. | FlowElement
|  | backgroundAlpha : * TextLayoutFormat: Alpha (transparency) value for the background (adopts default value if undefined during cascade). | FlowElement
|  | backgroundColor : * TextLayoutFormat: Background color of the text (adopts default value if undefined during cascade). | FlowElement
|  | baselineShift : * TextLayoutFormat: Amount to shift the baseline from the dominantBaseline value. | FlowElement
|  | blockProgression : * TextLayoutFormat: Specifies a vertical or horizontal progression of line placement. | FlowElement
|  | borderBottomColor : * TextLayoutFormat: Color of the bottom border (adopts default value if undefined during cascade). | FlowElement
|  | borderBottomPriority : * TextLayoutFormat: Specifies the priority when drawing cell boundaries. | FlowElement
|  | borderBottomWidth : * TextLayoutFormat: Bottom border width in pixels (adopts default value if undefined during cascade) Legal values are numbers from 0 to 128 and FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will have a value of 0. | FlowElement
|  | borderLeftColor : * TextLayoutFormat: Color of the left border (adopts default value if undefined during cascade). | FlowElement
|  | borderLeftPriority : * TextLayoutFormat: Specifies the priority when drawing cell boundaries. | FlowElement
|  | borderLeftWidth : * TextLayoutFormat: Left border width in pixels (adopts default value if undefined during cascade) Legal values are numbers from 0 to 128 and FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will have a value of 0. | FlowElement
|  | borderRightColor : * TextLayoutFormat: Color of the right border (adopts default value if undefined during cascade). | FlowElement
|  | borderRightPriority : * TextLayoutFormat: Specifies the priority when drawing cell boundaries. | FlowElement
|  | borderRightWidth : * TextLayoutFormat: Right border width in pixels (adopts default value if undefined during cascade) Legal values are numbers from 0 to 128 and FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will have a value of 0. | FlowElement
|  | borderTopColor : * TextLayoutFormat: Color of the top border (adopts default value if undefined during cascade). | FlowElement
|  | borderTopPriority : * TextLayoutFormat: Specifies the priority when drawing cell boundaries. | FlowElement
|  | borderTopWidth : * TextLayoutFormat: Top border width in pixels (adopts default value if undefined during cascade) Legal values are numbers from 0 to 128 and FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will have a value of 0. | FlowElement
|  | breakOpportunity : * TextLayoutFormat: Controls where lines are allowed to break when breaking wrapping text into multiple lines. | FlowElement
|  | cellPadding : * TextLayoutFormat: cellPadding specifies the amount of space between the border of the cell and its contents. | FlowElement
|  | cellSpacing : * [override] | TableElement
|  | cffHinting : * TextLayoutFormat: The type of CFF hinting used for this text. | FlowElement
|  | clearFloats : * TextLayoutFormat: Controls how text wraps around a float. | FlowElement
|  | color : * TextLayoutFormat: Color of the text. | FlowElement
|  | columnBreakAfter : * TextLayoutFormat: Controls column after before the element. | FlowElement
|  | columnBreakBefore : * TextLayoutFormat: Controls column break before the element. | FlowElement
|  | columnCount : * TextLayoutFormat: Number of text columns (adopts default value if undefined during cascade). | FlowElement
|  | columnGap : * TextLayoutFormat: Specifies the amount of gutter space, in pixels, to leave between the columns (adopts default value if undefined during cascade). | FlowElement
|  | columnWidth : * TextLayoutFormat: Column width in pixels (adopts default value if undefined during cascade). | FlowElement
|  | computedFormat : ITextLayoutFormat [read-only] Returns the computed format attributes that are in effect for this element. | FlowElement
|  | containerBreakAfter : * TextLayoutFormat: Controls container after before the element. | FlowElement
|  | containerBreakBefore : * TextLayoutFormat: Controls container break before the element. | FlowElement
|  | coreStyles : Object [read-only] Returns the coreStyles on this FlowElement. | FlowElement
|  | defaultColumnFormat : ITextLayoutFormat Gets the column format for new columns. | TableElement
|  | defaultRowFormat : ITextLayoutFormat Gets the row format for new rows. | TableElement
|  | digitCase : * TextLayoutFormat: The type of digit case used for this text. | FlowElement
|  | digitWidth : * TextLayoutFormat: Type of digit width used for this text. | FlowElement
|  | direction : * TextLayoutFormat: Specifies the default bidirectional embedding level of the text in the text block. | FlowElement
|  | dominantBaseline : * TextLayoutFormat: Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line. | FlowElement
|  | firstBaselineOffset : * TextLayoutFormat: Specifies the baseline position of the first line in the container. | FlowElement
|  | fontFamily : * TextLayoutFormat: The name of the font to use, or a comma-separated list of font names. | FlowElement
|  | fontLookup : * TextLayoutFormat: Font lookup to use. | FlowElement
|  | fontSize : * TextLayoutFormat: The size of the text in pixels. | FlowElement
|  | fontStyle : * TextLayoutFormat: Style of text. | FlowElement
|  | fontWeight : * TextLayoutFormat: Weight of text. | FlowElement
|  | footerRowCount : uint Returns the number of footer rows in the table | TableElement
|  | format : ITextLayoutFormat TextLayoutFormat properties applied directly to this element. | FlowElement
|  | frame : * TextLayoutFormat: frame specifies which sides of the frame surrounding a table will be visible. | FlowElement
|  | hasCellDamage : Boolean Indicates elements in the table have been modified and the table must be recomposed. | TableElement
|  | headerRowCount : uint Returns the number of header rows in the table | TableElement
|  | id : String Assigns an identifying name to the element, making it possible to set a style for the element by referencing the id. | FlowElement
|  | justificationRule : * TextLayoutFormat: Rule used to justify text in a paragraph. | FlowElement
|  | justificationStyle : * TextLayoutFormat: The style used for justification of the paragraph. | FlowElement
|  | kerning : * TextLayoutFormat: Kerning adjusts the pixels between certain character pairs to improve readability. | FlowElement
|  | leadingModel : * TextLayoutFormat: Specifies the leading model, which is a combination of leading basis and leading direction. | FlowElement
|  | ligatureLevel : * TextLayoutFormat: Controls which of the ligatures that are defined in the font may be used in the text. | FlowElement
|  | lineBreak : * TextLayoutFormat: Controls word wrapping within the container (adopts default value if undefined during cascade). | FlowElement
|  | lineHeight : * TextLayoutFormat: Leading controls for the text. | FlowElement
|  | lineThrough : * TextLayoutFormat: If true, applies strikethrough, a line drawn through the middle of the text. | FlowElement
|  | linkActiveFormat : * TextLayoutFormat: Defines the formatting attributes used for links in normal state. | FlowElement
|  | linkHoverFormat : * TextLayoutFormat: Defines the formatting attributes used for links in hover state, when the mouse is within the bounds (rolling over) a link. | FlowElement
|  | linkNormalFormat : * TextLayoutFormat: Defines the formatting attributes used for links in normal state. | FlowElement
|  | listAutoPadding : * TextLayoutFormat: This specifies an auto indent for the start edge of lists when the padding value of the list on that side is auto. | FlowElement
|  | listMarkerFormat : * TextLayoutFormat: Defines the formatting attributes list markers. | FlowElement
|  | listStylePosition : * TextLayoutFormat: Legal values are ListStylePosition.INSIDE, ListStylePosition.OUTSIDE, FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. | FlowElement
|  | listStyleType : * TextLayoutFormat: Legal values are ListStyleType.UPPER_ALPHA, ListStyleType.LOWER_ALPHA, ListStyleType.UPPER_ROMAN, ListStyleType.LOWER_ROMAN, ListStyleType.NONE, ListStyleType.DISC, ListStyleType.CIRCLE, ListStyleType.SQUARE, ListStyleType.BOX, ListStyleType.CHECK, ListStyleType.DIAMOND, ListStyleType.HYPHEN, ListStyleType.ARABIC_INDIC, ListStyleType.BENGALI, ListStyleType.DECIMAL, ListStyleType.DECIMAL_LEADING_ZERO, ListStyleType.DEVANAGARI, ListStyleType.GUJARATI, ListStyleType.GURMUKHI, ListStyleType.KANNADA, ListStyleType.PERSIAN, ListStyleType.THAI, ListStyleType.URDU, ListStyleType.CJK_EARTHLY_BRANCH, ListStyleType.CJK_HEAVENLY_STEM, ListStyleType.HANGUL, ListStyleType.HANGUL_CONSTANT, ListStyleType.HIRAGANA, ListStyleType.HIRAGANA_IROHA, ListStyleType.KATAKANA, ListStyleType.KATAKANA_IROHA, ListStyleType.LOWER_ALPHA, ListStyleType.LOWER_GREEK, ListStyleType.LOWER_LATIN, ListStyleType.UPPER_ALPHA, ListStyleType.UPPER_GREEK, ListStyleType.UPPER_LATIN, FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. | FlowElement
|  | locale : * TextLayoutFormat: The locale of the text. | FlowElement
|  | marginBottom : * TextLayoutFormat: bottom margin in pixels (adopts default value if undefined during cascade). | FlowElement
|  | marginLeft : * TextLayoutFormat: left margin in pixels(adopts default value if undefined during cascade). | FlowElement
|  | marginRight : * TextLayoutFormat: right margin in pixels (adopts default value if undefined during cascade). | FlowElement
|  | marginTop : * TextLayoutFormat: top margin in pixels (adopts default value if undefined during cascade). | FlowElement
|  | maxCellHeight : * TextLayoutFormat: Maximum height of a table cell. | FlowElement
|  | minCellHeight : * TextLayoutFormat: Minimum height of a table cell. | FlowElement
|  | mxmlChildren : Array Appends an array of children to this object. | FlowGroupElement
|  | numCells : int [read-only] Total number of cells | TableElement
|  | numChildren : int [read-only] Returns the number of FlowElement children that this FlowGroupElement object has. | FlowGroupElement
|  | numColumns : int Total number of columns in the table. | TableElement
|  | numRows : int Total number of rows in the table. | TableElement
|  | paddingBottom : * TextLayoutFormat: Bottom inset in pixels. | FlowElement
|  | paddingLeft : * TextLayoutFormat: Left inset in pixels. | FlowElement
|  | paddingRight : * TextLayoutFormat: Right inset in pixels. | FlowElement
|  | paddingTop : * TextLayoutFormat: Top inset in pixels. | FlowElement
|  | paragraphEndIndent : * TextLayoutFormat: A Number that specifies, in pixels, the amount to indent the paragraph's end edge. | FlowElement
|  | paragraphSpaceAfter : * TextLayoutFormat: A Number that specifies the amount of space, in pixels, to leave after the paragraph. | FlowElement
|  | paragraphSpaceBefore : * TextLayoutFormat: A Number that specifies the amount of space, in pixels, to leave before the paragraph. | FlowElement
|  | paragraphStartIndent : * TextLayoutFormat: A Number that specifies, in pixels, the amount to indent the paragraph's start edge. | FlowElement
|  | parent : FlowGroupElement [read-only] Returns the parent of this FlowElement object. | FlowElement
|  | parentRelativeEnd : int [read-only] Returns the relative end of this FlowElement object in the parent. | FlowElement
|  | parentRelativeStart : int [read-only] Returns the relative start of this FlowElement object in the parent. | FlowElement
|  | renderingMode : * TextLayoutFormat: The rendering mode used for this text. | FlowElement
|  | rules : * TextLayoutFormat: rules specifies which rules will appear between cells within a table. | FlowElement
|  | styleName : * TextLayoutFormat: Assigns an identifying class to the element, making it possible to set a style for the element by referencing the styleName. | FlowElement
|  | styles : Object [read-only] Returns the styles on this FlowElement. | FlowElement
|  | table : TableElement Returns a reference to the table. | TableFormattedElement
|  | tableBlocks : Vector.<TextFlowTableBlock> [read-only] Returns a vector of the table blocks. | TableElement
|  | tableColumnWidth : * TextLayoutFormat: Width of table column specifies a default width for each column spanned by the current COL element. | FlowElement
|  | tableWidth : * TextLayoutFormat: Width of table element specifies the desired width of the entire table and is intended for visual user agents. | FlowElement
|  | tabStops : * TextLayoutFormat: Specifies the tab stops associated with the paragraph. | FlowElement
|  | textAlign : * TextLayoutFormat: Alignment of lines in the paragraph relative to the container. | FlowElement
|  | textAlignLast : * TextLayoutFormat: Alignment of the last (or only) line in the paragraph relative to the container in justified text. | FlowElement
|  | textAlpha : * TextLayoutFormat: Alpha (transparency) value for the text. | FlowElement
|  | textDecoration : * TextLayoutFormat: Decoration on text. | FlowElement
|  | textIndent : * TextLayoutFormat: A Number that specifies, in pixels, the amount to indent the first line of the paragraph. | FlowElement
|  | textJustify : * TextLayoutFormat: Specifies options for justifying text. | FlowElement
|  | textLength : int [override] [read-only] Gets the total atom length of this flow element in the text flow. | TableElement
|  | textRotation : * TextLayoutFormat: Determines the number of degrees to rotate this text. | FlowElement
|  | tracking : Object [write-only] Sets the tracking and is synonymous with the trackingRight property. | FlowElement
|  | trackingLeft : * TextLayoutFormat: Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the left of each character. | FlowElement
|  | trackingRight : * TextLayoutFormat: Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the right of each character. | FlowElement
|  | typeName : String Each FlowElement has a typeName. | FlowElement
|  | typographicCase : * TextLayoutFormat: The type of typographic case used for this text. | FlowElement
|  | userStyles : Object Allows you to read and write user styles on a FlowElement object. | FlowElement
|  | verticalAlign : * TextLayoutFormat: Vertical alignment or justification (adopts default value if undefined during cascade). | FlowElement
|  | whiteSpaceCollapse : * TextLayoutFormat: Collapses or preserves whitespace when importing text into a TextFlow. | FlowElement
|  | width : Number Returns the table width | TableElement
|  | wordSpacing : * TextLayoutFormat: Specifies the optimum, minimum, and maximum spacing (as a multiplier of the width of a normal space) between words to use during justification. | FlowElement
|  | x : Number | TableElement
|  | y : Number | TableElement

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | TableElement() | TableElement
|  | addCellToBlock(cell:TableCellElement, block:TextFlowTableBlock):void Adds the table cell container to the table block specified. | TableElement
|  | addChild(child:FlowElement):FlowElement [override] Adds a table cell element to the table. | TableElement
|  | addChildAt(index:uint, child:FlowElement):FlowElement Adds a child FlowElement object at the specified index position. | FlowGroupElement
|  | addColumn(format:ITextLayoutFormat = null):void Adds a column. | TableElement
|  | addColumnAt(idx:int, format:ITextLayoutFormat = null):void Adds a column at the index specified. | TableElement
|  | addRow(format:ITextLayoutFormat = null):void Add a row at the end of the table. | TableElement
|  | addRowAt(idx:int, format:ITextLayoutFormat = null):void Add a row at the index specified. | TableElement
|  | clearStyle(styleProp:String):void Clears the style specified by the styleProp parameter from this FlowElement object. | FlowElement
|  | composeCells():void Sizes and positions the cells in the table. | TableElement
|  | deepCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement Makes a deep copy of this FlowElement object, including any children, copying the content between the two specified character positions and returning the copy as a FlowElement object. | FlowElement
|  | equalUserStyles(otherElement:FlowElement):Boolean Compare the userStyles of this with otherElement's userStyles. | FlowElement
|  | findCell(coords:CellCoordinates):TableCellElement Finds the cell at the specified cell coordinates or null if no cell is found. | TableElement
|  | findChildIndexAtPosition(relativePosition:int):int Given a relative text position, find the index of the first child FlowElement that contains the relative position. | FlowGroupElement
|  | findLeaf(relativePosition:int):FlowLeafElement [override] | TableElement
|  | getAbsoluteStart():int Returns the start location of the element in the text flow as an absolute index. | FlowElement
|  | getBodyRows():Vector.<TableCellElement> returns the body rows (sans header and footer cells) for composition | TableElement
|  | getCellAt(rowIndex:int, columnIndex:int):TableCellElement Returns the table cell at the row and column specified. | TableElement
|  | getCellBlock(cell:TableCellElement):TextFlowTableBlock Returns the table block for the given table cell. | TableElement
|  | getCells():Vector.<TableCellElement> Returns a vector of all the table cell elements in the table. | TableElement
|  | getCellsArray():Array Returns an array of all the table cells. | TableElement
|  | getCellsForColumn(column:TableColElement):Vector.<TableCellElement> Returns a Vector of the TableCellElements for the column specified. | TableElement
|  | getCellsForColumnAt(index:int):Vector.<TableCellElement> Returns a Vector of the TableCellElements for the column at the specified index. | TableElement
|  | getCellsForRow(row:TableRowElement):Vector.<TableCellElement> Returns a vector of the cells for the row specified. | TableElement
|  | getCellsForRowArray(row:TableRowElement):Array Returns a vector of the cells for the row specified. | TableElement
|  | getCellsForRowAt(index:int):Vector.<TableCellElement> Returns a vector of the cells for the row at the specified index. | TableElement
|  | getCellsForRowAtArray(index:int):Array Returns an array of the cells for the row specified. | TableElement
|  | getCellsInRange(anchorCoords:CellCoordinates, activeCoords:CellCoordinates, block:TextFlowTableBlock = null):Vector.<TableCellElement> Returns a vector of table cell elements in the given cell range. | TableElement
|  | getCharAtPosition(relativePosition:int):String Returns the character at the specified position, relative to this FlowElement object. | FlowElement
|  | getCharCodeAtPosition(relativePosition:int):int Returns the character code at the specified position, relative to this FlowElement. | FlowElement
|  | getChildAt(index:int):FlowElement Returns the FlowElement child at the specified index. | FlowGroupElement
|  | getChildIndex(child:FlowElement):int Searches in children for the specified FlowElement object and returns its index position. | FlowGroupElement
|  | getColumnAt(columnIndex:int):TableColElement Returns the column at the index specified or null if the index is out of range. | TableElement
|  | getColumnWidth(columnIndex:int):* Get the width of the column. | TableElement
|  | getElementRelativeStart(ancestorElement:FlowElement):int Returns the start of this element relative to an ancestor element. | FlowElement
|  | getFirstBlock():TextFlowTableBlock Gets the first TextFlowTableBlock in the table. | TableElement
|  | getFirstLeaf():FlowLeafElement [override] | TableElement
|  | getFooterHeight():Number Computed height of the footer cells | TableElement
|  | getFooterRows():Vector.<TableCellElement> returns the footer rows for composition | TableElement
|  | getHeaderHeight():Number Computed height of the header cells | TableElement
|  | getHeaderRows():Vector.<TableCellElement> returns the header rows for composition | TableElement
|  | getLastLeaf():FlowLeafElement [override] | TableElement
|  | getNextBlock():TextFlowTableBlock Gets the next TextFlowTableBlock. | TableElement
|  | getNextCell(tableCell:TableCellElement):TableCellElement Returns the next table cell after the supplied table cell | TableElement
|  | getNextRow():Vector.<TableCellElement> returns a vector of table cells in the next row during composition | TableElement
|  | getNextSibling():FlowElement Returns the next FlowElement sibling in the text flow hierarchy. | FlowElement
|  | getParagraph():ParagraphElement Returns the ParagraphElement object associated with this element. | FlowElement
|  | getParentCellElement():TableCellElement | FlowElement
|  | getPreviousCell(tableCell:TableCellElement):TableCellElement Returns the previous table cell after the supplied table cell | TableElement
|  | getPreviousSibling():FlowElement Returns the previous FlowElement sibling in the text flow hierarchy. | FlowElement
|  | getRowAt(rowIndex:int):TableRowElement Returns the row at the index specified or null if the index is out of range. | TableElement
|  | getRowIndex(row:TableRowElement):int Return the index of the row provided or -1 if the row is not found. | TableElement
|  | getStyle(styleProp:String):* Returns the value of the style specified by the styleProp parameter, which specifies the style name and can include any user style name. | FlowElement
|  | getTable():TableElement Get a reference to the table. | TableFormattedElement
|  | getTableBlocksInRange(start:CellCoordinates, end:CellCoordinates):Vector.<TextFlowTableBlock> Returns a vector of the table blocks in the specified cell range. | TableElement
|  | getText(relativeStart:int = 0, relativeEnd:int = -1, paragraphSeparator:String = ):String [override] | FlowGroupElement
|  | getTextFlow():TextFlow Climbs the text flow hierarchy to return the root TextFlow object for the element. | FlowElement
|  | hasMergedCells():Boolean Convenience method for checking if table has merged cells | TableElement
|  | initialized(document:Object, id:String):void Called for MXML objects after the implementing object has been created and all component properties specified on the MXML tag have been initialized. | FlowElement
|  | insertColumn(column:TableColElement = null, cells:Array = null):Boolean Inserts a column at the end of the table. | TableElement
|  | insertColumnAt(idx:int, column:TableColElement = null, cells:Array = null):Boolean Inserts a column at the column specified. | TableElement
|  | insertRow(row:TableRowElement = null, cells:Array = null):Boolean Inserts a row at the end of the table. | TableElement
|  | insertRowAt(idx:int, row:TableRowElement = null, cells:Array = null):Boolean Inserts a row at the index specified. | TableElement
|  | isInTable():Boolean | FlowElement
|  | normalizeCells():void Sets the row and column indices of the cells in the table to match their logical position as described by the table columns and rows | TableElement
|  | normalizeColumnWidths(suggestedWidth:Number = 600):void Accepts a suggested table width and calculates the column widths. | TableElement
|  | removeAllRows():void Removes all the rows. | TableElement
|  | removeAllRowsWithContent():void Removes all the rows and the cells. | TableElement
|  | removeChild(child:FlowElement):FlowElement [override] Removes a table cell element from the table. | TableElement
|  | removeChildAt(index:uint):FlowElement Removes the child FlowElement object at the specified index position. | FlowGroupElement
|  | removeColumn(column:TableColElement):TableColElement Removes the column | TableElement
|  | removeColumnAt(idx:int):TableColElement Removes the column at the index specified | TableElement
|  | removeColumnWithContent(column:TableColElement):Array Removes the column and the cells it contains. | TableElement
|  | removeColumnWithContentAt(idx:int):Array Removes the column at the index specified and the cells it contains. | TableElement
|  | removeRow(row:TableRowElement):TableRowElement Removes the row | TableElement
|  | removeRowAt(idx:int):TableRowElement Removes the row at the index specified. | TableElement
|  | removeRowWithContent(row:TableRowElement):Array Removes the row and the cells it contains. | TableElement
|  | removeRowWithContentAt(idx:int):Array Removes the row at the index specified and the cells it contains. | TableElement
|  | replaceChildren(beginChildIndex:int, endChildIndex:int, ... rest):void Replaces child elements in the group with the specified new elements. | FlowGroupElement
|  | setBorderColor(color:uint):void | FlowElement
|  | setBorderWidth(width:Number):void | FlowElement
|  | setColumnWidth(columnIndex:int, value:*):Boolean Set the width of the specified column. | TableElement
|  | setRowHeight(rowIdx:int, value:*):Boolean Set the height of the specified row. | TableElement
|  | setStyle(styleProp:String, newValue:*):void Sets the style specified by the styleProp parameter to the value specified by the newValue parameter. | FlowElement
|  | shallowCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement Makes a copy of this FlowElement object, copying the content between two specified character positions. | FlowElement
|  | splitAtIndex(childIndex:int):FlowGroupElement Splits this object at the position specified by the childIndex parameter. | FlowGroupElement
|  | splitAtPosition(relativePosition:int):FlowElement Splits this FlowElement object at the position specified by the relativePosition parameter, which is a relative position in the text for this element. | FlowElement

Property Detail

cellSpacing | property

`cellSpacing:*`[override]

Implementation
`public function get cellSpacing():*`
`public function set cellSpacing(value:any):void`

defaultColumnFormat | property |

`defaultColumnFormat:ITextLayoutFormat`

Gets the column format for new columns.

Implementation
`public function get defaultColumnFormat():ITextLayoutFormat`
`public function set defaultColumnFormat(value:ITextLayoutFormat):void`

defaultRowFormat | property |

`defaultRowFormat:ITextLayoutFormat`

Gets the row format for new rows.

Implementation
`public function get defaultRowFormat():ITextLayoutFormat`
`public function set defaultRowFormat(value:ITextLayoutFormat):void`

footerRowCount | property |

`footerRowCount:uint`

Returns the number of footer rows in the table

Implementation
`public function get footerRowCount():uint`
`public function set footerRowCount(value:uint):void`

hasCellDamage | property |

`hasCellDamage:Boolean`

Indicates elements in the table have been modified and the table must be recomposed.

Implementation
`public function get hasCellDamage():Boolean`
`public function set hasCellDamage(value:Boolean):void`

headerRowCount | property |

`headerRowCount:uint`

Returns the number of header rows in the table

Implementation
`public function get headerRowCount():uint`
`public function set headerRowCount(value:uint):void`

numCells | property |

`numCells:int` [read-only]

Total number of cells

Implementation
`public function get numCells():int`

numColumns | property |

`numColumns:int`

Total number of columns in the table. If set to a value lower than the current number of columns the columns at the end of the table are removed. If the set to a value greater than the current number of columns additional columns are added to the table.

Implementation
`public function get numColumns():int`
`public function set numColumns(value:int):void`

numRows | property |

`numRows:int`

Total number of rows in the table. If set to a value lower than the current number of rows the rows at the end of the table are removed. If the set to a value greater than the current number of rows additional rows are added to the table.

Implementation
`public function get numRows():int`
`public function set numRows(value:int):void`

tableBlocks | property |

`tableBlocks:Vector.<TextFlowTableBlock>` [read-only]

Returns a vector of the table blocks.

Implementation
`public function get tableBlocks():Vector.<TextFlowTableBlock>`

textLength | property |

`textLength:int` [read-only] [override]

Gets the total atom length of this flow element in the text flow. Returns the total length of text owned by this FlowElement object and its children. If an element has no text, the value of `textLength` is usually zero.

ParagraphElement objects have a final span with a paragraph terminator character for the last SpanElement object.The paragraph terminator is included in the value of the `textLength` of that SpanElement object and all its parents. It is not included in `text` property of the SpanElement object.

Implementation
`public function get textLength():int`

width | property |

`width:Number`

Returns the table width

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

x | property |

`public var x:Number`

y | property |

`public var y:Number`

Constructor Detail

TableElement | () | Constructor

`public function TableElement()`

Method Detail

addCellToBlock | () | method

`public function addCellToBlock(cell:TableCellElement, block:TextFlowTableBlock):void`

Adds the table cell container to the table block specified.

Parameters

| `cell:TableCellElement`
| `block:TextFlowTableBlock`

addChild | () | method |

`override public function addChild(child:FlowElement):FlowElement`

Adds a table cell element to the table. Appends a child FlowElement object. The new child is added to the end of the children list.

Parameters

| `child:FlowElement` — The child element to append.

Returns

| `FlowElement` — the added child FlowElement

addColumn | () | method |

`public function addColumn(format:ITextLayoutFormat = null):void`

Adds a column. You would use this if you want to add a column without changing the table cells. The cells would reflow, so a cell in row 2 might move up to row 1.

Parameters

| `format:ITextLayoutFormat` (default = `null`)``

See also

addColumnAt
insertColumn
insertColumnAt

addColumnAt | () | method |

`public function addColumnAt(idx:int, format:ITextLayoutFormat = null):void`

Adds a column at the index specified.

Parameters

| `idx:int`
| `format:ITextLayoutFormat` (default = `null`)``

See also

addColumn
insertColumn
insertColumnAt

addRow | () | method |

`public function addRow(format:ITextLayoutFormat = null):void`

Add a row at the end of the table. You would use this if you want to add a row without changing the table cells.

Parameters

| `format:ITextLayoutFormat` (default = `null`)``

See also

addRowAt
insertRow
insertRowAt

addRowAt | () | method |

`public function addRowAt(idx:int, format:ITextLayoutFormat = null):void`

Add a row at the index specified.

Parameters

| `idx:int`
| `format:ITextLayoutFormat` (default = `null`)``

See also

addRow
insertRow
insertRowAt

composeCells | () | method |

`public function composeCells():void`

Sizes and positions the cells in the table.

createColumnElement | () | method |

`tlf_internal function createColumnElement(index:int, defaultColumnFormat:ITextLayoutFormat):TableColElement`

Creates and returns a default column

Parameters

| `index:int`
| `defaultColumnFormat:ITextLayoutFormat`

Returns

| `TableColElement`

createContentElement | () | method |

`override tlf_internal function createContentElement():void`

createRowElement | () | method |

`tlf_internal function createRowElement(index:int, defaultRowFormat:ITextLayoutFormat):TableRowElement`

Creates and returns a default row

Parameters

| `index:int`
| `defaultRowFormat:ITextLayoutFormat`

Returns

| `TableRowElement`

findCell | () | method |

`public function findCell(coords:CellCoordinates):TableCellElement`

Finds the cell at the specified cell coordinates or null if no cell is found.

Parameters

| `coords:CellCoordinates`

Returns

| `TableCellElement`

findLeaf | () | method |

`override public function findLeaf(relativePosition:int):FlowLeafElement`

Parameters

| `relativePosition:int`

Returns

| `FlowLeafElement`

getBodyRows | () | method |

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

returns the body rows (sans header and footer cells) for composition

Returns

| `Vector.<TableCellElement>`

getCellAt | () | method |

`public function getCellAt(rowIndex:int, columnIndex:int):TableCellElement`

Returns the table cell at the row and column specified.

Parameters

| `rowIndex:int`
| `columnIndex:int`

Returns

| `TableCellElement`

getCellBlock | () | method |

`public function getCellBlock(cell:TableCellElement):TextFlowTableBlock`

Returns the table block for the given table cell.

Parameters

| `cell:TableCellElement`

Returns

| `TextFlowTableBlock`

getCells | () | method |

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

Returns a vector of all the table cell elements in the table.

Returns

| `Vector.<TableCellElement>`

getCellsArray | () | method |

`public function getCellsArray():Array`

Returns an array of all the table cells.

Returns

| `Array`

getCellsForColumn | () | method |

`public function getCellsForColumn(column:TableColElement):Vector.<TableCellElement>`

Returns a Vector of the TableCellElements for the column specified.

Parameters

| `column:TableColElement`

Returns

| `Vector.<TableCellElement>`

getCellsForColumnAt | () | method |

`public function getCellsForColumnAt(index:int):Vector.<TableCellElement>`

Returns a Vector of the TableCellElements for the column at the specified index.

Parameters

| `index:int`

Returns

| `Vector.<TableCellElement>`

getCellsForRow | () | method |

`public function getCellsForRow(row:TableRowElement):Vector.<TableCellElement>`

Returns a vector of the cells for the row specified.

Parameters

| `row:TableRowElement`

Returns

| `Vector.<TableCellElement>`

getCellsForRowArray | () | method |

`public function getCellsForRowArray(row:TableRowElement):Array`

Returns a vector of the cells for the row specified.

Parameters

| `row:TableRowElement`

Returns

| `Array`

getCellsForRowAt | () | method |

`public function getCellsForRowAt(index:int):Vector.<TableCellElement>`

Returns a vector of the cells for the row at the specified index.

Parameters

| `index:int`

Returns

| `Vector.<TableCellElement>`

getCellsForRowAtArray | () | method |

`public function getCellsForRowAtArray(index:int):Array`

Returns an array of the cells for the row specified.

Parameters

| `index:int`

Returns

| `Array`

getCellsInRange | () | method |

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

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

Parameters

| `anchorCoords:CellCoordinates`
| `activeCoords:CellCoordinates`
| `block:TextFlowTableBlock` (default = `null`)``

Returns

| `Vector.<TableCellElement>`

getColumnAt | () | method |

`public function getColumnAt(columnIndex:int):TableColElement`

Returns the column at the index specified or null if the index is out of range.

Parameters

| `columnIndex:int`

Returns

| `TableColElement`

getColumnWidth | () | method |

`public function getColumnWidth(columnIndex:int):*`

Get the width of the column.

Parameters

| `columnIndex:int`

Returns

| `*`

getFirstBlock | () | method |

`public function getFirstBlock():TextFlowTableBlock`

Gets the first TextFlowTableBlock in the table.

Returns

| `TextFlowTableBlock`

getFirstLeaf | () | method |

`override public function getFirstLeaf():FlowLeafElement`

Returns

| `FlowLeafElement`

getFooterHeight | () | method |

`public function getFooterHeight():Number`

Computed height of the footer cells

Returns

| `Number`

getFooterRows | () | method |

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

returns the footer rows for composition

Returns

| `Vector.<TableCellElement>`

getHeaderHeight | () | method |

`public function getHeaderHeight():Number`

Computed height of the header cells

Returns

| `Number`

getHeaderRows | () | method |

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

returns the header rows for composition

Returns

| `Vector.<TableCellElement>`

getLastLeaf | () | method |

`override public function getLastLeaf():FlowLeafElement`

Returns

| `FlowLeafElement`

getNextBlock | () | method |

`public function getNextBlock():TextFlowTableBlock`

Gets the next TextFlowTableBlock.

Returns

| `TextFlowTableBlock`

getNextCell | () | method |

`public function getNextCell(tableCell:TableCellElement):TableCellElement`

Returns the next table cell after the supplied table cell

Parameters

| `tableCell:TableCellElement`

Returns

| `TableCellElement`

getNextRow | () | method |

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

returns a vector of table cells in the next row during composition

Returns

| `Vector.<TableCellElement>`

getPreviousCell | () | method |

`public function getPreviousCell(tableCell:TableCellElement):TableCellElement`

Returns the previous table cell after the supplied table cell

Parameters

| `tableCell:TableCellElement`

Returns

| `TableCellElement`

getRowAt | () | method |

`public function getRowAt(rowIndex:int):TableRowElement`

Returns the row at the index specified or null if the index is out of range.

Parameters

| `rowIndex:int`

Returns

| `TableRowElement`

getRowIndex | () | method |

`public function getRowIndex(row:TableRowElement):int`

Return the index of the row provided or -1 if the row is not found.

Parameters

| `row:TableRowElement`

Returns

| `int`

getTableBlocksInRange | () | method |

`public function getTableBlocksInRange(start:CellCoordinates, end:CellCoordinates):Vector.<TextFlowTableBlock>`

Returns a vector of the table blocks in the specified cell range.

Parameters

| `start:CellCoordinates`
| `end:CellCoordinates`

Returns

| `Vector.<TextFlowTableBlock>`

hasMergedCells | () | method |

`public function hasMergedCells():Boolean`

Convenience method for checking if table has merged cells

Returns

| `Boolean`

insertColumn | () | method |

`public function insertColumn(column:TableColElement = null, cells:Array = null):Boolean`

Inserts a column at the end of the table. If a column is not provided one is created.

Parameters

| `column:TableColElement` (default = `null`)``
| `cells:Array` (default = `null`)``

Returns

| `Boolean`

See also

addColumn
addColumnAt
insertColumnAt

insertColumnAt | () | method |

`public function insertColumnAt(idx:int, column:TableColElement = null, cells:Array = null):Boolean`

Inserts a column at the column specified. If the column is not provided it creates a new column containing the cells supplied or creates the cells based on the number of rows in the table.

Parameters

| `idx:int`
| `column:TableColElement` (default = `null`)``
| `cells:Array` (default = `null`)``

Returns

| `Boolean`

See also

addColumn
addColumnAt
insertColumn

insertRow | () | method |

`public function insertRow(row:TableRowElement = null, cells:Array = null):Boolean`

Inserts a row at the end of the table. If a row is not provided one is created.

Parameters

| `row:TableRowElement` (default = `null`)``
| `cells:Array` (default = `null`)``

Returns

| `Boolean`

See also

insertRowAt

insertRowAt | () | method |

`public function insertRowAt(idx:int, row:TableRowElement = null, cells:Array = null):Boolean`

Inserts a row at the index specified. If the row is not provided it creates a new row containing the cells supplied or creates the cells based on the number of columns in the table.

Parameters

| `idx:int`
| `row:TableRowElement` (default = `null`)``
| `cells:Array` (default = `null`)``

Returns

| `Boolean`

normalizeCells | () | method |

`public function normalizeCells():void`

Sets the row and column indices of the cells in the table to match their logical position as described by the table columns and rows

normalizeColumnWidths | () | method |

`public function normalizeColumnWidths(suggestedWidth:Number = 600):void`

Accepts a suggested table width and calculates the column widths.

Parameters

| `suggestedWidth:Number` (default = `600`)``

normalizeRange | () | method |

`override tlf_internal function normalizeRange(normalizeStart:uint, normalizeEnd:uint):void`

Parameters

| `normalizeStart:uint`
| `normalizeEnd:uint`

removeAllRows | () | method |

`public function removeAllRows():void`

Removes all the rows. Does not remove the cells.

See also

removeAllRowsWithContent

removeAllRowsWithContent | () | method |

`public function removeAllRowsWithContent():void`

Removes all the rows and the cells.

removeChild | () | method |

`override public function removeChild(child:FlowElement):FlowElement`

Removes a table cell element from the table. Removes the specified child FlowElement object from the group.

Parameters

| `child:FlowElement` — The child element to remove.

Returns

| `FlowElement` — the removed child FlowElement object

removeColumn | () | method |

`public function removeColumn(column:TableColElement):TableColElement`

Removes the column

Parameters

| `column:TableColElement`

Returns

| `TableColElement`

removeColumnAt | () | method |

`public function removeColumnAt(idx:int):TableColElement`

Removes the column at the index specified

Parameters

| `idx:int`

Returns

| `TableColElement`

removeColumnWithContent | () | method |

`public function removeColumnWithContent(column:TableColElement):Array`

Removes the column and the cells it contains.

Parameters

| `column:TableColElement`

Returns

| `Array`

removeColumnWithContentAt | () | method |

`public function removeColumnWithContentAt(idx:int):Array`

Removes the column at the index specified and the cells it contains.

Parameters

| `idx:int`

Returns

| `Array`

removed | () | method |

`override tlf_internal function removed():void`

Remove all cells Called when an element is removed. Used for container elements to run any clean up code.

removeRow | () | method |

`public function removeRow(row:TableRowElement):TableRowElement`

Removes the row

Parameters

| `row:TableRowElement`

Returns

| `TableRowElement`

removeRowAt | () | method |

`public function removeRowAt(idx:int):TableRowElement`

Removes the row at the index specified.

Parameters

| `idx:int`

Returns

| `TableRowElement`

See also

removeRowWithContentAt

removeRowWithContent | () | method |

`public function removeRowWithContent(row:TableRowElement):Array`

Removes the row and the cells it contains.

Parameters

| `row:TableRowElement`

Returns

| `Array`

removeRowWithContentAt | () | method |

`public function removeRowWithContentAt(idx:int):Array`

Removes the row at the index specified and the cells it contains.

Parameters

| `idx:int`

Returns

| `Array`

setColumnWidth | () | method |

`public function setColumnWidth(columnIndex:int, value:*):Boolean`

Set the width of the specified column. The value can be a number or percent.

Parameters

| `columnIndex:int`
| `value:*`

Returns

| `Boolean`

setRowHeight | () | method |

`public function setRowHeight(rowIdx:int, value:*):Boolean`

Set the height of the specified row. The value can be a number or percent.

Parameters

| `rowIdx:int`
| `value:*`

Returns

| `Boolean`

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