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>
144 <div class="long">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
152 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
158 <tr class="config-row expandable config-row-alt1">
159 <td class="micon"><a class="exi" href="#expand"> </a></td>
162 <a id="Roo.Component-cfg-allowDomMove" name=".allowDomMove"></a>
163 <div class="fixedFont">
164 <b class="itemname">allowDomMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
170 <div class="short">Whether the component can move the Dom node when rendering (defaults to true).</div>
174 <div class="long">Whether the component can move the Dom node when rendering (defaults to true).</div>
182 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
188 <tr class="config-row expandable config-row-alt0 notInherited">
189 <td class="micon"><a class="exi" href="#expand"> </a></td>
192 <a id="Roo.ColorPalette-cfg-allowReselect" name=".allowReselect"></a>
193 <div class="fixedFont">
194 <b class="itemname">allowReselect</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
200 <div class="short">If set to true then reselecting a color that is already selected fires the selection event</div>
204 <div class="long">If set to true then reselecting a color that is already selected fires the selection event</div>
218 <tr class="config-row expandable config-row-alt1">
219 <td class="micon"><a class="exi" href="#expand"> </a></td>
222 <a id="Roo.Component-cfg-disableClass" name=".disableClass"></a>
223 <div class="fixedFont">
224 <b class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
230 <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
234 <div class="long">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
242 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
248 <tr class="config-row expandable config-row-alt0">
249 <td class="micon"><a class="exi" href="#expand"> </a></td>
252 <a id="Roo.Component-cfg-hideMode" name=".hideMode"></a>
253 <div class="fixedFont">
254 <b class="itemname">hideMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
260 <div class="short">How this component should hidden.</div>
264 <div class="long">How this component should hidden. Supported values are<br/>"visibility" (css visibility), "offsets" (negative offset position) and<br/>"display" (css display) - defaults to "display".</div>
272 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
278 <tr class="config-row expandable config-row-alt1 notInherited">
279 <td class="micon"><a class="exi" href="#expand"> </a></td>
282 <a id="Roo.ColorPalette-cfg-itemCls" name=".itemCls"></a>
283 <div class="fixedFont">
284 <b class="itemname">itemCls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
290 <div class="short">The CSS class to apply to the containing element (defaults to "x-color-palette")</div>
294 <div class="long">The CSS class to apply to the containing element (defaults to "x-color-palette")</div>
308 <tr class="config-row expandable config-row-alt0">
309 <td class="micon"><a class="exi" href="#expand"> </a></td>
312 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
313 <div class="fixedFont">
314 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
320 <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>
324 <div class="long">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></div>
332 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
338 <tr class="config-row expandable config-row-alt1 notInherited">
339 <td class="micon"><a class="exi" href="#expand"> </a></td>
342 <a id="Roo.ColorPalette-cfg-value" name=".value"></a>
343 <div class="fixedFont">
344 <b class="itemname">value</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
350 <div class="short">The initial color to highlight (should be a valid 6-digit color hex code without the # symbol).</div>
354 <div class="long">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.</div>
378 <!-- ============================== public properties ==================== -->
382 <a id="Roo.ColorPalette-props"></a>
388 <table cellspacing="0" class="member-table">
389 <caption class="Empty">Public Properties - Has None</caption>
395 <!-- ============================== methods summary / details ======================== -->
398 <a id="Roo.ColorPalette-methods"></a>
399 <!-- constructor?? -->
406 <!-- then dynamics first -->
413 <table cellspacing="0" class="member-table">
414 <caption>Public Methods</caption>
416 <th class="sig-header" colspan="2">Method</th>
417 <th class="msource-header">Defined By</th>
427 <tr class="method-row config-row-alt0 expandable notInherited">
428 <td class="micon"><a class="exi" href="#expand"> </a></td>
432 <a id="Roo-method-ColorPalette" name=".ColorPalette"></a>
433 <div class="fixedFont">
434 <span class="attributes">new <B>Roo.</B></span><b class="itemname">ColorPalette</b>
436 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
444 <div class="short">Create a new Roo.ColorPalette</div>
451 Create a new Roo.ColorPalette
454 <dl class="detailList">
455 <dt class="heading">Parameters:</dt>
458 <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>
461 <dd>The config object</dd>
485 <tr class="method-row config-row-alt1 expandable">
486 <td class="micon"><a class="exi" href="#expand"> </a></td>
490 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
491 <div class="fixedFont">
492 <span class="attributes"></span><b class="itemname">addEvents</b>
494 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
501 <div class="short">Used to define events on this Observable</div>
507 Used to define events on this Observable
514 <dl class="detailList">
515 <dt class="heading">Parameters:</dt>
518 <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>
521 <dd>The object with the events defined</dd>
541 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
547 <tr class="method-row config-row-alt0 expandable">
548 <td class="micon"><a class="exi" href="#expand"> </a></td>
552 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
553 <div class="fixedFont">
554 <span class="attributes"></span><b class="itemname">addListener</b>
556 (<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>)
563 <div class="short">Appends an event handler to this component</div>
569 Appends an event handler to this component
576 <dl class="detailList">
577 <dt class="heading">Parameters:</dt>
580 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
583 <dd>The type of event to listen for</dd>
586 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
589 <dd>The method the event invokes</dd>
592 <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>
595 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
598 <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>
601 <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>
621 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
627 <tr class="method-row config-row-alt1 expandable">
628 <td class="micon"><a class="exi" href="#expand"> </a></td>
632 <a id="Roo.Component-method-destroy" name=".destroy"></a>
633 <div class="fixedFont">
634 <span class="attributes"></span><b class="itemname">destroy</b>
643 <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>
649 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}.
672 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
678 <tr class="method-row config-row-alt0 expandable">
679 <td class="micon"><a class="exi" href="#expand"> </a></td>
683 <a id="Roo.Component-method-disable" name=".disable"></a>
684 <div class="fixedFont">
685 <span class="attributes"></span><b class="itemname">disable</b>
693 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
702 <div class="short">Disable this component.</div>
708 Disable this component.
719 <dl class="detailList">
720 <dt class="heading">Returns:</dt>
722 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
738 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
744 <tr class="method-row config-row-alt1 expandable">
745 <td class="micon"><a class="exi" href="#expand"> </a></td>
749 <a id="Roo.Component-method-enable" name=".enable"></a>
750 <div class="fixedFont">
751 <span class="attributes"></span><b class="itemname">enable</b>
759 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
768 <div class="short">Enable this component.</div>
774 Enable this component.
785 <dl class="detailList">
786 <dt class="heading">Returns:</dt>
788 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
804 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
810 <tr class="method-row config-row-alt0 expandable">
811 <td class="micon"><a class="exi" href="#expand"> </a></td>
815 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
816 <div class="fixedFont">
817 <span class="attributes"></span><b class="itemname">fireEvent</b>
819 (<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>)
825 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
834 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
840 Fires the specified event with the passed parameters (minus the event name).
847 <dl class="detailList">
848 <dt class="heading">Parameters:</dt>
851 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
857 <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>
860 <dd>Variable number of parameters are passed to handlers</dd>
868 <dl class="detailList">
869 <dt class="heading">Returns:</dt>
871 <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>
887 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
893 <tr class="method-row config-row-alt1 expandable">
894 <td class="micon"><a class="exi" href="#expand"> </a></td>
898 <a id="Roo.Component-method-focus" name=".focus"></a>
899 <div class="fixedFont">
900 <span class="attributes"></span><b class="itemname">focus</b>
902 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
908 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
917 <div class="short">Try to focus this component.</div>
923 Try to focus this component.
930 <dl class="detailList">
931 <dt class="heading">Parameters:</dt>
934 <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>
937 <dd>True to also select the text in this component (if applicable)</dd>
945 <dl class="detailList">
946 <dt class="heading">Returns:</dt>
948 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
964 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
970 <tr class="method-row config-row-alt0 expandable">
971 <td class="micon"><a class="exi" href="#expand"> </a></td>
975 <a id="Roo.Component-method-getEl" name=".getEl"></a>
976 <div class="fixedFont">
977 <span class="attributes"></span><b class="itemname">getEl</b>
985 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
994 <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
1000 Returns the underlying {<b>link</b> Roo.Element}.
1011 <dl class="detailList">
1012 <dt class="heading">Returns:</dt>
1014 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1028 <td class="msource">
1030 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1036 <tr class="method-row config-row-alt1 expandable">
1037 <td class="micon"><a class="exi" href="#expand"> </a></td>
1041 <a id="Roo.Component-method-getId" name=".getId"></a>
1042 <div class="fixedFont">
1043 <span class="attributes"></span><b class="itemname">getId</b>
1051 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1060 <div class="short">Returns the id of this component.</div>
1066 Returns the id of this component.
1077 <dl class="detailList">
1078 <dt class="heading">Returns:</dt>
1080 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1094 <td class="msource">
1096 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1102 <tr class="method-row config-row-alt0 expandable">
1103 <td class="micon"><a class="exi" href="#expand"> </a></td>
1107 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1108 <div class="fixedFont">
1109 <span class="attributes"></span><b class="itemname">hasListener</b>
1111 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1117 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1126 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1132 Checks to see if this object has any listeners for a specified event
1139 <dl class="detailList">
1140 <dt class="heading">Parameters:</dt>
1143 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1146 <dd>The name of the event to check for</dd>
1154 <dl class="detailList">
1155 <dt class="heading">Returns:</dt>
1157 <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>
1171 <td class="msource">
1173 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1179 <tr class="method-row config-row-alt1 expandable">
1180 <td class="micon"><a class="exi" href="#expand"> </a></td>
1184 <a id="Roo.Component-method-hide" name=".hide"></a>
1185 <div class="fixedFont">
1186 <span class="attributes"></span><b class="itemname">hide</b>
1194 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1203 <div class="short">Hide this component.</div>
1209 Hide this component.
1220 <dl class="detailList">
1221 <dt class="heading">Returns:</dt>
1223 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1237 <td class="msource">
1239 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1245 <tr class="method-row config-row-alt0 expandable">
1246 <td class="micon"><a class="exi" href="#expand"> </a></td>
1250 <a id="Roo.Component-method-isVisible" name=".isVisible"></a>
1251 <div class="fixedFont">
1252 <span class="attributes"></span><b class="itemname">isVisible</b>
1261 <div class="short">Returns true if this component is visible.</div>
1267 Returns true if this component is visible.
1288 <td class="msource">
1290 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1296 <tr class="method-row config-row-alt1 expandable">
1297 <td class="micon"><a class="exi" href="#expand"> </a></td>
1301 <a id="Roo.util.Observable-method-on" name=".on"></a>
1302 <div class="fixedFont">
1303 <span class="attributes"></span><b class="itemname">on</b>
1305 (<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>)
1312 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1318 Appends an event handler to this element (shorthand for addListener)
1325 <dl class="detailList">
1326 <dt class="heading">Parameters:</dt>
1329 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1332 <dd>The type of event to listen for</dd>
1335 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1338 <dd>The method the event invokes</dd>
1341 <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>
1344 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1347 <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>
1368 <td class="msource">
1370 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1376 <tr class="method-row config-row-alt0 expandable">
1377 <td class="micon"><a class="exi" href="#expand"> </a></td>
1381 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1382 <div class="fixedFont">
1383 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1392 <div class="short">Removes all listeners for this object</div>
1398 Removes all listeners for this object
1419 <td class="msource">
1421 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1427 <tr class="method-row config-row-alt1 expandable">
1428 <td class="micon"><a class="exi" href="#expand"> </a></td>
1432 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1433 <div class="fixedFont">
1434 <span class="attributes"></span><b class="itemname">removeListener</b>
1436 (<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>)
1443 <div class="short">Removes a listener</div>
1456 <dl class="detailList">
1457 <dt class="heading">Parameters:</dt>
1460 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1463 <dd>The type of event to listen for</dd>
1466 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1469 <dd>The handler to remove</dd>
1472 <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>
1475 <dd>(optional) The scope (this object) for the handler</dd>
1493 <td class="msource">
1495 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1501 <tr class="method-row config-row-alt0 expandable">
1502 <td class="micon"><a class="exi" href="#expand"> </a></td>
1506 <a id="Roo.Component-method-render" name=".render"></a>
1507 <div class="fixedFont">
1508 <span class="attributes"></span><b class="itemname">render</b>
1510 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
1517 <div class="short">If this is a lazy rendering component, render it to its container element.</div>
1523 If this is a lazy rendering component, render it to its container element.
1530 <dl class="detailList">
1531 <dt class="heading">Parameters:</dt>
1534 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
1537 <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
1555 <td class="msource">
1557 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1563 <tr class="method-row config-row-alt1 expandable notInherited">
1564 <td class="micon"><a class="exi" href="#expand"> </a></td>
1568 <a id="Roo.ColorPalette-method-select" name=".select"></a>
1569 <div class="fixedFont">
1570 <span class="attributes"></span><b class="itemname">select</b>
1572 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>color</i></B>)
1579 <div class="short">Selects the specified color in the palette (fires the select event)</div>
1585 Selects the specified color in the palette (fires the select event)
1592 <dl class="detailList">
1593 <dt class="heading">Parameters:</dt>
1596 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>color</b>
1599 <dd>A valid 6-digit color hex code (# will be stripped if included)</dd>
1617 <td class="msource">
1625 <tr class="method-row config-row-alt0 expandable">
1626 <td class="micon"><a class="exi" href="#expand"> </a></td>
1630 <a id="Roo.Component-method-setDisabled" name=".setDisabled"></a>
1631 <div class="fixedFont">
1632 <span class="attributes"></span><b class="itemname">setDisabled</b>
1634 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
1641 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
1647 Convenience function for setting disabled/enabled by boolean.
1654 <dl class="detailList">
1655 <dt class="heading">Parameters:</dt>
1658 <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>
1679 <td class="msource">
1681 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1687 <tr class="method-row config-row-alt1 expandable">
1688 <td class="micon"><a class="exi" href="#expand"> </a></td>
1692 <a id="Roo.Component-method-setVisible" name=".setVisible"></a>
1693 <div class="fixedFont">
1694 <span class="attributes"></span><b class="itemname">setVisible</b>
1696 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
1702 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1711 <div class="short">Convenience function to hide or show this component by boolean.</div>
1717 Convenience function to hide or show this component by boolean.
1724 <dl class="detailList">
1725 <dt class="heading">Parameters:</dt>
1728 <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>
1731 <dd>True to show, false to hide</dd>
1739 <dl class="detailList">
1740 <dt class="heading">Returns:</dt>
1742 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1756 <td class="msource">
1758 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1764 <tr class="method-row config-row-alt0 expandable">
1765 <td class="micon"><a class="exi" href="#expand"> </a></td>
1769 <a id="Roo.Component-method-show" name=".show"></a>
1770 <div class="fixedFont">
1771 <span class="attributes"></span><b class="itemname">show</b>
1779 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1788 <div class="short">Show this component.</div>
1794 Show this component.
1805 <dl class="detailList">
1806 <dt class="heading">Returns:</dt>
1808 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1822 <td class="msource">
1824 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1830 <tr class="method-row config-row-alt1 expandable">
1831 <td class="micon"><a class="exi" href="#expand"> </a></td>
1835 <a id="Roo.util.Observable-method-un" name=".un"></a>
1836 <div class="fixedFont">
1837 <span class="attributes"></span><b class="itemname">un</b>
1839 (<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>)
1846 <div class="short">Removes a listener (shorthand for removeListener)</div>
1852 Removes a listener (shorthand for removeListener)
1859 <dl class="detailList">
1860 <dt class="heading">Parameters:</dt>
1863 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1866 <dd>The type of event to listen for</dd>
1869 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1872 <dd>The handler to remove</dd>
1875 <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>
1878 <dd>(optional) The scope (this object) for the handler</dd>
1896 <td class="msource">
1898 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1907 <!-- ============================== events summary / details ======================== -->
1910 <a id="Roo.ColorPalette-events"></a>
1919 <table cellspacing="0" class="member-table">
1920 <caption>Events</caption>
1923 <th class="sig-header" colspan="2">Event</th>
1924 <th class="msource-header">Defined By</th>
1933 <tr class="method-row expandable config-row-alt0">
1934 <td class="micon"><a class="exi" href="#expand"> </a></td>
1937 <a id="Roo.Component-event-*beforedestroy"></a>
1939 <div class="fixedFont">
1940 <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>)
1946 <div class="short">Fires before the component is destroyed.
1952 Fires before the component is destroyed. Return false to stop the destroy.
1958 <dl class="detailList">
1959 <dt class="heading">Parameters:</dt>
1962 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1983 <td class="msource">
1984 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1988 <tr class="method-row expandable config-row-alt1">
1989 <td class="micon"><a class="exi" href="#expand"> </a></td>
1992 <a id="Roo.Component-event-*beforehide"></a>
1994 <div class="fixedFont">
1995 <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>)
2001 <div class="short">Fires before the component is hidden.
2007 Fires before the component is hidden. Return false to stop the hide.
2013 <dl class="detailList">
2014 <dt class="heading">Parameters:</dt>
2017 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2038 <td class="msource">
2039 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2043 <tr class="method-row expandable config-row-alt0">
2044 <td class="micon"><a class="exi" href="#expand"> </a></td>
2047 <a id="Roo.Component-event-*beforerender"></a>
2049 <div class="fixedFont">
2050 <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>)
2056 <div class="short">Fires before the component is rendered.
2062 Fires before the component is rendered. Return false to stop the render.
2068 <dl class="detailList">
2069 <dt class="heading">Parameters:</dt>
2072 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2093 <td class="msource">
2094 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2098 <tr class="method-row expandable config-row-alt1">
2099 <td class="micon"><a class="exi" href="#expand"> </a></td>
2102 <a id="Roo.Component-event-*beforeshow"></a>
2104 <div class="fixedFont">
2105 <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>)
2111 <div class="short">Fires before the component is shown.
2117 Fires before the component is shown. Return false to stop the show.
2123 <dl class="detailList">
2124 <dt class="heading">Parameters:</dt>
2127 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2148 <td class="msource">
2149 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2153 <tr class="method-row expandable config-row-alt0">
2154 <td class="micon"><a class="exi" href="#expand"> </a></td>
2157 <a id="Roo.Component-event-*destroy"></a>
2159 <div class="fixedFont">
2160 <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>)
2166 <div class="short">Fires after the component is destroyed.
2172 Fires after the component is destroyed.
2178 <dl class="detailList">
2179 <dt class="heading">Parameters:</dt>
2182 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2203 <td class="msource">
2204 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2208 <tr class="method-row expandable config-row-alt1">
2209 <td class="micon"><a class="exi" href="#expand"> </a></td>
2212 <a id="Roo.Component-event-*disable"></a>
2214 <div class="fixedFont">
2215 <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>)
2221 <div class="short">Fires after the component is disabled.
2227 Fires after the component is disabled.
2233 <dl class="detailList">
2234 <dt class="heading">Parameters:</dt>
2237 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2258 <td class="msource">
2259 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2263 <tr class="method-row expandable config-row-alt0">
2264 <td class="micon"><a class="exi" href="#expand"> </a></td>
2267 <a id="Roo.Component-event-*enable"></a>
2269 <div class="fixedFont">
2270 <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>)
2276 <div class="short">Fires after the component is enabled.
2282 Fires after the component is enabled.
2288 <dl class="detailList">
2289 <dt class="heading">Parameters:</dt>
2292 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2313 <td class="msource">
2314 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2318 <tr class="method-row expandable config-row-alt1">
2319 <td class="micon"><a class="exi" href="#expand"> </a></td>
2322 <a id="Roo.Component-event-*hide"></a>
2324 <div class="fixedFont">
2325 <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>)
2331 <div class="short">Fires after the component is hidden.
2337 Fires after the component is hidden.
2343 <dl class="detailList">
2344 <dt class="heading">Parameters:</dt>
2347 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2368 <td class="msource">
2369 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2373 <tr class="method-row expandable config-row-alt0">
2374 <td class="micon"><a class="exi" href="#expand"> </a></td>
2377 <a id="Roo.Component-event-*render"></a>
2379 <div class="fixedFont">
2380 <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>)
2386 <div class="short">Fires after the component is rendered.
2392 Fires after the component is rendered.
2398 <dl class="detailList">
2399 <dt class="heading">Parameters:</dt>
2402 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2423 <td class="msource">
2424 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2428 <tr class="method-row expandable config-row-alt1 notInherited">
2429 <td class="micon"><a class="exi" href="#expand"> </a></td>
2432 <a id="Roo.ColorPalette-event-*select"></a>
2434 <div class="fixedFont">
2435 <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>)
2441 <div class="short">Fires when a color is selected
2447 Fires when a color is selected
2453 <dl class="detailList">
2454 <dt class="heading">Parameters:</dt>
2457 <span class="fixedFont">ColorPalette</span> <b>this</b>
2463 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>color</b>
2466 <dd>The 6-digit color hex code (without the # symbol)</dd>
2484 <td class="msource">
2489 <tr class="method-row expandable config-row-alt0">
2490 <td class="micon"><a class="exi" href="#expand"> </a></td>
2493 <a id="Roo.Component-event-*show"></a>
2495 <div class="fixedFont">
2496 <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>)
2502 <div class="short">Fires after the component is shown.
2508 Fires after the component is shown.
2514 <dl class="detailList">
2515 <dt class="heading">Parameters:</dt>
2518 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2539 <td class="msource">
2540 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2551 <!-- ============================== footer ================================= -->
2552 <div class="fineprint" style="clear:both">
2554 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Mon Mar 31 2014 14:16:30 GMT+0800 (HKT)
2556 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>