CSFlexTableContainer
extends CSFlexObject
in package
Represents a Flex Table Container
The Flex Table Container can contain a CSFlexTable and more content around it provided by a Flex Template Plugin
Tags
Table of Contents
- __clone() : void
- Clones the object
- __construct() : mixed
- The constructor, constructs also the inner CSFlexTable so that it can be retrieved by the template
- clearContents() : void
- Can be called to completely swipe out all content of a table container
- getAppendedText() : string
- Retrieves the appended text of the table
- getObjectFromPathIdentifier() : mixed
- Returns the object corresponding to the path identifier. This can be a row, a cell or a content object.
- getPrependedText() : string
- Retrieves the prepended text of the table
- getTable() : CSFlexTable
- Retrieves the contained table object
- setAppendedText() : void
- Sets appended text that should be shown after the table.
- setPrependedText() : void
- Sets prepended text that should be shown before the table.
- setTable() : void
- Overwrites the contained table
Methods
__clone()
Clones the object
public
__clone() : void
Tags
Return values
void —__construct()
The constructor, constructs also the inner CSFlexTable so that it can be retrieved by the template
public
__construct([CSFlexTable $oTable = NULL ]) : mixed
Parameters
- $oTable : CSFlexTable = NULL
-
an optional CSFlexTable to start with
Tags
Return values
mixed —clearContents()
Can be called to completely swipe out all content of a table container
public
clearContents() : void
Tags
Return values
void —getAppendedText()
Retrieves the appended text of the table
public
getAppendedText() : string
Tags
Return values
string —the appended text
getObjectFromPathIdentifier()
Returns the object corresponding to the path identifier. This can be a row, a cell or a content object.
public
getObjectFromPathIdentifier(string $sPathIdentifier) : mixed
Parameters
- $sPathIdentifier : string
-
The path identifier specifying the object to find in the table.
Tags
Return values
mixed —The corresponding object of one of the following classes:
CSFlexTableRow CSFlexTableCell CSFlexTableCellContent
getPrependedText()
Retrieves the prepended text of the table
public
getPrependedText() : string
Tags
Return values
string —the prepended text
getTable()
Retrieves the contained table object
public
getTable() : CSFlexTable
Tags
Return values
CSFlexTable —the contained table object
setAppendedText()
Sets appended text that should be shown after the table.
public
setAppendedText(string $sAppendedText) : void
Parameters
- $sAppendedText : string
-
The text to be shown after the table.
Tags
Return values
void —setPrependedText()
Sets prepended text that should be shown before the table.
public
setPrependedText(string $sPrependedText) : void
Parameters
- $sPrependedText : string
-
The text to be shown before the table.
Tags
Return values
void —setTable()
Overwrites the contained table
public
setTable(CSFlexTable $oTable) : void
Parameters
- $oTable : CSFlexTable
-
the new table object