StringUI
class StringUI extends UI (View source)
StringUI Object
Customization for String filters in dashboards
Constants
| TYPE |
Type of UI object
|
Methods
Builds a new StringUI Object
Shortcut method to set the value of an option and return $this.
Parses the config array by passing the values through each method to check validity against if the option exists.
A separator string appended to the label, to visually separate the label from the control.
Whether the label should display above or beside the control.
Whether the control should match any time a key is pressed or only when the input field 'changes' (loss of focus or pressing the Enter key).
Details
at line 46
__construct(
array $config = array())
Builds a new StringUI Object
in
JsonConfig at line 64
mixed
__get(
string $option)
Get the value of a set option via magic method.
in
JsonConfig at line 75
Options
getOptions()
Gets the Options object for the JsonConfig
in
JsonConfig at line 90
JsonConfig
setOption(
string $option,
mixed $value)
Shortcut method to set the value of an option and return $this.
In order to maintain backwards compatibility, ConfigObjects will be unwrapped.
in
JsonConfig at line 106
setOptions(
array $config)
Parses the config array by passing the values through each method to check validity against if the option exists.
in
JsonConfig at line 275
array
jsonSerialize()
Custom serialization of the JsonConfig object.
in
UI at line 41
string
getType()
Returns the UI object type
in
UI at line 55
UI
label(
string $label)
The label to display next to the category picker.
If unspecified, the label of the column the control operates on will be used.
in
UI at line 67
UI
labelSeparator(
string $labelSeparator)
A separator string appended to the label, to visually separate the label from the control.
in
UI at line 83
UI
labelStacking(
string $labelStacking)
Whether the label should display above or beside the control.
Accepted values: - 'vertical' - 'horizontal'
in
UI at line 100
UI
cssClass(
string $cssClass)
The CSS class to assign to the control, for custom styling.
at line 63
StringUI
realtimeTrigger(
string $realtimeTrigger)
Whether the control should match any time a key is pressed or only when the input field 'changes' (loss of focus or pressing the Enter key).