Contentserv PHP API

CSFlexTableCell extends CSFlexObject
in package

Represents a Flex Table Cell

Tags
since

CS15.0

access

public

Table of Contents

__clone()  : mixed
Internal method to clone a table.
__construct()  : mixed
Constructor
addAttributeValueContent()  : CSFlexTableCellAttributeValueContent
Adds an attribute value as content to the cell.
addContent()  : CSFlexTableCellTextContent
Adds content to the cell.
addFileValueContent()  : CSFlexTableCellItemValueContent
Adds a file meta data value as content to the cell.
addHtmlContent()  : CSFlexTableCellHtmlContent
Adds html content to the cell.
addImageContent()  : CSFlexTableCellImageContent
Adds an image to the cell.
addItemValueContent()  : CSFlexTableCellItemValueContent
Adds an item value as content to the cell.
addProductValueContent()  : CSFlexTableCellItemValueContent
Adds a product value as content to the cell.
addStyleName()  : void
Adds a unique style name to the list of styles for the cell content
addTextContent()  : CSFlexTableCellTextContent
Adds text content to the cell.
clearContents()  : void
This method clears the content of the cell. It removes all assigned content objects.
getAutomergeStyleNameForCols()  : string
Returns the automerge style name for cols of the cell.
getAutomergeStyleNameForRows()  : string
Returns the automerge style name for rows of the cell.
getCol()  : CSFlexTableCol
Returns the parent column of the cell.
getColSpan()  : int
Returns the col span of the cell.
getContentAtIndex()  : CSFlexTableCellContent
Returns the content object at the specified index.
getContentFromPathIdentifier()  : CSFlexTableCellContent
Returns a content based on the path identifier. The path itself must be build in the following way:
getContents()  : array<string|int, CSFlexTableCellContent>
Returns the contents of the cell.
getContentSeparator()  : string
Returns the content separator of the cell.
getIndex()  : int
Returns the Index of the cell within the row
getPathIdentifier()  : string
Returns the path identifier for the current cell. The identifier has the following format:
getRow()  : CSFlexTableRow
Returns the parent row of the cell.
getRowSpan()  : int
Returns the row span of the cell.
getStyleNames()  : array<string|int, mixed>
Returns all style names assigned to the cell.
setAutomergeStyleNameForCols()  : void
Sets the automerge style name for cols of the cell. This style name is added to the style names of the cell when a renderer performs automerge operations on cells for equal content. The default value is "col_merged"
setAutomergeStyleNameForRows()  : void
Sets the automerge style name for rows of the cell. This style name is added to the style names of the cell when a renderer performs automerge operations on cells for equal content. The default value is "row_merged"
setColSpan()  : void
Sets the col span of the cell.
setContent()  : void
Sets the content of the cell.
setContentSeparator()  : void
Sets the content separator for the cell. This separator is used when the table cell is rendered and all the content objects are concatenated.
setRowSpan()  : void
Sets the row span of the cell.
setStyleName()  : void
Sets the style name of the cell.
setStyleNames()  : void
Sets a list of style names for the cell.

Methods

__clone()

Internal method to clone a table.

public __clone() : mixed
Tags
Return values
mixed —

addAttributeValueContent()

Adds an attribute value as content to the cell.

public addAttributeValueContent(Itemconfiguration $oAttribute, mixed $sValueName[, ing $iLanguageID = NULL ]) : CSFlexTableCellAttributeValueContent
Parameters
$oAttribute : Itemconfiguration

The attribute object that contains the value to be set as cell content.

$sValueName : mixed

The name of the value that should be read from the attribute object.

$iLanguageID : ing = NULL

the LanguageID

Tags
access

public

Return values
CSFlexTableCellAttributeValueContent —

The content object that has been assigned to the cell.

addContent()

Adds content to the cell.

public addContent(mixed $oContent) : CSFlexTableCellTextContent
Parameters
$oContent : mixed

The content that should be added to the cell as one of the available CSFlexTableCell{FORMAT}Content objects. If a String is provided it is automatically converted to a CSFlexTableTextContent

Tags
access

public

Return values
CSFlexTableCellTextContent —

addFileValueContent()

Adds a file meta data value as content to the cell.

public addFileValueContent(mixed $mFileOrID, mixed $mAttributeID[, int $iLanguageID = NULL ]) : CSFlexTableCellItemValueContent
Parameters
$mFileOrID : mixed

The file or file ID that contains the value to be set as cell content.

$mAttributeID : mixed

The id or the name of the field, from which the value should be read.

$iLanguageID : int = NULL

The language id in which the value should be retrieved. If NULL the preset or config language will be used.

Tags
access

public

Return values
CSFlexTableCellItemValueContent —

The content object that has been assigned to the cell.

addImageContent()

Adds an image to the cell.

public addImageContent(mixed $mFileOrID[, int $iWidth = 70 ][, int $iHeight = NULL ]) : CSFlexTableCellImageContent
Parameters
$mFileOrID : mixed

The image or image ID that should be assigned as cell content.

$iWidth : int = 70

Width of the Image in Pixel

$iHeight : int = NULL

Height of the Image in Pixel

Tags
access

public

Return values
CSFlexTableCellImageContent —

The content object that has been assigned to the cell.

addItemValueContent()

Adds an item value as content to the cell.

public addItemValueContent(CSItemApiItem $oItem, mixed $mAttributeID[, int $iLanguageID = NULL ]) : CSFlexTableCellItemValueContent
Parameters
$oItem : CSItemApiItem

The item that contains the value to be set as cell content.

$mAttributeID : mixed

The id or the name of the field, from which the value should be read.

$iLanguageID : int = NULL

The language id in which the value should be retrieved. If NULL the preset or config language will be used.

Tags
access

public

Return values
CSFlexTableCellItemValueContent —

The content object that has been assigned to the cell.

addProductValueContent()

Adds a product value as content to the cell.

public addProductValueContent(mixed $mProductOrID, mixed $mAttributeID[, int $iLanguageID = NULL ]) : CSFlexTableCellItemValueContent
Parameters
$mProductOrID : mixed

The product or product ID that contains the value to be set as cell content.

$mAttributeID : mixed

The id or the name of the field, from which the value should be read.

$iLanguageID : int = NULL

The language id in which the value should be retrieved. If NULL the preset or config language will be used.

Tags
access

public

Return values
CSFlexTableCellItemValueContent —

The content object that has been assigned to the cell.

addStyleName()

Adds a unique style name to the list of styles for the cell content

public addStyleName(string $sStyleName) : void
Parameters
$sStyleName : string
Tags
access

public

Return values
void —

clearContents()

This method clears the content of the cell. It removes all assigned content objects.

public clearContents() : void
Tags
access

public

Return values
void —

getAutomergeStyleNameForCols()

Returns the automerge style name for cols of the cell.

public getAutomergeStyleNameForCols() : string
Tags
access

public

Return values
string —

The style name for automerged cells.

getAutomergeStyleNameForRows()

Returns the automerge style name for rows of the cell.

public getAutomergeStyleNameForRows() : string
Tags
access

public

Return values
string —

The style name for automerged cells.

getCol()

Returns the parent column of the cell.

public getCol() : CSFlexTableCol
Tags
access

public

Return values
CSFlexTableCol —

A reference to the parent column.

getColSpan()

Returns the col span of the cell.

public getColSpan() : int
Tags
access

public

Return values
int —

The number of col the cell should span over.

getContentFromPathIdentifier()

Returns a content based on the path identifier. The path itself must be build in the following way:

public getContentFromPathIdentifier(string $sPathIdentifier) : CSFlexTableCellContent

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: the cell content index relative to the parent cell.

Parameters
$sPathIdentifier : string

The path indentifier of the requested content object.

Tags
access

public

Return values
CSFlexTableCellContent —

The content object matching the path identifier.

getContentSeparator()

Returns the content separator of the cell.

public getContentSeparator() : string
Tags
access

public

Return values
string —

The content separator set for the cell.

getIndex()

Returns the Index of the cell within the row

public getIndex() : int
Tags
throws
UnexpectedValueException

if the the cell can not be found in the row

access

public

Return values
int —

The index of the cell

getPathIdentifier()

Returns the path identifier for the current cell. The identifier has the following format:

public final getPathIdentifier() : string

d: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

Tags
access

public

Return values
string —

The path identifier of the current cell

getRowSpan()

Returns the row span of the cell.

public getRowSpan() : int
Tags
access

public

Return values
int —

The number of rows the cell should span over.

getStyleNames()

Returns all style names assigned to the cell.

public getStyleNames() : array<string|int, mixed>
Tags
access

public

Return values
array<string|int, mixed> —

A list of style names assigned to the cell.

setAutomergeStyleNameForCols()

Sets the automerge style name for cols of the cell. This style name is added to the style names of the cell when a renderer performs automerge operations on cells for equal content. The default value is "col_merged"

public setAutomergeStyleNameForCols(string $sStyleName) : void
Parameters
$sStyleName : string

The automerge style name for cols to use.

Tags
access

public

Return values
void —

setAutomergeStyleNameForRows()

Sets the automerge style name for rows of the cell. This style name is added to the style names of the cell when a renderer performs automerge operations on cells for equal content. The default value is "row_merged"

public setAutomergeStyleNameForRows(string $sStyleName) : void
Parameters
$sStyleName : string

The automerge style name for rows to use.

Tags
access

public

Return values
void —

setColSpan()

Sets the col span of the cell.

public setColSpan(int $iColSpan) : void
Parameters
$iColSpan : int

The number of col the cell should span over.

Tags
access

public

Return values
void —

setContent()

Sets the content of the cell.

public setContent(mixed $oContent) : void
Parameters
$oContent : mixed

The content object that should be assigned to the cell as one of the available CSFlexTableCell{FORMAT}Content objects. All existing contents are removed when calling this method. If a string is provided it is automatically converted to a CSFlexTableCellTextContent object.

Tags
access

public

Return values
void —

setContentSeparator()

Sets the content separator for the cell. This separator is used when the table cell is rendered and all the content objects are concatenated.

public setContentSeparator(string $sSeparator) : void
Parameters
$sSeparator : string

The separator string to use.

Tags
access

public

Return values
void —

setRowSpan()

Sets the row span of the cell.

public setRowSpan(int $iRowSpan) : void
Parameters
$iRowSpan : int

The number of rows the cell should span over.

Tags
access

public

Return values
void —

setStyleName()

Sets the style name of the cell.

public setStyleName(string $sStyleName) : void
Parameters
$sStyleName : string

The style name of the cell.

Tags
access

public

Return values
void —

setStyleNames()

Sets a list of style names for the cell.

public setStyleNames(array<string|int, mixed> $aStyleNames) : void
Parameters
$aStyleNames : array<string|int, mixed>

The style names that should be assigned to the cell.

Tags
access

public

Return values
void — 

        

        
    




    

    

                

    

        

            
Search results