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.ColorPalette</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.ColorPalette-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.ColorPalette-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.ColorPalette-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.ColorPalette-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 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
48 <img src="../../images/default/s.gif" height="1" width="40"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.ColorPalette
53 <!-- ============================== class title / details ============================ -->
56 <h1 class="classTitle">
58 Class Roo.ColorPalette
61 <table cellspacing="0" class="class-summary-table">
63 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
65 <tr><td class="label">Defined In:</td><td class="hd-info">
67 <a href="./src/Roo_ColorPalette.js.html">Roo/ColorPalette.js</a>.
70 <tr><td class="label">Class:</td><td class="hd-info">ColorPalette</td></tr>
75 <tr><td class="label">Extends:</td><td class="hd-info">
76 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
84 <!-- ============================== class summary ========================== -->
85 <div class="description">
86 Simple color palette class for choosing colors. The palette can be rendered to any container.<br /><br/>Here's an example of typical usage:<br/><pre><code><br/>var cp = new Roo.ColorPalette({value:'993300'}); // initial selected color<br/>cp.render('my-div');<br/><br/>cp.on('select', function(palette, selColor){<br/> // do something with selColor<br/>});<br/></code></pre>
90 <!-- ============================== Class comment block... ========================== -->
92 <div class="comments">
93 <b>Class Comments / Notes</B> =>
94 <u onclick="parent.CommentDialog.showCommentId = 'Roo.ColorPalette';">[Add Your comment/notes about this class]</u>
96 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
97 src="/blog.php/GtkDjsComments/Roo.ColorPalette.html"></iframe>
102 <!-- ============================== config options ========================== -->
107 <div class="hr"></div>
108 <a id="Roo.ColorPalette-configs"></a>
114 <table cellspacing="0" class="member-table">
115 <caption>Config Options (Usually are also Properties)</caption>
119 <th class="sig-header" colspan="2">Options</th>
121 <th class="msource-header">Defined By</th>
128 <tr class="config-row expandable config-row-alt0">
129 <td class="micon"><a class="exi" href="#expand"> </a></td>
132 <a id="Roo.Component-cfg-actionMode" name=".actionMode"></a>
133 <div class="fixedFont">
134 <b class="itemname">actionMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
140 <div class="short">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
145 which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'
155 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
161 <tr class="config-row expandable config-row-alt1">
162 <td class="micon"><a class="exi" href="#expand"> </a></td>
165 <a id="Roo.Component-cfg-allowDomMove" name=".allowDomMove"></a>
166 <div class="fixedFont">
167 <b class="itemname">allowDomMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
173 <div class="short">Whether the component can move the Dom node when rendering (defaults to true).</div>
178 Whether the component can move the Dom node when rendering (defaults to true).
188 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
194 <tr class="config-row expandable config-row-alt0 notInherited">
195 <td class="micon"><a class="exi" href="#expand"> </a></td>
198 <a id="Roo.ColorPalette-cfg-allowReselect" name=".allowReselect"></a>
199 <div class="fixedFont">
200 <b class="itemname">allowReselect</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
206 <div class="short">If set to true then reselecting a color that is already selected fires the selection event</div>
211 If set to true then reselecting a color that is already selected fires the selection event
227 <tr class="config-row expandable config-row-alt1">
228 <td class="micon"><a class="exi" href="#expand"> </a></td>
231 <a id="Roo.Component-cfg-disableClass" name=".disableClass"></a>
232 <div class="fixedFont">
233 <b class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
239 <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
244 CSS class added to the component when it is disabled (defaults to "x-item-disabled").
254 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
260 <tr class="config-row expandable config-row-alt0">
261 <td class="micon"><a class="exi" href="#expand"> </a></td>
264 <a id="Roo.Component-cfg-hideMode" name=".hideMode"></a>
265 <div class="fixedFont">
266 <b class="itemname">hideMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
272 <div class="short">How this component should hidden.</div>
277 How this component should hidden. Supported values are<br/>"visibility" (css visibility), "offsets" (negative offset position) and<br/>"display" (css display) - defaults to "display".
278 <BR/>Possible Values: display, visibility
287 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
293 <tr class="config-row expandable config-row-alt1 notInherited">
294 <td class="micon"><a class="exi" href="#expand"> </a></td>
297 <a id="Roo.ColorPalette-cfg-itemCls" name=".itemCls"></a>
298 <div class="fixedFont">
299 <b class="itemname">itemCls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
305 <div class="short">The CSS class to apply to the containing element (defaults to "x-color-palette")</div>
310 The CSS class to apply to the containing element (defaults to "x-color-palette")
326 <tr class="config-row expandable config-row-alt0">
327 <td class="micon"><a class="exi" href="#expand"> </a></td>
330 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
331 <div class="fixedFont">
332 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
338 <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> .</div>
343 list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> ..... <br/> } ,<br/> .... <br/> } <br/> </code></pre>
353 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
359 <tr class="config-row expandable config-row-alt1 notInherited">
360 <td class="micon"><a class="exi" href="#expand"> </a></td>
363 <a id="Roo.ColorPalette-cfg-value" name=".value"></a>
364 <div class="fixedFont">
365 <b class="itemname">value</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
371 <div class="short">The initial color to highlight (should be a valid 6-digit color hex code without the # symbol).</div>
376 The initial color to highlight (should be a valid 6-digit color hex code without the # symbol). Note that<br/>the hex codes are case-sensitive.
402 <!-- ============================== public properties ==================== -->
406 <a id="Roo.ColorPalette-props"></a>
412 <table cellspacing="0" class="member-table">
413 <caption class="Empty">Public Properties - Has None</caption>
419 <!-- ============================== methods summary / details ======================== -->
422 <a id="Roo.ColorPalette-methods"></a>
423 <!-- constructor?? -->
430 <!-- then dynamics first -->
437 <table cellspacing="0" class="member-table">
438 <caption>Public Methods</caption>
440 <th class="sig-header" colspan="2">Method</th>
441 <th class="msource-header">Defined By</th>
451 <tr class="method-row config-row-alt0 expandable notInherited">
452 <td class="micon"><a class="exi" href="#expand"> </a></td>
456 <a id="Roo-method-ColorPalette" name=".ColorPalette"></a>
457 <div class="fixedFont">
458 <span class="attributes">new <B>Roo.</B></span><b class="itemname">ColorPalette</b>
460 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
468 <div class="short">Create a new Roo.ColorPalette</div>
475 Create a new Roo.ColorPalette
478 <dl class="detailList">
479 <dt class="heading">Parameters:</dt>
482 <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>
485 <dd>The config object</dd>
509 <tr class="method-row config-row-alt1 expandable">
510 <td class="micon"><a class="exi" href="#expand"> </a></td>
514 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
515 <div class="fixedFont">
516 <span class="attributes"></span><b class="itemname">addEvents</b>
518 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
525 <div class="short">Used to define events on this Observable</div>
531 Used to define events on this Observable
538 <dl class="detailList">
539 <dt class="heading">Parameters:</dt>
542 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>object</b>
545 <dd>The object with the events defined</dd>
565 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
571 <tr class="method-row config-row-alt0 expandable">
572 <td class="micon"><a class="exi" href="#expand"> </a></td>
576 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
577 <div class="fixedFont">
578 <span class="attributes"></span><b class="itemname">addListener</b>
580 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
587 <div class="short">Appends an event handler to this component</div>
593 Appends an event handler to this component
600 <dl class="detailList">
601 <dt class="heading">Parameters:</dt>
604 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
607 <dd>The type of event to listen for</dd>
610 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
613 <dd>The method the event invokes</dd>
616 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
619 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
622 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
625 <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/> <pre><code><br/> el.on('click', this.onClick, this, {<br/> single: true,<br/> delay: 100,<br/> forumId: 4<br/> });<br/> </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/> el.on({<br/> 'click': {<br/> fn: this.onClick,<br/> scope: this,<br/> delay: 100<br/> }, <br/> 'mouseover': {<br/> fn: this.onMouseOver,<br/> scope: this<br/> },<br/> 'mouseout': {<br/> fn: this.onMouseOut,<br/> scope: this<br/> }<br/> });<br/> </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/> <pre><code><br/> el.on({<br/> 'click': this.onClick,<br/> 'mouseover': this.onMouseOver,<br/> 'mouseout': this.onMouseOut,<br/> scope: this<br/> });<br/> </code></pre></dd>
645 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
651 <tr class="method-row config-row-alt1 expandable">
652 <td class="micon"><a class="exi" href="#expand"> </a></td>
656 <a id="Roo.Component-method-destroy" name=".destroy"></a>
657 <div class="fixedFont">
658 <span class="attributes"></span><b class="itemname">destroy</b>
667 <div class="short">Destroys this component by purging any event listeners, removing the component's element from the DOM,<br/>removing the component from its {<b>link</b> Roo.Container} (if applicable) and unregistering it from {<b>link</b> Roo.ComponentMgr}.</div>
673 Destroys this component by purging any event listeners, removing the component's element from the DOM,<br/>removing the component from its {<b>link</b> Roo.Container} (if applicable) and unregistering it from {<b>link</b> Roo.ComponentMgr}.
696 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
702 <tr class="method-row config-row-alt0 expandable">
703 <td class="micon"><a class="exi" href="#expand"> </a></td>
707 <a id="Roo.Component-method-disable" name=".disable"></a>
708 <div class="fixedFont">
709 <span class="attributes"></span><b class="itemname">disable</b>
717 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
726 <div class="short">Disable this component.</div>
732 Disable this component.
743 <dl class="detailList">
744 <dt class="heading">Returns:</dt>
746 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
762 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
768 <tr class="method-row config-row-alt1 expandable">
769 <td class="micon"><a class="exi" href="#expand"> </a></td>
773 <a id="Roo.Component-method-enable" name=".enable"></a>
774 <div class="fixedFont">
775 <span class="attributes"></span><b class="itemname">enable</b>
783 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
792 <div class="short">Enable this component.</div>
798 Enable this component.
809 <dl class="detailList">
810 <dt class="heading">Returns:</dt>
812 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
828 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
834 <tr class="method-row config-row-alt0 expandable">
835 <td class="micon"><a class="exi" href="#expand"> </a></td>
839 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
840 <div class="fixedFont">
841 <span class="attributes"></span><b class="itemname">fireEvent</b>
843 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
849 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
858 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
864 Fires the specified event with the passed parameters (minus the event name).
871 <dl class="detailList">
872 <dt class="heading">Parameters:</dt>
875 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
881 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span> <b>args</b>
884 <dd>Variable number of parameters are passed to handlers</dd>
892 <dl class="detailList">
893 <dt class="heading">Returns:</dt>
895 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> returns false if any of the handlers return false otherwise it returns true</dd>
911 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
917 <tr class="method-row config-row-alt1 expandable">
918 <td class="micon"><a class="exi" href="#expand"> </a></td>
922 <a id="Roo.Component-method-focus" name=".focus"></a>
923 <div class="fixedFont">
924 <span class="attributes"></span><b class="itemname">focus</b>
926 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
932 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
941 <div class="short">Try to focus this component.</div>
947 Try to focus this component.
954 <dl class="detailList">
955 <dt class="heading">Parameters:</dt>
958 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>selectText</b>
961 <dd>True to also select the text in this component (if applicable)</dd>
969 <dl class="detailList">
970 <dt class="heading">Returns:</dt>
972 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
988 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
994 <tr class="method-row config-row-alt0 expandable">
995 <td class="micon"><a class="exi" href="#expand"> </a></td>
999 <a id="Roo.Component-method-getEl" name=".getEl"></a>
1000 <div class="fixedFont">
1001 <span class="attributes"></span><b class="itemname">getEl</b>
1009 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1018 <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
1024 Returns the underlying {<b>link</b> Roo.Element}.
1035 <dl class="detailList">
1036 <dt class="heading">Returns:</dt>
1038 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1052 <td class="msource">
1054 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1060 <tr class="method-row config-row-alt1 expandable">
1061 <td class="micon"><a class="exi" href="#expand"> </a></td>
1065 <a id="Roo.Component-method-getId" name=".getId"></a>
1066 <div class="fixedFont">
1067 <span class="attributes"></span><b class="itemname">getId</b>
1075 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1084 <div class="short">Returns the id of this component.</div>
1090 Returns the id of this component.
1101 <dl class="detailList">
1102 <dt class="heading">Returns:</dt>
1104 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1118 <td class="msource">
1120 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1126 <tr class="method-row config-row-alt0 expandable">
1127 <td class="micon"><a class="exi" href="#expand"> </a></td>
1131 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1132 <div class="fixedFont">
1133 <span class="attributes"></span><b class="itemname">hasListener</b>
1135 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1141 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1150 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1156 Checks to see if this object has any listeners for a specified event
1163 <dl class="detailList">
1164 <dt class="heading">Parameters:</dt>
1167 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1170 <dd>The name of the event to check for</dd>
1178 <dl class="detailList">
1179 <dt class="heading">Returns:</dt>
1181 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> True if the event is being listened for, else false</dd>
1195 <td class="msource">
1197 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1203 <tr class="method-row config-row-alt1 expandable">
1204 <td class="micon"><a class="exi" href="#expand"> </a></td>
1208 <a id="Roo.Component-method-hide" name=".hide"></a>
1209 <div class="fixedFont">
1210 <span class="attributes"></span><b class="itemname">hide</b>
1218 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1227 <div class="short">Hide this component.</div>
1233 Hide this component.
1244 <dl class="detailList">
1245 <dt class="heading">Returns:</dt>
1247 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1261 <td class="msource">
1263 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1269 <tr class="method-row config-row-alt0 expandable">
1270 <td class="micon"><a class="exi" href="#expand"> </a></td>
1274 <a id="Roo.Component-method-isVisible" name=".isVisible"></a>
1275 <div class="fixedFont">
1276 <span class="attributes"></span><b class="itemname">isVisible</b>
1285 <div class="short">Returns true if this component is visible.</div>
1291 Returns true if this component is visible.
1312 <td class="msource">
1314 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1320 <tr class="method-row config-row-alt1 expandable">
1321 <td class="micon"><a class="exi" href="#expand"> </a></td>
1325 <a id="Roo.util.Observable-method-on" name=".on"></a>
1326 <div class="fixedFont">
1327 <span class="attributes"></span><b class="itemname">on</b>
1329 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1336 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1342 Appends an event handler to this element (shorthand for addListener)
1349 <dl class="detailList">
1350 <dt class="heading">Parameters:</dt>
1353 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1356 <dd>The type of event to listen for</dd>
1359 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1362 <dd>The method the event invokes</dd>
1365 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1368 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1371 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
1392 <td class="msource">
1394 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1400 <tr class="method-row config-row-alt0 expandable">
1401 <td class="micon"><a class="exi" href="#expand"> </a></td>
1405 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1406 <div class="fixedFont">
1407 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1416 <div class="short">Removes all listeners for this object</div>
1422 Removes all listeners for this object
1443 <td class="msource">
1445 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1451 <tr class="method-row config-row-alt1 expandable">
1452 <td class="micon"><a class="exi" href="#expand"> </a></td>
1456 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1457 <div class="fixedFont">
1458 <span class="attributes"></span><b class="itemname">removeListener</b>
1460 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1467 <div class="short">Removes a listener</div>
1480 <dl class="detailList">
1481 <dt class="heading">Parameters:</dt>
1484 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1487 <dd>The type of event to listen for</dd>
1490 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1493 <dd>The handler to remove</dd>
1496 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1499 <dd>(optional) The scope (this object) for the handler</dd>
1517 <td class="msource">
1519 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1525 <tr class="method-row config-row-alt0 expandable">
1526 <td class="micon"><a class="exi" href="#expand"> </a></td>
1530 <a id="Roo.Component-method-render" name=".render"></a>
1531 <div class="fixedFont">
1532 <span class="attributes"></span><b class="itemname">render</b>
1534 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
1541 <div class="short">If this is a lazy rendering component, render it to its container element.</div>
1547 If this is a lazy rendering component, render it to its container element.
1554 <dl class="detailList">
1555 <dt class="heading">Parameters:</dt>
1558 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
1561 <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
1579 <td class="msource">
1581 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1587 <tr class="method-row config-row-alt1 expandable notInherited">
1588 <td class="micon"><a class="exi" href="#expand"> </a></td>
1592 <a id="Roo.ColorPalette-method-select" name=".select"></a>
1593 <div class="fixedFont">
1594 <span class="attributes"></span><b class="itemname">select</b>
1596 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>color</i></B>)
1603 <div class="short">Selects the specified color in the palette (fires the select event)</div>
1609 Selects the specified color in the palette (fires the select event)
1616 <dl class="detailList">
1617 <dt class="heading">Parameters:</dt>
1620 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>color</b>
1623 <dd>A valid 6-digit color hex code (# will be stripped if included)</dd>
1641 <td class="msource">
1649 <tr class="method-row config-row-alt0 expandable">
1650 <td class="micon"><a class="exi" href="#expand"> </a></td>
1654 <a id="Roo.Component-method-setDisabled" name=".setDisabled"></a>
1655 <div class="fixedFont">
1656 <span class="attributes"></span><b class="itemname">setDisabled</b>
1658 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
1665 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
1671 Convenience function for setting disabled/enabled by boolean.
1678 <dl class="detailList">
1679 <dt class="heading">Parameters:</dt>
1682 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>disabled</b>
1703 <td class="msource">
1705 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1711 <tr class="method-row config-row-alt1 expandable">
1712 <td class="micon"><a class="exi" href="#expand"> </a></td>
1716 <a id="Roo.Component-method-setVisible" name=".setVisible"></a>
1717 <div class="fixedFont">
1718 <span class="attributes"></span><b class="itemname">setVisible</b>
1720 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
1726 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1735 <div class="short">Convenience function to hide or show this component by boolean.</div>
1741 Convenience function to hide or show this component by boolean.
1748 <dl class="detailList">
1749 <dt class="heading">Parameters:</dt>
1752 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>visible</b>
1755 <dd>True to show, false to hide</dd>
1763 <dl class="detailList">
1764 <dt class="heading">Returns:</dt>
1766 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1780 <td class="msource">
1782 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1788 <tr class="method-row config-row-alt0 expandable">
1789 <td class="micon"><a class="exi" href="#expand"> </a></td>
1793 <a id="Roo.Component-method-show" name=".show"></a>
1794 <div class="fixedFont">
1795 <span class="attributes"></span><b class="itemname">show</b>
1803 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1812 <div class="short">Show this component.</div>
1818 Show this component.
1829 <dl class="detailList">
1830 <dt class="heading">Returns:</dt>
1832 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1846 <td class="msource">
1848 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1854 <tr class="method-row config-row-alt1 expandable">
1855 <td class="micon"><a class="exi" href="#expand"> </a></td>
1859 <a id="Roo.util.Observable-method-un" name=".un"></a>
1860 <div class="fixedFont">
1861 <span class="attributes"></span><b class="itemname">un</b>
1863 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1870 <div class="short">Removes a listener (shorthand for removeListener)</div>
1876 Removes a listener (shorthand for removeListener)
1883 <dl class="detailList">
1884 <dt class="heading">Parameters:</dt>
1887 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1890 <dd>The type of event to listen for</dd>
1893 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1896 <dd>The handler to remove</dd>
1899 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1902 <dd>(optional) The scope (this object) for the handler</dd>
1920 <td class="msource">
1922 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1931 <!-- ============================== events summary / details ======================== -->
1934 <a id="Roo.ColorPalette-events"></a>
1943 <table cellspacing="0" class="member-table">
1944 <caption>Events</caption>
1947 <th class="sig-header" colspan="2">Event</th>
1948 <th class="msource-header">Defined By</th>
1957 <tr class="method-row expandable config-row-alt0">
1958 <td class="micon"><a class="exi" href="#expand"> </a></td>
1961 <a id="Roo.Component-event-*beforedestroy"></a>
1963 <div class="fixedFont">
1964 <b class="itemname">beforedestroy</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
1970 <div class="short">Fires before the component is destroyed.
1976 Fires before the component is destroyed. Return false to stop the destroy.
1982 <dl class="detailList">
1983 <dt class="heading">Parameters:</dt>
1986 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2007 <td class="msource">
2008 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2012 <tr class="method-row expandable config-row-alt1">
2013 <td class="micon"><a class="exi" href="#expand"> </a></td>
2016 <a id="Roo.Component-event-*beforehide"></a>
2018 <div class="fixedFont">
2019 <b class="itemname">beforehide</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2025 <div class="short">Fires before the component is hidden.
2031 Fires before the component is hidden. Return false to stop the hide.
2037 <dl class="detailList">
2038 <dt class="heading">Parameters:</dt>
2041 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2062 <td class="msource">
2063 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2067 <tr class="method-row expandable config-row-alt0">
2068 <td class="micon"><a class="exi" href="#expand"> </a></td>
2071 <a id="Roo.Component-event-*beforerender"></a>
2073 <div class="fixedFont">
2074 <b class="itemname">beforerender</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2080 <div class="short">Fires before the component is rendered.
2086 Fires before the component is rendered. Return false to stop the render.
2092 <dl class="detailList">
2093 <dt class="heading">Parameters:</dt>
2096 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2117 <td class="msource">
2118 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2122 <tr class="method-row expandable config-row-alt1">
2123 <td class="micon"><a class="exi" href="#expand"> </a></td>
2126 <a id="Roo.Component-event-*beforeshow"></a>
2128 <div class="fixedFont">
2129 <b class="itemname">beforeshow</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2135 <div class="short">Fires before the component is shown.
2141 Fires before the component is shown. Return false to stop the show.
2147 <dl class="detailList">
2148 <dt class="heading">Parameters:</dt>
2151 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2172 <td class="msource">
2173 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2177 <tr class="method-row expandable config-row-alt0">
2178 <td class="micon"><a class="exi" href="#expand"> </a></td>
2181 <a id="Roo.Component-event-*destroy"></a>
2183 <div class="fixedFont">
2184 <b class="itemname">destroy</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2190 <div class="short">Fires after the component is destroyed.
2196 Fires after the component is destroyed.
2202 <dl class="detailList">
2203 <dt class="heading">Parameters:</dt>
2206 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2227 <td class="msource">
2228 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2232 <tr class="method-row expandable config-row-alt1">
2233 <td class="micon"><a class="exi" href="#expand"> </a></td>
2236 <a id="Roo.Component-event-*disable"></a>
2238 <div class="fixedFont">
2239 <b class="itemname">disable</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2245 <div class="short">Fires after the component is disabled.
2251 Fires after the component is disabled.
2257 <dl class="detailList">
2258 <dt class="heading">Parameters:</dt>
2261 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2282 <td class="msource">
2283 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2287 <tr class="method-row expandable config-row-alt0">
2288 <td class="micon"><a class="exi" href="#expand"> </a></td>
2291 <a id="Roo.Component-event-*enable"></a>
2293 <div class="fixedFont">
2294 <b class="itemname">enable</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2300 <div class="short">Fires after the component is enabled.
2306 Fires after the component is enabled.
2312 <dl class="detailList">
2313 <dt class="heading">Parameters:</dt>
2316 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2337 <td class="msource">
2338 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2342 <tr class="method-row expandable config-row-alt1">
2343 <td class="micon"><a class="exi" href="#expand"> </a></td>
2346 <a id="Roo.Component-event-*hide"></a>
2348 <div class="fixedFont">
2349 <b class="itemname">hide</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2355 <div class="short">Fires after the component is hidden.
2361 Fires after the component is hidden.
2367 <dl class="detailList">
2368 <dt class="heading">Parameters:</dt>
2371 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2392 <td class="msource">
2393 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2397 <tr class="method-row expandable config-row-alt0">
2398 <td class="micon"><a class="exi" href="#expand"> </a></td>
2401 <a id="Roo.Component-event-*render"></a>
2403 <div class="fixedFont">
2404 <b class="itemname">render</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2410 <div class="short">Fires after the component is rendered.
2416 Fires after the component is rendered.
2422 <dl class="detailList">
2423 <dt class="heading">Parameters:</dt>
2426 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2447 <td class="msource">
2448 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2452 <tr class="method-row expandable config-row-alt1 notInherited">
2453 <td class="micon"><a class="exi" href="#expand"> </a></td>
2456 <a id="Roo.ColorPalette-event-*select"></a>
2458 <div class="fixedFont">
2459 <b class="itemname">select</b> (ColorPalette <B><i>this</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>color</i></B>)
2465 <div class="short">Fires when a color is selected
2471 Fires when a color is selected
2477 <dl class="detailList">
2478 <dt class="heading">Parameters:</dt>
2481 <span class="fixedFont">ColorPalette</span> <b>this</b>
2487 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>color</b>
2490 <dd>The 6-digit color hex code (without the # symbol)</dd>
2508 <td class="msource">
2513 <tr class="method-row expandable config-row-alt0">
2514 <td class="micon"><a class="exi" href="#expand"> </a></td>
2517 <a id="Roo.Component-event-*show"></a>
2519 <div class="fixedFont">
2520 <b class="itemname">show</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2526 <div class="short">Fires after the component is shown.
2532 Fires after the component is shown.
2538 <dl class="detailList">
2539 <dt class="heading">Parameters:</dt>
2542 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2563 <td class="msource">
2564 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2575 <!-- ============================== footer ================================= -->
2576 <div class="fineprint" style="clear:both">
2578 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 13 2018 14:10:53 GMT+0800 (HKT)
2580 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>