\Hazaar\View\Widgets
ListMenu

ListMenu widget.

Tags

Since

1.1

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

Initialise an ListMenu widget

Parameters

$namestring

The name (ID) of the widget to create.

$itemsmixed

The initial items of the input.

$paramsarray

Optional additional parameters

alwaysShowNavigationArrows()
alwaysShowNavigationArrows($value)

Parameters

$value

No description

animationDuration()
animationDuration($value)

Parameters

$value

No description

animationType()
animationType($value)

Parameters

$value

No description

autoSeparators()
autoSeparators($value)

Parameters

$value

No description

back()
back()
backLabel()
backLabel($value)

Parameters

$value

No description

changePage()
changePage($newpage)

Parameters

$newpage

No description

enableScrolling()
enableScrolling($value)

Parameters

$value

No description

filterCallback()
filterCallback($value)

Parameters

$value

No description

headerAnimationDuration()
headerAnimationDuration($value)

Parameters

$value

No description

placeHolder()
placeHolder($value)

Parameters

$value

No description

readOnly()
readOnly($value)

Parameters

$value

No description

roundedCorners()
roundedCorners($value)

Parameters

$value

No description

showBackButton()
showBackButton($value)

Parameters

$value

No description

showFilter()
showFilter($value)

Parameters

$value

No description

showHeader()
showHeader($value)

Parameters

$value

No description

showNavigationArrows()
showNavigationArrows($value)

Parameters

$value

No description

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.