CSGuiSelectionOption
in package
Tags
Table of Contents
- addFieldDependency() : bool
- Adds a field dependency for a specific value.
- createSelectionOption() : CSGuiSelectionOption
- Creates a selection option.
- getColor() : CSColor|null
- Returns the color API object.
- getFieldDependencies() : mixed
- getKey() : string
- Returns the key of the current selection option.
- getLabel() : string
- Returns the label of the current selection option.
- hasFieldDependencies() : bool
- Check for field dependencies.
- setColor() : mixed
- Defines the color API object for the current option.
- setLabel() : bool
- Sets the label for the current selection option.
Methods
addFieldDependency()
Adds a field dependency for a specific value.
public
addFieldDependency(string $sFieldName[, bool $bShouldBeVisible = false ]) : bool
It defines whether a field name should be visible or invisible if a specific value has been selected.
Parameters
- $sFieldName : string
-
The target field name of the field dependency.
- $bShouldBeVisible : bool = false
-
Whether the field should be visible or invisible.
Tags
Return values
bool —createSelectionOption()
Creates a selection option.
public
static createSelectionOption(string $sKey, CSGuiField $oField) : CSGuiSelectionOption
Parameters
- $sKey : string
-
The key for the selection option.
- $oField : CSGuiField
-
The target field object for the selection option.
Tags
Return values
CSGuiSelectionOption —getColor()
Returns the color API object.
public
getColor() : CSColor|null
Tags
Return values
CSColor|null —The color API object or null if not defined.
getFieldDependencies()
public
getFieldDependencies() : mixed
Tags
Return values
mixed —getKey()
Returns the key of the current selection option.
public
getKey() : string
Tags
Return values
string —with the key of the current selection option.
getLabel()
Returns the label of the current selection option.
public
getLabel() : string
Tags
Return values
string —hasFieldDependencies()
Check for field dependencies.
public
hasFieldDependencies() : bool
Tags
Return values
bool —setColor()
Defines the color API object for the current option.
public
setColor(CSColor $oColor) : mixed
Parameters
- $oColor : CSColor
-
The color API object.
Tags
Return values
mixed —setLabel()
Sets the label for the current selection option.
public
setLabel(string $sLabel) : bool
Parameters
- $sLabel : string