1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.QuickTips</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.QuickTips-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.QuickTips-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.QuickTips-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.QuickTips-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <!-- ============================== class title / details ============================ -->
48 <h1 class="classTitle">
53 <table cellspacing="0" class="class-summary-table">
55 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
57 <tr><td class="label">Defined In:</td><td class="hd-info">
59 <a href="./src/Roo_QuickTips.js.html">Roo/QuickTips.js</a>.
62 <tr><td class="label">Class:</td><td class="hd-info">QuickTips</td></tr>
70 <!-- ============================== class summary ========================== -->
71 <div class="description">
72 Provides attractive and customizable tooltips for any element.
76 <!-- ============================== Class comment block... ========================== -->
78 <div class="comments">
79 <b>Class Comments / Notes</B> =>
80 <u onclick="parent.CommentDialog.showCommentId = 'Roo.QuickTips';">[Add Your comment/notes about this class]</u>
82 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
83 src="/blog.php/GtkDjsComments/Roo.QuickTips.html"></iframe>
88 <!-- ============================== config options ========================== -->
93 <div class="hr"></div>
94 <a id="Roo.QuickTips-configs"></a>
98 <table cellspacing="0" class="member-table">
99 <caption class="Empty">Config Options - Has None</caption>
113 <!-- ============================== public properties ==================== -->
117 <a id="Roo.QuickTips-props"></a>
123 <table cellspacing="0" class="member-table">
124 <caption class="Empty">Public Properties - Has None</caption>
130 <!-- ============================== methods summary / details ======================== -->
133 <a id="Roo.QuickTips-methods"></a>
134 <!-- constructor?? -->
141 <!-- then dynamics first -->
148 <table cellspacing="0" class="member-table">
149 <caption>Public Methods</caption>
151 <th class="sig-header" colspan="2">Method</th>
152 <th class="msource-header">Defined By</th>
162 <tr class="method-row config-row-alt0 expandable notInherited">
163 <td class="micon"><a class="exi" href="#expand"> </a></td>
167 <a id="Roo.QuickTips-method-disable" name=".disable"></a>
168 <div class="fixedFont">
169 <span class="attributes">Roo.QuickTips.</span><b class="itemname">disable</b>
178 <div class="short">Disable this quick tip.</div>
184 Disable this quick tip.
213 <tr class="method-row config-row-alt1 expandable notInherited">
214 <td class="micon"><a class="exi" href="#expand"> </a></td>
218 <a id="Roo.QuickTips-method-enable" name=".enable"></a>
219 <div class="fixedFont">
220 <span class="attributes">Roo.QuickTips.</span><b class="itemname">enable</b>
229 <div class="short">Enable this quick tip.</div>
235 Enable this quick tip.
264 <tr class="method-row config-row-alt0 expandable notInherited">
265 <td class="micon"><a class="exi" href="#expand"> </a></td>
269 <a id="Roo.QuickTips-method-init" name=".init"></a>
270 <div class="fixedFont">
271 <span class="attributes">Roo.QuickTips.</span><b class="itemname">init</b>
280 <div class="short">Initialize and enable QuickTips for first use.</div>
286 Initialize and enable QuickTips for first use. This should be called once before the first attempt to access<br/>or display QuickTips in a page.
315 <tr class="method-row config-row-alt1 expandable notInherited">
316 <td class="micon"><a class="exi" href="#expand"> </a></td>
320 <a id="Roo.QuickTips-method-isEnabled" name=".isEnabled"></a>
321 <div class="fixedFont">
322 <span class="attributes">Roo.QuickTips.</span><b class="itemname">isEnabled</b>
331 <div class="short">Returns true if the quick tip is enabled, else false.</div>
337 Returns true if the quick tip is enabled, else false.
366 <tr class="method-row config-row-alt0 expandable notInherited">
367 <td class="micon"><a class="exi" href="#expand"> </a></td>
371 <a id="Roo.QuickTips-method-register" name=".register"></a>
372 <div class="fixedFont">
373 <span class="attributes">Roo.QuickTips.</span><b class="itemname">register</b>
375 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
382 <div class="short">Configures a new quick tip instance and assigns it to a target element.</div>
388 Configures a new quick tip instance and assigns it to a target element. The following config options<br/>are supported:<br/><pre><br/>Property Type Description<br/>---------- --------------------- ------------------------------------------------------------------------<br/>target Element/String/Array An Element, id or array of ids that this quick tip should be tied to<br/></ul>
395 <dl class="detailList">
396 <dt class="heading">Parameters:</dt>
399 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
402 <dd>The config object</dd>
428 <tr class="method-row config-row-alt1 expandable notInherited">
429 <td class="micon"><a class="exi" href="#expand"> </a></td>
433 <a id="Roo.QuickTips-method-unregister" name=".unregister"></a>
434 <div class="fixedFont">
435 <span class="attributes">Roo.QuickTips.</span><b class="itemname">unregister</b>
437 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>)
444 <div class="short">Removes this quick tip from its element and destroys it.</div>
450 Removes this quick tip from its element and destroys it.
457 <dl class="detailList">
458 <dt class="heading">Parameters:</dt>
461 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
464 <dd>The element from which the quick tip is to be removed.</dd>
493 <!-- ============================== events summary / details ======================== -->
496 <a id="Roo.QuickTips-events"></a>
502 <table cellspacing="0" class="member-table">
503 <caption class="Empty">Events - Has None</caption>
514 <!-- ============================== footer ================================= -->
515 <div class="fineprint" style="clear:both">
517 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Tue Mar 15 2016 16:02:46 GMT+0800 (HKT)
519 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>