| baseAttrs : ObjectAn object containing attributes to be added to all nodes
+and modifying the attributes as needed before they are used to create the associated TreeNode. Config Options|
| baseAttrs : ObjectAn object containing attributes to be added to all nodes
created by this loader. If the attributes sent by the serve... An object containing attributes to be added to all nodes
created by this loader. If the attributes sent by the server have an attribute in this object,
they take priority. | TreeLoader | | baseParams : Object An object containing properties which
specify HTTP parameters to be passed to each request for child nodes. | TreeLoader | | clearOnLoad : Boolean Default to true. Remove previously existing
-child nodes before loading. | TreeLoader | | dataUrl : StringThe URL from which to request a Json string which
+child nodes before loading. | TreeLoader | | dataUrl : StringThe URL from which to request a Json string which
specifies an array of node definition objects representing the chi... The URL from which to request a Json string which
specifies an array of node definition objects representing the child nodes
-to be loaded. | TreeLoader | | directFn : Function Function to call when executing a request. | TreeLoader | | listeners : ObjectA config object containing one or more event handlers to be added to this
+to be loaded. | TreeLoader | | directFn : Function Function to call when executing a request. | TreeLoader | | listeners : ObjectA config object containing one or more event handlers to be added to this
object during initialization. This should ... 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.
@@ -68,8 +68,8 @@ Ext.DomObserver = Ext.extend(Object, {
typeAhead: true,
mode: 'local',
triggerAction: 'all'
-}); | Observable | | paramOrder : Array/StringDefaults to undefined. Only used when using directFn.
-A list of params to be executed
+}); | Observable | | paramOrder : Array/StringDefaults to undefined. Only used when using directFn.
+A list of params to be executed
server side. Specify the par... Defaults to undefined. Only used when using directFn.
A list of params to be executed
server side. Specify the params in the order in which they must be executed on the server-side
@@ -78,21 +78,23 @@ comma, or pipe. For example,
any of the following would be acceptable: paramOrder: ['param1','param2','param3']
paramOrder: 'param1 param2 param3'
paramOrder: 'param1,param2,param3'
-paramOrder: 'param1|param2|param'
| TreeLoader | | paramsAsHash : BooleanOnly used when using directFn.
-Send parameters as a collection of named arguments (defaults to false). Providing a
+paramOrder: 'param1|param2|param' | TreeLoader | | paramsAsHash : BooleanOnly used when using directFn.
+Send parameters as a collection of named arguments (defaults to false). Providing a
... Only used when using directFn.
Send parameters as a collection of named arguments (defaults to false). Providing a
- paramOrder nullifies this configuration. | TreeLoader | | preloadChildren : Boolean If set to true, the loader recursively loads "children" attributes when doing the first load on nodes. | TreeLoader | | requestMethod : StringThe HTTP request method for loading data (defaults to the value of Ext.Ajax.method). | TreeLoader | | uiProviders : ObjectAn object containing properties which
-specify custom Ext.tree.TreeNodeUI implementations. If the optional
+ paramOrder nullifies this configuration. | TreeLoader | | preloadChildren : Boolean If set to true, the loader recursively loads "children" attributes when doing the first load on nodes. | TreeLoader | | requestMethod : StringThe HTTP request method for loading data (defaults to the value of Ext.Ajax.method). | TreeLoader | | uiProviders : ObjectAn object containing properties which
+specify custom Ext.tree.TreeNodeUI implementations. If the optional
uiProvide... An object containing properties which
specify custom Ext.tree.TreeNodeUI implementations. If the optional
uiProvider attribute of a returned child node is a string rather
than a reference to a TreeNodeUI implementation, then that string value
-is used as a property name in the uiProviders object. | TreeLoader | | url : String | TreeLoader |
Public Properties|
| XML_NODE_ELEMENT : Number XML element node (value 1, read-only) | XmlTreeLoader | | XML_NODE_TEXT : Number XML text node (value 3, read-only) | XmlTreeLoader |
Public Methods|
| XmlTreeLoader( Object config )
- Creates a new XmlTreeloader. Creates a new XmlTreeloader. | XmlTreeLoader | | addEvents( Object object )
- :
- voidUsed to define events on this Observable Used to define events on this Observable | Observable | | addListener( String eventName , Function handler , [Object scope ], [Object options ] )
- :
+is used as a property name in the uiProviders object. | TreeLoader | | url : String | TreeLoader |
Public Properties|
| XML_NODE_ELEMENT : Number XML element node (value 1, read-only) | XmlTreeLoader | | XML_NODE_TEXT : Number XML text node (value 3, read-only) | XmlTreeLoader |
Public Methods|
| XmlTreeLoader( Object config )
+ Creates a new XmlTreeloader. Creates a new XmlTreeloader. | XmlTreeLoader | | addEvents( Object|String o , string Optional. )
+ :
+ voidAdds 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. | Observable | | addListener( String eventName , Function handler , [Object scope ], [Object options ] )
+ :
voidAppends an event handler to this object. Appends an event handler to this object. Parameters:eventName : StringThe name of the event to listen for. handler : FunctionThe 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:
@@ -112,8 +114,8 @@ Using the options argument, it is possible to combine different types of listene
A delayed, one-time listener.
myDataView.on('click', this.onClick, this, {
- single: true,
- delay: 100
+single: true,
+delay: 100
});
Attaching multiple handlers in 1 call
@@ -121,36 +123,36 @@ The method also allows for a single argument to be passed which is a config obje
which specify multiple handlers.
myGridPanel.on({
- 'click' : {
- fn: this.onClick,
- scope: this,
- delay: 100
- },
- 'mouseover' : {
- fn: this.onMouseOver,
- scope: this
- },
- 'mouseout' : {
- fn: this.onMouseOut,
- scope: this
- }
+'click' : {
+ fn: this.onClick,
+ scope: this,
+ delay: 100
+},
+'mouseover' : {
+ fn: this.onMouseOver,
+ scope: this
+},
+'mouseout' : {
+ fn: this.onMouseOut,
+ scope: this
+}
});
Or a shorthand syntax:
myGridPanel.on({
- 'click' : this.onClick,
- 'mouseover' : this.onMouseOver,
- 'mouseout' : this.onMouseOut,
- scope: this
-});
Returns: | Observable | | createNode( attr {Object} )
- :
- voidOverride this function for custom TreeNode node implementation, or to
-modify the attributes at creation time.
+'click' : this.onClick,
+'mouseover' : this.onMouseOver,
+'mouseout' : this.onMouseOut,
+ scope: this
+}); Returns: | Observable | | createNode( attr {Object} )
+ :
+ voidOverride this function for custom TreeNode node implementation, or to
+modify the attributes at creation time.
Examp... Override this function for custom TreeNode node implementation, or to
modify the attributes at creation time.
Example: new Ext.tree.TreePanel({
...
- new Ext.tree.TreeLoader({
+ loader: new Ext.tree.TreeLoader({
url: 'dataUrl',
createNode: function(attr) {
// Allow consolidation consignments to have
@@ -159,48 +161,80 @@ Example:new Ext.tree.TreePanel({
attr.iconCls = 'x-consol',
attr.allowDrop = true;
}
- return Ext.tree.TreeLoader.prototype.call(this, attr);
+ return Ext.tree.TreeLoader.prototype.createNode.call(this, attr);
}
}),
...
-});
| TreeLoader | | enableBubble( Object events )
- :
- voidUsed to enable bubbling of events Used to enable bubbling of events | Observable | | fireEvent( String eventName , Object... args )
- :
- BooleanFires the specified event with the passed parameters (minus the event name).
+}); | TreeLoader | | enableBubble( Object events )
+ :
+ voidEnables 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, {
+// Add functionality to Field's initComponent to enable the change event to bubble
+ initComponent: Ext.form.Field.prototype.initComponent.createSequence(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");
+ }
+ }
+});
| Observable | | fireEvent( String eventName , Object... args )
+ :
+ BooleanFires the specified event with the passed parameters (minus the event name).
An event may be set to bubble up an Obse... | Observable | | hasListener( String eventName )
- :
- BooleanChecks 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 | Observable | | load( Ext.tree.TreeNode node , Function callback , (Object) scope )
- :
- voidLoad an Ext.tree.TreeNode from the URL specified in the constructor.
+by calling enableBubble. | Observable | | hasListener( String eventName )
+ :
+ BooleanChecks 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 | Observable | | load( Ext.tree.TreeNode node , Function callback , (Object) scope )
+ :
+ voidLoad an Ext.tree.TreeNode from the URL specified in the constructor.
This is called automatically when a node is exp... Load an Ext.tree.TreeNode from the URL specified in the constructor.
This is called automatically when a node is expanded, but may be used to reload
-a node (or append new children if the clearOnLoad option is false.) Parameters:node : Ext.tree.TreeNodecallback : Functionscope : (Object) Returns: | TreeLoader | | on( String eventName , Function handler , [Object scope ], [Object options ] )
- :
+a node (or append new children if the clearOnLoad option is false.)Parameters:node : Ext.tree.TreeNodecallback : Functionscope : (Object) Returns: | TreeLoader | | on( String eventName , Function handler , [Object scope ], [Object options ] )
+ :
voidAppends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:eventName : StringThe type of event to listen for handler : FunctionThe 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: | Observable | | purgeListeners()
- :
- voidRemoves all listeners for this object Removes all listeners for this object | Observable | | relayEvents( Object o , Array events )
- :
- voidRelays 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. | Observable | | removeListener( String eventName , Function handler , [Object scope ] )
- :
- voidRemoves an event handler. Removes an event handler. | Observable | | resumeEvents()
- :
- voidResume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
+If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration. Returns: | Observable | | purgeListeners()
+ :
+ voidRemoves all listeners for this object Removes all listeners for this object | Observable | | relayEvents( Object o , Array events )
+ :
+ voidRelays 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. | Observable | | removeListener( String eventName , Function handler , [Object scope ] )
+ :
+ voidRemoves an event handler. Removes an event handler. | Observable | | resumeEvents()
+ :
+ voidResume 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. | Observable | | suspendEvents( Boolean queueSuspended )
- :
+events fired during event suspension will be sent to any listeners now. | Observable | | suspendEvents( Boolean queueSuspended )
+ :
voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:queueSuspended : BooleanPass as true to queue up suspended events to be fired
-after the resumeEvents call instead of discarding all suspended events; Returns: | Observable | | un( String eventName , Function handler , [Object scope ] )
- :
- voidRemoves an event handler (shorthand for removeListener.) | Observable |
Public Events|
| beforeload :
- ( Object This , Object node , Object callback )
- Fires before a network request is made to retrieve the Json text which specifies a node's children. Fires before a network request is made to retrieve the Json text which specifies a node's children. Listeners will be called with the following arguments:This : ObjectTreeLoader object. node : Objectcallback : ObjectThe callback function specified in the load call.
| TreeLoader | | load :
- ( Object This , Object node , Object response )
- Fires when the node has been successfuly loaded. Fires when the node has been successfuly loaded. Listeners will be called with the following arguments: | TreeLoader | | loadexception :
- ( Object This , Object node , Object response )
+after the resumeEvents call instead of discarding all suspended events;Returns: | Observable | | un( String eventName , Function handler , [Object scope ] )
+ :
+ voidRemoves an event handler (shorthand for removeListener.) | Observable |
Public Events|
| beforeload :
+ ( Object This , Object node , Object callback )
+ Fires before a network request is made to retrieve the Json text which specifies a node's children. Fires before a network request is made to retrieve the Json text which specifies a node's children. Listeners will be called with the following arguments:This : ObjectTreeLoader object. node : Objectcallback : ObjectThe callback function specified in the load call.
| TreeLoader | | load :
+ ( Object This , Object node , Object response )
+ Fires when the node has been successfuly loaded. Fires when the node has been successfuly loaded. Listeners will be called with the following arguments: | TreeLoader | | loadexception :
+ ( Object This , Object node , Object response )
Fires if the network request failed. Fires if the network request failed. Listeners will be called with the following arguments: | TreeLoader |
\ No newline at end of file
|