Contentserv PHP API

CSFlexPreset
in package

Represents a Flex Preset that configures a Flex Table To create a new CSFlexPreset use @see CSFlex::createPreset()

Tags
since

CS15.0

access

public

Table of Contents

__call()  : mixed
This is needed to reach various methods on Record because this api is used on various places as 'Api' which might not have various functions.
__construct()  : CSFlexPreset
The constructor should not be called by anyone directly, use factory methods of CSFlex
addConfigListToEditor()  : mixed
Adds a List with the configs using this preset
addDataFieldsToEditor()  : void
Adds the Data Fields to the Editor
addFieldsToEditor()  : void
Adds the Preset Fields to the editor
addGeneralFieldsToEditor()  : mixed
This method can be used by CSGuiEditors to add the general preset fields to the editor
addOutputFieldsToEditor()  : void
Adds the renderer specific output fields to the editor
addStructureFieldsToEditor()  : mixed
This method can be used by CSGuiEditors to add the general preset fields to the editor
addTemplateFieldsToEditor()  : mixed
This method can be used by CSGuiEditors to add the template specific preset fields to the editor
addTranslationsFieldsToEditor()  : mixed
This method can be used by CSGuiEditors to add the translations preset fields to the editor
createDefaultPreset()  : mixed
Creates a default Preset for the given template name
createDefaultPresets()  : array<string|int, CSSmartPreset>
Method that will be called at update data model to make sure that for each template there's at least one preset - disable the presets if not required
createRenderer()  : CSFlexTableRenderer|string
Creates a renderer according to the presets setting
delete()  : void
Deletes the Preset
getApi()  : mixed
Implementation for the Comet Connector
getClass()  : mixed
Implementation for the Comet Connector
getConfigs()  : array<string|int, CSFlexConfig>
Gets all configs that have been created based on this preset
getContext()  : Record
Loads the context record from the context id and class stored with this CSFlexPreset
getContextAsApiItem()  : CSItemApiItem
This method retrieves naturally the selected item
getContextAttribute()  : CSItemApiField
Retrieves the Context Attribute that points to this presets table
getContextAttributeID()  : int
Retrieves the context Attribute ID of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Flex Preview was triggered. The ContextAttributeID is the ID of the (Flex-)Attribute that targets this Preset.
getContextClass()  : string
Retrieves the context class of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Flex Preview was triggered. The context class defines the type of these objects.
getContextDocumentID()  : int
Retrieves the ID of the document where the table is embedded in (if at all) Each Preset can be used within a context. Normally this would be for example the product from which the Flex Preview was triggered. The ContextDocumentID is the ID of the CSMam wbd or indd File, that contains the table.
getContextID()  : string
Retrieves the context IDs of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Flex Preview was triggered. The ContextID is the ID of this object.
getContextLanguage()  : string
Retrieves the context language of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Flex Preview was triggered. The context class defines the type of these objects.
getContextMedium()  : mixed
Returns the Context Medium the preset is used in
getCSSFiles()  : array<string|int, string>
Retrieves the CSS File for this preset based on the template
getCSSLink()  : string
It is possible to provide CSSLinks with a CSFlexPreset that should be added at the end of the CSS processing chain and overwrite other standard settings
getDescription()  : string
Gets the description attribute.
getEditorUrl()  : string
Creates the URL to the preset editor
getEmptyColsHidden()  : bool
Gets if the empty cols should be hidden
getEmptyRowsHidden()  : bool
Gets if the empty rows should be hidden
getEqualCellsInColsMerged()  : bool
Gets if equal cells in a col should be merged before rendering the table.
getEqualCellsInRowsMerged()  : bool
Gets if equal cells in a row should be merged before rendering the table.
getFormat()  : string
Gets the requested format like html
getHeaderRowsRemoved()  : string
Gets if the header rows should be removed
getHelpMessage()  : string
Creates a visible message that can be used to hint a user about a situation in a table
getID()  : int
Gets the ID of the Preset as stored in the DB
getIDField()  : string
Returns the Name of the ID Field
getLabel()  : string
Gets the Label attribute.
getLanguage()  : int
Gets the Language ID selected for this preset
getLanguageAsObject()  : CSLanguage
Gets the Language as Object selected for this preset
getLanguageID()  : int
Each Preset also defines a language to use
getLanguageShortName()  : string
Each Preset also defines a language to use
getLastChange()  : string
Returns the date and time when the preset was modified
getLastEditor()  : string
Returns the full user name that modified this preset
getMaxCols()  : int
Gets the maximum number of data cols a table can have
getMaxRows()  : int
Gets the maximum number of data rows a table can have
getMimeType()  : string
Gets the MIME Type for this presets format
getModuleName()  : mixed
Implementation for the Comet Connector
getName()  : string
Returns the value of the name field.
getNumberOfConfigs()  : int
Fast method to retrieve the number of configs that have been created based on this preset
getOrientationInverted()  : bool
If the table should be inverted
getPlaceholderCreated()  : bool
Tells if data in table cells should be created for InDesign with placeholders
getPreviewImage()  : mixed
Implementation for the Comet Connector
getPreviewUrl()  : string
Generates the URL to open when previewing this preset
getRecord()  : Flexpreset
Returns the internal CONTENTSERV Record object for this preset api object
getTableStyleName()  : string
Returns the style name of the table
getTemplate()  : string
Gets the Template Short Name of the Preset
getTemplatePlugin()  : CSFlexTemplatePlugin
Gets the Flex Template Plugin of the Preset
getUserAccess()  : int
Gets the UserAccess attribute.
getUserAccessFormatted()  : string
Gets the UserAccess type in a human readable format
getUserAccessIDs()  : string
Gets the UserIDs attribute.
getValue()  : string
Returns a value from the inner record object
isAvailableForCurrentUser()  : bool
Check if the current user is allowed to use the REST service.
isConfig()  : bool
Can be called to ask the object if it is a config
isDisabled()  : bool
Tells if the preset has the "Disabled" checkbox set in the preset configuration
isPreset()  : bool
Can be called to ask the object if it is a preset
makeTableContainer()  : CSFlexTableContainer
Renders the Preset according to all its settings
renderCellContent()  : mixed
Renders a Cell Content in the preset format
renderTableContainer()  : mixed
Renders the Table in the preset format
setContextAttributeID()  : void
Sets the context Attribute ID of the preset
setContextClass()  : void
Sets the context class of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Flex Preview was triggered. The context class defines the type of these objects separated by commas.
setContextDocumentID()  : void
Retrieves the ID of the document where the table is embedded in (if at all) Each Preset can be used within a context. Normally this would be for example the product from which the Flex Preview was triggered. The ContextDocumentID is the ID of the CSMam wbd or indd File, that contains the table.
setContextID()  : void
Sets the ContextID field of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Flex Preview was triggered. The ContextID is the IDs of this objects.
setContextLanguage()  : void
Sets the context language of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Flex Preview was triggered. The context class defines the type of these objects separated by commas.
setContextMedium()  : mixed
In Memory Storage for the current context medium
setCSSLink()  : void
It is possible to provide CSSLinks with a CSFlexPreset that should be added at the end of the CSS processing chain and overwrite other standard settings
setDescription()  : void
Set the Description attribute.
setDisabled()  : void
Disables or enables a preset
setEmptyColsHidden()  : void
This method can be used to tell the renderer that empty cols should be removed before rendering the table. This method only takes data cols into account. Header and footer rows are not considered.
setEmptyRowsHidden()  : 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 considered.
setEqualCellsInColsMerged()  : void
This method can be used to tell the renderer that equal cells in a col should be merged before rendering the table.
setEqualCellsInRowsMerged()  : void
This method can be used to tell the renderer that equal cells in a row should be merged before rendering the table.
setFormat()  : void
Sets the requested file format like html
setHeaderRowsRemoved()  : mixed
Sets if the header rows should be removed
setLabel()  : void
Set the Label attribute.
setLanguage()  : mixed
Overwrites the language short name set with this CSFlexPreset
setMaxCols()  : mixed
Sets the maximum number of data cols a table can have
setMaxRows()  : mixed
Sets the maximum number of data rows a table can have
setName()  : void
Set the name attribute.
setOrientationInverted()  : mixed
Sets if the table should be inverted
setPlaceholderCreated()  : void
Tells if data in table cells should be created for InDesign with placeholders
setTableStyleName()  : mixed
Sets the style name of the Table which will become a CSS Style in HTML, Table Style in InDesign
setTemplate()  : void
Sets the Template Short Name of the Preset
setUserAccess()  : void
Set the UserAccess attribute.
setValue()  : void
Sets a value to the the inner record object
store()  : Record
Stores the inner record with the current preset data to the database

Methods

__call()

This is needed to reach various methods on Record because this api is used on various places as 'Api' which might not have various functions.

public __call(mixed $name, mixed $params) : mixed

For example in Planned and Placed Lists for Whiteboard / Indesign.

If any methods on the record returning incorrect values, you have to add this method here and fix it...

Parameters
$name : mixed
$params : mixed
Tags
Return values
mixed —

__construct()

The constructor should not be called by anyone directly, use factory methods of CSFlex

public __construct([int $FlexpresetID = NULL ]) : CSFlexPreset
Parameters
$FlexpresetID : int = NULL

the ID of the preset

Tags
access

internal

Return values
CSFlexPreset —

addConfigListToEditor()

Adds a List with the configs using this preset

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

the Editor

Tags
Return values
mixed —

addDataFieldsToEditor()

Adds the Data Fields to the Editor

public addDataFieldsToEditor(CSGuiEditor $editor) : void
Parameters
$editor : CSGuiEditor
Tags
Return values
void —

addFieldsToEditor()

Adds the Preset Fields to the editor

public addFieldsToEditor(CSGuiEditor $editor) : void
Parameters
$editor : CSGuiEditor
Tags
Return values
void —

addGeneralFieldsToEditor()

This method can be used by CSGuiEditors to add the general preset fields to the editor

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

the CSGuiEditor or descendant

Tags
access

public

Return values
mixed —

addOutputFieldsToEditor()

Adds the renderer specific output fields to the editor

public addOutputFieldsToEditor(CSGuiEditor $editor) : void
Parameters
$editor : CSGuiEditor
Tags
Return values
void —

addStructureFieldsToEditor()

This method can be used by CSGuiEditors to add the general preset fields to the editor

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

the CSGuiEditor or descendant

Tags
access

public

Return values
mixed —

addTemplateFieldsToEditor()

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

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

the CSGuiEditor or descendant

Tags
access

public

Return values
mixed —

addTranslationsFieldsToEditor()

This method can be used by CSGuiEditors to add the translations preset fields to the editor

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

the CSGuiEditor or descendant

Tags
access

public

Return values
mixed —

createDefaultPreset()

Creates a default Preset for the given template name

public static createDefaultPreset(mixed $templateName) : mixed
Parameters
$templateName : mixed
Tags
access

public

@return
Return values
mixed —

createDefaultPresets()

Method that will be called at update data model to make sure that for each template there's at least one preset - disable the presets if not required

public static createDefaultPresets() : array<string|int, CSSmartPreset>
Tags
Return values
array<string|int, CSSmartPreset> —

array with the default presets

delete()

Deletes the Preset

public delete() : void
Tags
Return values
void —

getApi()

Implementation for the Comet Connector

public getApi() : mixed
Tags
Return values
mixed —

getClass()

Implementation for the Comet Connector

public getClass() : mixed
Tags
Return values
mixed —

getConfigs()

Gets all configs that have been created based on this preset

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

array with the configs

getContext()

Loads the context record from the context id and class stored with this CSFlexPreset

public getContext() : Record
Tags
access

public

Return values
Record —

context record

getContextAsApiItem()

This method retrieves naturally the selected item

public getContextAsApiItem() : CSItemApiItem
Tags
access

public

Return values
CSItemApiItem —

CSApiItem selected

getContextAttributeID()

Retrieves the context Attribute ID of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Flex Preview was triggered. The ContextAttributeID is the ID of the (Flex-)Attribute that targets this Preset.

public getContextAttributeID() : int
Tags
access

public

Return values
int —

the ID of the Attribute

getContextClass()

Retrieves the context class of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Flex Preview was triggered. The context class defines the type of these objects.

public getContextClass() : string
Tags
access

public

Return values
string —

getContextDocumentID()

Retrieves the ID of the document where the table is embedded in (if at all) Each Preset can be used within a context. Normally this would be for example the product from which the Flex Preview was triggered. The ContextDocumentID is the ID of the CSMam wbd or indd File, that contains the table.

public getContextDocumentID() : int
Tags
access

public

Return values
int —

the Mam ID of the context document

getContextID()

Retrieves the context IDs of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Flex Preview was triggered. The ContextID is the ID of this object.

public getContextID() : string
Tags
access

public

Return values
string —

getContextLanguage()

Retrieves the context language of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Flex Preview was triggered. The context class defines the type of these objects.

public getContextLanguage() : string
Tags
access

public

Return values
string —

the context ID or short name

getContextMedium()

Returns the Context Medium the preset is used in

public getContextMedium() : mixed
Tags
Return values
mixed —

the Context Medium

getCSSFiles()

Retrieves the CSS File for this preset based on the template

public getCSSFiles([mixed $base = 'external' ]) : array<string|int, string>
Parameters
$base : mixed = 'external'
Tags
Return values
array<string|int, string> —

array with external path to the CSS File

getCSSLink()

It is possible to provide CSSLinks with a CSFlexPreset that should be added at the end of the CSS processing chain and overwrite other standard settings

public getCSSLink() : string
Tags
access

public

Return values
string —

the CSS Link

getDescription()

Gets the description attribute.

public getDescription() : string
Tags
access

public

Return values
string —

the description attribute

getEditorUrl()

Creates the URL to the preset editor

public getEditorUrl([string $base = 'external' ]) : string
Parameters
$base : string = 'external'

the base like 'external' or 'internal'

Tags
Return values
string —

the URL

getEmptyColsHidden()

Gets if the empty cols should be hidden

public getEmptyColsHidden() : bool
Tags
Return values
bool —

TRUE if empty cols should be hidden

getEmptyRowsHidden()

Gets if the empty rows should be hidden

public getEmptyRowsHidden() : bool
Tags
Return values
bool —

TRUE if empty rows should be hidden

getEqualCellsInColsMerged()

Gets if equal cells in a col should be merged before rendering the table.

public getEqualCellsInColsMerged() : bool
Tags
access

public

Return values
bool —

TRUE if equal cells in a col should be merged

getEqualCellsInRowsMerged()

Gets if equal cells in a row should be merged before rendering the table.

public getEqualCellsInRowsMerged() : bool
Tags
access

public

Return values
bool —

TRUE if equal cells in a col should be merged

getFormat()

Gets the requested format like html

public getFormat() : string
Tags
access

public

Return values
string —

the format

getHeaderRowsRemoved()

Gets if the header rows should be removed

public getHeaderRowsRemoved() : string
Tags
Return values
string —

getHelpMessage()

Creates a visible message that can be used to hint a user about a situation in a table

public getHelpMessage(mixed $message) : string
Parameters
$message : mixed
Tags
Return values
string —

html formatted message

getID()

Gets the ID of the Preset as stored in the DB

public getID() : int
Tags
access

public

Return values
int —

the ID

getIDField()

Returns the Name of the ID Field

public getIDField() : string
Tags
access

public

Return values
string —

the name

getLabel()

Gets the Label attribute.

public getLabel() : string
Tags
access

public

Return values
string —

the label attribute

getLanguage()

Gets the Language ID selected for this preset

public getLanguage() : int
Tags
access

public

Return values
int —

the language ID

getLanguageAsObject()

Gets the Language as Object selected for this preset

public getLanguageAsObject() : CSLanguage
Tags
access

public

Return values
CSLanguage —

the language object

getLanguageID()

Each Preset also defines a language to use

public getLanguageID() : int
Tags
access

public

Return values
int —

the LanguageID for this preset

getLanguageShortName()

Each Preset also defines a language to use

public getLanguageShortName() : string
Tags
access

public

Return values
string —

the short name of the language to use for this preset

getLastChange()

Returns the date and time when the preset was modified

public getLastChange() : string
Tags
Return values
string —

the change date

getLastEditor()

Returns the full user name that modified this preset

public getLastEditor() : string
Tags
Return values
string —

the user name

getMaxCols()

Gets the maximum number of data cols a table can have

public getMaxCols() : int
Tags
Return values
int —

the max number of data cols

getMaxRows()

Gets the maximum number of data rows a table can have

public getMaxRows() : int
Tags
Return values
int —

the max number of data rows

getMimeType()

Gets the MIME Type for this presets format

public getMimeType() : string
Tags
Return values
string —

getModuleName()

Implementation for the Comet Connector

public getModuleName() : mixed
Tags
Return values
mixed —

getName()

Returns the value of the name field.

public getName() : string
Tags
Return values
string —

with the value of the name field.

getNumberOfConfigs()

Fast method to retrieve the number of configs that have been created based on this preset

public static getNumberOfConfigs(mixed $PresetID) : int
Parameters
$PresetID : mixed
Tags
Return values
int —

number of configs

getOrientationInverted()

If the table should be inverted

public getOrientationInverted() : bool
Tags
Return values
bool —

TRUE if the orientation should be inverted

getPlaceholderCreated()

Tells if data in table cells should be created for InDesign with placeholders

public getPlaceholderCreated() : bool
Tags
access

public

Return values
bool —

TRUE if placeholders should be created

getPreviewImage()

Implementation for the Comet Connector

public getPreviewImage() : mixed
Tags
Return values
mixed —

getPreviewUrl()

Generates the URL to open when previewing this preset

public getPreviewUrl([mixed $sContextID = NULL ][, array<string|int, string> $asOtherParams = array() ][, string $sBase = 'external' ]) : string
Parameters
$sContextID : mixed = NULL
$asOtherParams : array<string|int, string> = array()

an associative array with preset modifications like

  • ContextClass
  • Language
  • CSSLink
  • Format
$sBase : string = 'external'

the base as in @see CS::getLinkToResource()

Tags
Return values
string —

a HTTP URL that previews the preset

getRecord()

Returns the internal CONTENTSERV Record object for this preset api object

public getRecord() : Flexpreset
Tags
access

public

Return values
Flexpreset —

getTableStyleName()

Returns the style name of the table

public getTableStyleName() : string
Tags
Return values
string —

the style name

getTemplate()

Gets the Template Short Name of the Preset

public getTemplate() : string
Tags
access

public

Return values
string —

the template short name

getUserAccess()

Gets the UserAccess attribute.

public getUserAccess() : int
Tags
access

public

Return values
int —

UserAccess attribute

getUserAccessFormatted()

Gets the UserAccess type in a human readable format

public getUserAccessFormatted() : string
Tags
access

public

Return values
string —

UserAccess

getUserAccessIDs()

Gets the UserIDs attribute.

public getUserAccessIDs() : string
Tags
access

public

Return values
string —

UserIDs attribute

getValue()

Returns a value from the inner record object

public getValue(string $name[, string $default = '' ]) : string
Parameters
$name : string

The name of the value that should be returned

$default : string = ''

The default value which will be returned if no value is stored in database

Tags
access

public

Return values
string —

isAvailableForCurrentUser()

Check if the current user is allowed to use the REST service.

public isAvailableForCurrentUser() : bool

First, this method checks the value of the field UserAccess UserAccess==0, means all users but Anonymous have access to the service UserAccess==1, means all users including Anonymous have access to the service UserAccess==2, means only Users with UserIDs mentioned in the chooser have access to the service

Tags
access

public

Return values
bool —

current user allowed to use the REST service

isConfig()

Can be called to ask the object if it is a config

public isConfig() : bool
Tags
Return values
bool —

TRUE if the object is a config

isDisabled()

Tells if the preset has the "Disabled" checkbox set in the preset configuration

public isDisabled() : bool
Tags
access

public

Return values
bool —

TRUE if the preset is disabled

isPreset()

Can be called to ask the object if it is a preset

public isPreset() : bool
Tags
Return values
bool —

TRUE if the object is a preset

renderCellContent()

Renders a Cell Content in the preset format

public renderCellContent(string $ContentID) : mixed
Parameters
$ContentID : string

comma separated string containing the RowIndex, ColIndex and ContentIndex

Tags
Return values
mixed —

renderTableContainer()

Renders the Table in the preset format

public renderTableContainer() : mixed
Tags
Return values
mixed —

setContextAttributeID()

Sets the context Attribute ID of the preset

public setContextAttributeID(mixed $AttributeID) : void

Each Preset can be used within a context. Normally this would be for example the product from which the Flex Preview was triggered. The ContextAttributeID is the ID of the (Flex-)Attribute that targets this Preset.

Parameters
$AttributeID : mixed
Tags
access

public

Return values
void —

setContextClass()

Sets the context class of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Flex Preview was triggered. The context class defines the type of these objects separated by commas.

public setContextClass(string $class) : void
Parameters
$class : string

the class of the context objects

Tags
access

public

Return values
void —

setContextDocumentID()

Retrieves the ID of the document where the table is embedded in (if at all) Each Preset can be used within a context. Normally this would be for example the product from which the Flex Preview was triggered. The ContextDocumentID is the ID of the CSMam wbd or indd File, that contains the table.

public setContextDocumentID(mixed $MamID) : void
Parameters
$MamID : mixed
Tags
access

public

Return values
void —

setContextID()

Sets the ContextID field of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Flex Preview was triggered. The ContextID is the IDs of this objects.

public setContextID(string $ID) : void
Parameters
$ID : string

the ID of the context objects

Tags
access

public

Return values
void —

setContextLanguage()

Sets the context language of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Flex Preview was triggered. The context class defines the type of these objects separated by commas.

public setContextLanguage(string $language) : void
Parameters
$language : string

the language ID or short name of the context objects

Tags
access

public

Return values
void —

setContextMedium()

In Memory Storage for the current context medium

public setContextMedium(mixed $medium) : mixed
Parameters
$medium : mixed

as passed to the CSType

Tags
Return values
mixed —

setCSSLink()

It is possible to provide CSSLinks with a CSFlexPreset that should be added at the end of the CSS processing chain and overwrite other standard settings

public setCSSLink(mixed $cssLink) : void
Parameters
$cssLink : mixed
Tags
access

public

Return values
void —

setDescription()

Set the Description attribute.

public setDescription(string $description) : void
Parameters
$description : string

the description value

Tags
access

public

Return values
void —

setDisabled()

Disables or enables a preset

public setDisabled([bool $disabled = TRUE ]) : void
Parameters
$disabled : bool = TRUE

if TRUE the preset will not be usable

Tags
access

public

Return values
void —

setEmptyColsHidden()

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

public setEmptyColsHidden([bool $hidden = TRUE ]) : void

.

Parameters
$hidden : bool = TRUE

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

Tags
access

public

Return values
void —

setEmptyRowsHidden()

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

public setEmptyRowsHidden([bool $hidden = TRUE ]) : void
Parameters
$hidden : bool = TRUE

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

Tags
access

public

Return values
void —

setEqualCellsInColsMerged()

This method can be used to tell the renderer that equal cells in a col should be merged before rendering the table.

public setEqualCellsInColsMerged([mixed $merged = TRUE ]) : void
Parameters
$merged : mixed = TRUE
Tags
access

public

Return values
void —

setEqualCellsInRowsMerged()

This method can be used to tell the renderer that equal cells in a row should be merged before rendering the table.

public setEqualCellsInRowsMerged([mixed $merged = TRUE ]) : void
Parameters
$merged : mixed = TRUE
Tags
access

public

Return values
void —

setFormat()

Sets the requested file format like html

public setFormat(string $format) : void
Parameters
$format : string

the format

Tags
access

public

Return values
void —

setHeaderRowsRemoved()

Sets if the header rows should be removed

public setHeaderRowsRemoved([bool $removed = TRUE ]) : mixed
Parameters
$removed : bool = TRUE
Tags
Return values
mixed —

setLabel()

Set the Label attribute.

public setLabel(string $sLabel) : void
Parameters
$sLabel : string

Label value

Tags
access

public

Return values
void —

setLanguage()

Overwrites the language short name set with this CSFlexPreset

public setLanguage(string $language) : mixed
Parameters
$language : string

the language short name

Tags
access

public

Return values
mixed —

setMaxCols()

Sets the maximum number of data cols a table can have

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

setMaxRows()

Sets the maximum number of data rows a table can have

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

setName()

Set the name attribute.

public setName(string $sName) : void
Parameters
$sName : string

The technical name value.

Tags
access

public

Return values
void —

setOrientationInverted()

Sets if the table should be inverted

public setOrientationInverted([bool $orientationInverted = TRUE ]) : mixed
Parameters
$orientationInverted : bool = TRUE
Tags
Return values
mixed —

setPlaceholderCreated()

Tells if data in table cells should be created for InDesign with placeholders

public setPlaceholderCreated([mixed $placeholderCreated = TRUE ]) : void
Parameters
$placeholderCreated : mixed = TRUE
Tags
access

public

Return values
void —

setTableStyleName()

Sets the style name of the Table which will become a CSS Style in HTML, Table Style in InDesign

public setTableStyleName(string $styleName) : mixed
Parameters
$styleName : string

the style name

Tags
Return values
mixed —

setTemplate()

Sets the Template Short Name of the Preset

public setTemplate(string $template) : void
Parameters
$template : string

the template short name like "AttributeTable"

Tags
access

public

Return values
void —

setUserAccess()

Set the UserAccess attribute.

public setUserAccess(int $userAccess) : void
Parameters
$userAccess : int

UserAccess value

Tags
access

public

Return values
void —

setValue()

Sets a value to the the inner record object

public setValue(string $name, string $value) : void
Parameters
$name : string

the name of the value that should be set

$value : string

the value that should be set

Tags
access

public

Return values
void —

store()

Stores the inner record with the current preset data to the database

public store() : Record
Tags
access

public

Return values
Record — 

        

        
    




    

    

                

    

        

            
Search results