JHtmlBehavior

class JHtmlBehavior

Utility class for JavaScript behaviors

Methods

static  void
framework( boolean $extras = false, mixed $debug = null)

Method to load the MooTools framework into the document head

static  void
core()

Method to load core.js into the document head.

static  void
caption( string $selector = 'img.caption')

Add unobtrusive JavaScript support for image captions.

static  void
formvalidation()

Add unobtrusive JavaScript support for form validation.

static  void
formvalidator()

Add unobtrusive JavaScript support for form validation.

static  void
switcher()

Add unobtrusive JavaScript support for submenu switcher support

static  void
combobox()

Add unobtrusive JavaScript support for a combobox effect.

static  void
tooltip( string $selector = '.hasTip', array $params = array())

Add unobtrusive JavaScript support for a hover tooltips.

static  void
modal( string $selector = 'a.modal', array $params = array())

Add unobtrusive JavaScript support for modal links.

static  void
multiselect( string $id = 'adminForm')

JavaScript behavior to allow shift select in grids

static  void
tree( string $id, array $params = array(), array $root = array())

Add unobtrusive javascript support for a collapsible tree.

static  void
calendar()

Add unobtrusive JavaScript support for a calendar control.

static  void
colorpicker()

Add unobtrusive JavaScript support for a color picker.

static  void
simplecolorpicker()

Add unobtrusive JavaScript support for a simple color picker.

static  void
keepalive()

Keep session alive, for example, while editing or creating an article.

static  void
highlighter( array $terms, string $start = 'highlighter-start', string $end = 'highlighter-end', string $className = 'highlight', string $tag = 'span')

Highlight some words via Javascript.

static  void
noframes()

Break us out of any containing iframes

static  void
tabstate()

Add unobtrusive JavaScript support to keep a tab state.

static  void
polyfill( string|array $polyfillTypes = null, string $conditionalBrowser = null)

Add javascript polyfills.

Details

static void framework( boolean $extras = false, mixed $debug = null)

Method to load the MooTools framework into the document head

If debugging mode is on an uncompressed version of MooTools is included for easier debugging.

Parameters

boolean $extras Flag to determine whether to load MooTools More in addition to Core
mixed $debug Is debugging mode on? [optional]

Return Value

void

static void core()

Method to load core.js into the document head.

Core.js defines the 'Joomla' namespace and contains functions which are used across extensions

Return Value

void

static void caption( string $selector = 'img.caption')

Add unobtrusive JavaScript support for image captions.

Parameters

string $selector The selector for which a caption behaviour is to be applied.

Return Value

void

static void formvalidation()

Add unobtrusive JavaScript support for form validation.

To enable form validation the form tag must have class="form-validate". Each field that needs to be validated needs to have class="validate". Additional handlers can be added to the handler for username, password, numeric and email. To use these add class="validate-email" and so on.

Return Value

void

static void formvalidator()

Add unobtrusive JavaScript support for form validation.

To enable form validation the form tag must have class="form-validate". Each field that needs to be validated needs to have class="validate". Additional handlers can be added to the handler for username, password, numeric and email. To use these add class="validate-email" and so on.

Return Value

void

static void switcher()

Add unobtrusive JavaScript support for submenu switcher support

Return Value

void

static void combobox()

Add unobtrusive JavaScript support for a combobox effect.

Note that this control is only reliable in absolutely positioned elements. Avoid using a combobox in a slider or dynamic pane.

Return Value

void

static void tooltip( string $selector = '.hasTip', array $params = array())

Add unobtrusive JavaScript support for a hover tooltips.

Add a title attribute to any element in the form title="title::text"

Uses the core Tips class in MooTools.

Parameters

string $selector The class selector for the tooltip.
array $params An array of options for the tooltip. Options for the tooltip can be: - maxTitleChars integer The maximum number of characters in the tooltip title (defaults to 50). - offsets object The distance of your tooltip from the mouse (defaults to {'x': 16, 'y': 16}). - showDelay integer The millisecond delay the show event is fired (defaults to 100). - hideDelay integer The millisecond delay the hide hide is fired (defaults to 100). - className string The className your tooltip container will get. - fixed boolean If set to true, the toolTip will not follow the mouse. - onShow function The default function for the show event, passes the tip element and the currently hovered element. - onHide function The default function for the hide event, passes the currently hovered element.

Return Value

void

static void modal( string $selector = 'a.modal', array $params = array())

Add unobtrusive JavaScript support for modal links.

Parameters

string $selector The selector for which a modal behaviour is to be applied.
array $params An array of parameters for the modal behaviour. Options for the modal behaviour can be: - ajaxOptions - size - shadow - overlay - onOpen - onClose - onUpdate - onResize - onShow - onHide

Return Value

void

static void multiselect( string $id = 'adminForm')

JavaScript behavior to allow shift select in grids

Parameters

string $id The id of the form for which a multiselect behaviour is to be applied.

Return Value

void

static void tree( string $id, array $params = array(), array $root = array())

Add unobtrusive javascript support for a collapsible tree.

Parameters

string $id An index
array $params An array of options.
array $root The root node

Return Value

void

static void calendar()

Add unobtrusive JavaScript support for a calendar control.

Return Value

void

static void colorpicker()

Add unobtrusive JavaScript support for a color picker.

Return Value

void

static void simplecolorpicker()

Add unobtrusive JavaScript support for a simple color picker.

Return Value

void

static void keepalive()

Keep session alive, for example, while editing or creating an article.

Return Value

void

static void highlighter( array $terms, string $start = 'highlighter-start', string $end = 'highlighter-end', string $className = 'highlight', string $tag = 'span')

Highlight some words via Javascript.

Parameters

array $terms Array of words that should be highlighted.
string $start ID of the element that marks the begin of the section in which words should be highlighted. Note this element will be removed from the DOM.
string $end ID of the element that end this section. Note this element will be removed from the DOM.
string $className Class name of the element highlights are wrapped in.
string $tag Tag that will be used to wrap the highlighted words.

Return Value

void

static void noframes()

Break us out of any containing iframes

Return Value

void

static void tabstate()

Add unobtrusive JavaScript support to keep a tab state.

Note that keeping tab state only works for inner tabs if in accordance with the following example:

parent tab = permissions child tab = permission-<identifier>

Each tab header <a> tag also should have a unique href attribute

Return Value

void

static void polyfill( string|array $polyfillTypes = null, string $conditionalBrowser = null)

Add javascript polyfills.

Parameters

string|array $polyfillTypes The polyfill type(s). Examples: event, array('event', 'classlist').
string $conditionalBrowser An IE conditional expression. Example: lt IE 9 (lower than IE 9).

Return Value

void