Joomla! Platform 12.1

Download

Demo

Abstract Class JHtmlBehavior

Description
Description | Variables (details) | Methods (details)

Utility class for javascript behaviors

  • abstract:
  • since: 11.1

Located in /libraries/joomla/html/html/behavior.php (line 19) 

Abstract class JHtmlBehavior   (Subpackage HTML)
Variable Summary
Description | Variables (details) | Methods (details)
Static variable static array $loaded
Method Summary
Description | Variables (details) | Methods (details)
Static method static void calendar ()
Static method static void caption ([string $selector = 'img.caption'])
Static method static void colorpicker ()
Static method static void combobox ()
Static method static void formvalidation ()
Static method static void framework ([string $extras = false], [mixed $debug = null])
Static method static void highlighter ( $terms, [string $start = 'highlighter-start'], [string $end = 'highlighter-end'], [string $className = 'highlight'], [string $tag = 'span'])
Static method static void keepalive ()
Static method static void modal ([string $selector = 'a.modal'], [array $params = array()])
Static method static void multiselect ([string $id = 'adminForm'])
Static method static void noframes ()
Static method static void switcher ()
Static method static void tooltip ([string $selector = '.hasTip'], [array $params = array()])
Static method static void tree (string $id, [array $params = array()], [array $root = array()])
Static method static void uploader ([string $id = 'file-upload'], [array $params = array()], [string $upload_queue = 'upload-queue'])
Static method static string _calendartranslation ()
Static method static string _getJSObject ([array $array = array()])
Variables
Description | Variables (details) | Methods (details)
array $loaded = array() (line 24)
  • var: array containing information for loaded files
  • access: protected
Methods
Description | Variables (details) Methods (details)
calendar (line 612)

Add unobtrusive javascript support for a calendar control.

  • since: 11.1
  • access: public
void calendar ()
caption (line 76)

Add unobtrusive javascript support for image captions.

  • since: 11.1
  • access: public
void caption ([string $selector = 'img.caption'])
  • string $selector: The selector for which a caption behaviour is to be applied.
colorpicker (line 642)

Add unobtrusive javascript support for a color picker.

  • since: 11.2
  • access: public
void colorpicker ()
combobox (line 172)

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.

  • since: 11.1
  • access: public
void combobox ()
formvalidation (line 112)

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.

  • since: 11.1
  • access: public
void formvalidation ()
framework (line 38)

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.

  • since: 11.1
  • access: public
void framework ([string $extras = false], [mixed $debug = null])
  • string $extras: MooTools file to load
  • mixed $debug: Is debugging mode on? [optional]
highlighter (line 746)

Highlight some words via Javascript.

  • since: 11.4
  • access: public
void highlighter ( $terms, [string $start = 'highlighter-start'], [string $end = 'highlighter-end'], [string $className = 'highlight'], [string $tag = 'span'])
  • 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.
keepalive (line 693)

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

  • since: 11.1
  • access: public
void keepalive ()
modal (line 279)

Add unobtrusive javascript support for modal links.

  • since: 11.1
  • access: public
void modal ([string $selector = 'a.modal'], [array $params = array()])
  • 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
multiselect (line 350)

JavaScript behavior to allow shift select in grids

  • since: 11.1
  • access: public
void multiselect ([string $id = 'adminForm'])
  • string $id: The id of the form for which a multiselect behaviour is to be applied.
noframes (line 790)

Break us out of any containing iframes

  • since: 11.1
  • access: public
void noframes ()
switcher (line 135)

Add unobtrusive javascript support for submenu switcher support in Global Configuration and System Information.

  • since: 11.1
  • access: public
void switcher ()
tooltip (line 212)

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.

  • since: 11.1
  • access: public
void tooltip ([string $selector = '.hasTip'], [array $params = array()])
  • 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.
tree (line 552)

Add unobtrusive javascript support for a collapsible tree.

  • since: 11.1
  • access: public
void tree (string $id, [array $params = array()], [array $root = array()])
  • string $id: An index
  • array $params: An array of options.
  • array $root: The root node
uploader (line 386)

Add unobtrusive javascript support for the advanced uploader.

  • since: 11.1
  • access: public
void uploader ([string $id = 'file-upload'], [array $params = array()], [string $upload_queue = 'upload-queue'])
  • string $id: An index.
  • array $params: An array of options for the uploader.
  • string $upload_queue: The HTML id of the upload queue element (??).
_calendartranslation (line 883)

Internal method to translate the JavaScript Calendar

  • return: JavaScript that translates the object
  • since: 11.1
  • access: protected
string _calendartranslation ()
_getJSObject (line 821)

Internal method to get a JavaScript object notation string from an array

  • return: JavaScript object notation representation of the array
  • since: 11.1
  • access: protected
string _getJSObject ([array $array = array()])
  • array $array: The array to convert to JavaScript object notation
Support Joomla!
/html>