X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/2e847cf21b8ab9d15fa167b315ca5b2fa92638fc..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/api/Ext.data.Tree.html diff --git a/docs/api/Ext.data.Tree.html b/docs/api/Ext.data.Tree.html new file mode 100644 index 00000000..11505045 --- /dev/null +++ b/docs/api/Ext.data.Tree.html @@ -0,0 +1,450 @@ +Ext.data.Tree | Ext JS 4.0 Documentation +
For up to date documentation and features, visit +http://docs.sencha.com/ext-js/4-0

Sencha Documentation

+ + + + + +

Mixins

This class is used as a container for a series of nodes. The nodes themselves maintain +the relationship between parent/child. The tree itself acts as a manager. It gives functionality +to retrieve a node by its identifier: getNodeById.

+ +

The tree also relays events from any of it's child nodes, allowing them to be handled in a +centralized fashion. In general this class is not used directly, rather used internally +by other parts of the framework.

+
Defined By

Config Options

Other Configs

 
(optional) A config object containing one or more event handlers to be added to this +object during initialization. T...

(optional)

A config object containing one or more event handlers to be added to this +object during initialization. This should be a valid listeners config object as specified in the +addListener example for attaching multiple handlers at once.

+ +

DOM events from ExtJs Components

+ + +

While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this + + +

is usually only done when extra value can be added. For example the DataView's +click event passing the node clicked on. To access DOM +events directly from a child element of a Component, we need to specify the element option to +identify the Component property to add a DOM listener to:

+ +
new Ext.panel.Panel({
+    width: 400,
+    height: 200,
+    dockedItems: [{
+        xtype: 'toolbar'
+    }],
+    listeners: {
+        click: {
+            element: 'el', //bind to the underlying el property on the panel
+            fn: function(){ console.log('click el'); }
+        },
+        dblclick: {
+            element: 'body', //bind to the underlying body property on the panel
+            fn: function(){ console.log('dblclick body'); }
+        }
+    }
+});
+
+ + +

+
Defined By

Properties

 

The root node for this tree

+

The root node for this tree

+
Defined By

Methods

 
Tree( +[Node root]) + : void

 

+

Parameters

  • root : Node

    (optional) The root node

    +

Returns

  • void    +
 
addEvents( +Object/String o, String ) + : void

Adds the specified events to the list of events which this Observable may fire.

+

Adds the specified events to the list of events which this Observable may fire.

+

Parameters

  • o : Object/String

    Either an object with event names as properties with a value of true +or the first event name string if multiple event names are being passed as separate parameters.

    +
  • : String

    [additional] Optional additional event names if multiple event names are being passed as separate parameters. +Usage:

    + +
    this.addEvents('storeloaded', 'storecleared');
    +
    + +

Returns

  • void    +
 
addListener( +String eventName, Function handler, [Object scope], [Object options]) + : void

Appends an event handler to this object.

+

Appends an event handler to this object.

+

Parameters

  • eventName : String

    The name of the event to listen for. May also be an object who's property names are event names. See

    +
  • handler : Function

    The method the event invokes.

    +
  • scope : Object

    (optional) The scope (this reference) in which the handler function is executed. +If omitted, defaults to the object which fired the event.

    +
  • options : Object

    (optional) An object containing handler configuration. +properties. This may contain any of the following properties:

      +
    • scope : Object
      The scope (this reference) in which the handler function is executed. +If omitted, defaults to the object which fired the event.
    • +
    • delay : Number
      The number of milliseconds to delay the invocation of the handler after the event fires.
    • +
    • single : Boolean
      True to add a handler to handle just the next firing of the event, and then remove itself.
    • +
    • buffer : Number
      Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed +by the specified number of milliseconds. If the event fires again within that time, the original +handler is not invoked, but the new handler is scheduled in its place.
    • +
    • target : Observable
      Only call the handler if the event was fired on the target Observable, not +if the event was bubbled up from a child Observable.
    • +
    • element : String
      This option is only valid for listeners bound to Components. +The name of a Component property which references an element to add a listener to.

      + +

      This option is useful during Component construction to add DOM event listeners to elements of Components which +will exist only after the Component is rendered. For example, to add a click listener to a Panel's body: +

      new Ext.panel.Panel({
      +    title: 'The title',
      +    listeners: {
      +        click: this.handlePanelClick,
      +        element: 'body'
      +    }
      +});
      +

      + + +

      When added in this way, the options available are the options applicable to Ext.core.Element.addListener

      + + +

    • +

    + +

    +Combining Options
    +Using the options argument, it is possible to combine different types of listeners:
    +
    +A delayed, one-time listener. +

    myPanel.on('hide', this.handleClick, this, {
    +single: true,
    +delay: 100
    +});
    +

    +Attaching multiple handlers in 1 call
    +The method also allows for a single argument to be passed which is a config object containing properties +which specify multiple events. For example: +

    myGridPanel.on({
    +    cellClick: this.onCellClick,
    +    mouseover: this.onMouseOver,
    +    mouseout: this.onMouseOut,
    +    scope: this // Important. Ensure "this" is correct during handler execution
    +});
    +
    . +

    + +

Returns

  • void    +
 
addManagedListener( +Observable/Element item, Object/String ename, Function fn, Object scope, Object opt) + : void

Adds listeners to any Observable object (or Element) which are automatically removed when this Component +is destroyed. + +

Adds listeners to any Observable object (or Element) which are automatically removed when this Component +is destroyed. + +

Parameters

  • item : Observable/Element

    The item to which to add a listener/listeners.

    +
  • ename : Object/String

    The event name, or an object containing event name properties.

    +
  • fn : Function

    Optional. If the ename parameter was an event name, this +is the handler function.

    +
  • scope : Object

    Optional. If the ename parameter was an event name, this +is the scope (this reference) in which the handler function is executed.

    +
  • opt : Object

    Optional. If the ename parameter was an event name, this +is the addListener options.

    +

Returns

  • void    +
 
capture( +Observable o, Function fn, [Object scope]) + : void
Starts capture on the specified Observable. All events will be passed +to the supplied function with the event name + ...

Starts capture on the specified Observable. All events will be passed +to the supplied function with the event name + standard signature of the event +before the event is fired. If the supplied function returns false, +the event will not fire.

+

Parameters

  • o : Observable

    The Observable to capture events from.

    +
  • fn : Function

    The function to call when an event is fired.

    +
  • scope : Object

    (optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.

    +

Returns

  • void    +
 

Removes all listeners for this object including the managed listeners

+

Removes all listeners for this object including the managed listeners

+

Returns

  • void    +
 

Removes all managed listeners for this object.

+

Removes all managed listeners for this object.

+

Returns

  • void    +
 
enableBubble( +String/Array events) + : void
Enables events fired by this Observable to bubble up an owner hierarchy by calling +this.getBubbleTarget() if present....

Enables events fired by this Observable to bubble up an owner hierarchy by calling +this.getBubbleTarget() if present. There is no implementation in the Observable base class.

+ + +

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. 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.

+ + +

Example:

+ + +
Ext.override(Ext.form.field.Base, {
+//  Add functionality to Field's initComponent to enable the change event to bubble
+initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
+    this.enableBubble('change');
+}),
+
+//  We know that we want Field's events to bubble directly to the FormPanel.
+getBubbleTarget : function() {
+    if (!this.formPanel) {
+        this.formPanel = this.findParentByType('form');
+    }
+    return this.formPanel;
+}
+});
+
+var myForm = new Ext.formPanel({
+title: 'User Details',
+items: [{
+    ...
+}],
+listeners: {
+    change: function() {
+        // Title goes red if form has been modified.
+        myForm.header.setStyle('color', 'red');
+    }
+}
+});
+
+ +

Parameters

  • events : String/Array

    The event name to bubble, or an Array of event names.

    +

Returns

  • void    +
 
fireEvent( +String eventName, Object... args) + : Boolean
Fires the specified event with the passed parameters (minus the event name). + + +An event may be set to bubble up an Ob...

Fires the specified event with the passed parameters (minus the event name).

+ + +

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) +by calling enableBubble.

+ +

Parameters

  • eventName : String

    The name of the event to fire.

    +
  • args : Object...

    Variable number of parameters are passed to handlers.

    +

Returns

  • Boolean   

    returns false if any of the handlers return false otherwise it returns true.

    +
 
getNodeById( +String id) + : Ext.data.NodeInterface

Gets a node in this tree by its id.

+

Gets a node in this tree by its id.

+

Parameters

  • id : String
    +

Returns

  • Ext.data.NodeInterface   

    The match node.

    +
 
getRootNode : Ext.data.NodeInterface

Returns the root node for this tree.

+

Returns the root node for this tree.

+

Returns

  • Ext.data.NodeInterface    +
 
hasListener( +String eventName) + : Boolean

Checks to see if this object has any listeners for a specified event

+

Checks to see if this object has any listeners for a specified event

+

Parameters

  • eventName : String

    The name of the event to check for

    +

Returns

  • Boolean   

    True if the event is being listened for, else false

    +
 
observe( +Function c, Object listeners) + : void
Sets observability on the passed class constructor. + +This makes any event fired on any instance of the passed class a...

Sets observability on the passed class constructor.

+ +

This makes any event fired on any instance of the passed class also fire a single event through +the class allowing for central handling of events on many instances at once.

+ +

Usage:

+ +
Ext.util.Observable.observe(Ext.data.Connection);
+Ext.data.Connection.on('beforerequest', function(con, options) {
+    console.log('Ajax request made to ' + options.url);
+});
+
+

Parameters

  • c : Function

    The class constructor to make observable.

    +
  • listeners : Object

    An object containing a series of listeners to add. See addListener.

    +

Returns

  • void    +
 
on( +String eventName, Function handler, [Object scope], [Object options]) + : void

Appends an event handler to this object (shorthand for addListener.)

+

Appends an event handler to this object (shorthand for addListener.)

+

Parameters

  • eventName : String

    The type of event to listen for

    +
  • handler : Function

    The method the event invokes

    +
  • scope : Object

    (optional) The scope (this reference) in which the handler function is executed. +If omitted, defaults to the object which fired the event.

    +
  • options : Object

    (optional) An object containing handler configuration.

    +

Returns

  • void    +
 
relayEvents( +Object origin, Array events, Object prefix) + : void

Relays selected events from the specified Observable as if the events were fired by this.

+

Relays selected events from the specified Observable as if the events were fired by this.

+

Parameters

  • origin : Object

    The Observable whose events this object is to relay.

    +
  • events : Array

    Array of event names to relay.

    +
  • prefix : Object
    +

Returns

  • void    +
 

Removes all added captures from the Observable.

+

Removes all added captures from the Observable.

+

Parameters

  • o : Observable

    The Observable to release

    +

Returns

  • void    +
 
removeListener( +String eventName, Function handler, [Object scope]) + : void

Removes an event handler.

+

Removes an event handler.

+

Parameters

  • eventName : String

    The type of event the handler was associated with.

    +
  • handler : Function

    The handler to remove. This must be a reference to the function passed into the addListener call.

    +
  • scope : Object

    (optional) The scope originally specified for the handler.

    +

Returns

  • void    +
 
removeManagedListener( +Observable|Element item, Object|String ename, Function fn, Object scope) + : void

Removes listeners that were added by the mon method.

+

Removes listeners that were added by the mon method.

+

Parameters

  • item : Observable|Element

    The item from which to remove a listener/listeners.

    +
  • ename : Object|String

    The event name, or an object containing event name properties.

    +
  • fn : Function

    Optional. If the ename parameter was an event name, this +is the handler function.

    +
  • scope : Object

    Optional. If the ename parameter was an event name, this +is the scope (this reference) in which the handler function is executed.

    +

Returns

  • void    +
 
Resume firing events. (see suspendEvents) +If events were suspended using the queueSuspended parameter, then all +event...

Resume firing events. (see suspendEvents) +If events were suspended using the queueSuspended parameter, then all +events fired during event suspension will be sent to any listeners now.

+

Returns

  • void    +
 
setRootNode( +Ext.data.NodeInterface node) + : Ext.data.NodeInterface

Sets the root node for this tree.

+

Sets the root node for this tree.

+

Parameters

  • node : Ext.data.NodeInterface
    +

Returns

  • Ext.data.NodeInterface   

    The root node

    +
 
suspendEvents( +Boolean queueSuspended) + : void

Suspend the firing of all events. (see resumeEvents)

+

Suspend the firing of all events. (see resumeEvents)

+

Parameters

  • queueSuspended : Boolean

    Pass as true to queue up suspended events to be fired +after the resumeEvents call instead of discarding all suspended events;

    +

Returns

  • void    +
 
un( +String eventName, Function handler, [Object scope]) + : void

Removes an event handler (shorthand for removeListener.)

+

Removes an event handler (shorthand for removeListener.)

+

Parameters

  • eventName : String

    The type of event the handler was associated with.

    +
  • handler : Function

    The handler to remove. This must be a reference to the function passed into the addListener call.

    +
  • scope : Object

    (optional) The scope originally specified for the handler.

    +

Returns

  • void    +
Defined By

Events

 
append( +Tree tree, Node parent, Node node, Number index) +

Fires when a new child node is appended to a node in this tree.

+

Fires when a new child node is appended to a node in this tree.

+

Parameters

  • tree : Tree

    The owner tree

    +
  • parent : Node

    The parent node

    +
  • node : Node

    The newly appended node

    +
  • index : Number

    The index of the newly appended node

    +
 
beforeappend( +Tree tree, Node parent, Node node) +

Fires before a new child is appended to a node in this tree, return false to cancel the append.

+

Fires before a new child is appended to a node in this tree, return false to cancel the append.

+

Parameters

  • tree : Tree

    The owner tree

    +
  • parent : Node

    The parent node

    +
  • node : Node

    The child node to be appended

    +
 

Fires before this node is collapsed.

+

Fires before this node is collapsed.

+

Parameters

  • this : Node

    The collapsing node

    +
 

Fires before this node is expanded.

+

Fires before this node is expanded.

+

Parameters

  • this : Node

    The expanding node

    +
 
beforeinsert( +Tree tree, Node parent, Node node, Node refNode) +

Fires before a new child is inserted in a node in this tree, return false to cancel the insert.

+

Fires before a new child is inserted in a node in this tree, return false to cancel the insert.

+

Parameters

  • tree : Tree

    The owner tree

    +
  • parent : Node

    The parent node

    +
  • node : Node

    The child node to be inserted

    +
  • refNode : Node

    The child node the node is being inserted before

    +
 
beforemove( +Tree tree, Node node, Node oldParent, Node newParent, Number index) +

Fires before a node is moved to a new location in the tree. Return false to cancel the move.

+

Fires before a node is moved to a new location in the tree. Return false to cancel the move.

+

Parameters

  • tree : Tree

    The owner tree

    +
  • node : Node

    The node being moved

    +
  • oldParent : Node

    The parent of the node

    +
  • newParent : Node

    The new parent the node is moving to

    +
  • index : Number

    The index it is being moved to

    +
 
beforeremove( +Tree tree, Node parent, Node node) +

Fires before a child is removed from a node in this tree, return false to cancel the remove.

+

Fires before a child is removed from a node in this tree, return false to cancel the remove.

+

Parameters

  • tree : Tree

    The owner tree

    +
  • parent : Node

    The parent node

    +
  • node : Node

    The child node to be removed

    +
 

Fires when this node is collapsed.

+

Fires when this node is collapsed.

+

Parameters

  • this : Node

    The collapsing node

    +
 

Fires when this node is expanded.

+

Fires when this node is expanded.

+

Parameters

  • this : Node

    The expanding node

    +
 
insert( +Tree tree, Node parent, Node node, Node refNode) +

Fires when a new child node is inserted in a node in this tree.

+

Fires when a new child node is inserted in a node in this tree.

+

Parameters

  • tree : Tree

    The owner tree

    +
  • parent : Node

    The parent node

    +
  • node : Node

    The child node inserted

    +
  • refNode : Node

    The child node the node was inserted before

    +
 
move( +Tree tree, Node node, Node oldParent, Node newParent, Number index) +

Fires when a node is moved to a new location in the tree

+

Fires when a node is moved to a new location in the tree

+

Parameters

  • tree : Tree

    The owner tree

    +
  • node : Node

    The node moved

    +
  • oldParent : Node

    The old parent of this node

    +
  • newParent : Node

    The new parent of this node

    +
  • index : Number

    The index it was moved to

    +
 
remove( +Tree tree, Node parent, Node node) +

Fires when a child node is removed from a node in this tree.

+

Fires when a child node is removed from a node in this tree.

+

Parameters

  • tree : Tree

    The owner tree

    +
  • parent : Node

    The parent node

    +
  • node : Node

    The child node removed

    +
 
rootchange( +Ext.data.Model root) +

Fires whenever the root node is changed in the tree.

+

Fires whenever the root node is changed in the tree.

+

Parameters

  • root : Ext.data.Model

    The new root

    +
\ No newline at end of file