\Hazaar\View\Widgets
Docking

ListMenu widget.

Tags

Since

1.1

Summary
Methods Properties Constants
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

addWindow()
addWindow($window, $mode = null, $panel = null, $position = null) : \\Hazaar\\Widgets\\Docking

Adding new window to the docking. This method accepts four arguments. The first one is id of the window we wish to add to the docking. The second argument is window’s mode (default, docked, floating) the third argument is the panel’s number and the last one is the position into the panel. The last three arguments are optional.

Tags

Since

1.1

Parameters

$window

No description

$mode

No description

$panel

No description

$position

No description

Returns

\\Hazaar\\Widgets\\Docking
closeWindow()
closeWindow($window) : \\Hazaar\\Widgets\\Docking

Closing specific window.

Tags

Since

1.1

Parameters

$window

No description

Returns

\\Hazaar\\Widgets\\Docking
collapseWindow()
collapseWindow($window) : \\Hazaar\\Widgets\\Docking

Collapsing a specific window.

Tags

Since

1.1

Parameters

$window

No description

Returns

\\Hazaar\\Widgets\\Docking
cookieOptions()
cookieOptions($value) : \\Hazaar\\Widgets\\Docking

Sets or gets the cookie options.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Docking
cookies()
cookies($value) : \\Hazaar\\Widgets\\Docking

Enables or disables the cookies. If the cookies are enabled then the docking layout is going to be saved and kept every time the page is being reloaded.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Docking
disableWindowResize()
disableWindowResize($window) : \\Hazaar\\Widgets\\Docking

Disabling the resize of a specific window.

Tags

Since

1.1

Parameters

$window

No description

Returns

\\Hazaar\\Widgets\\Docking
enableWindowResize()
enableWindowResize($window) : \\Hazaar\\Widgets\\Docking

Enabling the resize of a specific window which is not docked into a panel.

Tags

Since

1.1

Parameters

$window

No description

Returns

\\Hazaar\\Widgets\\Docking
expandWindow()
expandWindow($window) : \\Hazaar\\Widgets\\Docking

Expanding a specific window.

Tags

Since

1.1

Parameters

$window

No description

Returns

\\Hazaar\\Widgets\\Docking
exportLayout()
exportLayout() : \\Hazaar\\Widgets\\Docking

Exporting docking’s layout into a JSON string.

Tags

Since

1.1

floatingWindowOpacity()
floatingWindowOpacity($value) : \\Hazaar\\Widgets\\Docking

Sets or gets the opacity of the window which is currently dragged by the user.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Docking
hideAllCloseButtons()
hideAllCloseButtons() : \\Hazaar\\Widgets\\Docking

Hiding the close buttons of all windows.

Tags

Since

1.1

hideAllCollapseButtons()
hideAllCollapseButtons() : \\Hazaar\\Widgets\\Docking

Hiding the collapse buttons of all windows.

Tags

Since

1.1

hideCloseButton()
hideCloseButton($window) : \\Hazaar\\Widgets\\Docking

Hiding the close button of a specific window.

Tags

Since

1.1

Parameters

$window

No description

Returns

\\Hazaar\\Widgets\\Docking
hideCollapseButton()
hideCollapseButton($window) : \\Hazaar\\Widgets\\Docking

Hiding the collapse button of a specific window.

Tags

Since

1.1

Parameters

$window

No description

Returns

\\Hazaar\\Widgets\\Docking
importLayout()
importLayout($layout) : \\Hazaar\\Widgets\\Docking

Importing the docking layout from a JSON string.

Tags

Since

1.1

Parameters

$layout

No description

Returns

\\Hazaar\\Widgets\\Docking
mode()
mode($value) : \\Hazaar\\Widgets\\Docking

Sets or gets docking’s mode.

Possible Values:

  • ‘default’-the user can drop every window inside any docking panel or outside the docking panels
  • ‘docked’-the user can drop every window just into the docking panels
  • ‘floating’-the user can drop any window just outside of the docking panels.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Docking
move()
move($window, $panel, $position) : \\Hazaar\\Widgets\\Docking

Moving window to specific position into specific panel. This method have three parameters. The first one is id of the window we want to move, the second one is number of the panel where we want to move our window and the last one is the position into this panel.

Tags

Since

1.1

Parameters

$window

No description

$panel

No description

$position

No description

Returns

\\Hazaar\\Widgets\\Docking
onDragEnd()
onDragEnd($code) : \\Hazaar\\Widgets\\Docking

This event is triggered when the user drop any window.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Docking
onDragStart()
onDragStart($code) : \\Hazaar\\Widgets\\Docking

This event is triggered when the user start to drag any window.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

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

Sets or gets docking’s orientation. This property is setting whether the panels are going to be side by side or below each other.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Docking
panelsRoundedCorners()
panelsRoundedCorners($value) : \\Hazaar\\Widgets\\Docking

Set or gets whether the panels of the docking are going to be with rounded corners.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Docking
pinWindow()
pinWindow($window) : \\Hazaar\\Widgets\\Docking

Pinning a specific window

Tags

Since

1.1

Parameters

$window

No description

Returns

\\Hazaar\\Widgets\\Docking
setWindowMode()
setWindowMode($window, $mode) : \\Hazaar\\Widgets\\Docking

Setting mode to a specific window. This method accepts two arguments – window id and mode type.

Tags

Since

1.1

Parameters

$window

No description

$mode

No description

Returns

\\Hazaar\\Widgets\\Docking
setWindowPosition()
setWindowPosition($window, $x, $y) : \\Hazaar\\Widgets\\Docking

Moving window in floating mode to a specific position.

Tags

Since

1.1

Parameters

$window

No description

$x

No description

$y

No description

Returns

\\Hazaar\\Widgets\\Docking
showAllCloseButtons()
showAllCloseButtons() : \\Hazaar\\Widgets\\Docking

Showing the close buttons of all windows.

Tags

Since

1.1

showAllCollapseButtons()
showAllCollapseButtons() : \\Hazaar\\Widgets\\Docking

Showing the collapse buttons of all windows.

Tags

Since

1.1

showCloseButton()
showCloseButton($window) : \\Hazaar\\Widgets\\Docking

Showing the close button of a specific window.

Tags

Since

1.1

Parameters

$window

No description

Returns

\\Hazaar\\Widgets\\Docking
showCollapseButton()
showCollapseButton($window) : \\Hazaar\\Widgets\\Docking

Showing the collapse button of a specific window.

Tags

Since

1.1

Parameters

$window

No description

Returns

\\Hazaar\\Widgets\\Docking
unpinWindow()
unpinWindow($window) : \\Hazaar\\Widgets\\Docking

Unpinning a specific window

Tags

Since

1.1

Parameters

$window

No description

Returns

\\Hazaar\\Widgets\\Docking
windowsMode()
windowsMode($value) : \\Hazaar\\Widgets\\Docking

Sets ot gets specific mode for each window. The value of the property is object with keys – window’s ids and values – specific modes.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Docking
windowsOffset()
windowsOffset($value) : \\Hazaar\\Widgets\\Docking

Sets or gets the offset between the windows.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Docking