Contentserv PHP API

CSFlexInddTableRenderer extends CSFlexTableRenderer
in package

Flex Renderer that converts a Flex Table to HTML

Tags
since

CS15.0

access

public

Table of Contents

AUTOMERGE_AREAS_DATA  = 1
Defines the data area to be included in automerging of cells.
AUTOMERGE_AREAS_FOOTER  = 4
Defines the footer area to be included in automerging of cells.
AUTOMERGE_AREAS_HEADER  = 2
Defines the header area to be included in automerging of cells.
AUTOMERGE_AREAS_NONE  = 0
Defines the no areas to be included in automerging of cells.
SECTION_TYPE_BODY  = 'body'
SECTION_TYPE_FOOTER  = 'footer'
SECTION_TYPE_HEADER  = 'header'
VALUE_MATRIX_GROUP_BY_COLUMN  = 1
Defines the col grouping when generating the value matrix for a table.
VALUE_MATRIX_GROUP_BY_ROW  = 0
Defines the row grouping when generating the value matrix for a table.
VALUE_MATRIX_GROUP_BY_ROW_COLUMN  = 0
Defines if the operation is only column merging of cells.
__construct()  : mixed
Instantiates the table renderer
addFieldsToEditor()  : mixed
This method can be used by CSGuiEditors to add the renderer specific fields to the editor
getColWidths()  : array<string|int, int>
Calculates the widths of the cols in a table
getCometImagePlaceholder()  : string
Creates an Comet Image Frame based a MamFileID
getCometItemImageAttributePlaceholder()  : string
Creates an Image Placeholder for Comet
getCometItemTextPlaceholder()  : string
Creates a Text Placeholder for Comet
getGenericCometTextPlaceholder()  : string
Creates a Text Placeholder for Comet that can reload the cell content
getPreset()  : CSFlexPreset
Returns the preset used to render this table
getShareID()  : mixed
Returns the ID of the Comet Sharepoint that is asking for the rendering results
getTableContainer()  : CSFlexTableContainer
Allows to access the prepared and filled table container
getTemplatePlugin()  : CSFlexTemplatePlugin
isEmptyRowForValue()  : bool
Checks whether value is empty or not
mm2pt()  : float
Converts a millimeter to post script points
renderCellContent()  : mixed
Renders a dedicated table cell identified by the $CellID
renderTableContainer()  : mixed
Renders the table by calling the necessary methods.
setHeaderRowsRemoved()  : mixed
Allows to remove the headers for rendering
setMaxCols()  : mixed
Sets the maximum number of cols
setMaxRows()  : mixed
Sets the maximum number of rows
setMergingOfColCellsWithEqualValues()  : void
This method can be used to tell the renderer that cells with equal content in one col should be merged before render the table.
setMergingOfRowCellsWithEqualValues()  : void
This method can be used to tell the renderer that cells with equal content in one row should be merged before render the table.
setOrientationInverted()  : void
This method can be used to tell the renderer that the table should invert rows and cols
setPreset()  : void
Overwrites the internal preset
setRemovingOfEmptyCols()  : void
This method can be used to tell the renderer that empty cols should be removed before rendering the table.
setRemovingOfEmptyRows()  : void
This method can be used to tell the renderer that empty rows should be removed before rendering the table. This method only takes data rows into account. Header and footer rows are not modified.

Constants

AUTOMERGE_AREAS_DATA

Defines the data area to be included in automerging of cells.

public mixed AUTOMERGE_AREAS_DATA = 1
Tags

AUTOMERGE_AREAS_FOOTER

Defines the footer area to be included in automerging of cells.

public mixed AUTOMERGE_AREAS_FOOTER = 4
Tags

AUTOMERGE_AREAS_HEADER

Defines the header area to be included in automerging of cells.

public mixed AUTOMERGE_AREAS_HEADER = 2
Tags

AUTOMERGE_AREAS_NONE

Defines the no areas to be included in automerging of cells.

public mixed AUTOMERGE_AREAS_NONE = 0
Tags

VALUE_MATRIX_GROUP_BY_COLUMN

Defines the col grouping when generating the value matrix for a table.

public mixed VALUE_MATRIX_GROUP_BY_COLUMN = 1
Tags

VALUE_MATRIX_GROUP_BY_ROW

Defines the row grouping when generating the value matrix for a table.

public mixed VALUE_MATRIX_GROUP_BY_ROW = 0
Tags

VALUE_MATRIX_GROUP_BY_ROW_COLUMN

Defines if the operation is only column merging of cells.

public mixed VALUE_MATRIX_GROUP_BY_ROW_COLUMN = 0
Tags

Methods

addFieldsToEditor()

This method can be used by CSGuiEditors to add the renderer specific fields to the editor

public addFieldsToEditor(CSGuiEditor $editor) : mixed
Parameters
$editor : CSGuiEditor

the CSGuiEditor or descendant

Tags
access

public

Return values
mixed —

getColWidths()

Calculates the widths of the cols in a table

public getColWidths() : array<string|int, int>
Tags
Return values
array<string|int, int> —

array with the col widths

getCometImagePlaceholder()

Creates an Comet Image Frame based a MamFileID

public getCometImagePlaceholder(int $MamID, int $ShareID[, int $ClassID = COMET_CLASS_FILE ][, float $width = 70.0 ][, float $height = 50.0 ][, array<string|int, string> $aStyleNames = array() ]) : string
Parameters
$MamID : int

the MamFile ID

$ShareID : int

the ShareID

$ClassID : int = COMET_CLASS_FILE

the ClassID

$width : float = 70.0

in mm

$height : float = 50.0

in mm

$aStyleNames : array<string|int, string> = array()

optional array with style names added to the cell content

Tags
Return values
string —

the placeholder string for tagged text

getCometItemImageAttributePlaceholder()

Creates an Image Placeholder for Comet

public getCometItemImageAttributePlaceholder(mixed $AttributeID, mixed $ItemID, mixed $ShareID[, int $ClassID = COMET_CLASS_FILE ][, mixed $width = 70 ][, mixed $height = 50 ][, array<string|int, string> $aStyleNames = array() ]) : string
Parameters
$AttributeID : mixed
$ItemID : mixed
$ShareID : mixed
$ClassID : int = COMET_CLASS_FILE
$width : mixed = 70
$height : mixed = 50
$aStyleNames : array<string|int, string> = array()

array with optional style names to add

Tags
Return values
string —

getCometItemTextPlaceholder()

Creates a Text Placeholder for Comet

public getCometItemTextPlaceholder(string $value, mixed $AttributeID, int $ItemID, int $ShareID[, int $ClassID = COMET_CLASS_PRODUCT ]) : string
Parameters
$value : string

the content within the placeholder

$AttributeID : mixed

the Attribute ID or name that points to this content

$ItemID : int

the ID of the Item that has this content

$ShareID : int

the ID of the Share that gives access to this item

$ClassID : int = COMET_CLASS_PRODUCT

the type of the Item that has this content

Tags
Return values
string —

getGenericCometTextPlaceholder()

Creates a Text Placeholder for Comet that can reload the cell content

public getGenericCometTextPlaceholder(CSFlexCellContent $oContent, string $text, int $ShareID) : string
Parameters
$oContent : CSFlexCellContent
$text : string
$ShareID : int
Tags
Return values
string —

the rendered value

getShareID()

Returns the ID of the Comet Sharepoint that is asking for the rendering results

public getShareID() : mixed
Tags
Return values
mixed —

the ShareID

isEmptyRowForValue()

Checks whether value is empty or not

public isEmptyRowForValue(string $sValue) : bool
Parameters
$sValue : string

string to check either empty or not

Tags
access

protected

Return values
bool —

Whether the row is empty or not

mm2pt()

Converts a millimeter to post script points

public static mm2pt(int $iMillimeter) : float
Parameters
$iMillimeter : int

the millimeter

Tags
Return values
float —

the points

renderTableContainer()

Renders the table by calling the necessary methods.

public final renderTableContainer() : mixed
Tags
access

public

Return values
mixed —

The rendered table.

setHeaderRowsRemoved()

Allows to remove the headers for rendering

public setHeaderRowsRemoved([mixed $headerRowsRemoved = true ]) : mixed
Parameters
$headerRowsRemoved : mixed = true
Tags
Return values
mixed —

setMaxCols()

Sets the maximum number of cols

public setMaxCols(int $maxCols) : mixed
Parameters
$maxCols : int
Tags
Return values
mixed —

setMaxRows()

Sets the maximum number of rows

public setMaxRows(int $maxRows) : mixed
Parameters
$maxRows : int
Tags
Return values
mixed —

setMergingOfColCellsWithEqualValues()

This method can be used to tell the renderer that cells with equal content in one col should be merged before render the table.

public setMergingOfColCellsWithEqualValues([bool $bMerge = true ]) : void
Parameters
$bMerge : bool = true

If set to true, cells with equal content are merged before rendering the table.

Tags
access

public

Return values
void —

setMergingOfRowCellsWithEqualValues()

This method can be used to tell the renderer that cells with equal content in one row should be merged before render the table.

public setMergingOfRowCellsWithEqualValues([int $iMerge = 7 ]) : void
Parameters
$iMerge : int = 7

Defines which areas in the table should be included in automerging of equal cells. The following BIT operators can be used:

AUTOMERGE_AREAS_NONE: No areas are automerged. AUTOMERGE_AREAS_HEADER: The header area should be included in the automerge. AUTOMERGE_AREAS_DATA: The data area should be included in the automerge. AUTOMERGE_AREAS_FOOTER: The footer area should be included in the automerge.

Tags
access

public

Return values
void —

setOrientationInverted()

This method can be used to tell the renderer that the table should invert rows and cols

public setOrientationInverted([bool $bInverted = true ]) : void
Parameters
$bInverted : bool = true

If set to true, the rows and cols are inverted

Tags
access

public

Return values
void —

setRemovingOfEmptyCols()

This method can be used to tell the renderer that empty cols should be removed before rendering the table.

public setRemovingOfEmptyCols([bool $bRemove = true ]) : void
Parameters
$bRemove : bool = true

If set to true, empty cols are removed from the rendered table.

Tags
access

public

Return values
void —

setRemovingOfEmptyRows()

This method can be used to tell the renderer that empty rows should be removed before rendering the table. This method only takes data rows into account. Header and footer rows are not modified.

public setRemovingOfEmptyRows([bool $bRemove = true ]) : void
Parameters
$bRemove : bool = true

If set to true, empty rows are removed from the rendered table.

Tags
access

public

Return values
void — 

        

        
    




    

    

                

    

        

            
Search results