class StringUI extends UI (View source)

StringUI Object

Customization for String filters in dashboards

Constants

TYPE

Type of UI object

Methods

__construct( array $config = array())

Builds a new StringUI Object

mixed
__get( string $option)

Get the value of a set option via magic method.

from  JsonConfig
getOptions()

Gets the Options object for the JsonConfig

from  JsonConfig
setOption( string $option, mixed $value)

Shortcut method to set the value of an option and return $this.

from  JsonConfig
setOptions( array $config)

Parses the config array by passing the values through each method to check validity against if the option exists.

from  JsonConfig
array
jsonSerialize()

Custom serialization of the JsonConfig object.

from  JsonConfig
string
getType()

Returns the UI object type

from  UI
UI
label( string $label)

The label to display next to the category picker.

from  UI
UI
labelSeparator( string $labelSeparator)

A separator string appended to the label, to visually separate the label from the control.

from  UI
UI
labelStacking( string $labelStacking)

Whether the label should display above or beside the control.

from  UI
UI
cssClass( string $cssClass)

The CSS class to assign to the control, for custom styling.

from  UI
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).

Details

at line 46
__construct( array $config = array())

Builds a new StringUI Object

Parameters

array $config

Exceptions

InvalidConfigValue

in JsonConfig at line 64
mixed __get( string $option)

Get the value of a set option via magic method.

Parameters

string $option Name of option.

Return Value

mixed

Exceptions

InvalidConfigProperty

in JsonConfig at line 75
Options getOptions()

Gets the Options object for the JsonConfig

Return Value

Options

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.

Parameters

string $option Option to set.
mixed $value Value of the option.

Return Value

JsonConfig

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.

Parameters

array $config

Exceptions

InvalidConfigValue
InvalidConfigProperty

in JsonConfig at line 275
array jsonSerialize()

Custom serialization of the JsonConfig object.

Return Value

array

in UI at line 41
string getType()

Returns the UI object type

Return Value

string

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.

Parameters

string $label Label to display

Return Value

UI

Exceptions

InvalidConfigValue

in UI at line 67
UI labelSeparator( string $labelSeparator)

A separator string appended to the label, to visually separate the label from the control.

Parameters

string $labelSeparator

Return Value

UI

Exceptions

InvalidConfigValue

in UI at line 83
UI labelStacking( string $labelStacking)

Whether the label should display above or beside the control.

Accepted values: - 'vertical' - 'horizontal'

Parameters

string $labelStacking

Return Value

UI

Exceptions

InvalidConfigValue

in UI at line 100
UI cssClass( string $cssClass)

The CSS class to assign to the control, for custom styling.

Parameters

string $cssClass

Return Value

UI

Exceptions

InvalidConfigValue

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).

Parameters

string $realtimeTrigger

Return Value

StringUI

Exceptions

InvalidConfigValue