\Hazaar\View\Widgets
NavigationBar

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

addItem()
addItem($header, $content) : string

This method inserts an item at the bottom of the navigationbar. It has two parameters – header (the header of the new item) and content (the content of the new item).

Tags

Since

1.1

Parameters

$header

No description

$content

No description

Returns

string
animationType()
animationType($value) : \\Hazaar\\Widgets\\NavigationBar

Sets or gets the animation type.

Possible Values:

  • ‘slide’
  • ‘fade’
  • ‘none’

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\NavigationBar
arrowPosition()
arrowPosition($value) : \\Hazaar\\Widgets\\NavigationBar

Sets or gets header’s arrow position.

Possible Values:

  • ‘left’
  • ‘right’

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\NavigationBar
collapseAnimationDuration()
collapseAnimationDuration($value) : \\Hazaar\\Widgets\\NavigationBar

Sets or gets the collapsing animation duration.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\NavigationBar
collapseAt()
collapseAt($index) : string

Collapsing item with any index.

Tags

Since

1.1

Parameters

$index

No description

Returns

string
disableAt()
disableAt($index) : string

Disabling item with any index.

Tags

Since

1.1

Parameters

$index

No description

Returns

string
enableAt()
enableAt($index) : string

Enabling item with any index.

Tags

Since

1.1

Parameters

$index

No description

Returns

string
expandAnimationDuration()
expandAnimationDuration($value) : \\Hazaar\\Widgets\\NavigationBar

Sets or gets the expanding animation duration.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\NavigationBar
expandAt()
expandAt($index) : string

Expanding item with any index.

Tags

Since

1.1

Parameters

$index

No description

Returns

string
expandMode()
expandMode($value) : \\Hazaar\\Widgets\\NavigationBar

Sets or gets navigation bar’s expand mode. Possible values [‘single’, ‘singleFitHeight’ ‘multiple’, ‘toggle’, ‘none’].

Possible Values:

  • ‘single’ – only one item can be expanded. If the expanded item’s height is greater than the value of the height property, a vertical scrollbar is shown.
  • ‘singleFitHeight’ – only one item can be expanded. If the expanded item’s height is greater than the value of the height property, a vertical scrollbar is shown inside the content of the expanded item
  • ‘multiple’ – multiple items can be expanded. If the expanded items’ height is greater than the value of the height property, a vertical scrollbar is shown.
  • ‘toggle’ – only one item can be expanded. The expanded item can also be collapsed.If the expanded item’s height is greater than the value of the height property, a vertical scrollbar is shown
  • ‘none’ – no items can be expanded/collapsed

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\NavigationBar
expandedIndexes()
expandedIndexes($value) : \\Hazaar\\Widgets\\NavigationBar

Sets or gets the expanded item(s). If the property expandMode is set to either ‘single’, ‘singleFitHeight’, ‘toggle’ or ‘none’, only the item corresponding to the first value in the array is expanded. If the property expandMode is set to either ‘single’ or ‘singleFitHeight’ and the expandedIndexes array is empty, the first item is expanded automatically.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\NavigationBar
getContentAt()
getContentAt($index) : string

Getting content of item with any index. Returns a string value.

Tags

Since

1.1

Parameters

$index

No description

Returns

string
getHeaderContentAt()
getHeaderContentAt($index) : string

Getting header content of item with any index. Returns a string value.

Tags

Since

1.1

Parameters

$index

No description

Returns

string
hideArrowAt()
hideArrowAt($index) : string

Hiding the arrow of an item with specific index.

Tags

Since

1.1

Parameters

$index

No description

Returns

string
initContent()
initContent($value) : \\Hazaar\\Widgets\\NavigationBar

Callback function called when an item’s content needs to be initialized. Useful for initializing other widgets within the content of any of the items of jqxNavigationBar. The index argument shows which item is initialized.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\NavigationBar
insert()
insert($header, $content) : string

This method inserts an item at a specific index. It has three parameters – index, header (the header of the new item) and content (the content of the new item).

Tags

Since

1.1

Parameters

$header

No description

$content

No description

Returns

string
invalidate()
invalidate() : string

This method refreshes the navigationbar.

Tags

Since

1.1

Returns

string
onCollapsedItem()
onCollapsedItem($code) : \\Hazaar\\Widgets\\NavigationBar

This event is triggered when a jqxNavigationBar item is collapsed.

Tags

Since

1.1

Parameters

$code

No description

Returns

\\Hazaar\\Widgets\\NavigationBar
onCollapsingItem()
onCollapsingItem($code) : \\Hazaar\\Widgets\\NavigationBar

This event is triggered when a jqxNavigationBar item is going to be collapsed.

Tags

Since

1.1

Parameters

$code

No description

Returns

\\Hazaar\\Widgets\\NavigationBar
onExpandedItem()
onExpandedItem($code) : \\Hazaar\\Widgets\\NavigationBar

This event is triggered when a jqxNavigationBar item is expanded.

Tags

Since

1.1

Parameters

$code

No description

Returns

\\Hazaar\\Widgets\\NavigationBar
onExpandingItem()
onExpandingItem($code) : \\Hazaar\\Widgets\\NavigationBar

This event is triggered when a jqxNavigationBar item is going to be expanded.

Tags

Since

1.1

Parameters

$code

No description

Returns

\\Hazaar\\Widgets\\NavigationBar
refresh()
refresh() : string

This method refreshes the navigationbar.

Tags

Since

1.1

Returns

string
render()
render() : string

This method renders the navigationbar.

Tags

Since

1.1

Returns

string
setContentAt()
setContentAt($index, $content) : string

Setting content to item with any index.

Tags

Since

1.1

Parameters

$index

No description

$content

No description

Returns

string
setHeaderContentAt()
setHeaderContentAt($index, $header) : string

Setting header content to item with any index

Tags

Since

1.1

Parameters

$index

No description

$header

No description

Returns

string
showArrow()
showArrow($value) : \\Hazaar\\Widgets\\NavigationBar

Sets or gets whether header’s arrow is going to be shown.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\NavigationBar
showArrowAt()
showArrowAt($index) : string

Showing the arrow of an item with specific index.

Tags

Since

1.1

Parameters

$index

No description

Returns

string
toggleMode()
toggleMode($value) : \\Hazaar\\Widgets\\NavigationBar

Sets or gets user interaction used for expanding or collapsing the content. Possible values [‘click’, ‘dblclick’, ‘none’].

Possible Values:

  • ‘click’
  • ‘dblclick’
  • ‘none’

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\NavigationBar
update()
update($index, $header = null, $content = null) : string

This method updates an item at a specific index. It has three parameters – index, header (the new header of the item) and content (the new content of the item).

Tags

Since

1.1

Parameters

$index

No description

$header

No description

$content

No description

Returns

string