-<div xmlns:ext="http://www.extjs.com" class="body-wrap"><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a> <img src="resources/elbow-end.gif"><a href="output/Ext.Component.html" ext:member="" ext:cls="Ext.Component">Component</a> <img src="resources/elbow-end.gif"><a href="output/Ext.BoxComponent.html" ext:member="" ext:cls="Ext.BoxComponent">BoxComponent</a> <img src="resources/elbow-end.gif"><a href="output/Ext.Container.html" ext:member="" ext:cls="Ext.Container">Container</a> <img src="resources/elbow-end.gif"><a href="output/Ext.Panel.html" ext:member="" ext:cls="Ext.Panel">Panel</a> <img src="resources/elbow-end.gif">TreePanel</pre></div><h1>Class <a href="source/TreePanel.html#cls-Ext.tree.TreePanel">Ext.tree.TreePanel</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.tree</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">TreePanel.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/TreePanel.html#cls-Ext.tree.TreePanel">TreePanel</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.Panel.html" ext:cls="Ext.Panel" ext:member="">Panel</a></td></tr></table><div class="description"><p>The TreePanel provides tree-structured UI representation of tree-structured data.</p>\r
-<p><a href="output/Ext.tree.TreeNode.html" ext:cls="Ext.tree.TreeNode">TreeNode</a>s added to the TreePanel may each contain metadata\r
-used by your application in their <a href="output/Ext.tree.TreeNode.html#Ext.tree.TreeNode-attributes" ext:member="attributes" ext:cls="Ext.tree.TreeNode">attributes</a> property.</p>\r
-<p><b>A TreePanel must have a <a href="output/Ext.tree.TreePanel.html#Ext.tree.TreePanel-root" ext:member="root" ext:cls="Ext.tree.TreePanel">root</a> node before it is rendered.</b> This may either be\r
-specified using the <a href="output/Ext.tree.TreePanel.html#Ext.tree.TreePanel-root" ext:member="root" ext:cls="Ext.tree.TreePanel">root</a> config option, or using the <a href="output/Ext.tree.TreePanel.html#Ext.tree.TreePanel-setRootNode" ext:member="setRootNode" ext:cls="Ext.tree.TreePanel">setRootNode</a> method.\r
-<p>An example of tree rendered to an existing div:</p><pre><code><b>var</b> tree = <b>new</b> Ext.tree.TreePanel({\r
- renderTo: <em>'tree-div'</em>,\r
- useArrows: true,\r
- autoScroll: true,\r
- animate: true,\r
- enableDD: true,\r
- containerScroll: true,\r
- border: false,\r
- <i>// auto create TreeLoader\r</i>
- dataUrl: <em>'get-nodes.php'</em>,\r
-\r
- root: {\r
- nodeType: <em>'async'</em>,\r
- text: <em>'Ext JS'</em>,\r
- draggable: false,\r
- id: <em>'source'</em>\r
- }\r
-});\r
-\r
-tree.getRootNode().expand();</code></pre>\r
-<p>The example above would work with a data packet similar to this:</p><pre><code>[{\r
- <em>"text"</em>: <em>"adapter"</em>,\r
- <em>"id"</em>: <em>"source\/adapter"</em>,\r
- <em>"cls"</em>: <em>"folder"</em>\r
-}, {\r
- <em>"text"</em>: <em>"dd"</em>,\r
- <em>"id"</em>: <em>"source\/dd"</em>,\r
- <em>"cls"</em>: <em>"folder"</em>\r
-}, {\r
- <em>"text"</em>: <em>"debug.js"</em>,\r
- <em>"id"</em>: <em>"source\/debug.js"</em>,\r
- <em>"leaf"</em>: true,\r
- <em>"cls"</em>: <em>"file"</em>\r
-}]</code></pre>\r
-<p>An example of tree within a Viewport:</p><pre><code><b>new</b> Ext.Viewport({\r
- layout: <em>'border'</em>,\r
- items: [{\r
- region: <em>'west'</em>,\r
- collapsible: true,\r
- title: <em>'Navigation'</em>,\r
- xtype: <em>'treepanel'</em>,\r
- width: 200,\r
- autoScroll: true,\r
- split: true,\r
- loader: <b>new</b> Ext.tree.TreeLoader(),\r
- root: <b>new</b> Ext.tree.AsyncTreeNode({\r
- expanded: true,\r
- children: [{\r
- text: <em>'Menu Option 1'</em>,\r
- leaf: true\r
- }, {\r
- text: <em>'Menu Option 2'</em>,\r
- leaf: true\r
- }, {\r
- text: <em>'Menu Option 3'</em>,\r
- leaf: true\r
- }]\r
- }),\r
- rootVisible: false,\r
- listeners: {\r
- click: <b>function</b>(n) {\r
- Ext.Msg.alert(<em>'Navigation Tree Click'</em>, <em>'You clicked: <em>"'</em> + n.attributes.text + <em>'"</em>'</em>);\r
- }\r
- }\r
- }, {\r
- region: <em>'center'</em>,\r
- xtype: <em>'tabpanel'</em>,\r
- <i>// remaining code not shown ...\r</i>
- }]\r
+<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.tree.TreePanel-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> <a class="inner-link" href="#Ext.tree.TreePanel-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a> <a class="inner-link" href="#Ext.tree.TreePanel-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a> <a class="inner-link" href="#Ext.tree.TreePanel-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a> <a class="bookmark" href="../docs/?class=Ext.tree.TreePanel"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> </div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a> <img src="resources/elbow-end.gif"><a href="output/Ext.Component.html" ext:member="" ext:cls="Ext.Component">Component</a> <img src="resources/elbow-end.gif"><a href="output/Ext.BoxComponent.html" ext:member="" ext:cls="Ext.BoxComponent">BoxComponent</a> <img src="resources/elbow-end.gif"><a href="output/Ext.Container.html" ext:member="" ext:cls="Ext.Container">Container</a> <img src="resources/elbow-end.gif"><a href="output/Ext.Panel.html" ext:member="" ext:cls="Ext.Panel">Panel</a> <img src="resources/elbow-end.gif">TreePanel</pre></div><h1>Class <a href="source/TreePanel.html#cls-Ext.tree.TreePanel">Ext.tree.TreePanel</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.tree</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/TreePanel.html#cls-Ext.tree.TreePanel">TreePanel.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/TreePanel.html#cls-Ext.tree.TreePanel">TreePanel</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.Panel.html" ext:cls="Ext.Panel" ext:member="">Panel</a></td></tr></table><div class="description"><p>The TreePanel provides tree-structured UI representation of tree-structured data.</p>
+<p><a href="output/Ext.tree.TreeNode.html" ext:cls="Ext.tree.TreeNode">TreeNode</a>s added to the TreePanel may each contain metadata
+used by your application in their <a href="output/Ext.tree.TreeNode.html#Ext.tree.TreeNode-attributes" ext:member="attributes" ext:cls="Ext.tree.TreeNode">attributes</a> property.</p>
+<p><b>A TreePanel must have a <a href="output/Ext.tree.TreePanel.html#Ext.tree.TreePanel-root" ext:member="root" ext:cls="Ext.tree.TreePanel">root</a> node before it is rendered.</b> This may either be
+specified using the <a href="output/Ext.tree.TreePanel.html#Ext.tree.TreePanel-root" ext:member="root" ext:cls="Ext.tree.TreePanel">root</a> config option, or using the <a href="output/Ext.tree.TreePanel.html#Ext.tree.TreePanel-setRootNode" ext:member="setRootNode" ext:cls="Ext.tree.TreePanel">setRootNode</a> method.
+<p>An example of tree rendered to an existing div:</p><pre><code><b>var</b> tree = <b>new</b> Ext.tree.TreePanel({
+ renderTo: <em>'tree-div'</em>,
+ useArrows: true,
+ autoScroll: true,
+ animate: true,
+ enableDD: true,
+ containerScroll: true,
+ border: false,
+ <i>// auto create TreeLoader</i>
+ dataUrl: <em>'get-nodes.php'</em>,
+
+ root: {
+ nodeType: <em>'async'</em>,
+ text: <em>'Ext JS'</em>,
+ draggable: false,
+ id: <em>'source'</em>
+ }
+});
+
+tree.getRootNode().expand();</code></pre>
+<p>The example above would work with a data packet similar to this:</p><pre><code>[{
+ <em>"text"</em>: <em>"adapter"</em>,
+ <em>"id"</em>: <em>"source\/adapter"</em>,
+ <em>"cls"</em>: <em>"folder"</em>
+}, {
+ <em>"text"</em>: <em>"dd"</em>,
+ <em>"id"</em>: <em>"source\/dd"</em>,
+ <em>"cls"</em>: <em>"folder"</em>
+}, {
+ <em>"text"</em>: <em>"debug.js"</em>,
+ <em>"id"</em>: <em>"source\/debug.js"</em>,
+ <em>"leaf"</em>: true,
+ <em>"cls"</em>: <em>"file"</em>
+}]</code></pre>
+<p>An example of tree within a Viewport:</p><pre><code><b>new</b> Ext.Viewport({
+ layout: <em>'border'</em>,
+ items: [{
+ region: <em>'west'</em>,
+ collapsible: true,
+ title: <em>'Navigation'</em>,
+ xtype: <em>'treepanel'</em>,
+ width: 200,
+ autoScroll: true,
+ split: true,
+ loader: <b>new</b> Ext.tree.TreeLoader(),
+ root: <b>new</b> Ext.tree.AsyncTreeNode({
+ expanded: true,
+ children: [{
+ text: <em>'Menu Option 1'</em>,
+ leaf: true
+ }, {
+ text: <em>'Menu Option 2'</em>,
+ leaf: true
+ }, {
+ text: <em>'Menu Option 3'</em>,
+ leaf: true
+ }]
+ }),
+ rootVisible: false,
+ listeners: {
+ click: <b>function</b>(n) {
+ Ext.Msg.alert(<em>'Navigation Tree Click'</em>, <em>'You clicked: <em>"'</em> + n.attributes.text + <em>'"</em>'</em>);
+ }
+ }
+ }, {
+ region: <em>'center'</em>,
+ xtype: <em>'tabpanel'</em>,
+ <i>// remaining code not shown ...</i>
+ }]
});</code></pre></div><div class="hr"></div><a id="Ext.tree.TreePanel-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-anchor"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-anchor">anchor</a></b> : String<div class="mdesc"><div class="short">Note: this config is only used when this Component is rendered
by a Container which has been configured to use an Anc...</div><div class="long"><p><b>Note</b>: this config is only used when this Component is rendered
by a Container which has been configured to use an <b><a href="output/Ext.layout.AnchorLayout.html" ext:cls="Ext.layout.AnchorLayout">AnchorLayout</a> (or subclass thereof).</b>
Warning: This will override any size mana...</div><div class="long"><p>The minimum value in pixels which this BoxComponent will set its height to.</p>
<p><b>Warning:</b> This will override any size management applied by layout managers.</p></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#boxMinHeight" ext:member="#boxMinHeight" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-boxMinWidth"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-boxMinWidth">boxMinWidth</a></b> : Number<div class="mdesc"><div class="short">The minimum value in pixels which this BoxComponent will set its width to.
Warning: This will override any size manag...</div><div class="long"><p>The minimum value in pixels which this BoxComponent will set its width to.</p>
-<p><b>Warning:</b> This will override any size management applied by layout managers.</p></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#boxMinWidth" ext:member="#boxMinWidth" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-bubbleEvents"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-bubbleEvents">bubbleEvents</a></b> : Array<div class="mdesc"><div class="short">An array of events that, when fired, should be bubbled to any parent container.
-See Ext.util.Observable.enableBubble...</div><div class="long"><p>An array of events that, when fired, should be bubbled to any parent container.\r
-See <a href="output/Ext.util.Observable.html#Ext.util.Observable-enableBubble" ext:member="enableBubble" ext:cls="Ext.util.Observable">Ext.util.Observable.enableBubble</a>.\r
+<p><b>Warning:</b> This will override any size management applied by layout managers.</p></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#boxMinWidth" ext:member="#boxMinWidth" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-bubbleEvents"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-bubbleEvents">bubbleEvents</a></b> : Array<div class="mdesc"><div class="short">An array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble....</div><div class="long"><p>An array of events that, when fired, should be bubbled to any parent container.
+See <a href="output/Ext.util.Observable.html#Ext.util.Observable-enableBubble" ext:member="enableBubble" ext:cls="Ext.util.Observable">Ext.util.Observable.enableBubble</a>.
Defaults to <tt>[]</tt>.</div></div></td><td class="msource">TreePanel</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-buttonAlign"></a><b><a href="source/Panel.html#cfg-Ext.Panel-buttonAlign">buttonAlign</a></b> : String<div class="mdesc"><div class="short">The alignment of any buttons added to this panel. Valid values are 'right',
'left' and 'center' (defaults to 'right'...</div><div class="long">The alignment of any <a href="output/Ext.Panel.html#Ext.Panel-buttons" ext:member="buttons" ext:cls="Ext.Panel">buttons</a> added to this panel. Valid values are <code><em>'right'</em></code>,
<code><em>'left'</em></code> and <code><em>'center'</em></code> (defaults to <code><em>'right'</em></code>).</div></div></td><td class="msource"><a href="output/Ext.Panel.html#buttonAlign" ext:member="#buttonAlign" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-buttons"></a><b><a href="source/Panel.html#cfg-Ext.Panel-buttons">buttons</a></b> : Array<div class="mdesc"><div class="short">buttons will be used as items for the toolbar in
display:none on the layout target, *or any of its parent elements* will mean it has no view area.</div></div></td><td class="msource"><a href="output/Ext.Container.html#private" ext:member="#private" ext:cls="Ext.Container">Container</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-refOwner"></a><b><a href="source/Component.html#prop-Ext.Component-refOwner">refOwner</a></b> : Ext.Container<div class="mdesc"><div class="short">The ancestor Container into which the ref reference was inserted if this Component
is a child of a Container, and has...</div><div class="long">The ancestor Container into which the <a href="output/Ext.Component.html#Ext.Component-ref" ext:member="ref" ext:cls="Ext.Component">ref</a> reference was inserted if this Component
is a child of a Container, and has been configured with a <code>ref</code>.</div></div></td><td class="msource"><a href="output/Ext.Component.html#refOwner" ext:member="#refOwner" ext:cls="Ext.Component">Component</a></td></tr><tr class="property-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-rendered"></a><b><a href="source/Component.html#prop-Ext.Component-rendered">rendered</a></b> : Boolean<div class="mdesc">True if this component has been rendered. Read-only.</div></td><td class="msource"><a href="output/Ext.Component.html#rendered" ext:member="#rendered" ext:cls="Ext.Component">Component</a></td></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-root"></a><b><a href="source/TreePanel.html#prop-Ext.tree.TreePanel-root">root</a></b> : Ext.tree.TreeNode<div class="mdesc">The root node of this tree.</div></td><td class="msource">TreePanel</td></tr></tbody></table><a id="Ext.tree.TreePanel-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-TreePanel"></a><b><a href="source/TreePanel.html#cls-Ext.tree.TreePanel">TreePanel</a></b>( <code>Object config</code> )
- <div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Container-add"></a><b><a href="source/Container.html#method-Ext.Container-add">add</a></b>( <code>Object/Array component</code>, <code>Object (Optional)</code>, <code>Object (Optional)</code> )
+ <div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Container-add"></a><b><a href="source/Container.html#method-Ext.Container-add">add</a></b>( <code>...Object/Array component</code> )
:
- Ext.Component<div class="mdesc"><div class="short">Adds Component(s) to this Container.
+ Ext.Component
/Array<div class="mdesc"><div class="short">Adds Component(s) to this Container.
Description :
<ul class="mdetail-params">
Fires the beforeadd event before addin...</div><div class="long"><p>Adds <a href="output/Ext.Component.html" ext:cls="Ext.Component">Component</a>(s) to this Container.</p>
<li><i>Warning:</i> Containers directly managed by the BorderLayout layout manager
may not be removed or added. See the Notes for <a href="output/Ext.layout.BorderLayout.html" ext:cls="Ext.layout.BorderLayout">BorderLayout</a>
for more details.</li>
-</ul></div><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>component</code> : Object/Array<div class="sub-desc"><p>Either a single component or an Array of components to add. See
-<code><a href="output/Ext.Container.html#Ext.Container-items" ext:member="items" ext:cls="Ext.Container">items</a></code> for additional information.</p></div></li><
li><code>(Optional)</code> : Object<div class="sub-desc">component_2</div></li><li><code>(Optional)</code> : Object<div class="sub-desc">component_n</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">component The Component (or config object) that was added.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Container.html#add" ext:member="#add" ext:cls="Ext.Container">Container</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-addButton"></a><b><a href="source/Panel.html#method-Ext.Panel-addButton">addButton</a></b>( <code>String/Object config</code>, <code>Function handler</code>, <code>Object scope</code> )
+</ul></div><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>component</code> : ...Object/Array<div class="sub-desc"><p>Either one or more Components to add or an Array of Components to add. See
+<code><a href="output/Ext.Container.html#Ext.Container-items" ext:member="items" ext:cls="Ext.Container">items</a></code> for additional information.</p></div></li><
/ul><strong>Returns:</strong><ul><li><code>Ext.Component/Array</code><div class="sub-desc">The Components that were added.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Container.html#add" ext:member="#add" ext:cls="Ext.Container">Container</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-addButton"></a><b><a href="source/Panel.html#method-Ext.Panel-addButton">addButton</a></b>( <code>String/Object config</code>, <code>Function handler</code>, <code>Object scope</code> )
:
Ext.Button<div class="mdesc"><div class="short">Adds a button to this panel. Note that this method must be called prior to rendering. The preferred
approach is to ...</div><div class="long">Adds a button to this panel. Note that this method must be called prior to rendering. The preferred
<a href="output/Ext.ComponentMgr.html" ext:cls="Ext.ComponentMgr">Ext.ComponentMgr</a>. Destruction is generally handled automatically by the framework and this method
should usually not need to be called directly.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#destroy" ext:member="#destroy" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-enableBubble"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-enableBubble">enableBubble</a></b>( <code>String/Array events</code> )
:
- void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
-this.getBubbleTarget() if present...</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\r
-<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\r
-<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="output/Ext.Component.getBubbleTarget.html" ext:cls="Ext.Component.getBubbleTarget">Ext.Component.getBubbleTarget</a>. The default\r
-implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\r
-access the required target more quickly.</p>\r
-<p>Example:</p><pre><code>Ext.override(Ext.form.Field, {\r
- <i>// Add functionality to Field's initComponent to enable the change event to bubble\r</i>
- initComponent : Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {\r
- this.enableBubble(<em>'change'</em>);\r
- }),\r
-\r
- <i>// We know that we want Field's events to bubble directly to the FormPanel.\r</i>
- getBubbleTarget : <b>function</b>() {\r
- <b>if</b> (!this.formPanel) {\r
- this.formPanel = this.findParentByType(<em>'form'</em>);\r
- }\r
- <b>return</b> this.formPanel;\r
- }\r
-});\r
-\r
-<b>var</b> myForm = <b>new</b> Ext.formPanel({\r
- title: <em>'User Details'</em>,\r
- items: [{\r
- ...\r
- }],\r
- listeners: {\r
- change: <b>function</b>() {\r
- <i>// Title goes red <b>if</b> form has been modified.\r</i>
- myForm.header.setStyle(<em>'color'</em>, <em>'red'</em>);\r
- }\r
- }\r
+ void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
+<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
+<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="output/Ext.Component.getBubbleTarget.html" ext:cls="Ext.Component.getBubbleTarget">Ext.Component.getBubbleTarget</a>. The default
+implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
+access the required target more quickly.</p>
+<p>Example:</p><pre><code>Ext.override(Ext.form.Field, {
+ <i>// Add functionality to Field's initComponent to enable the change event to bubble</i>
+ initComponent : Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {
+ this.enableBubble(<em>'change'</em>);
+ }),
+
+ <i>// We know that we want Field's events to bubble directly to the FormPanel.</i>
+ getBubbleTarget : <b>function</b>() {
+ <b>if</b> (!this.formPanel) {
+ this.formPanel = this.findParentByType(<em>'form'</em>);
+ }
+ <b>return</b> this.formPanel;
+ }
+});
+
+<b>var</b> myForm = <b>new</b> Ext.formPanel({
+ title: <em>'User Details'</em>,
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: <b>function</b>() {
+ <i>// Title goes red <b>if</b> form has been modified.</i>
+ myForm.header.setStyle(<em>'color'</em>, <em>'red'</em>);
+ }
+ }
});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : String/Array<div class="sub-desc">The event name to bubble, or an Array of event names.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-expand"></a><b><a href="source/Panel.html#method-Ext.Panel-expand">expand</a></b>( <code>Boolean animate</code> )
:
Ext.Panel<div class="mdesc"><div class="short">Expands the panel body so that it becomes visible. Fires the beforeexpand event which will
:
void<div class="mdesc"><div class="short">Expand all nodes</div><div class="long">Expand all nodes<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-expandPath"></a><b><a href="source/TreePanel.html#method-Ext.tree.TreePanel-expandPath">expandPath</a></b>( <code>String path</code>, <span title="Optional" class="optional">[<code>String attr</code>]</span>, <span title="Optional" class="optional">[<code>Function callback</code>]</span> )
:
- void<div class="mdesc"><div class="short">Expands a specified path in this TreePanel. A path can be retrieved from a node with Ext.data.Node.getPath</div><div class="long">Expands a specified path in this TreePanel. A path can be retrieved from a node with <a href="output/Ext.data.Node.html#Ext.data.Node-getPath" ext:member="getPath" ext:cls="Ext.data.Node">Ext.data.Node.getPath</a><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>path</code> : String<div class="sub-desc"></div></li><li><code>attr</code> : String<div class="sub-desc">(optional) The attribute used in the path (see <a href="output/Ext.data.Node.html#Ext.data.Node-getPath" ext:member="getPath" ext:cls="Ext.data.Node">Ext.data.Node.getPath</a> for more info)</div></li><li><code>callback</code> : Function<div class="sub-desc">(optional) The callback to call when the expand is complete. The callback will be called with\r
+ void<div class="mdesc"><div class="short">Expands a specified path in this TreePanel. A path can be retrieved from a node with Ext.data.Node.getPath</div><div class="long">Expands a specified path in this TreePanel. A path can be retrieved from a node with <a href="output/Ext.data.Node.html#Ext.data.Node-getPath" ext:member="getPath" ext:cls="Ext.data.Node">Ext.data.Node.getPath</a><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>path</code> : String<div class="sub-desc"></div></li><li><code>attr</code> : String<div class="sub-desc">(optional) The attribute used in the path (see <a href="output/Ext.data.Node.html#Ext.data.Node-getPath" ext:member="getPath" ext:cls="Ext.data.Node">Ext.data.Node.getPath</a> for more info)</div></li><li><code>callback</code> : Function<div class="sub-desc">(optional) The callback to call when the expand is complete. The callback will be called with
(bSuccess, oLastNode) where bSuccess is if the expand was successful and oLastNode is the last node that was expanded.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-findParentBy"></a><b><a href="source/Component.html#method-Ext.Component-findParentBy">findParentBy</a></b>( <code>Function fn</code> )
:
Ext.Container<div class="mdesc"><div class="short">Find a container above this component at any level by a custom function. If the passed function returns
},
single: true <i>// Remove the listener after first invocation</i>
}
-});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The Element which encapsulates this Component.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#getEl" ext:member="#getEl" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-getFrameHeight"></a><b><a href="source/Panel.html#method-Ext.Panel-getFrameHeight">getFrameHeight</a></b>()
+});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The Element which encapsulates this Component.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#getEl" ext:member="#getEl" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-getFooterToolbar"></a><b><a href="source/Panel.html#method-Ext.Panel-getFooterToolbar">getFooterToolbar</a></b>()
+ :
+ Ext.Toolbar<div class="mdesc"><div class="short">Returns the toolbar from the footer (fbar) section of the panel.</div><div class="long">Returns the <a href="output/Ext.Toolbar.html" ext:cls="Ext.Toolbar">toolbar</a> from the footer (<code><a href="output/Ext.Panel.html#Ext.Panel-fbar" ext:member="fbar" ext:cls="Ext.Panel">fbar</a></code>) section of the panel.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Toolbar</code><div class="sub-desc">The toolbar</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#getFooterToolbar" ext:member="#getFooterToolbar" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-getFrameHeight"></a><b><a href="source/Panel.html#method-Ext.Panel-getFrameHeight">getFrameHeight</a></b>()
:
Number<div class="mdesc"><div class="short">Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and
header and ...</div><div class="long">Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and
If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
events fired during event suspension will be sent to any listeners now.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#resumeEvents" ext:member="#resumeEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-selectPath"></a><b><a href="source/TreePanel.html#method-Ext.tree.TreePanel-selectPath">selectPath</a></b>( <code>String path</code>, <span title="Optional" class="optional">[<code>String attr</code>]</span>, <span title="Optional" class="optional">[<code>Function callback</code>]</span> )
:
- void<div class="mdesc"><div class="short">Selects the node in this tree at the specified path. A path can be retrieved from a node with Ext.data.Node.getPath</div><div class="long">Selects the node in this tree at the specified path. A path can be retrieved from a node with <a href="output/Ext.data.Node.html#Ext.data.Node-getPath" ext:member="getPath" ext:cls="Ext.data.Node">Ext.data.Node.getPath</a><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>path</code> : String<div class="sub-desc"></div></li><li><code>attr</code> : String<div class="sub-desc">(optional) The attribute used in the path (see <a href="output/Ext.data.Node.html#Ext.data.Node-getPath" ext:member="getPath" ext:cls="Ext.data.Node">Ext.data.Node.getPath</a> for more info)</div></li><li><code>callback</code> : Function<div class="sub-desc">(optional) The callback to call when the selection is complete. The callback will be called with\r
+ void<div class="mdesc"><div class="short">Selects the node in this tree at the specified path. A path can be retrieved from a node with Ext.data.Node.getPath</div><div class="long">Selects the node in this tree at the specified path. A path can be retrieved from a node with <a href="output/Ext.data.Node.html#Ext.data.Node-getPath" ext:member="getPath" ext:cls="Ext.data.Node">Ext.data.Node.getPath</a><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>path</code> : String<div class="sub-desc"></div></li><li><code>attr</code> : String<div class="sub-desc">(optional) The attribute used in the path (see <a href="output/Ext.data.Node.html#Ext.data.Node-getPath" ext:member="getPath" ext:cls="Ext.data.Node">Ext.data.Node.getPath</a> for more info)</div></li><li><code>callback</code> : Function<div class="sub-desc">(optional) The callback to call when the selection is complete. The callback will be called with
(bSuccess, oSelNode) where bSuccess is if the selection was successful and oSelNode is the selected node.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-setAutoScroll"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setAutoScroll">setAutoScroll</a></b>( <code>Boolean scroll</code> )
:
- Ext.BoxComponent<div class="mdesc"><div class="short">Sets the overflow on the content element of the component.</div><div class="long">Sets the overflow on the content element of the component.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>scroll</code> : Boolean<div class="sub-desc">True to allow the Component to auto scroll.</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#setAutoScroll" ext:member="#setAutoScroll" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-setHeight"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setHeight">setHeight</a></b>( <code>Number height</code> )
+ Ext.BoxComponent<div class="mdesc"><div class="short">Sets the overflow on the content element of the component.</div><div class="long">Sets the overflow on the content element of the component.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>scroll</code> : Boolean<div class="sub-desc">True to allow the Component to auto scroll.</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#setAutoScroll" ext:member="#setAutoScroll" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-setHeight"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setHeight">setHeight</a></b>( <code>Mixed height</code> )
:
- Ext.BoxComponent<div class="mdesc"><div class="short">Sets the height of the component. This method fires the resize event.</div><div class="long">Sets the height of the component. This method fires the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-resize" ext:member="resize" ext:cls="Ext.BoxComponent">resize</a> event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>height</code> :
Number<div class="sub-desc">The new height to set. This may be one of:<div class="mdetail-params"><ul>
-<li>A Number specifying the new height in the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-getEl" ext:member="getEl" ext:cls="Ext.BoxComponent">Element</a>'s <a href="output/Ext.Element.html#Ext.Element-defaultUnit" ext:member="defaultUnit" ext:cls="Ext.Element">Ext.Element.defaultUnit</a>s (by default, pixels).</li>
+ Ext.BoxComponent<div class="mdesc"><div class="short">Sets the height of the component. This method fires the resize event.</div><div class="long">Sets the height of the component. This method fires the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-resize" ext:member="resize" ext:cls="Ext.BoxComponent">resize</a> event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>height</code> :
Mixed<div class="sub-desc">The new height to set. This may be one of:<div class="mdetail-params"><ul>
+<li>A Number specifying the new height in the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-getEl" ext:member="getEl" ext:cls="Ext.BoxComponent">Element</a>'s <a href="output/Ext.Element.html#Ext.Element-defaultUnit" ext:member="defaultUnit" ext:cls="Ext.Element">defaultUnit</a>s (by default, pixels).</li>
<li>A String used to set the CSS height style.</li>
<li><i>undefined</i> to leave the height unchanged.</li>
</ul></div></div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#setHeight" ext:member="#setHeight" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-setIconClass"></a><b><a href="source/Panel.html#method-Ext.Panel-setIconClass">setIconClass</a></b>( <code>String cls</code> )
This method fires ...</div><div class="long">Sets the left and top of the component. To set the page XY position instead, use <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-setPagePosition" ext:member="setPagePosition" ext:cls="Ext.BoxComponent">setPagePosition</a>.
This method fires the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-move" ext:member="move" ext:cls="Ext.BoxComponent">move</a> event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>left</code> : Number<div class="sub-desc">The new left</div></li><li><code>top</code> : Number<div class="sub-desc">The new top</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#setPosition" ext:member="#setPosition" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-setRootNode"></a><b><a href="source/TreePanel.html#method-Ext.tree.TreePanel-setRootNode">setRootNode</a></b>( <code>Node node</code> )
:
- Node<div class="mdesc"><div class="short">Sets the root node for this tree. If the TreePanel has already rendered a root node, the
-previous root node (and all...</div><div class="long">Sets the root node for this tree. If the TreePanel has already rendered a root node, the\r
+ Node<div class="mdesc"><div class="short">Sets the root node for this tree. If the TreePanel has already rendered a root node, the
+previous root node (and all ...</div><div class="long">Sets the root node for this tree. If the TreePanel has already rendered a root node, the
previous root node (and all of its descendants) are destroyed before the new root node is rendered.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>node</code> : Node<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li><code>Node</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-setSize"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setSize">setSize</a></b>( <code>Mixed width</code>, <code>Mixed height</code> )
:
Ext.BoxComponent<div class="mdesc"><div class="short">Sets the width and height of this BoxComponent. This method fires the resize event. This method can accept
for the Panel. This is triggered either by configuring the Panel with a non-blank <code><a href="output/Ext.Panel.html#Ext.Panel-title" ext:member="title" ext:cls="Ext.Panel">title</a></code>,
or configuring it with <code><b><a href="output/Ext.Panel.html#Ext.Panel-header" ext:member="header" ext:cls="Ext.Panel">header</a>: true</b></code>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>title</code> : String<div class="sub-desc">The title text to set</div></li><li><code>iconCls</code> : String<div class="sub-desc">(optional) <a href="output/Ext.Panel.html#Ext.Panel-iconCls" ext:member="iconCls" ext:cls="Ext.Panel">iconCls</a> A user-defined CSS class that provides the icon image for this panel</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#setTitle" ext:member="#setTitle" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-setVisible"></a><b><a href="source/Component.html#method-Ext.Component-setVisible">setVisible</a></b>( <code>Boolean visible</code> )
:
- Ext.Component<div class="mdesc"><div class="short">Convenience function to hide or show this component by boolean.</div><div class="long">Convenience function to hide or show this component by boolean.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>visible</code> : Boolean<div class="sub-desc">True to show, false to hide</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#setVisible" ext:member="#setVisible" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-setWidth"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setWidth">setWidth</a></b>( <code>Number width</code> )
+ Ext.Component<div class="mdesc"><div class="short">Convenience function to hide or show this component by boolean.</div><div class="long">Convenience function to hide or show this component by boolean.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>visible</code> : Boolean<div class="sub-desc">True to show, false to hide</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#setVisible" ext:member="#setVisible" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-setWidth"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setWidth">setWidth</a></b>( <code>Mixed width</code> )
:
- Ext.BoxComponent<div class="mdesc"><div class="short">Sets the width of the component. This method fires the resize event.</div><div class="long">Sets the width of the component. This method fires the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-resize" ext:member="resize" ext:cls="Ext.BoxComponent">resize</a> event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>width</code> :
Number<div class="sub-desc">The new width to setThis may be one of:<div class="mdetail-params"><ul>
-<li>A Number specifying the new width in the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-getEl" ext:member="getEl" ext:cls="Ext.BoxComponent">Element</a>'s <a href="output/Ext.Element.html#Ext.Element-defaultUnit" ext:member="defaultUnit" ext:cls="Ext.Element">Ext.Element.defaultUnit</a>s (by default, pixels).</li>
+ Ext.BoxComponent<div class="mdesc"><div class="short">Sets the width of the component. This method fires the resize event.</div><div class="long">Sets the width of the component. This method fires the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-resize" ext:member="resize" ext:cls="Ext.BoxComponent">resize</a> event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>width</code> :
Mixed<div class="sub-desc">The new width to set. This may be one of:<div class="mdetail-params"><ul>
+<li>A Number specifying the new width in the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-getEl" ext:member="getEl" ext:cls="Ext.BoxComponent">Element</a>'s <a href="output/Ext.Element.html#Ext.Element-defaultUnit" ext:member="defaultUnit" ext:cls="Ext.Element">defaultUnit</a>s (by default, pixels).</li>
<li>A String used to set the CSS width style.</li>
</ul></div></div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#setWidth" ext:member="#setWidth" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-show"></a><b><a href="source/Component.html#method-Ext.Component-show">show</a></b>()
:
( <code>Tree tree</code>, <code>Node node</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code> )
<div class="mdesc"><div class="short">Fires before a node is moved to a new location in the tree. Return false to cancel the move.</div><div class="long">Fires before a node is moved to a new location in the tree. Return false to cancel the move.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>node</code> : Node<div class="sub-desc">The node being moved</div></li><li><code>oldParent</code> : Node<div class="sub-desc">The parent of the node</div></li><li><code>newParent</code> : Node<div class="sub-desc">The new parent the node is moving to</div></li><li><code>index</code> : Number<div class="sub-desc">The index it is being moved to</div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-beforenodedrop"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-beforenodedrop">beforenodedrop</a></b> :
( <code>Object dropEvent</code> )
- <div class="mdesc"><div class="short">Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The drop...</div><div class="long">Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The dropEvent\r
-passed to handlers has the following properties:<br />\r
-<ul style="padding:5px;padding-left:16px;">\r
-<li>tree - The TreePanel</li>\r
-<li>target - The node being targeted for the drop</li>\r
-<li>data - The drag data from the drag source</li>\r
-<li>point - The point of the drop - append, above or below</li>\r
-<li>source - The drag source</li>\r
-<li>rawEvent - Raw mouse event</li>\r
-<li>dropNode - Drop node(s) provided by the source <b>OR</b> you can supply node(s)\r
-to be inserted by setting them on this object.</li>\r
-<li>cancel - Set this to true to cancel the drop.</li>\r
-<li>dropStatus - If the default drop action is cancelled but the drop is valid, setting this to true\r
-will prevent the animated 'repair' from appearing.</li>\r
+ <div class="mdesc"><div class="short">Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The drop...</div><div class="long">Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The dropEvent
+passed to handlers has the following properties:<br />
+<ul style="padding:5px;padding-left:16px;">
+<li>tree - The TreePanel</li>
+<li>target - The node being targeted for the drop</li>
+<li>data - The drag data from the drag source</li>
+<li>point - The point of the drop - append, above or below</li>
+<li>source - The drag source</li>
+<li>rawEvent - Raw mouse event</li>
+<li>dropNode - Drop node(s) provided by the source <b>OR</b> you can supply node(s)
+to be inserted by setting them on this object.</li>
+<li>cancel - Set this to true to cancel the drop.</li>
+<li>dropStatus - If the default drop action is cancelled but the drop is valid, setting this to true
+will prevent the animated 'repair' from appearing.</li>
</ul><div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>dropEvent</code> : Object<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-beforeremove"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-beforeremove">beforeremove</a></b> :
( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code> )
<div class="mdesc"><div class="short">Fires before a child is removed from a node in this tree, return false to cancel the remove.</div><div class="long">Fires before a child is removed from a node in this tree, return false to cancel the remove.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>parent</code> : Node<div class="sub-desc">The parent node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node to be removed</div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-beforerender"></a><b><a href="source/Component.html#event-Ext.Component-beforerender">beforerender</a></b> :
( <code>Tree this</code>, <code>Ext.EventObject e</code> )
<div class="mdesc"><div class="short">Fires when the tree container is double clicked</div><div class="long">Fires when the tree container is double clicked<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Tree<div class="sub-desc"></div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-contextmenu"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-contextmenu">contextmenu</a></b> :
( <code>Node node</code>, <code>Ext.EventObject e</code> )
- <div class="mdesc"><div class="short">Fires when a node is right clicked. To display a context menu in response to this
-event, first create a Menu object ...</div><div class="long">Fires when a node is right clicked. To display a context menu in response to this\r
-event, first create a Menu object (see <a href="output/Ext.menu.Menu.html" ext:cls="Ext.menu.Menu">Ext.menu.Menu</a> for details), then add\r
-a handler for this event:<pre><code><b>new</b> Ext.tree.TreePanel({\r
- title: <em>'My TreePanel'</em>,\r
- root: <b>new</b> Ext.tree.AsyncTreeNode({\r
- text: <em>'The Root'</em>,\r
- children: [\r
- { text: <em>'Child node 1'</em>, leaf: true },\r
- { text: <em>'Child node 2'</em>, leaf: true }\r
- ]\r
- }),\r
- contextMenu: <b>new</b> Ext.menu.Menu({\r
- items: [{\r
- id: <em>'<b>delete</b>-node'</em>,\r
- text: <em>'Delete Node'</em>\r
- }],\r
- listeners: {\r
- itemclick: <b>function</b>(item) {\r
- <b>switch</b> (item.id) {\r
- <b>case</b> <em>'<b>delete</b>-node'</em>:\r
- <b>var</b> n = item.parentMenu.contextNode;\r
- <b>if</b> (n.parentNode) {\r
- n.remove();\r
- }\r
- <b>break</b>;\r
- }\r
- }\r
- }\r
- }),\r
- listeners: {\r
- contextmenu: <b>function</b>(node, e) {\r
-<i>// Register the context node <b>with</b> the menu so that a Menu Item<em>'s handler <b>function</b> can access\r</i>
-<i>// it via its <a href="output/Ext.menu.BaseItem.html#Ext.menu.BaseItem-parentMenu" ext:member="parentMenu" ext:cls="Ext.menu.BaseItem">parentMenu</a> property.\r</i>
- node.select();\r
- <b>var</b> c = node.getOwnerTree().contextMenu;\r
- c.contextNode = node;\r
- c.showAt(e.getXY());\r
- }\r
- }\r
+ <div class="mdesc"><div class="short">Fires when a node is right clicked. To display a context menu in response to this
+event, first create a Menu object (...</div><div class="long">Fires when a node is right clicked. To display a context menu in response to this
+event, first create a Menu object (see <a href="output/Ext.menu.Menu.html" ext:cls="Ext.menu.Menu">Ext.menu.Menu</a> for details), then add
+a handler for this event:<pre><code><b>new</b> Ext.tree.TreePanel({
+ title: <em>'My TreePanel'</em>,
+ root: <b>new</b> Ext.tree.AsyncTreeNode({
+ text: <em>'The Root'</em>,
+ children: [
+ { text: <em>'Child node 1'</em>, leaf: true },
+ { text: <em>'Child node 2'</em>, leaf: true }
+ ]
+ }),
+ contextMenu: <b>new</b> Ext.menu.Menu({
+ items: [{
+ id: <em>'<b>delete</b>-node'</em>,
+ text: <em>'Delete Node'</em>
+ }],
+ listeners: {
+ itemclick: <b>function</b>(item) {
+ <b>switch</b> (item.id) {
+ <b>case</b> <em>'<b>delete</b>-node'</em>:
+ <b>var</b> n = item.parentMenu.contextNode;
+ <b>if</b> (n.parentNode) {
+ n.remove();
+ }
+ <b>break</b>;
+ }
+ }
+ }
+ }),
+ listeners: {
+ contextmenu: <b>function</b>(node, e) {
+<i>// Register the context node <b>with</b> the menu so that a Menu Item<em>'s handler <b>function</b> can access</i>
+<i>// it via its <a href="output/Ext.menu.BaseItem.html#Ext.menu.BaseItem-parentMenu" ext:member="parentMenu" ext:cls="Ext.menu.BaseItem">parentMenu</a> property.</i>
+ node.select();
+ <b>var</b> c = node.getOwnerTree().contextMenu;
+ c.contextNode = node;
+ c.showAt(e.getXY());
+ }
+ }
});</code></pre><div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-dblclick"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-dblclick">dblclick</a></b> :
( <code>Node node</code>, <code>Ext.EventObject e</code> )
<div class="mdesc"><div class="short">Fires when a node is double clicked</div><div class="long">Fires when a node is double clicked<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-deactivate"></a><b><a href="source/Panel.html#event-Ext.Panel-deactivate">deactivate</a></b> :
( <code>Tree tree</code>, <code>Node node</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code> )
<div class="mdesc"><div class="short">Fires when a node is moved to a new location in the tree</div><div class="long">Fires when a node is moved to a new location in the tree<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>node</code> : Node<div class="sub-desc">The node moved</div></li><li><code>oldParent</code> : Node<div class="sub-desc">The old parent of this node</div></li><li><code>newParent</code> : Node<div class="sub-desc">The new parent of this node</div></li><li><code>index</code> : Number<div class="sub-desc">The index it was moved to</div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-nodedragover"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-nodedragover">nodedragover</a></b> :
( <code>Object dragOverEvent</code> )
- <div class="mdesc"><div class="short">Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent ...</div><div class="long">Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent\r
-passed to handlers has the following properties:<br />\r
-<ul style="padding:5px;padding-left:16px;">\r
-<li>tree - The TreePanel</li>\r
-<li>target - The node being targeted for the drop</li>\r
-<li>data - The drag data from the drag source</li>\r
-<li>point - The point of the drop - append, above or below</li>\r
-<li>source - The drag source</li>\r
-<li>rawEvent - Raw mouse event</li>\r
-<li>dropNode - Drop node(s) provided by the source.</li>\r
-<li>cancel - Set this to true to signal drop not allowed.</li>\r
+ <div class="mdesc"><div class="short">Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent
+...</div><div class="long">Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent
+passed to handlers has the following properties:<br />
+<ul style="padding:5px;padding-left:16px;">
+<li>tree - The TreePanel</li>
+<li>target - The node being targeted for the drop</li>
+<li>data - The drag data from the drag source</li>
+<li>point - The point of the drop - append, above or below</li>
+<li>source - The drag source</li>
+<li>rawEvent - Raw mouse event</li>
+<li>dropNode - Drop node(s) provided by the source.</li>
+<li>cancel - Set this to true to signal drop not allowed.</li>
</ul><div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>dragOverEvent</code> : Object<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-nodedrop"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-nodedrop">nodedrop</a></b> :
( <code>Object dropEvent</code> )
- <div class="mdesc"><div class="short">Fires after a DD object is dropped on a node in this tree. The dropEvent
-passed to handlers has the following proper...</div><div class="long">Fires after a DD object is dropped on a node in this tree. The dropEvent\r
-passed to handlers has the following properties:<br />\r
-<ul style="padding:5px;padding-left:16px;">\r
-<li>tree - The TreePanel</li>\r
-<li>target - The node being targeted for the drop</li>\r
-<li>data - The drag data from the drag source</li>\r
-<li>point - The point of the drop - append, above or below</li>\r
-<li>source - The drag source</li>\r
-<li>rawEvent - Raw mouse event</li>\r
-<li>dropNode - Dropped node(s).</li>\r
+ <div class="mdesc"><div class="short">Fires after a DD object is dropped on a node in this tree. The dropEvent
+passed to handlers has the following propert...</div><div class="long">Fires after a DD object is dropped on a node in this tree. The dropEvent
+passed to handlers has the following properties:<br />
+<ul style="padding:5px;padding-left:16px;">
+<li>tree - The TreePanel</li>
+<li>target - The node being targeted for the drop</li>
+<li>data - The drag data from the drag source</li>
+<li>point - The point of the drop - append, above or below</li>
+<li>source - The drag source</li>
+<li>rawEvent - Raw mouse event</li>
+<li>dropNode - Dropped node(s).</li>
</ul><div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>dropEvent</code> : Object<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-remove"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-remove">remove</a></b> :
( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code> )
<div class="mdesc"><div class="short">Fires when a child node is removed from a node in this tree.</div><div class="long">Fires when a child node is removed from a node in this tree.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>parent</code> : Node<div class="sub-desc">The parent node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node removed</div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-removed"></a><b><a href="source/Component.html#event-Ext.Component-removed">removed</a></b> :
git.ithinksw.org / extjs.git / blobdiff