\Hazaar\View\Widgets\Button
SwitchButton

Toggle button widget.

Tags

Since

1.0.0

Summary
Methods Properties Constants
set
val
No constants
Properties
Inherited
$element
$element
Inherited
$name
$name
Inherited
$script
$script
Methods
__construct()
__construct($name, $params = Array ( ) )

Parameters

$name

No description

$params

No description

check()
check()

Execute the check method on a widget

checked()
checked($value) : Hazaar\\jqWidgets\\Button\\SwitchButton

Gets or sets the ckeck state. Possible Values: true, false.

disable()
disable()

Execute the disable method on a widget

disabled()
disabled($value) : Hazaar\\jqWidgets\\Button\\SwitchButton

Gets whether the switch button is disabled.

enable()
enable()

Execute the enable method on a widget

offLabel()
offLabel($value) : Hazaar\\jqWidgets\\Button\\SwitchButton

Sets the string displayed when the button is unchecked.

onChange()
onChange($code) : \\Hazaar\\Widgets\\Button\\Group

This event is triggered when a switch state is changed.

Parameters

$codestring

The code to execute when the event is triggered

Returns

\\Hazaar\\Widgets\\Button\\Group
onChecked()
onChecked($code) : \\Hazaar\\Widgets\\Button\\Group

This event is triggered when a switch is unchecked.

Parameters

$codestring

The code to execute when the event is triggered

Returns

\\Hazaar\\Widgets\\Button\\Group
onLabel()
onLabel($value) : Hazaar\\jqWidgets\\Button\\SwitchButton

Sets the string displayed when the button is checked.

onUnchecked()
onUnchecked($code) : \\Hazaar\\Widgets\\Button\\Group

This event is triggered when a switch is checked.

Parameters

$codestring

The code to execute when the event is triggered

Returns

\\Hazaar\\Widgets\\Button\\Group
orientation()
orientation($value) : Hazaar\\jqWidgets\\Button\\SwitchButton

Sets the orientation.

thumbSize()
thumbSize($value) : Hazaar\\jqWidgets\\Button\\SwitchButton

Sets the size of the thumb in percentages.

toggle()
toggle()

Execute the toggle method on a widget

uncheck()
uncheck()

Execute the uncheck method on a widget

Inherited
onClick()
onClick($value) : \Hazaar\View\Widgets\Widget

Adds a click event to a widget

Parameters

$valuemixed

The code as a string or JavaScript object, or array of objects to execute.

Returns

\Hazaar\View\Widgets\Widget
Inherited
render()
render() : string

Execute the render method on a widget

Returns

string

JavaScript code to execute the render method.

Inherited
renderObject()
renderObject() : string

Method to render the widget into HTML.

Returns

string

The widget rendererd as HTML.

Inherited
set()
set($key, $value = null, $type = null) : \Hazaar\View\Widgets\Widget

Sets a parameter that is sent to the DOM object.

This method can be used to set a single parameter, with the $key and $value arguments, or multiple parameters by just using the $key argument which is an array of key/value pairs of parameters that are to be set.

Parameters

$keymixed

The name of the parameter to be set, or an array of key/value pairs listing multiple parameters to be set.

$valuemixed

(Optional) The value of the parameter if only specifying one parameter.

$typestring

(Optional) The data type of the value. If set then this will be set explicitly.

Returns

\Hazaar\View\Widgets\Widget

A reference to the current object.

Inherited
setContent()
setContent($content) : string

Sets or gets the value.

Parameters

$content

No description

Returns

string
Inherited
style()
style($value)

Parameters

$value

No description

Inherited
theme()
theme($value) : \Hazaar\View\Widgets\Widget

Specifies the theme to use when initialising the widget. This is not normally needed as the default theme is set when creating each widget. However you may want to override the theme on a per widget basis and this allows for that.

Keep in mind that the theme file used will have to included manually.

Parameters

$valuestring

The name of the theme.

Returns

\Hazaar\View\Widgets\Widget

A reference to the current object.

Inherited
val()
val($value = null) : string

Sets or gets the value.

Parameters

$valuestring

The value to set

Returns

string
Inherited
width()
width($value) : \Hazaar\View\Widgets\Widget

Specifies the width of the widget in pixels.

Parameters

$valuemixed

The width value. Either an integer or string (with px suffix);

Returns

\Hazaar\View\Widgets\Widget

A reference to the current object.