fTableRow interface

FOM Reference > Formatting > Tables > fTableRow interface

fTableRow interface

The objects of this class provide settings for the rows in a table.

balanced attribute

PI: tbrbal

Only works when using a block slim table (table.overflow = 3) and the table is working in flow mode.

If true then will cause the whole row to be balanced when the next hard end of row is encountered (i.e. not a tableCellStart() which breaks to a new row).

N.B. Only a single level of balance is supported. You cannot nest another slim table within the row that is also balancing and you cannot balance a slim table within a frame balance either.

balanced
Access	read-write
Returns	boolean

boxed attribute

PI: tbrbox

If true then designates the current row as being a boxed row. Boxed rows have quite distinct properties as follows:

• They are isolated. Cells from previous rows are not allowed to span into a boxed row, and cells from the boxed row can't span into later rows.

• Within a boxed row there is the concept of a baseline and cells stack either above or below this baseline.

• There can be numerous cells within the same column within a boxed row. Cells simply stack above or below existing cells.

• The height of a cell in one column does NOT affect the height of cells in other columns - they are independent.

• Cells either flow onto the next column or can jump to designated columns by using formatting.tableCellStart(cell, startcol, [endcol]).

boxed
Access	read-write
Returns	boolean

columnTopPreserve attribute

PI: tbrctp

TableCells and their content within a row behave slightly differently when that row is at the top of a column, in terms of conditional rules, margins, drop tops etc. Setting this to true lets you specify that iff this row is at the top of a column, then that property is preserved for the following row. It can be a useful property to apply to a header, so that rows immediately after the header are treated as being at top of column.

columnTopPreserve
Access	read-write
Returns	boolean

defaultCell attribute

Specify default cell properties for cells in this row.

defaultCell
Access	read-write
Returns	fTableCell

defaultParagraph attribute

Specify default paragraph properties for cells in this row.

defaultParagraph
Access	read-write
Returns	fParagraph

defaultStyle attribute

Specify default styling for cells in this row.

defaultStyle
Access	read-write
Returns	fStyle

gutterAbove attribute

PI: tbrtgut

It is possible to allocate a gutter above a row in your table with gutterAbove. You must include a height measurement (e.g. row.gutterAbove = '20mm'). The command must be included at the start of a row for it to be effective, however if the command is found at the first row of the table it will be ignored. If you include the command at the top of the table it will define the default for every row.

gutterAbove
Access	read-write
Returns	fLength

gutterBelow attribute

PI: tbrgut

Specifies the measure of the table gutter under a row in a table.

gutterBelow
Access	read-write
Returns	fLength

keepTop attribute

PI: tbrkeept

Only relevant for tables of table.overflow = 2.

Setting keepTop = true will ensure the the top of a row is always kept together. So if any cell within the row overflows entirely leaving no content, then the whole of the row will overflow with it. This is particularly useful for a table where the first column contains a single line title as it ensures against the possibility of the title being left on it's own at the bottom of a frame.

keepTop
Access	read-write
Returns	boolean

keepTopExtended attribute

PI: tbrkeeptx

This is the extended version of keepTop and also works for a row that has already split, ensuring the top of the split row is also kept together.

keepTopExtended
Access	read-write
Returns	boolean

keepWithNext attribute

PI: tbrkeepn

If true, specifies that the current row will stay with the next row when the table breaks.

Specifying table.defaultRow.keepWithNext at the top of the table specifies the default for the whole table, which would cause the whole table to stay as a lump if true. Individual rows can be overridden if row.keepWithNext is set at tableRowStart(row).

keepWithNext
Access	read-write
Returns	int

keepWithPrevious attribute

PI: tbrkeepp

Specifies whether or not the current row will stay with the previous row when the table breaks.

Specifying table.defaultRow.keepWithPrevious specifies the default for the whole table, which would cause the whole table to stay as a lump if true. Individual rows can be overridden if row.keepWithPrevious is changed at tableRowStart(row).

keepWithPrevious
Access	read-write
Returns	int

verticalAlignInherit attribute

PI: tbrivj

Row inherits vj values for the row from cell contents.

verticalAlignInherit
Access	read-write
Returns	boolean

verticalAlignInheritBottom attribute

PI: tbrivjb

Row inherits bottom vj values for the row from cell contents.

verticalAlignInheritBottom
Access	read-write
Returns	boolean

fTableRow method

Create a new fTableRow object.

fTableRow
Parameters	None
Returns	fTableRow. The newly created object.

readResolve method

Return the object corresponding to the given serialized representation.

readResolveobj
Parameters	Objectobj The serialized representation.
Returns	fTableRow. The object corresponding to the serialized representation.

writeReplace method

Create a serializable representation of this object.

writeReplace
Parameters	None
Returns	Object. A serializable representation of this object.