1151 lines
No EOL
66 KiB
HTML
1151 lines
No EOL
66 KiB
HTML
<!doctype html public "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>Ext.data.Node</title>
|
|
<link rel="stylesheet" type="text/css" href="../resources/reset.css"/>
|
|
<link rel="stylesheet" type="text/css" href="../resources/style.css" media="screen"/>
|
|
<link rel="stylesheet" type="text/css" href="../resources/print.css" media="print">
|
|
<!-- GC -->
|
|
</head>
|
|
<body>
|
|
<div class="body-wrap">
|
|
<div class="top-tools">
|
|
<img src="../resources/print.gif" width="16" height="16" align="absmiddle"> <a href="Ext.data.Node.html" target="_blank">Print Friendly</a><br/>
|
|
|
|
</div>
|
|
<h1>Class Ext.data.Node</h1>
|
|
<table cellspacing="0">
|
|
<tr><td class="label">Package:</td><td>Ext.data</td></tr>
|
|
<tr><td class="label">Class:</td><td>Node</td></tr>
|
|
<tr><td class="label">Extends:</td><td><a href="Ext.util.Observable.html">Observable</a></td></tr>
|
|
<tr><td class="label">Subclasses:</td><td><a href="Ext.tree.TreeNode.html">TreeNode</a></td></tr>
|
|
<tr><td class="label">Defined In:</td><td><a href="Tree.jss.html">Tree.js</a></td></tr>
|
|
</table>
|
|
<div class="description">
|
|
</div>
|
|
<br />
|
|
<a href="#properties">Properties</a>
|
|
- <a href="#methods">Methods</a>
|
|
- <a href="#events">Events</a>
|
|
- <a href="#configs">Config Options</a>
|
|
<hr />
|
|
<a name="properties"></a>
|
|
<h2>Public Properties</h2>
|
|
<table cellspacing="0" class="member-table">
|
|
<tr>
|
|
<th class="sig-header" colspan="2">Property</th>
|
|
<th class="msource-header">Defined By</th>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#attributes">attributes</a> : Object</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">The attributes supplied for the node. You can use this property to access any custom attributes you supplied.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#childNodes">childNodes</a> : Array</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">All child nodes of this node.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#firstChild">firstChild</a> : Node</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">The first direct child node of this node, or null if this node has no child nodes.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#id">id</a> : String</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">The node id.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#lastChild">lastChild</a> : Node</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">The last direct child node of this node, or null if this node has no child nodes.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#nextSibling">nextSibling</a> : Node</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">The node immediately following this node in the tree, or null if there is no sibling node.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#parentNode">parentNode</a> : Node</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">The parent node for this node.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#previousSibling">previousSibling</a> : Node</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">The node immediately preceding this node in the tree, or null if there is no sibling node.</td>
|
|
</tr>
|
|
</table>
|
|
<a name="methods"></a>
|
|
<h2>Public Methods</h2>
|
|
<table cellspacing="0" class="member-table">
|
|
<tr>
|
|
<th class="sig-header" colspan="2">Method</th>
|
|
<th class="msource-header">Defined By</th>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#Node">Node</a>(<code>Object attributes</code>)</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc"></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#addEvents">addEvents</a>(<code>Object object</code>) : void</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#addEvents">Observable</a></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Copies any events from the passed object onto this object if they do not already exist. The passed object
|
|
must also ...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#addListener">addListener</a>(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#addListener">Observable</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Appends an event handler to this component</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#appendChild">appendChild</a>(<code>Node/Array node</code>) : Node</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Insert node(s) as the last child node of this node.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#bubble">bubble</a>(<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Array args</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Bubbles up the tree from this node, calling the specified function with each node. The scope (this) of
|
|
function call...</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#cascade">cascade</a>(<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Array args</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Cascades down the tree from this node, calling the specified function with each node. The scope (this) of
|
|
function c...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#contains">contains</a>(<code>Node node</code>) : Boolean</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns true if this node is an ancestor (at any point) of the passed node.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#eachChild">eachChild</a>(<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Array args</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Interates the child nodes of this node, calling the specified function with each node. The scope (this) of
|
|
function ...</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#findChild">findChild</a>(<code>String attribute</code>, <code>Mixed value</code>) : Node</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Finds the first child that has the attribute with the specified value.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#findChildBy">findChildBy</a>(<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>) : Node</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Finds the first child by a custom function. The child matches if the function passed
|
|
returns true.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#fireEvent">fireEvent</a>(<code>String eventName</code>, <code>Object... args</code>) : Boolean</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#fireEvent">Observable</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Fires the specified event with the passed parameters (minus the event name).</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getDepth">getDepth</a>() : Number</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns depth of this node (the root node has a depth of 0)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getOwnerTree">getOwnerTree</a>() : Tree</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns the tree this node is in.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getPath">getPath</a>(<span class="optional" title="Optional">[<code>String attr</code>]</span>) : String</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns the path for this node. The path can be used to expand or select this node programmatically.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#hasListener">hasListener</a>(<code>String eventName</code>) : Boolean</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#hasListener">Observable</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Checks to see if this object is currently listening for a specified event</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#indexOf">indexOf</a>(<code>Node node</code>) : Number</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns the index of a child node</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#insertBefore">insertBefore</a>(<code>Node node</code>, <code>Node refNode</code>) : Node</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Inserts the first node before the second node in this nodes childNodes collection.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#isAncestor">isAncestor</a>(<code>Node node</code>) : Boolean</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns true if the passed node is an ancestor (at any point) of this node.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#isFirst">isFirst</a>() : Boolean</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns true if this node is the first child of its parent</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#isLast">isLast</a>() : Boolean</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns true if this node is the last child of its parent</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#isLeaf">isLeaf</a>() : Boolean</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns true if this node is a leaf</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#item">item</a>(<code>Number index</code>) : Node</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns the child node at the specified index.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#on">on</a>(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object options</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#on">Observable</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Appends an event handler to this element (shorthand for addListener)</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#purgeListeners">purgeListeners</a>() : void</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#purgeListeners">Observable</a></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Removes all listeners for this object</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#removeChild">removeChild</a>(<code>Node node</code>) : Node</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Removes a child node from this node.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#removeListener">removeListener</a>(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#removeListener">Observable</a></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Removes a listener</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#replaceChild">replaceChild</a>(<code>Node newChild</code>, <code>Node oldChild</code>) : Node</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Replaces one child node in this node with another.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#sort">sort</a>(<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Sorts this nodes children using the supplied sort function</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#un">un</a>(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2"><a href="Ext.util.Observable.html#un">Observable</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Removes a listener (shorthand for removeListener)</td>
|
|
</tr>
|
|
</table>
|
|
<a name="events"></a>
|
|
<h2>Public Events</h2>
|
|
<table cellspacing="0" class="member-table">
|
|
<tr>
|
|
<th class="sig-header" colspan="2">Event</th>
|
|
<th class="msource-header">Defined By</th>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-append">append</a> : (<code>Tree tree</code>, <code>Node this</code>, <code>Node node</code>, <code>Number index</code>)</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Fires when a new child node is appended</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-beforeappend">beforeappend</a> : (<code>Tree tree</code>, <code>Node this</code>, <code>Node node</code>)</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Fires before a new child is appended, return false to cancel the append.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-beforeinsert">beforeinsert</a> : (<code>Tree tree</code>, <code>Node this</code>, <code>Node node</code>, <code>Node refNode</code>)</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Fires before a new child is inserted, return false to cancel the insert.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-beforemove">beforemove</a> : (<code>Tree tree</code>, <code>Node this</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code>)</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Fires before this node is moved to a new location in the tree. Return false to cancel the move.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-beforeremove">beforeremove</a> : (<code>Tree tree</code>, <code>Node this</code>, <code>Node node</code>)</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Fires before a child is removed, return false to cancel the remove.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-insert">insert</a> : (<code>Tree tree</code>, <code>Node this</code>, <code>Node node</code>, <code>Node refNode</code>)</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Fires when a new child node is inserted.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-move">move</a> : (<code>Tree tree</code>, <code>Node this</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code>)</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Fires when this node is moved to a new location in the tree</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-remove">remove</a> : (<code>Tree tree</code>, <code>Node this</code>, <code>Node node</code>)</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Fires when a child node is removed</td>
|
|
</tr>
|
|
</table>
|
|
<a name="configs"></a>
|
|
<h2>Config Options</h2>
|
|
<table cellspacing="0" class="member-table">
|
|
<tr>
|
|
<th class="sig-header" colspan="2">Config Options</th>
|
|
<th class="msource-header">Defined By</th>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-id">id</a> : String</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">The id for this node. If one is not specified, one is generated.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#config-leaf">leaf</a> : Boolean</td>
|
|
<td class="msource" rowspan="2">Node</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">true if this node is a leaf and does not have children</td>
|
|
</tr>
|
|
</table>
|
|
<h2 class="mdetail-head">Property Details</h2>
|
|
<div class="detail-wrap">
|
|
<a name="attributes"></a>
|
|
<div class="mdetail">
|
|
<h3>attributes</i></h3>
|
|
<code>public Object attributes</code>
|
|
<div class="mdetail-desc">
|
|
The attributes supplied for the node. You can use this property to access any custom attributes you supplied. </div>
|
|
<div class="mdetail-def">This property is defined by Node.</div>
|
|
</div>
|
|
<a name="childNodes"></a>
|
|
<div class="mdetail alt">
|
|
<h3>childNodes</i></h3>
|
|
<code>public Array childNodes</code>
|
|
<div class="mdetail-desc">
|
|
All child nodes of this node. </div>
|
|
<div class="mdetail-def">This property is defined by Node.</div>
|
|
</div>
|
|
<a name="firstChild"></a>
|
|
<div class="mdetail">
|
|
<h3>firstChild</i></h3>
|
|
<code>public Node firstChild</code>
|
|
<div class="mdetail-desc">
|
|
The first direct child node of this node, or null if this node has no child nodes. </div>
|
|
<div class="mdetail-def">This property is defined by Node.</div>
|
|
</div>
|
|
<a name="id"></a>
|
|
<div class="mdetail alt">
|
|
<h3>id</i></h3>
|
|
<code>public String id</code>
|
|
<div class="mdetail-desc">
|
|
The node id. </div>
|
|
<div class="mdetail-def">This property is defined by Node.</div>
|
|
</div>
|
|
<a name="lastChild"></a>
|
|
<div class="mdetail">
|
|
<h3>lastChild</i></h3>
|
|
<code>public Node lastChild</code>
|
|
<div class="mdetail-desc">
|
|
The last direct child node of this node, or null if this node has no child nodes. </div>
|
|
<div class="mdetail-def">This property is defined by Node.</div>
|
|
</div>
|
|
<a name="nextSibling"></a>
|
|
<div class="mdetail alt">
|
|
<h3>nextSibling</i></h3>
|
|
<code>public Node nextSibling</code>
|
|
<div class="mdetail-desc">
|
|
The node immediately following this node in the tree, or null if there is no sibling node. </div>
|
|
<div class="mdetail-def">This property is defined by Node.</div>
|
|
</div>
|
|
<a name="parentNode"></a>
|
|
<div class="mdetail">
|
|
<h3>parentNode</i></h3>
|
|
<code>public Node parentNode</code>
|
|
<div class="mdetail-desc">
|
|
The parent node for this node. </div>
|
|
<div class="mdetail-def">This property is defined by Node.</div>
|
|
</div>
|
|
<a name="previousSibling"></a>
|
|
<div class="mdetail alt">
|
|
<h3>previousSibling</i></h3>
|
|
<code>public Node previousSibling</code>
|
|
<div class="mdetail-desc">
|
|
The node immediately preceding this node in the tree, or null if there is no sibling node. </div>
|
|
<div class="mdetail-def">This property is defined by Node.</div>
|
|
</div>
|
|
</div>
|
|
|
|
<a name="Node"></a>
|
|
<h2 class="mdetail-head">Constructor Details</h2>
|
|
<div class="detail-wrap">
|
|
<div class="mdetail">
|
|
<h3>Node</i></h3>
|
|
<code>public function Node(<code>Object attributes</code>)</code>
|
|
<div class="mdetail-desc">
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>attributes</code> : Object<div class="sub-desc">The attributes/config for the node</div></li> </ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<h2 class="mdetail-head">Method Details</h2>
|
|
<div class="detail-wrap">
|
|
<a name="addEvents"></a>
|
|
<div class="mdetail">
|
|
<h3>addEvents</i></h3>
|
|
<code>public function addEvents(<code>Object object</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Copies any events from the passed object onto this object if they do not already exist. The passed object
|
|
must also inherit from Observable for this method to have any effect.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>object</code> : Object<div class="sub-desc">The object from which to copy events</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#addEvents">Observable</a>.</div>
|
|
</div>
|
|
<a name="addListener"></a>
|
|
<div class="mdetail alt">
|
|
<h3>addListener</i></h3>
|
|
<code>public function addListener(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Appends an event handler to this component
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration properties. This may contain any of the following properties:<ul> <li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li> <li>delegate {String} A simple selector to filter the target or look for a descendant of the target</li> <li>stopEvent {Boolean} True to stop the event. That is stop propagation, and prevent the default action.</li> <li>preventDefault {Boolean} True to prevent the default action</li> <li>stopPropagation {Boolean} True to prevent event propagation</li> <li>normalized {Boolean} False to pass a browser event to the handler function instead of an Ext.EventObject</li> <li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li> <li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li> <li>buffer {Number} Causes the handler to be scheduled to run in an <a href="Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li> </ul> <p> <b>Combining Options</b><br> Using the options argument, it is possible to combine different types of listeners:<br> <br> A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<div style="margin: 5px 20px 20px;"> Code: <pre><code>el.on('click', this.onClick, this, { single: true, delay: 100, stopEvent : true, forumId: 4 });</pre> <p> The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers. <p> <b>Attaching multiple handlers in 1 call</b><br> Code: <pre><code>el.on({ 'click' : { fn: this.onClick scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver scope: this }, 'mouseout' : { fn: this.onMouseOut scope: this } });</pre> <p> Or a shorthand syntax:<br> Code: <pre><code>el.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut scope: this });</pre></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#addListener">Observable</a>.</div>
|
|
</div>
|
|
<a name="appendChild"></a>
|
|
<div class="mdetail">
|
|
<h3>appendChild</i></h3>
|
|
<code>public function appendChild(<code>Node/Array node</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Insert node(s) as the last child node of this node.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>node</code> : Node/Array<div class="sub-desc">The node or Array of nodes to append</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Node</code><div class="sub-desc">The appended node if single append, or null if an array was passed</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Node.</div>
|
|
</div>
|
|
<a name="bubble"></a>
|
|
<div class="mdetail alt">
|
|
<h3>bubble</i></h3>
|
|
<code>public function bubble(<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Array args</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Bubbles up the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of
|
|
function call will be the scope provided or the current node. The arguments to the function
|
|
will be the args provided or the current node. If the function returns false at any point,
|
|
the bubble is stopped.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>fn</code> : Function<div class="sub-desc">The function to call</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to current node)</div></li><li><code>args</code> : Array<div class="sub-desc">(optional) The args to call the function with (default to passing the current node)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Node.</div>
|
|
</div>
|
|
<a name="cascade"></a>
|
|
<div class="mdetail">
|
|
<h3>cascade</i></h3>
|
|
<code>public function cascade(<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Array args</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Cascades down the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of
|
|
function call will be the scope provided or the current node. The arguments to the function
|
|
will be the args provided or the current node. If the function returns false at any point,
|
|
the cascade is stopped on that branch.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>fn</code> : Function<div class="sub-desc">The function to call</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to current node)</div></li><li><code>args</code> : Array<div class="sub-desc">(optional) The args to call the function with (default to passing the current node)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Node.</div>
|
|
</div>
|
|
<a name="contains"></a>
|
|
<div class="mdetail alt">
|
|
<h3>contains</i></h3>
|
|
<code>public function contains(<code>Node node</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Returns true if this node is an ancestor (at any point) of the passed node.
|
|
<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>Boolean</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Node.</div>
|
|
</div>
|
|
<a name="eachChild"></a>
|
|
<div class="mdetail">
|
|
<h3>eachChild</i></h3>
|
|
<code>public function eachChild(<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Array args</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Interates the child nodes of this node, calling the specified function with each node. The scope (<i>this</i>) of
|
|
function call will be the scope provided or the current node. The arguments to the function
|
|
will be the args provided or the current node. If the function returns false at any point,
|
|
the iteration stops.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>fn</code> : Function<div class="sub-desc">The function to call</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to current node)</div></li><li><code>args</code> : Array<div class="sub-desc">(optional) The args to call the function with (default to passing the current node)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Node.</div>
|
|
</div>
|
|
<a name="findChild"></a>
|
|
<div class="mdetail alt">
|
|
<h3>findChild</i></h3>
|
|
<code>public function findChild(<code>String attribute</code>, <code>Mixed value</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Finds the first child that has the attribute with the specified value.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>attribute</code> : String<div class="sub-desc">The attribute name</div></li><li><code>value</code> : Mixed<div class="sub-desc">The value to search for</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Node</code><div class="sub-desc">The found child or null if none was found</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Node.</div>
|
|
</div>
|
|
<a name="findChildBy"></a>
|
|
<div class="mdetail">
|
|
<h3>findChildBy</i></h3>
|
|
<code>public function findChildBy(<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Finds the first child by a custom function. The child matches if the function passed
|
|
returns true.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>fn</code> : Function<div class="sub-desc"></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Node</code><div class="sub-desc">The found child or null if none was found</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Node.</div>
|
|
</div>
|
|
<a name="fireEvent"></a>
|
|
<div class="mdetail alt">
|
|
<h3>fireEvent</i></h3>
|
|
<code>public function fireEvent(<code>String eventName</code>, <code>Object... args</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Fires the specified event with the passed parameters (minus the event name).
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#fireEvent">Observable</a>.</div>
|
|
</div>
|
|
<a name="getDepth"></a>
|
|
<div class="mdetail">
|
|
<h3>getDepth</i></h3>
|
|
<code>public function getDepth()</code>
|
|
<div class="mdetail-desc">
|
|
Returns depth of this node (the root node has a depth of 0)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Number</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Node.</div>
|
|
</div>
|
|
<a name="getOwnerTree"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getOwnerTree</i></h3>
|
|
<code>public function getOwnerTree()</code>
|
|
<div class="mdetail-desc">
|
|
Returns the tree this node is in.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Tree</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Node.</div>
|
|
</div>
|
|
<a name="getPath"></a>
|
|
<div class="mdetail">
|
|
<h3>getPath</i></h3>
|
|
<code>public function getPath(<span class="optional" title="Optional">[<code>String attr</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Returns the path for this node. The path can be used to expand or select this node programmatically.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>attr</code> : String<div class="sub-desc">(optional) The attr to use for the path (defaults to the node's id)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>String</code><div class="sub-desc">The path</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Node.</div>
|
|
</div>
|
|
<a name="hasListener"></a>
|
|
<div class="mdetail alt">
|
|
<h3>hasListener</i></h3>
|
|
<code>public function hasListener(<code>String eventName</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Checks to see if this object is currently listening for a specified event
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#hasListener">Observable</a>.</div>
|
|
</div>
|
|
<a name="indexOf"></a>
|
|
<div class="mdetail">
|
|
<h3>indexOf</i></h3>
|
|
<code>public function indexOf(<code>Node node</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Returns the index of a child node
|
|
<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>Number</code><div class="sub-desc">The index of the node or -1 if it was not found</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Node.</div>
|
|
</div>
|
|
<a name="insertBefore"></a>
|
|
<div class="mdetail alt">
|
|
<h3>insertBefore</i></h3>
|
|
<code>public function insertBefore(<code>Node node</code>, <code>Node refNode</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Inserts the first node before the second node in this nodes childNodes collection.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>node</code> : Node<div class="sub-desc">The node to insert</div></li><li><code>refNode</code> : Node<div class="sub-desc">The node to insert before (if null the node is appended)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Node</code><div class="sub-desc">The inserted node</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Node.</div>
|
|
</div>
|
|
<a name="isAncestor"></a>
|
|
<div class="mdetail">
|
|
<h3>isAncestor</i></h3>
|
|
<code>public function isAncestor(<code>Node node</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Returns true if the passed node is an ancestor (at any point) of this node.
|
|
<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>Boolean</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Node.</div>
|
|
</div>
|
|
<a name="isFirst"></a>
|
|
<div class="mdetail alt">
|
|
<h3>isFirst</i></h3>
|
|
<code>public function isFirst()</code>
|
|
<div class="mdetail-desc">
|
|
Returns true if this node is the first child of its parent
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Node.</div>
|
|
</div>
|
|
<a name="isLast"></a>
|
|
<div class="mdetail">
|
|
<h3>isLast</i></h3>
|
|
<code>public function isLast()</code>
|
|
<div class="mdetail-desc">
|
|
Returns true if this node is the last child of its parent
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Node.</div>
|
|
</div>
|
|
<a name="isLeaf"></a>
|
|
<div class="mdetail alt">
|
|
<h3>isLeaf</i></h3>
|
|
<code>public function isLeaf()</code>
|
|
<div class="mdetail-desc">
|
|
Returns true if this node is a leaf
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Node.</div>
|
|
</div>
|
|
<a name="item"></a>
|
|
<div class="mdetail">
|
|
<h3>item</i></h3>
|
|
<code>public function item(<code>Number index</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Returns the child node at the specified index.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>index</code> : Number<div class="sub-desc"></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Node</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Node.</div>
|
|
</div>
|
|
<a name="on"></a>
|
|
<div class="mdetail alt">
|
|
<h3>on</i></h3>
|
|
<code>public function on(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object options</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Appends an event handler to this element (shorthand for addListener)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#on">Observable</a>.</div>
|
|
</div>
|
|
<a name="purgeListeners"></a>
|
|
<div class="mdetail">
|
|
<h3>purgeListeners</i></h3>
|
|
<code>public function purgeListeners()</code>
|
|
<div class="mdetail-desc">
|
|
Removes all listeners for this object
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#purgeListeners">Observable</a>.</div>
|
|
</div>
|
|
<a name="removeChild"></a>
|
|
<div class="mdetail alt">
|
|
<h3>removeChild</i></h3>
|
|
<code>public function removeChild(<code>Node node</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Removes a child node from this node.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>node</code> : Node<div class="sub-desc">The node to remove</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Node</code><div class="sub-desc">The removed node</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Node.</div>
|
|
</div>
|
|
<a name="removeListener"></a>
|
|
<div class="mdetail">
|
|
<h3>removeListener</i></h3>
|
|
<code>public function removeListener(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Removes a listener
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#removeListener">Observable</a>.</div>
|
|
</div>
|
|
<a name="replaceChild"></a>
|
|
<div class="mdetail alt">
|
|
<h3>replaceChild</i></h3>
|
|
<code>public function replaceChild(<code>Node newChild</code>, <code>Node oldChild</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Replaces one child node in this node with another.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>newChild</code> : Node<div class="sub-desc">The replacement node</div></li><li><code>oldChild</code> : Node<div class="sub-desc">The node to replace</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Node</code><div class="sub-desc">The replaced node</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Node.</div>
|
|
</div>
|
|
<a name="sort"></a>
|
|
<div class="mdetail">
|
|
<h3>sort</i></h3>
|
|
<code>public function sort(<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Sorts this nodes children using the supplied sort function
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>fn</code> : Function<div class="sub-desc"></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Node.</div>
|
|
</div>
|
|
<a name="un"></a>
|
|
<div class="mdetail alt">
|
|
<h3>un</i></h3>
|
|
<code>public function un(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Removes a listener (shorthand for removeListener)
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="Ext.util.Observable.html#un">Observable</a>.</div>
|
|
</div>
|
|
</div>
|
|
|
|
<h2 class="mdetail-head">Event Details</h2>
|
|
<div class="detail-wrap">
|
|
<a name="event-append"></a>
|
|
<div class="mdetail">
|
|
<h3>append</i></h3>
|
|
<code>public event append</code>
|
|
<div class="mdetail-desc">
|
|
Fires when a new child node is appended
|
|
<div class="mdetail-params">
|
|
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
|
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>node</code> : Node<div class="sub-desc">The newly appended node</div></li><li><code>index</code> : Number<div class="sub-desc">The index of the newly appended node</div></li> </ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This event is defined by Node.</div>
|
|
</div>
|
|
<a name="event-beforeappend"></a>
|
|
<div class="mdetail alt">
|
|
<h3>beforeappend</i></h3>
|
|
<code>public event beforeappend</code>
|
|
<div class="mdetail-desc">
|
|
Fires before a new child is appended, return false to cancel the append.
|
|
<div class="mdetail-params">
|
|
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
|
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node to be appended</div></li> </ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This event is defined by Node.</div>
|
|
</div>
|
|
<a name="event-beforeinsert"></a>
|
|
<div class="mdetail">
|
|
<h3>beforeinsert</i></h3>
|
|
<code>public event beforeinsert</code>
|
|
<div class="mdetail-desc">
|
|
Fires before a new child is inserted, return false to cancel the insert.
|
|
<div class="mdetail-params">
|
|
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
|
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node to be inserted</div></li><li><code>refNode</code> : Node<div class="sub-desc">The child node the node is being inserted before</div></li> </ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This event is defined by Node.</div>
|
|
</div>
|
|
<a name="event-beforemove"></a>
|
|
<div class="mdetail alt">
|
|
<h3>beforemove</i></h3>
|
|
<code>public event beforemove</code>
|
|
<div class="mdetail-desc">
|
|
Fires before this 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;">Subscribers will be called with the following parameters:</strong>
|
|
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>oldParent</code> : Node<div class="sub-desc">The parent of this node</div></li><li><code>newParent</code> : Node<div class="sub-desc">The new parent this 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 class="mdetail-def">This event is defined by Node.</div>
|
|
</div>
|
|
<a name="event-beforeremove"></a>
|
|
<div class="mdetail">
|
|
<h3>beforeremove</i></h3>
|
|
<code>public event beforeremove</code>
|
|
<div class="mdetail-desc">
|
|
Fires before a child is removed, return false to cancel the remove.
|
|
<div class="mdetail-params">
|
|
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
|
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node to be removed</div></li> </ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This event is defined by Node.</div>
|
|
</div>
|
|
<a name="event-insert"></a>
|
|
<div class="mdetail alt">
|
|
<h3>insert</i></h3>
|
|
<code>public event insert</code>
|
|
<div class="mdetail-desc">
|
|
Fires when a new child node is inserted.
|
|
<div class="mdetail-params">
|
|
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
|
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node inserted</div></li><li><code>refNode</code> : Node<div class="sub-desc">The child node the node was inserted before</div></li> </ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This event is defined by Node.</div>
|
|
</div>
|
|
<a name="event-move"></a>
|
|
<div class="mdetail">
|
|
<h3>move</i></h3>
|
|
<code>public event move</code>
|
|
<div class="mdetail-desc">
|
|
Fires when this node is moved to a new location in the tree
|
|
<div class="mdetail-params">
|
|
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
|
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</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 class="mdetail-def">This event is defined by Node.</div>
|
|
</div>
|
|
<a name="event-remove"></a>
|
|
<div class="mdetail alt">
|
|
<h3>remove</i></h3>
|
|
<code>public event remove</code>
|
|
<div class="mdetail-desc">
|
|
Fires when a child node is removed
|
|
<div class="mdetail-params">
|
|
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
|
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>node</code> : Node<div class="sub-desc">The removed node</div></li> </ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This event is defined by Node.</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="mdetail-head">Config Details</h2>
|
|
<div class="detail-wrap">
|
|
<a name="config-id"></a>
|
|
<div class="mdetail">
|
|
<h3>id</i></h3>
|
|
<code>id : String</code>
|
|
<div class="mdetail-desc">
|
|
The id for this node. If one is not specified, one is generated. </div>
|
|
<div class="mdetail-def">This config option is defined by Node.</div>
|
|
</div>
|
|
<a name="config-leaf"></a>
|
|
<div class="mdetail alt">
|
|
<h3>leaf</i></h3>
|
|
<code>leaf : Boolean</code>
|
|
<div class="mdetail-desc">
|
|
true if this node is a leaf and does not have children </div>
|
|
<div class="mdetail-def">This config option is defined by Node.</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<hr>
|
|
<div style="font-size:10px;text-align:center;color:gray;">Ext - Copyright © 2006-2007 Ext JS, LLC<br />All rights reserved.</div>
|
|
|
|
</body>
|
|
</html> |