\Hazaar\View\Widgets
Splitter

Splitter 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, $value = null)

Initialise a Splitter widget

Parameters

$namestring

The name (ID) of the widget to create.

$valuestring

The initial value of the input.

addPanel()
addPanel($panel, $size = '50%', $min = 0, $collapsible = false, $collapsed = false)

Parameters

$panel

No description

$size

No description

$min

No description

$collapsible

No description

$collapsed

No description

collapse()
collapse() : string

Collapse a panel.

Tags

Since

1.1

Returns

string
collapsed()
collapsed($code) : \\Hazaar\\Widgets\\Splitter

This event is triggered when a panel is collapsed.

Tags

Since

1.1

Parameters

$code

No description

Returns

\\Hazaar\\Widgets\\Splitter
disabled()
disabled($value) : \\Hazaar\\Widgets\\Splitter

Sets or gets the disabled property.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Splitter
enable()
enable() : string

Enables the jqxSplitter.

Tags

Since

1.1

Returns

string
expand()
expand() : string

Expands a panel.

Tags

Since

1.1

Returns

string
expanded()
expanded($code) : \\Hazaar\\Widgets\\Splitter

This event is triggered when a panel is expanded.

Tags

Since

1.1

Parameters

$code

No description

Returns

\\Hazaar\\Widgets\\Splitter
orientation()
orientation($value) : \\Hazaar\\Widgets\\Splitter

Sets or gets the orientation property.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Splitter
panels()
panels()
refresh()
refresh() : string

Refreshes the jqxSplitter. This method will perform a layout and will arrange the split panels.

Tags

Since

1.1

Returns

string
render()
render() : string

Renders the jqxSplitter.

Tags

Since

1.1

Returns

string
resizable()
resizable($value) : \\Hazaar\\Widgets\\Splitter

Sets or gets the resizable property. When this property is set to false, the user will not be able to move the split bar.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Splitter
resize()
resize($code) : \\Hazaar\\Widgets\\Splitter

This event is triggered when the ‘resize’ operation has ended.

Tags

Since

1.1

Parameters

$code

No description

Returns

\\Hazaar\\Widgets\\Splitter
resizeStart()
resizeStart($code) : \\Hazaar\\Widgets\\Splitter

This event is triggered when the ‘resizeStart’ operation has started.

Tags

Since

1.1

Parameters

$code

No description

Returns

\\Hazaar\\Widgets\\Splitter
showSplitBar()
showSplitBar($value) : \\Hazaar\\Widgets\\Splitter

Sets or gets whether the split bar is displayed.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Splitter
splitBarSize()
splitBarSize($value) : \\Hazaar\\Widgets\\Splitter

Sets or gets the size of the split bar.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

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