\Hazaar\View\Widgets
Tooltip

Basic button widget.

Tags

Since

1.1

Summary
Methods Properties Constants
top
val
No constants
Properties
Inherited
$element
$element
Inherited
$name
$name
Inherited
$script
$script
Methods
__construct()
__construct($object, $value = null, $params = Array ( ) )

Initialise a button widget

Parameters

$object

No description

$value

No description

$params

No description

absolutePositionX()
absolutePositionX($value) : \\Hazaar\\Widgets\\Tooltip

Sets or gets the tooltip’s horizontal position if the position property is set to ‘absolute’.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Tooltip
absolutePositionY()
absolutePositionY($value) : \\Hazaar\\Widgets\\Tooltip

Sets or gets the tooltip’s vertical position if the position property is set to ‘absolute’.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

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

Sets or gets the duration of the tooltip animation at hide.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

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

Sets or gets the duration of the tooltip animation at show.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Tooltip
autoHide()
autoHide($value) : \\Hazaar\\Widgets\\Tooltip

Sets or gets whether the tooltip will automatically hide after duration equal to the autoHideDelay property.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Tooltip
autoHideDelay()
autoHideDelay($value) : \\Hazaar\\Widgets\\Tooltip

Sets or gets the duration after which the tooltip automatically hides (works only if the autoHide property is set to true).

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Tooltip
close()
close($value) : string

Specifies a time before the tooltip closes. If it is not set, the tooltip closes immediately.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

string
closeOnClick()
closeOnClick($value) : \\Hazaar\\Widgets\\Tooltip

Sets or gets whether the tooltip will close if it is clicked.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Tooltip
content()
content($value) : \\Hazaar\\Widgets\\Tooltip

Sets or gets the content of jqxTooltip. It can be either plain text or HTML code.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Tooltip
enableBrowserBoundsDetection()
enableBrowserBoundsDetection($value) : \\Hazaar\\Widgets\\Tooltip

Sets or gets whether jqxTooltip will be hidden if it leaves the browser bounds or will be offset so that it is always within the browser’s bounds and visible.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Tooltip
left()
left($value) : \\Hazaar\\Widgets\\Tooltip

Sets or gets the horizontal offset of jqxTooltip based on the position property.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Tooltip
onClose()
onClose($code) : \\Hazaar\\Widgets\\Tooltip

This event is triggered when the tooltip is closed (hidden).

Tags

Since

1.1

Parameters

$codestring

The JavaScript code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Tooltip
onOpen()
onOpen($code) : \\Hazaar\\Widgets\\Tooltip

This event is triggered when the tooltip is opened (shown).

Tags

Since

1.1

Parameters

$codestring

The JavaScript code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Tooltip
open()
open() : string

Opens the tooltip.

Tags

Since

1.1

Returns

string
position()
position($value) : \\Hazaar\\Widgets\\Tooltip

Sets or gets the position of jqxTooltip.

Possible Values:

  • ‘top’ – the tooltip shows above the host element
  • ‘bottom’ – the tooltip shows below the host element
  • ‘left’ – the tooltip shows at the left of the host element
  • ‘right’ – the tooltip shows at the right of the host element
  • ‘top-left’ – the tooltip shows at the top-left side of the host element
  • ‘bottom-left’ – the tooltip shows at the bottom-left side of the host element
  • ‘top-right’ – the tooltip shows at the top-right side of the host element
  • ‘bottom-right’ – the tooltip shows at the bottom-right side of the host element
  • ‘absolute’ – the tooltip shows at an absolute position on screen, defined by the coordinate properties absolutePositionX and absolutePositionY
  • ‘mouse’ – the tooltip shows after a short period of time at the position of the mouse cursor
  • ‘mouseenter’ – the tooltip shows where the mouse cursor has entered the host element
  • ‘default’ – the tooltip shows at the bottom-right side of the host element but does not make use of the left and top properties

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Tooltip
showArrow()
showArrow($value) : \\Hazaar\\Widgets\\Tooltip

Sets or gets whether the tooltip’s arrow will be shown.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Tooltip
showDelay()
showDelay($value) : \\Hazaar\\Widgets\\Tooltip

Sets or gets the duration after which the tooltip will be shown if its trigger property is set to ‘focus’.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Tooltip
top()
top($value) : \\Hazaar\\Widgets\\Tooltip

Sets or gets the vertical offset of jqxTooltip based on the position property.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Tooltip
trigger()
trigger($value) : \\Hazaar\\Widgets\\Tooltip

Sets or gets the way of triggering the tooltip.

Possible Values:

  • ‘hover’ – the tooltip shows immeadiately after hovering over the host element.
  • ‘focus’ – the tooltip shows after duration equal to the showDelay property after hovering over the host element
  • ‘click’ – the tooltip shows when the host element is clicked

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

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