CSWhiteboardMergedItem
in package
Class CSWhiteboardMergedItem
Tags
Table of Contents
- __construct() : mixed
- getPlacedReference() : CSCometItemApiReference
- getPlannedReference() : CSCometItemApiReference
- getReference() : CSCometItemApiReference
- Returns the reference, if planned is exiting, it will return the planned, if not, the placed reference will be used
- getState() : mixed
- getStateIcon() : mixed
- getStateName() : mixed
- getTranslatedStateName() : string
- Returns the translated state name.
- setPlacedReference() : void
- setPlannedReference() : void
- setState() : mixed
Methods
__construct()
public
__construct(mixed $iReferenceId) : mixed
Parameters
- $iReferenceId : mixed
Tags
Return values
mixed —getPlacedReference()
public
getPlacedReference() : CSCometItemApiReference
Tags
Return values
CSCometItemApiReference —getPlannedReference()
public
getPlannedReference() : CSCometItemApiReference
Tags
Return values
CSCometItemApiReference —getReference()
Returns the reference, if planned is exiting, it will return the planned, if not, the placed reference will be used
public
getReference() : CSCometItemApiReference
Tags
Return values
CSCometItemApiReference —the comet item reference
getState()
public
getState() : mixed
Tags
Return values
mixed —getStateIcon()
public
getStateIcon([mixed $iconSize = CSImageUtils::ICONSIZE_16X16 ]) : mixed
Parameters
- $iconSize : mixed = CSImageUtils::ICONSIZE_16X16
Tags
Return values
mixed —getStateName()
public
getStateName() : mixed
Tags
Return values
mixed —getTranslatedStateName()
Returns the translated state name.
public
getTranslatedStateName([string|null $sModuleName = null ]) : string
Parameters
- $sModuleName : string|null = null
Tags
Return values
string —setPlacedReference()
public
setPlacedReference(CSCometItemApiReference $oItemReference) : void
Parameters
- $oItemReference : CSCometItemApiReference
Tags
Return values
void —setPlannedReference()
public
setPlannedReference(CSCometItemApiReference $oItemReference) : void
Parameters
- $oItemReference : CSCometItemApiReference
Tags
Return values
void —setState()
public
setState(mixed $sState) : mixed
Parameters
- $sState : mixed