\Hazaar\View\Widgets
ScrollView

Basic button widget.

Tags

Since

1.1

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

Initialise a button widget

Parameters

$name

No description

$panels

No description

animationDuration()
animationDuration($value) : \\Hazaar\\Widgets\\ScrollView

Sets or gets the animationDuration property. Specifies the duration of the animation which starts when the current page is changed.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ScrollView
back()
back() : \\Hazaar\\Widgets\\ScrollView

Navigates to the previous page.

Tags

Since

1.1

bounceEnabled()
bounceEnabled($value) : \\Hazaar\\Widgets\\ScrollView

Sets or gets whether the bounce effect is enabled when pages are changed.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\ScrollView
buttonsOffset()
buttonsOffset($x = 0, $y = 0) : \\Hazaar\\Widgets\\ScrollView

Sets or gets the jqxScrollView’s buttonsOffset property. This property sets the offset from the default location of the navigation buttons.

Tags

Since

1.1

Parameters

$xint

The X offset

$yint

The Y offset

Returns

\\Hazaar\\Widgets\\ScrollView
changePage()
changePage($page) : \\Hazaar\\Widgets\\ScrollView

Navigates to a page.

Tags

Since

1.1

Parameters

$pageint

The page to navigate to.

Returns

\\Hazaar\\Widgets\\ScrollView
currentPage()
currentPage($value) : \\Hazaar\\Widgets\\ScrollView

Sets or gets the jqxScrollView’s currentPage property. The currentPage specifies the displayed element.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ScrollView
forward()
forward() : \\Hazaar\\Widgets\\ScrollView

Navigates to the next page.

Tags

Since

1.1

moveThreshold()
moveThreshold($value) : \\Hazaar\\Widgets\\ScrollView

Sets or gets the jqxScrollView’s moveThreshold property. The moveThreshold property specifies how much the user should drag the current element to navigate to next/previous element. Values should be set from 0.1 to 1. 0.5 means 50% of the element’s width.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ScrollView
pageChanged()
pageChanged($code) : \\Hazaar\\Widgets\\ScrollView

This event is triggered when the current page is changed.

Tags

Since

1.1

Parameters

$codestring

The JavaScript code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\ScrollView
refresh()
refresh() : \\Hazaar\\Widgets\\ScrollView

Refreshes the widget.

Tags

Since

1.1

showButtons()
showButtons($value) : \\Hazaar\\Widgets\\ScrollView

Sets or gets whether the navigation buttons are visible.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\ScrollView
slideDuration()
slideDuration($value) : \\Hazaar\\Widgets\\ScrollView

Sets or gets the duration in milliseconds of a time interval. The current page is changed when the time interval is elapsed.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\ScrollView
slideShow()
slideShow($value) : \\Hazaar\\Widgets\\ScrollView

Indicates whether the slideShow mode is enabled. In this mode, pages are changed automatically in a time interval.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

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