CSCometGroup
extends CSIcmComponent
in package
Represents a Comet group
Tags
Table of Contents
- getAbsoluteSize() : float
- returns the absolute size in square mm based on comet calculation algorithm
- getAbsoluteVisibleSize() : float
- returns the visible absolute size in square mm based on comet calculation algorithm
- getClassID() : int
- returns the class id associated with this group
- getFrames() : mixed
- getGlobalSize() : int
- returns the size calculated as width*height
- getHeight() : float
- returns the height
- getLabel() : string
- returns the label associated with this group
- getPageID() : int
- returns the id of the page
- getPageIndex() : int
- returns the index of the page relative to the document
- getParent() : mixed
- getPositionLeft() : float
- returns the left position
- getPositionTop() : float
- returns the top position
- getRecordClassName() : null|string
- returns the records class name of the referenced record determined by the comet class id
- getRecordID() : int
- returns the record id associated with this group
- getRelativeGlobalSize() : int
- returns the relative size calculated as width*height
- getRelativeSize() : float
- returns the relative size of the group in percent based on comet calculation algorithm
- getRelativeVisibleSize() : float
- returns the relative visible size of the group in percent based on comet calculation algorithm
- getShareID() : int
- returns the share id associated with this group
- getTemplateID() : int
- returns the template id associated with this group
- getType() : mixed
- getWidth() : float
- returns the width
- storePlaceholders() : bool
- stores the placeholders inside the group
- updatePlaceholders() : bool
- updates the placeholders inside the group
Methods
getAbsoluteSize()
returns the absolute size in square mm based on comet calculation algorithm
public
getAbsoluteSize() : float
Tags
Return values
float —the size in square mm
getAbsoluteVisibleSize()
returns the visible absolute size in square mm based on comet calculation algorithm
public
getAbsoluteVisibleSize() : float
Tags
Return values
float —the visible size in square mm
getClassID()
returns the class id associated with this group
public
getClassID() : int
Tags
Return values
int —the id of the associated record class
getFrames()
public
getFrames() : mixed
Tags
Return values
mixed —getGlobalSize()
returns the size calculated as width*height
public
getGlobalSize() : int
Tags
Return values
int —the calculated size based on width and height
getHeight()
returns the height
public
getHeight() : float
Tags
Return values
float —the height
getLabel()
returns the label associated with this group
public
getLabel() : string
Tags
Return values
string —the label of the associated record
getPageID()
returns the id of the page
public
getPageID() : int
Tags
Return values
int —the id of the page the group is placed on
getPageIndex()
returns the index of the page relative to the document
public
getPageIndex() : int
Tags
Return values
int —the index of the page the group is placed on
getParent()
public
getParent() : mixed
Tags
Return values
mixed —getPositionLeft()
returns the left position
public
getPositionLeft() : float
Tags
Return values
float —the left position
getPositionTop()
returns the top position
public
getPositionTop() : float
Tags
Return values
float —the top position
getRecordClassName()
returns the records class name of the referenced record determined by the comet class id
public
getRecordClassName() : null|string
Tags
Return values
null|string —the target record class name or null if the record does not exist
getRecordID()
returns the record id associated with this group
public
getRecordID() : int
Tags
Return values
int —the id of the associated record
getRelativeGlobalSize()
returns the relative size calculated as width*height
public
getRelativeGlobalSize() : int
Tags
Return values
int —the calculated size based on width and height
getRelativeSize()
returns the relative size of the group in percent based on comet calculation algorithm
public
getRelativeSize() : float
Tags
Return values
float —the relative size in percent
getRelativeVisibleSize()
returns the relative visible size of the group in percent based on comet calculation algorithm
public
getRelativeVisibleSize() : float
Tags
Return values
float —the relative visible size in percent
getShareID()
returns the share id associated with this group
public
getShareID() : int
Tags
Return values
int —the id of the associated record share
getTemplateID()
returns the template id associated with this group
public
getTemplateID() : int
Tags
Return values
int —the id of the associated template
getType()
public
getType() : mixed
Tags
Return values
mixed —getWidth()
returns the width
public
getWidth() : float
Tags
Return values
float —the width
storePlaceholders()
stores the placeholders inside the group
public
storePlaceholders([array<string|int, mixed> $placeholderIDs = array() ], int $recordID, int $shareID) : bool
Parameters
- $placeholderIDs : array<string|int, mixed> = array()
-
a list of placeholder ids that should be stored
- $recordID : int
-
if set, only placeholder referencing the corresponding record are stored
- $shareID : int
-
if the $recordID is set also the $shareID must be passed
Tags
Return values
bool —true on sccess otherwise false
updatePlaceholders()
updates the placeholders inside the group
public
updatePlaceholders([array<string|int, mixed> $placeholderIDs = array() ][, mixed $textUpdateType = CSComet::COMET_TEXT_UPDATE_TYPE_TO_VALUE ]) : bool
Parameters
- $placeholderIDs : array<string|int, mixed> = array()
-
a list of placeholder ids that should be updated
- $textUpdateType : mixed = CSComet::COMET_TEXT_UPDATE_TYPE_TO_VALUE
Tags
Return values
bool —true on sccess otherwise false