\Hazaar\View\Widgets
Expander

Expander widget.

Tags

Since

1.1

Summary
Methods Properties Constants
No constants
Properties
$content
$content
Inherited
$name
$name
Inherited
$script
$script
Methods
__construct()
__construct($name, $title = null, $content = null, $params = Array ( ) )

Initialise an Expander widget

Parameters

$namestring

The name (ID) of the widget to create.

$title

No description

$contentmixed

The initial value of the input.

$paramsarray

Optional additional parameters

animationType()
animationType($value) : \\Hazaar\\Widgets\\Expander

Sets or gets the animation type.

Possible Values:

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

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

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

Sets or gets header’s arrow position.

Possible Values:

  • ‘left’
  • ‘right’

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\Expander
collapse()
collapse() : string

Method which is collapsing the expander.

Tags

Since

1.1

Returns

string
collapseAnimationDuration()
collapseAnimationDuration($value) : \\Hazaar\\Widgets\\Expander

Sets or gets the collapsing animation duration.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

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

This method is enabling the expander.

Tags

Since

1.1

Returns

string
expand()
expand() : string

Method used for expanding the expander’s content.

Tags

Since

1.1

Returns

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

Sets or gets the expanding animation duration.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\Expander
expanded()
expanded($value) : \\Hazaar\\Widgets\\Expander

Sets or gets expander’s state (collapsed or expanded).

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Expander
getContent()
getContent() : string

Getting expander’s content. Returns a string with the content’s HTML.

Tags

Since

1.1

Returns

string
getHeaderContent()
getHeaderContent() : string

Getting expander’s header content. Returns a string with the header’s HTML.

Tags

Since

1.1

Returns

string
headerPosition()
headerPosition($value) : \\Hazaar\\Widgets\\Expander

Sets or gets header’s position.

Possible Values:

  • ‘top’
  • ‘bottom’

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\Expander
initContent()
initContent($value) : \\Hazaar\\Widgets\\Expander

Callback function called when the item’s content needs to be initialized. Useful for initializing other widgets within the content of jqxExpander.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\Expander
invalidate()
invalidate() : string

This method refreshes the expander.

Tags

Since

1.1

Returns

string
onCollapsed()
onCollapsed($code) : \\Hazaar\\Widgets\\Expander

This event is triggered when the jqxExpander is collapsed.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Expander
onCollapsing()
onCollapsing($code) : \\Hazaar\\Widgets\\Expander

This event is triggered when the jqxExpander is going to be collapsed.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Expander
onExpanded()
onExpanded($code) : \\Hazaar\\Widgets\\Expander

This event is triggered when the jqxExpander is expanded.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Expander
onExpanding()
onExpanding($code) : \\Hazaar\\Widgets\\Expander

This event is triggered when the jqxExpander is going to be expanded.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

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

This method refreshes the expander.

Tags

Since

1.1

Returns

string
render()
render() : string

This method renders the expander.

Tags

Since

1.1

Returns

string
setContent()
setContent($content) : string

This method is setting specific content to the expander.

Tags

Since

1.1

Parameters

$content

No description

Returns

string
setHeaderContent()
setHeaderContent($content) : string

This method is setting specific content to the expander’s header.

Tags

Since

1.1

Parameters

$content

No description

Returns

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

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\\Expander
toggleMode()
toggleMode($value) : \\Hazaar\\Widgets\\Expander

Sets or gets user interaction used for expanding or collapsing the content.

Possible Values:

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

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

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