\Hazaar\View\Widgets
ScrollBar

Menu widget.

Tags

Since

1.1

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

Initialise an Menu widget

Parameters

$namestring

The name (ID) of the widget to create.

$paramsarray

Optional additional parameters

isScrolling()
isScrolling() : string

Returns true, if the user is scrolling. Otherwise, returns false.

Tags

Since

1.1

Returns

string
largestep()
largestep($value) : \\Hazaar\\Widgets\\ProgressBar

Sets or gets the scrollbar’s largestep. The value is increased/decreased with this largestep when the ser presses the left mouse button in the area between a scrollbar button and thumb.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ProgressBar
max()
max($value) : \\Hazaar\\Widgets\\ProgressBar

Sets or gets the scrollbar’s maximum value.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ProgressBar
min()
min($value) : \\Hazaar\\Widgets\\ProgressBar

Sets or gets the scrollbar’s minimum value.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ProgressBar
onValuechanged()
onValuechanged($code) : \\Hazaar\\Widgets\\ProgressBar

This event is triggered when the value is changed.

Tags

Since

1.1

Parameters

$code

No description

Returns

\\Hazaar\\Widgets\\ProgressBar
setPosition()
setPosition($position) : string

Sets the thumb’s position

Tags

Since

1.1

Parameters

$position

No description

Returns

string
showButtons()
showButtons($value) : \\Hazaar\\Widgets\\ProgressBar

Sets or gets whether the scrollbar displays the increase and decrease arrow buttons.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ProgressBar
step()
step($value) : \\Hazaar\\Widgets\\ProgressBar

Sets or gets the scrollbar’s step. The value is increased/decreased with this step when the user presses a scrollbar button.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ProgressBar
thumbMinSize()
thumbMinSize($value) : \\Hazaar\\Widgets\\ProgressBar

Specifies the scrollbar thumb’s minimum size.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ProgressBar
value()
value($value) : \\Hazaar\\Widgets\\ProgressBar

Sets or gets the scrollbar’s value.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ProgressBar
vertical()
vertical($value) : \\Hazaar\\Widgets\\ProgressBar

Sets or gets the scrollbar’s orientation.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ProgressBar
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.