CSFlexTableRow
extends CSFlexObject
in package
Represents a Row in a Flex Table
Tags
Table of Contents
- __clone() : mixed
- Internal method to clone a table.
- __construct() : mixed
- Constructor
- addCell() : CSFlexTableCell
- Adds a cell to the row.
- addCellForRowsColumnsMerge() : CSFlexTableCell
- Adds a cell to the row at a particular Index after shifting the cell which is currently present in the row below.
- addCells() : array<string|int, mixed>
- Adds multiple cells to the row.
- getCellAtIndex() : CSFlexTableCell
- Returns the cell at the specified index.
- getCellFromPathIdentifier() : CSFlexTableCell
- Returns a cell based on the path identifier. The path itself must be build in the following way:
- getCells() : array<string|int, CSFlexTableCell>
- Returns a list of all cells currently assigned to the row.
- getHeight() : int
- Retrieves the height set for the table row in millimeter.
- getNumberOfCells() : int
- Returns the number of cells in the row.
- getPathIdentifier() : string
- Returns the path identifier for the current row. The identifier has the following format:
- getTable() : CSFlexTable
- Returns the parent table of the row.
- insertCellAtIndex() : CSFlexTableCell
- Inserts a cell to the row at a specified index.
- insertCellsAtIndex() : array<string|int, mixed>
- Inserts multiple cells to the row at a specified index.
- removeCellAtIndex() : mixed
- setHeight() : void
- Sets the height for the table row in millimetres.
- setTable() : void
- Sets the table reference for this row. This method is not meant to be called directly by a developer. It is used to initialize the row object on internal processes.
Methods
__clone()
Internal method to clone a table.
public
__clone() : mixed
Tags
Return values
mixed —__construct()
Constructor
public
__construct(CSFlexTable $oTable) : mixed
Parameters
- $oTable : CSFlexTable
Tags
Return values
mixed —addCell()
Adds a cell to the row.
public
addCell([mixed $mContent = NULL ]) : CSFlexTableCell
Parameters
- $mContent : mixed = NULL
-
The content of the cell as number, string or one of the CSFlexTableCellContent objects
Tags
Return values
CSFlexTableCell —The newly created cell object.
addCellForRowsColumnsMerge()
Adds a cell to the row at a particular Index after shifting the cell which is currently present in the row below.
public
addCellForRowsColumnsMerge(mixed $mContent, int $iIndex) : CSFlexTableCell
Parameters
- $mContent : mixed
-
The content of the cell as number, string or one of the CSFlexTableCellContent objects.
- $iIndex : int
-
The index at which we want to add the cell.
Tags
Return values
CSFlexTableCell —The newly created cell object.
addCells()
Adds multiple cells to the row.
public
addCells([int $iCellCount = 1 ][, array<string|int, mixed> $aContents = array() ]) : array<string|int, mixed>
Parameters
- $iCellCount : int = 1
-
The number of cells to add to the row.
- $aContents : array<string|int, mixed> = array()
-
List of content strings to add to the cells. The mapping is happening via indexes.
Tags
Return values
array<string|int, mixed> —A list of the newly created cell objects as array.
getCellAtIndex()
Returns the cell at the specified index.
public
getCellAtIndex(mixed $iIndex) : CSFlexTableCell
Parameters
- $iIndex : mixed
Tags
Return values
CSFlexTableCell —The cell object at the specified index.
getCellFromPathIdentifier()
Returns a cell based on the path identifier. The path itself must be build in the following way:
public
getCellFromPathIdentifier(string $sPathIdentifier) : CSFlexTableCell
d:0:0[:0]
where the chunks separated by the ':' are defined as follows:
d: The type of the row to return (d: data, h: header, f: footer) 0: The row index relative to the parent table 0: the cell index relative to the parent row 0: optional, the cell content index relative to the parent cell.
Parameters
- $sPathIdentifier : string
-
The path indentifier of the requested cell.
Tags
Return values
CSFlexTableCell —The cell matching the path identifier.
getCells()
Returns a list of all cells currently assigned to the row.
public
getCells() : array<string|int, CSFlexTableCell>
Tags
Return values
array<string|int, CSFlexTableCell> —The list of cells assigned to the current row.
getHeight()
Retrieves the height set for the table row in millimeter.
public
getHeight() : int
Tags
Return values
int —The height in millimeter set for the table row.
getNumberOfCells()
Returns the number of cells in the row.
public
getNumberOfCells() : int
Tags
Return values
int —The number of cells in the row.
getPathIdentifier()
Returns the path identifier for the current row. The identifier has the following format:
public
final getPathIdentifier() : string
d:0
where the chunks separated by the ':' are defined as follows:
d: The type of the row to return (d: data, h: header, f: footer) 0: The row index relative to the parent table
Tags
Return values
string —The path identifier of the current row
getTable()
Returns the parent table of the row.
public
getTable() : CSFlexTable
Tags
Return values
CSFlexTable —A reference to the parent table.
insertCellAtIndex()
Inserts a cell to the row at a specified index.
public
insertCellAtIndex(int $iIndex[, string $mContent = NULL ]) : CSFlexTableCell
Parameters
- $iIndex : int
-
The index where the cell should be added, relative to the already existing cells.
- $mContent : string = NULL
-
The content of the cell.
Tags
Return values
CSFlexTableCell —The newly created cell object.
insertCellsAtIndex()
Inserts multiple cells to the row at a specified index.
public
insertCellsAtIndex(int $iIndex[, int $iCellCount = 1 ][, array<string|int, mixed> $aContents = array() ]) : array<string|int, mixed>
Parameters
- $iIndex : int
-
The index where the cells should be added, relative to the already existing cells.
- $iCellCount : int = 1
-
The number of cells to insert into the row.
- $aContents : array<string|int, mixed> = array()
-
List of content strings to add to the cells. The mapping is happening via indexes.
Tags
Return values
array<string|int, mixed> —A list of the newly created cell objects as array.
removeCellAtIndex()
public
removeCellAtIndex(mixed $iIndex) : mixed
Parameters
- $iIndex : mixed
Tags
Return values
mixed —setHeight()
Sets the height for the table row in millimetres.
public
setHeight(int $iHeight) : void
Parameters
- $iHeight : int
-
The height in millimetres for the table row.
Tags
Return values
void —setTable()
Sets the table reference for this row. This method is not meant to be called directly by a developer. It is used to initialize the row object on internal processes.
public
setTable(CSFlexTable $oTable) : void
Parameters
- $oTable : CSFlexTable
-
The parent table object of this row.