CategoryUI
class CategoryUI extends UI (View source)
CategoryUI Object
Customization for Category Filters in Dashboards.
Constants
| TYPE |
Type of UI object
|
Methods
Creates a new CategoryUI 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.
The caption to display inside the value picker widget when no item is selected.
Whether the values to choose from should be sorted.
How to display selected values, when multiple selection is allowed.
Whether the user is allowed not to choose any value.
Whether multiple values can be selected, rather than just one.
Allow typing in a text field for filtering.
Details
at line 52
__construct(
array $config = array())
Creates a new CategoryUI 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 67
CategoryUI
caption(
string $caption)
The caption to display inside the value picker widget when no item is selected.
at line 79
CategoryUI
sortValues(
boolean $sortValues)
Whether the values to choose from should be sorted.
at line 97
CategoryUI
selectedValuesLayout(
string $selectedValuesLayout)
How to display selected values, when multiple selection is allowed.
Possible values are: - 'aside': selected values will display in a single text line next to the value picker widget, - 'below': selected values will display in a single text line below the widget, - 'belowWrapping': similar to below, but entries that cannot fit in the picker will wrap to a new line, - 'belowStacked': selected values will be displayed in a column below the widget.
at line 120
CategoryUI
allowNone(
boolean $allowNone)
Whether the user is allowed not to choose any value.
If false the user must choose at least one value from the available ones. During control initialization, if the option is set to false and no selectedValues state is given, the first value from the available ones is automatically selected.
at line 132
CategoryUI
allowMultiple(
boolean $allowMultiple)
Whether multiple values can be selected, rather than just one.
at line 147
CategoryUI
allowTyping(
boolean $allowTyping)
Allow typing in a text field for filtering.
Whether the user is allowed to type in a text field to narrow down the list of possible choices (via an autocompleter), or not.