Contentserv PHP API

CSFlexTableCellItemValueContent extends CSFlexTableCellContent
in package

Represents a Flex Table Cell Content for the Attribute Value of an Item

Tags
since

CS15.0

access

public

Table of Contents

CONTENT_TYPE_ATTRIBUTE_VALUE  = 5
Defines attribute value content
CONTENT_TYPE_HTML  = 4
Defines html content
CONTENT_TYPE_IMAGE  = 2
Defines image content
CONTENT_TYPE_ITEM_VALUE  = 3
Defines item value content
CONTENT_TYPE_TEXT  = 1
Defines text content
__call()  : mixed
Internal method for handling friend class calls
__construct()  : void
Constructor
addStyleName()  : void
Adds a unique style name to the list of styles for the cell content
getAttributeID()  : mixed
Returns the currently assigned attribute id of this content object.
getCell()  : CSFlexTableCell
Returns the parent cell of the content object.
getIndex()  : int
Returns the Index of the content object within the Cell
getItem()  : CSItemApiItem
Returns the currently set item of this content object.
getLanguageID()  : int
Returns the currently assigned language id of this content object.
getPathIdentifier()  : string
Returns the path identifier for the current content object. The identifier has the following format:
getStyleNames()  : array<string|int, mixed>
Returns all style names assigned to the cell content.
getType()  : int
Returns the type of the content object.
getValue()  : mixed
Returns the item value for the current configuration of this content object.
setAttributeID()  : void
Sets the attribute id for this content object. This id is used later in a renderer to access the value that should be shown in the table.
setItem()  : void
Sets the item for this content object.
setLanguageID()  : void
Sets the language id for this content object. It is used later to retrieve the table value in the defined language.
setStyleName()  : void
Sets the style name of the cell.
setStyleNames()  : void
Sets a list of style names for the cell content.

Constants

CONTENT_TYPE_ATTRIBUTE_VALUE

Defines attribute value content

public mixed CONTENT_TYPE_ATTRIBUTE_VALUE = 5
Tags

CONTENT_TYPE_ITEM_VALUE

Defines item value content

public mixed CONTENT_TYPE_ITEM_VALUE = 3
Tags

Methods

__call()

Internal method for handling friend class calls

public __call(mixed $sMethodName, mixed $aMethodParams) : mixed
Parameters
$sMethodName : mixed
$aMethodParams : mixed
Tags
Return values
mixed —

__construct()

Constructor

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

The item that should be used to read th item value.

$mAttributeID : mixed

The attribute id that should be assigned to this content object.

$iLanguageID : int = NULL

the Language ID

Tags
access

public

Return values
void —

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 —

getAttributeID()

Returns the currently assigned attribute id of this content object.

public getAttributeID() : mixed
Tags
access

public

Return values
mixed —

The attribute id currently assigned to this content object.

getIndex()

Returns the Index of the content object within the Cell

public getIndex() : int
Tags
throws
UnexpectedValueException

if the the content object can not be found in the cell

access

public

Return values
int —

The index of the content object

getLanguageID()

Returns the currently assigned language id of this content object.

public getLanguageID() : int
Tags
access

public

Return values
int —

The currently assigned language id.

getPathIdentifier()

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

public final getPathIdentifier() : string

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

Tags
access

public

Return values
string —

The path identifier of the current content object

getStyleNames()

Returns all style names assigned to the cell content.

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

public

Return values
array<string|int, mixed> —

A list of style names assigned to the cell content.

getType()

Returns the type of the content object.

public getType() : int
Tags
access

public

Return values
int —

CSFlexTableCellContent::CONTENT_TYPE_ITEM_VALUE

getValue()

Returns the item value for the current configuration of this content object.

public getValue() : mixed
Tags
access

public

Return values
mixed —

The item value.

setAttributeID()

Sets the attribute id for this content object. This id is used later in a renderer to access the value that should be shown in the table.

public setAttributeID(mixed $mAttributeID) : void
Parameters
$mAttributeID : mixed

The attribute id that should be assigned to this content object.

Tags
access

public

Return values
void —

setLanguageID()

Sets the language id for this content object. It is used later to retrieve the table value in the defined language.

public setLanguageID(int $iLanguageID) : void
Parameters
$iLanguageID : int

The language id that should be assigned to this content object.

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 content.

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

The style names that should be assigned to the cell content.

Tags
access

public

Return values
void — 

        

        
    




    

    

                

    

        

            
Search results