X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/0494b8d9b9bb03ab6c22b34dae81261e3cd7e3e6..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/output/Ext.QuickTips.html diff --git a/docs/output/Ext.QuickTips.html b/docs/output/Ext.QuickTips.html deleted file mode 100644 index be3b8432..00000000 --- a/docs/output/Ext.QuickTips.html +++ /dev/null @@ -1,78 +0,0 @@ -
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 the config options for the QuickTip class
-QuickTips singleton configs (all are optional)
-Target element configs (optional unless otherwise noted)
-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, // Show 50ms after entering target
- 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: 10000 // Hide after 10 seconds hover
-});
-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>
Method | Defined By | |
---|---|---|
disable()
- :
- void Disable quick tips globally. Disable quick tips globally. Parameters:
| QuickTips | |
enable()
- :
- void Enable quick tips globally. Enable quick tips globally. Parameters:
| QuickTips | |
getQuickTip()
- :
- Ext.QuickTip 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. Parameters:
| QuickTips | |
init( Boolean autoRender )
- :
- voidInitialize the global QuickTips instance and prepare any quick tips. Initialize the global QuickTips instance and prepare any quick tips. Parameters:
| QuickTips | |
isEnabled()
- :
- Boolean Returns true if quick tips are enabled, else false. Returns true if quick tips are enabled, else false. Parameters:
| QuickTips | |
register( Object config )
- :
- voidConfigures a new quick tip instance and assigns it to a target element. See
-Ext.QuickTip.register for details. Configures a new quick tip instance and assigns it to a target element. See
-Ext.QuickTip.register for details. Parameters:
| QuickTips | |
tips( Object config )
- :
- voidAlias of register. Alias of register. Parameters:
| QuickTips | |
unregister( String/HTMLElement/Element el )
- :
- voidRemoves any registered quick tip from the target element and destroys it. Removes any registered quick tip from the target element and destroys it. Parameters:
| QuickTips |