X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/d41dc04ad17d1d9125fb2cf72db2b4782dbe3a8c..05ce1c11e98b33f14ddee184493bd5a60dc947e2:/docs/output/Ext.QuickTips.html diff --git a/docs/output/Ext.QuickTips.html b/docs/output/Ext.QuickTips.html index b7cb83db..9811398f 100644 --- a/docs/output/Ext.QuickTips.html +++ b/docs/output/Ext.QuickTips.html @@ -1,254 +1,78 @@ -
-
- Properties - Methods - Events - Direct Link -
-

Class Ext.QuickTips

- - - - - -
Package:Ext
Defined In:QuickTips.js
Class:QuickTips
Extends:Object
-
- * -

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

-

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

-

The singleton's instance of Ext.QuickTip is available via -getQuickTip, and supports all the methods, and all the all the -configuration properties of Ext.QuickTip. These settings will apply to all -tooltips shown by the singleton.

-

Below is the summary of the configuration properties which can be used. -For detailed descriptions see getQuickTip

-

QuickTips singleton configs (all are optional)

-
  • dismissDelay
    • -
  • hideDelay
    • -
  • maxWidth
    • -
  • minWidth
    • -
  • showDelay
    • -
  • trackMouse
-

Target element configs (optional unless otherwise noted)

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

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

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

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

- -

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

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


This class is a singleton and cannot be created directly.
- -
- -

Public Properties

-
This class has no public properties.
-

Public Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
MethodDefined By
- -

Public Events

-
This class has no public events.
-
\ No newline at end of file +
Properties Methods Events Direct Link

Class Ext.QuickTips

Package:Ext
Defined In:QuickTips.js
Class:QuickTips
Extends:Object

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

+

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

+

The singleton's instance of Ext.QuickTip is available via +getQuickTip, and supports all the methods, and all the all the +configuration properties of Ext.QuickTip. These settings will apply to all +tooltips shown by the singleton.

+

Below is the summary of the configuration properties which can be used. +For detailed descriptions see getQuickTip

+

QuickTips singleton configs (all are optional)

+
  • dismissDelay
    • +
  • hideDelay
    • +
  • maxWidth
    • +
  • minWidth
    • +
  • showDelay
    • +
  • trackMouse
+

Target element configs (optional unless otherwise noted)

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

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

+
// Init the singleton.  Any tag-based quick tips will start working.

+Ext.QuickTips.init();
+
+// Apply a set of config properties to the singleton

+Ext.apply(Ext.QuickTips.getQuickTip(), {
+    maxWidth: 200,
+    minWidth: 100,
+    showDelay: 50,
+    trackMouse: true
+});
+
+// Manually register a quick tip for a specific element

+Ext.QuickTips.register({
+    target: 'my-div',
+    title: 'My Tooltip',
+    text: 'This tooltip was added in code',
+    width: 100,
+    dismissDelay: 20
+});
+

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

+ +

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

+
// Add a quick tip to an HTML button

+<input type="button" value="OK" ext:qtitle="OK Button" ext:qwidth="100"
+     ext:qtip="This is a quick tip from markup!"></input>


This class is a singleton and cannot be created directly.

Public Properties

This class has no public properties.

Public Methods

MethodDefined By

Public Events

This class has no public events.
\ No newline at end of file