/* This file is part of Ext JS 3.4 Copyright (c) 2011-2013 Sencha Inc Contact: http://www.sencha.com/contact GNU General Public License Usage This file may be used under the terms of the GNU General Public License version 3.0 as published by the Free Software Foundation and appearing in the file LICENSE included in the packaging of this file. Please review the following information to ensure the GNU General Public License version 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html. If you are unsure which license is appropriate for your use, please contact the sales department at http://www.sencha.com/contact. Build date: 2013-04-03 15:07:25 */ Ext.data.JsonP.Ext_QuickTips({"alternateClassNames":[],"aliases":{},"enum":null,"parentMixins":[],"tagname":"class","subclasses":[],"extends":null,"uses":[],"html":"

Files

Provides attractive and customizable tooltips for any element. The QuickTips\nsingleton is used to configure and manage tooltips globally for multiple elements\nin a generic manner. To create individual tooltips with maximum customizability,\nyou should consider either Ext.Tip or Ext.ToolTip.

\n\n\n

Quicktips can be configured via tag attributes directly in markup, or by\nregistering quick tips programmatically via the register method.

\n\n\n

The singleton's instance of Ext.QuickTip is available via\ngetQuickTip, and supports all the methods, and all the all the\nconfiguration properties of Ext.QuickTip. These settings will apply to all\ntooltips shown by the singleton.

\n\n\n

Below is the summary of the configuration properties which can be used.\nFor detailed descriptions see the config options for the QuickTip class

\n\n\n

QuickTips singleton configs (all are optional)

\n\n\n
  • dismissDelay
  • \n
  • hideDelay
  • \n
  • maxWidth
  • \n
  • minWidth
  • \n
  • showDelay
  • \n
  • trackMouse
\n\n\n

Target element configs (optional unless otherwise noted)

\n\n\n
  • autoHide
  • \n
  • cls
  • \n
  • dismissDelay (overrides singleton value)
  • \n
  • target (required)
  • \n
  • text (required)
  • \n
  • title
  • \n
  • width
\n\n\n

Here is an example showing how some of these config options could be used:

\n\n\n
// Init the singleton.  Any tag-based quick tips will start working.\nExt.QuickTips.init();\n\n// Apply a set of config properties to the singleton\nExt.apply(Ext.QuickTips.getQuickTip(), {\n    maxWidth: 200,\n    minWidth: 100,\n    showDelay: 50,      // Show 50ms after entering target\n    trackMouse: true\n});\n\n// Manually register a quick tip for a specific element\nExt.QuickTips.register({\n    target: 'my-div',\n    title: 'My Tooltip',\n    text: 'This tooltip was added in code',\n    width: 100,\n    dismissDelay: 10000 // Hide after 10 seconds hover\n});\n
\n\n\n

To register a quick tip in markup, you simply add one or more of the valid QuickTip attributes prefixed with\nthe ext: namespace. The HTML element itself is automatically set as the quick tip target. Here is the summary\nof supported attributes (optional unless otherwise noted):

\n\n\n\n\n\n

Here is an example of configuring an HTML element to display a tooltip from markup:

\n\n\n
// Add a quick tip to an HTML button\n<input type=\"button\" value=\"OK\" ext:qtitle=\"OK Button\" ext:qwidth=\"100\"\n     ext:qtip=\"This is a quick tip from markup!\"></input>\n
\n\n
Defined By

Methods

Ext.QuickTips
view source
( )
Disable quick tips globally. ...

Disable quick tips globally.

\n
Ext.QuickTips
view source
( )
Enable quick tips globally. ...

Enable quick tips globally.

\n
Gets the single QuickTip instance used to show tips from all registered elements. ...

Gets the single QuickTip instance used to show tips from all registered elements.

\n

Returns

Ext.QuickTips
view source
( autoRender )
Initialize the global QuickTips instance and prepare any quick tips. ...

Initialize the global QuickTips instance and prepare any quick tips.

\n

Parameters

  • autoRender : Boolean

    True to render the QuickTips container immediately to preload images. (Defaults to true)

    \n
Ext.QuickTips
view source
( ) : Boolean
Returns true if quick tips are enabled, else false. ...

Returns true if quick tips are enabled, else false.

\n

Returns

  • Boolean
    \n
Ext.QuickTips
view source
( config )
Configures a new quick tip instance and assigns it to a target element. ...

Configures a new quick tip instance and assigns it to a target element. See\nExt.QuickTip.register for details.

\n

Parameters

  • config : Object

    The config object

    \n
Ext.QuickTips
view source
( config )
Alias of register. ...

Alias of register.

\n

Parameters

  • config : Object

    The config object

    \n
Ext.QuickTips
view source
( el )
Removes any registered quick tip from the target element and destroys it. ...

Removes any registered quick tip from the target element and destroys it.

\n

Parameters

  • el : String/HTMLElement/Element

    The element from which the quick tip is to be removed.

    \n
","superclasses":[],"meta":{},"requires":[],"html_meta":{},"statics":{"property":[],"cfg":[],"css_var":[],"method":[],"event":[],"css_mixin":[]},"files":[{"href":"QuickTips.html#Ext-QuickTips","filename":"QuickTips.js"}],"linenr":1,"members":{"property":[],"cfg":[],"css_var":[],"method":[{"tagname":"method","owner":"Ext.QuickTips","meta":{},"name":"disable","id":"method-disable"},{"tagname":"method","owner":"Ext.QuickTips","meta":{},"name":"enable","id":"method-enable"},{"tagname":"method","owner":"Ext.QuickTips","meta":{},"name":"getQuickTip","id":"method-getQuickTip"},{"tagname":"method","owner":"Ext.QuickTips","meta":{},"name":"init","id":"method-init"},{"tagname":"method","owner":"Ext.QuickTips","meta":{},"name":"isEnabled","id":"method-isEnabled"},{"tagname":"method","owner":"Ext.QuickTips","meta":{},"name":"register","id":"method-register"},{"tagname":"method","owner":"Ext.QuickTips","meta":{},"name":"tips","id":"method-tips"},{"tagname":"method","owner":"Ext.QuickTips","meta":{},"name":"unregister","id":"method-unregister"}],"event":[],"css_mixin":[]},"inheritable":null,"private":null,"component":false,"name":"Ext.QuickTips","singleton":true,"override":null,"inheritdoc":null,"id":"class-Ext.QuickTips","mixins":[],"mixedInto":[]});