\Hazaar\View\Widgets
Button

Basic button widget.

Tags

Since

1.1

Summary
Methods Properties Constants
get
set
val
No constants
Properties
Inherited
$element
$element
Inherited
$name
$name
Inherited
$script
$script
Methods
__construct()
__construct($name, $label = 'Button', $button_style = null, $params = Array ( ) )

Initialise a button widget

Parameters

$name

No description

$labelstring

The label to display on the button.

$button_style

No description

$params

No description

disabled()
disabled($value) : Hazaar\\jqWidgets\\Gauge

Enables or disables the button.

Parameters

$value

No description

Returns

\Hazaar\View\Widgets\Hazaar\\jqWidgets\\Gauge
label()
label($value) : Hazaar\\jqWidgets\\Button

Set the button label

Parameters

$value

No description

Returns

\Hazaar\View\Widgets\Hazaar\\jqWidgets\\Button
roundedCorners()
roundedCorners($value) : Hazaar\\jqWidgets\\Gauge

Enables or disables the rounded corners functionality. This property setting has effect in browsers which support CSS border-radius.

Parameters

$value

No description

Returns

\Hazaar\View\Widgets\Hazaar\\jqWidgets\\Gauge
Inherited
destroy()
destroy() : string

Execute the destroy method on a widget

Returns

string

JavaScript code to execute the destroy method.

Inherited
disable()
disable() : string

This method disables the widget.

Returns

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

Sets whether the widget is disabled by default or not.

Parameters

$value\Hazaar\View\Widgets\bool

True to disable, false to not.

Returns

\Hazaar\View\Widgets\Widget

A reference to the current object.

Inherited
enable()
enable() : string

This method enabled the widget.

Returns

string
Inherited
event()
event($name, $code) : \Hazaar\View\Widgets\Widget

Add an event to the Widget

Parameters

$namestring

The name of the event. eg: ‘click’

$codemixed

The JavaScript code to execute either as a string or a JavaScript object.

Returns

\Hazaar\View\Widgets\Widget
Inherited
exec()
exec($script)

Parameters

$script

No description

Inherited
focus()
focus() : string

Execute the focus method on a widget

Returns

string

JavaScript code to execute the focus method.

Inherited
get()
get($key) : mixed

Gets a widget property that has already been set

Parameters

$keystring

The property to return

Returns

mixed
Inherited
height()
height($value) : \Hazaar\View\Widgets\Widget

Specifies the height of the widget in pixels.

Parameters

$valuemixed

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

Returns

\Hazaar\View\Widgets\Widget

A reference to the current object.

Inherited
method()
method($name) : \Hazaar\View\Widgets\Widget

Call a jqWidgets method using the jqWidgets interface. Methods are called using this interface by specifying the first argument as the method being called and subsequent arguments are the actual arguments for the method call.

Parameters

$namestring

The method to call.

Returns

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

Returns the name of the object class. This is used to generate the jqxWidget plugin method name.

Returns

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