\Hazaar\View\Widgets
Menu

Menu widget.

Tags

Since

1.1

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

animationHideDelay()
animationHideDelay($value) : \\Hazaar\\Widgets\\Menu

Sets or gets the delay before the start of the hide animation.

Tags

Since

1.1

Parameters

$value

No description

Returns

\\Hazaar\\Widgets\\Menu
animationHideDuration()
animationHideDuration($value) : \\Hazaar\\Widgets\\Menu

Sets or gets the duration of the hide animation.

Tags

Since

1.1

Parameters

$value

No description

Returns

\\Hazaar\\Widgets\\Menu
animationShowDelay()
animationShowDelay($value) : \\Hazaar\\Widgets\\Menu

Sets or gets the delay before the start of the show animation.

Tags

Since

1.1

Parameters

$value

No description

Returns

\\Hazaar\\Widgets\\Menu
animationShowDuration()
animationShowDuration($value) : \\Hazaar\\Widgets\\Menu

Sets or gets the duration of the show animation.

Tags

Since

1.1

Parameters

$value

No description

Returns

\\Hazaar\\Widgets\\Menu
autoCloseInterval()
autoCloseInterval($value) : \\Hazaar\\Widgets\\Menu

Sets or gets the time interval after which all opened items will be closed. When you open a new sub menu, the interval is cleared. If you want to disable this automatic closing behavior of the jqxMenu, you need to set the autoCloseInterval property to 0.

Tags

Since

1.1

Parameters

$value

No description

Returns

\\Hazaar\\Widgets\\Menu
autoCloseOnClick()
autoCloseOnClick($value) : \\Hazaar\\Widgets\\Menu

Automatically closes the opened popups after a click.

Tags

Since

1.1

Parameters

$value

No description

Returns

\\Hazaar\\Widgets\\Menu
autoOpen()
autoOpen($value) : \\Hazaar\\Widgets\\Menu

Opens the top level menu items when the user hovers them.

Tags

Since

1.1

Parameters

$value

No description

Returns

\\Hazaar\\Widgets\\Menu
autoOpenPopup()
autoOpenPopup($value) : \\Hazaar\\Widgets\\Menu

Opens the Context Menu when the right-mouse button is pressed. When this property is set to false, the Open and Close functions can be used to open and close the Context Menu.

Tags

Since

1.1

Parameters

$value

No description

Returns

\\Hazaar\\Widgets\\Menu
autoSizeMainItems()
autoSizeMainItems($value) : \\Hazaar\\Widgets\\Menu

Auto-Sizes the jqxMenu’s main items when the menu’s mode is ‘horizontal’.

Tags

Since

1.1

Parameters

$value

No description

Returns

\\Hazaar\\Widgets\\Menu
clickToOpen()
clickToOpen($value) : \\Hazaar\\Widgets\\Menu

Opens an item after a click by the user.

Tags

Since

1.1

Parameters

$value

No description

Returns

\\Hazaar\\Widgets\\Menu
close()
close() : string

Closes the menu (only in context menu mode).

Tags

Since

1.1

Returns

string
closeItem()
closeItem($item_id) : string

Closes a menu item.

Tags

Since

1.1

Parameters

$item_id

No description

Returns

string
easing()
easing($value) : \\Hazaar\\Widgets\\Menu

Sets or gets the animation’s easing to one of the JQuery’s supported easings.

Tags

Since

1.1

Parameters

$value

No description

Returns

\\Hazaar\\Widgets\\Menu
enableHover()
enableHover($value) : \\Hazaar\\Widgets\\Menu

Enables or disables the hover state.

Tags

Since

1.1

Parameters

$value

No description

Returns

\\Hazaar\\Widgets\\Menu
enableRoundedCorners()
enableRoundedCorners($value) : \\Hazaar\\Widgets\\Menu

Enables or disables the rounded corners. This setting has effectin browsers that support the ‘border-radius CSS setting.’

Tags

Since

1.1

Parameters

$value

No description

Returns

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

Sets or gets the menu’s display mode.

Possible Values:

  • ‘horizontal’
  • ‘vertical’
  • ‘popup’

Tags

Since

1.1

Parameters

$value

No description

Returns

\\Hazaar\\Widgets\\Menu
onClosed()
onClosed($code) : string

This event is triggered when any of the jqxMenu Sub Menus is closed.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered

Returns

string
onInitialized()
onInitialized($code) : string

This event is triggered after the menu is initialized.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered

Returns

string
onItemclick()
onItemclick($code) : string

This event is triggered when a menu item is clicked.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered

Returns

string
onShown()
onShown($code) : string

This event is triggered when any of the jqxMenu Sub Menus is displayed.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered

Returns

string
open()
open($left, $top) : string

Opens the menu(only in context menu mode).

Tags

Since

1.1

Parameters

$left

No description

$top

No description

Returns

string
openItem()
openItem($item_id) : string

Opens a menu item

Tags

Since

1.1

Parameters

$item_id

No description

Returns

string
setItemOpenDirection()
setItemOpenDirection($value) : string

Sets the item’s popup open direction

Tags

Since

1.1

Parameters

$value

No description

Returns

string
source()
source($source) : Hazaar\\jqWidgets\\Input

Sets the widget’s data source. This can be either an array or a datasource. Either way, the resulting array data can have the following fields:

  • id – A DOM id to set on the item. This will be accessible in events as event.args.id.
  • label – The label to set on the item. Overrides html.
  • html – The html to use for the item. Use this if you want more complex items rendered such as those with icons.

Example:

<code class="php">
array(
    array('id' => 'mail', 'html' => $this->fontawesome->icon('envelope') . ' ' .
$this->html->span('Email')),
    array('id' => 'calendar', 'label' => 'Calendar')
);
</code>

All fields are optional. Just keep in mind that without a label or html element, the text ‘Item’ will be displayed and without an ‘id’ field the id will be automatically generated and you may not end up knowing what item triggered an event.

Tags

Since

1.1

Parameters

$sourcemixed

The data source. Can be an array or a DataSource object.

Returns

\Hazaar\View\Widgets\Hazaar\\jqWidgets\\Input