anchor : String

Note: this config is only used when this Component is rendered\nby a Container which has been configured to use an Anc...

Note: this config is only used when this Component is rendered\nby a Container which has been configured to use an AnchorLayout (or subclass thereof).\nbased layout manager, for example:

Ext.form.FormPanel
specifying layout: 'anchor' // or 'form', or 'absolute'

\n\n\n

See Ext.layout.AnchorLayout.anchor also.

\n\n

animCollapse : Boolean

true to animate the transition when the panel is collapsed, false to skip the\nanimation (defaults to true if the Ext....

true to animate the transition when the panel is collapsed, false to skip the\nanimation (defaults to true if the Ext.Fx class is available, otherwise false).

Ext.tree.TreePanel
view source

animate : Boolean

true to enable animated expand/collapse (defaults to the value of Ext.enableFx)

autoHeight : Boolean

true to use height:'auto', false to use fixed height (defaults to false). ...

true to use height:'auto', false to use fixed height (defaults to false).\nNote: Setting autoHeight: true means that the browser will manage the panel's height\nbased on its contents, and that Ext will not manage it at all. If the panel is within a layout that\nmanages dimensions (fit, border, etc.) then setting autoHeight: true\ncan cause issues with scrolling and will not generally work as expected since the panel will take\non the height of its contents rather than the height required by the Ext layout.

Overrides: Ext.BoxComponent.autoHeight

autoScroll : Boolean

true to use overflow:'auto' on the components layout element and show scroll bars automatically when\nnecessary, false...

true to use overflow:'auto' on the components layout element and show scroll bars automatically when\nnecessary, false to clip any overflowing content (defaults to false).

autoShow : Boolean

True if the component should check for hidden classes (e.g. ...

True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove\nthem on render (defaults to false).

Defaults to: false

baseCls : String

The base CSS class to apply to this panel's element (defaults to 'x-panel'). ...

The base CSS class to apply to this panel's element (defaults to 'x-panel').

\n\n

Another option available by default is to specify 'x-plain' which strips all styling\nexcept for required attributes for Ext layouts to function (e.g. overflow:hidden).\nSee unstyled also.

\n\n

Defaults to: 'x-panel'

bbar : Object/Array

The bottom toolbar of the panel. ...

The bottom toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of\nbuttons/button configs to be added to the toolbar. Note that this is not available as a property after render.\nTo access the bottom toolbar after render, use getBottomToolbar.

\n\n\n

Note: Although a Toolbar may contain Field components, these will not be updated by a load\nof an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and\nso are not scanned to collect form items. However, the values will be submitted because form\nsubmission parameters are collected from the DOM tree.

\n\n

bbarCfg : Object

A DomHelper element specification object specifying the element structure\nof this Panel's bbar Element. ...

A DomHelper element specification object specifying the element structure\nof this Panel's bbar Element. See bodyCfg also.

\n\n

bodyBorder : Boolean

True to display an interior border on the body element of the panel, false to hide it (defaults to true). ...

True to display an interior border on the body element of the panel, false to hide it (defaults to true).\nThis only applies when border == true. If border == true and bodyBorder == false, the border will display\nas a 1px wide inset border, giving the entire body element an inset appearance.

bodyCfg : Object

A DomHelper element specification object may be specified for any\nPanel Element. ...

A DomHelper element specification object may be specified for any\nPanel Element.

\n\n\n

By default, the Default element in the table below will be used for the html markup to\ncreate a child element with the commensurate Default class name (baseCls will be\nreplaced by baseCls):

\n\n\n

Panel      Default  Default             Custom      Additional       Additional\nElement    element  class               element     class            style\n========   ==========================   =========   ==============   ===========\nheader     div      baseCls+'-header'   headerCfg   headerCssClass   headerStyle\nbwrap      div      baseCls+'-bwrap'     bwrapCfg    bwrapCssClass    bwrapStyle\n+ tbar     div      baseCls+'-tbar'       tbarCfg     tbarCssClass     tbarStyle\n+ body     div      baseCls+'-body'       bodyCfg     bodyCssClass     bodyStyle\n+ bbar     div      baseCls+'-bbar'       bbarCfg     bbarCssClass     bbarStyle\n+ footer   div      baseCls+'-footer'   footerCfg   footerCssClass   footerStyle\n

\n\n\n

Configuring a Custom element may be used, for example, to force the body Element\nto use a different form of markup than is created by default. An example of this might be\nto create a child Panel containing a custom content, such as\na header, or forcing centering of all Panel content by having the body be a <center>\nelement:

\n\n\n

new Ext.Panel({\n    title: 'Message Title',\n    renderTo: Ext.getBody(),\n    width: 200, height: 130,\n    bodyCfg: {\n        tag: 'center',\n        cls: 'x-panel-body',  // Default class not applied if Custom element specified\n        html: 'Message'\n    },\n    footerCfg: {\n        tag: 'h2',\n        cls: 'x-panel-footer',        // same as the Default class\n        html: 'footer html'\n    },\n    footerCssClass: 'custom-footer', // additional css class, see addClass\n    footerStyle:    'background-color:red' // see bodyStyle\n});\n

\n\n\n

The example above also explicitly creates a footer with custom markup and\nstyling applied.

\n\n

bodyCssClass : String/Object/Function

Additional css class selector to be applied to the body element in the format expected by\nExt.Element.addClass (defau...

Additional css class selector to be applied to the body element in the format expected by\nExt.Element.addClass (defaults to null). See bodyCfg.

bodyStyle : String/Object/Function

Custom CSS styles to be applied to the body element in the format expected by\nExt.Element.applyStyles (defaults to nu...

Custom CSS styles to be applied to the body element in the format expected by\nExt.Element.applyStyles (defaults to null). See bodyCfg.

border : Boolean

True to display the borders of the panel's body element, false to hide them (defaults to true). ...

True to display the borders of the panel's body element, false to hide them (defaults to true). By default,\nthe border is a 2px wide inset border, but this can be further altered by setting bodyBorder to false.

boxMaxHeight : Number

The maximum value in pixels which this BoxComponent will set its height to. ...

The maximum value in pixels which this BoxComponent will set its height to.

\n\n\n

Warning: This will override any size management applied by layout managers.

\n\n

boxMaxWidth : Number

The maximum value in pixels which this BoxComponent will set its width to. ...

The maximum value in pixels which this BoxComponent will set its width to.

\n\n\n

Warning: This will override any size management applied by layout managers.

\n\n

boxMinHeight : Number

The minimum value in pixels which this BoxComponent will set its height to. ...

The minimum value in pixels which this BoxComponent will set its height to.

\n\n\n

Warning: This will override any size management applied by layout managers.

\n\n

boxMinWidth : Number

The minimum value in pixels which this BoxComponent will set its width to. ...

The minimum value in pixels which this BoxComponent will set its width to.

\n\n\n

Warning: This will override any size management applied by layout managers.

\n\n

Ext.tree.TreePanel
view source

bubbleEvents : Array

An array of events that, when fired, should be bubbled to any parent container. ...

An array of events that, when fired, should be bubbled to any parent container.\nSee Ext.util.Observable.enableBubble.\nDefaults to [].\n\n

Defaults to: []

Overrides: Ext.Container.bubbleEvents

buttonAlign : String

The alignment of any buttons added to this panel. ...

The alignment of any buttons added to this panel. Valid values are 'right',\n'left' and 'center' (defaults to 'right').

Defaults to: 'right'

buttons : Array

buttons will be used as items for the toolbar in\nthe footer (fbar). ...

buttons will be used as items for the toolbar in\nthe footer (fbar). Typically the value of this configuration property will be\nan array of Ext.Buttons or Ext.Button configuration objects.\nIf an item is configured with minWidth or the Panel is configured with minButtonWidth,\nthat width will be applied to the item.

bwrapCfg : Object

A DomHelper element specification object specifying the element structure\nof this Panel's bwrap Element. ...

A DomHelper element specification object specifying the element structure\nof this Panel's bwrap Element. See bodyCfg also.

\n\n

clearCls : String

The CSS class used to to apply to the special clearing div rendered\ndirectly after each form field wrapper to provide...

The CSS class used to to apply to the special clearing div rendered\ndirectly after each form field wrapper to provide field clearing (defaults to\n'x-form-clear-left').

\n\n\n

Note: this config is only used when this Component is rendered by a Container\n\n\n

which has been configured to use the FormLayout layout\nmanager (e.g. Ext.form.FormPanel or specifying layout:'form') and either a\nfieldLabel is specified or isFormField=true is specified.

\n\n

See Ext.layout.FormLayout.fieldTpl also.

\n\n

closable : Boolean

Panels themselves do not directly support being closed, but some Panel subclasses do (like\nExt.Window) or a Panel Cla...

Panels themselves do not directly support being closed, but some Panel subclasses do (like\nExt.Window) or a Panel Class within an Ext.TabPanel. Specify true\nto enable closing in such situations. Defaults to false.

cls : String

An optional extra CSS class that will be added to this component's Element (defaults to ''). ...

An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be\nuseful for adding customized styles to the component or any of its children using standard CSS rules.

collapseFirst : Boolean

true to make sure the collapse/expand toggle button always renders first (to the left of)\nany other tools in the pane...

true to make sure the collapse/expand toggle button always renders first (to the left of)\nany other tools in the panel's title bar, false to render it last (defaults to true).

Defaults to: true

collapsed : Boolean

true to render the panel collapsed, false to render it expanded (defaults to\nfalse). ...

true to render the panel collapsed, false to render it expanded (defaults to\nfalse).

Defaults to: false

collapsedCls : String

A CSS class to add to the panel's element after it has been collapsed (defaults to\n'x-panel-collapsed'). ...

A CSS class to add to the panel's element after it has been collapsed (defaults to\n'x-panel-collapsed').

Defaults to: 'x-panel-collapsed'

collapsible : Boolean

True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into\nthe header ...

True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into\nthe header tool button area, false to keep the panel statically sized with no button (defaults to false).

Ext.tree.TreePanel
view source

containerScroll : Boolean

true to register this container with ScrollManager

ctCls : String

An optional extra CSS class that will be added to this component's container. ...

An optional extra CSS class that will be added to this component's container. This can be useful for\nadding customized styles to the container or any of its children using standard CSS rules. See\nExt.layout.ContainerLayout.extraCls also.

\n\n\n

Note: ctCls defaults to '' except for the following class\nwhich assigns a value by default:\n

Box Layout : 'x-box-layout-ct'

\nTo configure the above Class with an extra CSS class append to the default. For example,\nfor BoxLayout (Hbox and Vbox):\n

ctCls: 'x-box-layout-ct custom-class'\n

\n\n

Ext.tree.TreePanel
view source

ddAppendOnly : Boolean

true if the tree should only allow append drops (use for trees which are sorted)

Ext.tree.TreePanel
view source

ddGroup : String

The DD group this TreePanel belongs to

Ext.tree.TreePanel
view source

ddScroll : Boolean

true to enable body scrolling

disabled : Boolean

Render this panel disabled (default is false). ...

Render this panel disabled (default is false). An important note when using the disabled\nconfig on panels is that IE will often fail to initialize the disabled mask element correectly if\nthe panel's layout has not yet completed by the time the Panel is disabled during the render process.\nIf you experience this issue, you may need to instead use the afterlayout event to initialize\nthe disabled state:

\n\n

new Ext.Panel({\n    ...\n    listeners: {\n        'afterlayout': {\n            fn: function(p){\n                p.disable();\n            },\n            single: true // important, as many layouts can occur\n        }\n    }\n});\n

\n\n

Overrides: Ext.Component.disabled

Ext.tree.TreePanel
view source

dragConfig : Object

Custom config to pass to the Ext.tree.TreeDragZone instance

draggable : Boolean/Object

true to enable dragging of this Panel (defaults to false). ...

true to enable dragging of this Panel (defaults to false).

\n\n\n

For custom drag/drop implementations, an Ext.Panel.DD config could also be passed\nin this config instead of true. Ext.Panel.DD is an internal, undocumented class which\nmoves a proxy Element around in place of the Panel's element, but provides no other behaviour\nduring dragging or on drop. It is a subclass of Ext.dd.DragSource, so behaviour may be\nadded by implementing the interface methods of Ext.dd.DragDrop e.g.:\n

new Ext.Panel({\n    title: 'Drag me',\n    x: 100,\n    y: 100,\n    renderTo: Ext.getBody(),\n    floating: true,\n    frame: true,\n    width: 400,\n    height: 200,\n    draggable: {\n//      Config option of Ext.Panel.DD class.\n//      It's a floating Panel, so do not show a placeholder proxy in the original position.\n        insertProxy: false,\n\n//      Called for each mousemove event while dragging the DD object.\n        onDrag : function(e){\n//          Record the x,y position of the drag proxy so that we can\n//          position the Panel at end of drag.\n            var pel = this.proxy.getEl();\n            this.x = pel.getLeft(true);\n            this.y = pel.getTop(true);\n\n//          Keep the Shadow aligned if there is one.\n            var s = this.panel.getEl().shadow;\n            if (s) {\n                s.realign(this.x, this.y, pel.getWidth(), pel.getHeight());\n            }\n        },\n\n//      Called on the mouseup event.\n        endDrag : function(e){\n            this.panel.setPosition(this.x, this.y);\n        }\n    }\n}).show();\n

\n\n

Ext.tree.TreePanel
view source

dropConfig : Object

Custom config to pass to the Ext.tree.TreeDropZone instance

Ext.tree.TreePanel
view source

enableDD : Boolean

true to enable drag and drop

Ext.tree.TreePanel
view source

enableDrag : Boolean

true to enable just drag

Ext.tree.TreePanel
view source

enableDrop : Boolean

true to enable just drop

fbar : Object/Array

A Toolbar object, a Toolbar config, or an array of\nButtons/Button configs, describing a Toolbar to be rendered into t...

A Toolbar object, a Toolbar config, or an array of\nButtons/Button configs, describing a Toolbar to be rendered into this Panel's footer element.

\n\n\n

After render, the fbar property will be an Toolbar instance.

\n\n\n

If buttons are specified, they will supersede the fbar configuration property.

\n\n\n

The Panel's buttonAlign configuration affects the layout of these items, for example:

\n\n

var w = new Ext.Window({\n    height: 250,\n    width: 500,\n    bbar: new Ext.Toolbar({\n        items: [{\n            text: 'bbar Left'\n        },'->',{\n            text: 'bbar Right'\n        }]\n    }),\n    buttonAlign: 'left', // anything but 'center' or 'right' and you can use '-', and '->'\n                                  // to control the alignment of fbar items\n    fbar: [{\n        text: 'fbar Left'\n    },'->',{\n        text: 'fbar Right'\n    }]\n}).show();\n

\n\n\n

\n\n

fieldLabel : String

The label text to display next to this Component (defaults to ''). ...

The label text to display next to this Component (defaults to '').

\n\n\n

Note: this config is only used when this Component is rendered by a Container which\n\n\n

has been configured to use the FormLayout layout manager (e.g.\nExt.form.FormPanel or specifying layout:'form').

\n\n

Also see hideLabel and\nExt.layout.FormLayout.fieldTpl.

\n\n\n

Example use:

\n\n

new Ext.FormPanel({\n    height: 100,\n    renderTo: Ext.getBody(),\n    items: [{\n        xtype: 'textfield',\n        fieldLabel: 'Name'\n    }]\n});\n

\n\n

flex : Number

Note: this config is only used when this Component is rendered\nby a Container which has been configured to use a BoxL...

Note: this config is only used when this Component is rendered\nby a Container which has been configured to use a BoxLayout.\nEach child Component with a flex property will be flexed either vertically (by a VBoxLayout)\nor horizontally (by an HBoxLayout) according to the item's relative flex value\ncompared to the sum of all Components with flex value specified. Any child items that have\neither a flex = 0 or flex = undefined will not be 'flexed' (the initial size will not be changed).\n\n

floating : Mixed

This property is used to configure the underlying Ext.Layer. ...

This property is used to configure the underlying Ext.Layer. Acceptable values for this\nconfiguration property are:

\n\n\n

false : Default.
Display the panel inline where it is\nrendered.
true :
Float the panel (absolute position it with automatic\nshimming and shadow).
object :
The specified object will be used\nas the configuration object for the Ext.Layer that will be created.

\n\n

footerCfg : Object

A DomHelper element specification object specifying the element structure\nof this Panel's footer Element. ...

A DomHelper element specification object specifying the element structure\nof this Panel's footer Element. See bodyCfg also.

\n\n

forceLayout : Boolean

If true the container will force a layout initially even if hidden or collapsed. ...

If true the container will force a layout initially even if hidden or collapsed. This option\nis useful for forcing forms to render in collapsed or hidden containers. (defaults to false).

Defaults to: false

frame : Boolean

false by default to render with plain 1px square borders. ...

false by default to render with plain 1px square borders. true to render with\n9 elements, complete with custom rounded corners (also see Ext.Element.boxWrap).

\n\n

The template generated for each condition is depicted below:

\n\n\n

\n// frame = false\n<div id=\"developer-specified-id-goes-here\" class=\"x-panel\">\n\n    <div class=\"x-panel-header\"><span class=\"x-panel-header-text\">Title: (frame:false)</span></div>\n\n    <div class=\"x-panel-bwrap\">\n        <div class=\"x-panel-body\"><p>html value goes here</p></div>\n    </div>\n</div>\n\n// frame = true (create 9 elements)\n<div id=\"developer-specified-id-goes-here\" class=\"x-panel\">\n    <div class=\"x-panel-tl\"><div class=\"x-panel-tr\"><div class=\"x-panel-tc\">\n        <div class=\"x-panel-header\"><span class=\"x-panel-header-text\">Title: (frame:true)</span></div>\n    </div></div></div>\n\n    <div class=\"x-panel-bwrap\">\n        <div class=\"x-panel-ml\"><div class=\"x-panel-mr\"><div class=\"x-panel-mc\">\n            <div class=\"x-panel-body\"><p>html value goes here</p></div>\n        </div></div></div>\n\n        <div class=\"x-panel-bl\"><div class=\"x-panel-br\"><div class=\"x-panel-bc\"/>\n        </div></div></div>\n</div>\n

\n\n

header : Boolean

true to create the Panel's header element explicitly, false to skip creating\nit. ...

true to create the Panel's header element explicitly, false to skip creating\nit. If a title is set the header will be created automatically, otherwise it will not.\nIf a title is set but header is explicitly set to false, the header\nwill not be rendered.

headerAsText : Boolean

true to display the panel title in the header,\nfalse to hide it (defaults to true). ...

true to display the panel title in the header,\nfalse to hide it (defaults to true).

Defaults to: true

headerCfg : Object

A DomHelper element specification object specifying the element structure\nof this Panel's header Element. ...

A DomHelper element specification object specifying the element structure\nof this Panel's header Element. See bodyCfg also.

\n\n

height : Number

The height of this component in pixels (defaults to auto). ...

The height of this component in pixels (defaults to auto).\nNote to express this dimension as a percentage or offset see Ext.Component.anchor.

hidden : Boolean

Render this component hidden (default is false). ...

Render this component hidden (default is false). If true, the\nhide method will be called internally.

Defaults to: false

hideCollapseTool : Boolean

true to hide the expand/collapse toggle button when collapsible == true,\nfalse to display it (defaults to false).

hideLabel : Boolean

true to completely hide the label element\n(label and separator). ...

true to completely hide the label element\n(label and separator). Defaults to false.\nBy default, even if you do not specify a fieldLabel the space will still be\nreserved so that the field will line up with other fields that do have labels.\nSetting this to true will cause the field to not reserve that space.

\n\n\n

Note: see the note for clearCls.

\n\n\n

Example use:

\n\n

new Ext.FormPanel({\n    height: 100,\n    renderTo: Ext.getBody(),\n    items: [{\n        xtype: 'textfield'\n        hideLabel: true\n    }]\n});\n

\n\n

hideMode : String

How this component should be hidden. ...

How this component should be hidden. Supported values are 'visibility'\n(css visibility), 'offsets' (negative offset position) and 'display'\n(css display).

\n\n\n

Note: the default of 'display' is generally preferred\n\n\n

since items are automatically laid out when they are first shown (no sizing\nis done while hidden).

Defaults to: 'display'

hideParent : Boolean

True to hide and show the component's container when hide/show is called on the component, false to hide\nand show the...

True to hide and show the component's container when hide/show is called on the component, false to hide\nand show the component itself (defaults to false). For example, this can be used as a shortcut for a hide\nbutton on a window by setting hide:true on the button when adding it to its parent container.

Defaults to: false

Ext.tree.TreePanel
view source

hlColor : String

The color of the node highlight (defaults to 'C3DAF9')

Ext.tree.TreePanel
view source

hlDrop : Boolean

false to disable node highlight on drop (defaults to the value of Ext.enableFx)

iconCls : String

The CSS class selector that specifies a background image to be used as the header icon (defaults to ''). ...

The CSS class selector that specifies a background image to be used as the header icon (defaults to '').

\n\n

An example of specifying a custom icon class would be something like:\n

\n\n\n

// specify the property in the config for the class:\n     ...\n     iconCls: 'my-icon'\n\n// css class that specifies background image to be used as the icon image:\n.my-icon { background-image: url(../images/my-icon.gif) 0 6px no-repeat !important; }\n

\n\n

id : String

The unique id of this component (defaults to an auto-assigned id). ...

The unique id of this component (defaults to an auto-assigned id).\nYou should assign an id if you need to be able to access the component later and you do\nnot have an object reference available (e.g., using Ext.getCmp).

\n\n\n

Note that this id will also be used as the element id for the containing HTML element\nthat is rendered to the page for this component. This allows you to write id-based CSS\nrules to style the specific instance of this component uniquely, and also to select\nsub-elements using this component's id as the parent.

\n\n\n

Note: to avoid complications imposed by a unique id also see\nitemId and ref.

\n\n\n

Note: to access the container of an item see ownerCt.

\n\n

itemCls : String

Note: this config is only used when this Component is rendered by a Container which\nhas been configured to use the Fo...

Note: this config is only used when this Component is rendered by a Container which\nhas been configured to use the FormLayout layout manager (e.g.\nExt.form.FormPanel or specifying layout:'form').

\n\n\n
\n\n\n

An additional CSS class to apply to the div wrapping the form item\nelement of this field. If supplied, itemCls at the field level will override\nthe default itemCls supplied at the container level. The value specified for\nitemCls will be added to the default class ('x-form-item').

\n\n\n

Since it is applied to the item wrapper (see\nExt.layout.FormLayout.fieldTpl), it allows\nyou to write standard CSS rules that can apply to the field, the label (if specified), or\nany other element within the markup for the field.

\n\n\n

Note: see the note for fieldLabel.

\n\n\n

Example use:

\n\n

// Apply a style to the field's label:\n<style>\n    .required .x-form-item-label {font-weight:bold;color:red;}\n</style>\n\nnew Ext.FormPanel({\n    height: 100,\n    renderTo: Ext.getBody(),\n    items: [{\n        xtype: 'textfield',\n        fieldLabel: 'Name',\n        itemCls: 'required' //this label will be styled\n    },{\n        xtype: 'textfield',\n        fieldLabel: 'Favorite Color'\n    }]\n});\n

\n\n

itemId : String

An itemId can be used as an alternative way to get a reference to a component\nwhen no object reference is available. ...

An itemId can be used as an alternative way to get a reference to a component\nwhen no object reference is available. Instead of using an id with\nExt.getCmp, use itemId with\nExt.Container.getComponent which will retrieve\nitemId's or id's. Since itemId's are an index to the\ncontainer's internal MixedCollection, the itemId is scoped locally to the container --\navoiding potential conflicts with Ext.ComponentMgr which requires a unique\nid.

\n\n\n

var c = new Ext.Panel({ //\n    height: 300,\n    renderTo: document.body,\n    layout: 'auto',\n    items: [\n        {\n            itemId: 'p1',\n            title: 'Panel 1',\n            height: 150\n        },\n        {\n            itemId: 'p2',\n            title: 'Panel 2',\n            height: 150\n        }\n    ]\n})\np1 = c.getComponent('p1'); // not the same as Ext.getCmp()\np2 = p1.ownerCt.getComponent('p2'); // reference via a sibling\n

\n\n\n

Also see id and ref.

\n\n\n

Note: to access the container of an item see ownerCt.

\n\n

keys : Object/Array

A Ext.KeyMap config object (in the format expected by Ext.KeyMap.addBinding\nused to assign custom key handling to thi...

A Ext.KeyMap config object (in the format expected by Ext.KeyMap.addBinding\nused to assign custom key handling to this panel (defaults to null).

labelSeparator : String

The separator to display after the text of each\nfieldLabel. ...

The separator to display after the text of each\nfieldLabel. This property may be configured at various levels.\nThe order of precedence is:\n

field / component level
container level
layout level (defaults to colon ':')

\nTo display no separator for this field's label specify empty string ''.

\n\n\n

Note: see the note for clearCls.

\n\n\n

Also see hideLabel and\nExt.layout.FormLayout.fieldTpl.

\n\n\n

Example use:

\n\n

new Ext.FormPanel({\n    height: 100,\n    renderTo: Ext.getBody(),\n    layoutConfig: {\n        labelSeparator: '~'   // layout config has lowest priority (defaults to ':')\n    },\n    labelSeparator: '>>',     // config at container level\n    items: [{\n        xtype: 'textfield',\n        fieldLabel: 'Field 1',\n        labelSeparator: '...' // field/component level config supersedes others\n    },{\n        xtype: 'textfield',\n        fieldLabel: 'Field 2' // labelSeparator will be '='\n    }]\n});\n

\n\n

labelStyle : String

A CSS style specification string to apply directly to this field's\nlabel. ...

A CSS style specification string to apply directly to this field's\nlabel. Defaults to the container's labelStyle value if set (e.g.,\nExt.layout.FormLayout.labelStyle , or '').

\n\n\n

Note: see the note for clearCls.

\n\n\n

Also see hideLabel and\nExt.layout.FormLayout.fieldTpl.

\n\n\n

Example use:

\n\n

new Ext.FormPanel({\n    height: 100,\n    renderTo: Ext.getBody(),\n    items: [{\n        xtype: 'textfield',\n        fieldLabel: 'Name',\n        labelStyle: 'font-weight:bold;'\n    }]\n});\n

\n\n

Ext.tree.TreePanel
view source

lines : Boolean

false to disable tree lines (defaults to true)

listeners : Object

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

(optional)

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

\n\n

DOM events from ExtJs Components

\n\n\n

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

is usually only done when extra value can be added. For example the DataView's\nclick event passing the node clicked on. To access DOM\nevents directly from a Component's HTMLElement, listeners must be added to the Element after the Component\nhas been rendered. A plugin can simplify this step:

\n\n

// Plugin is configured with a listeners config object.\n// The Component is appended to the argument list of all handler functions.\nExt.DomObserver = Ext.extend(Object, {\n    constructor: function(config) {\n        this.listeners = config.listeners ? config.listeners : config;\n    },\n\n    // Component passes itself into plugin's init method\n    init: function(c) {\n        var p, l = this.listeners;\n        for (p in l) {\n            if (Ext.isFunction(l[p])) {\n                l[p] = this.createHandler(l[p], c);\n            } else {\n                l[p].fn = this.createHandler(l[p].fn, c);\n            }\n        }\n\n        // Add the listeners to the Element immediately following the render call\n        c.render = c.render.createSequence(function() {\n            var e = c.getEl();\n            if (e) {\n                e.on(l);\n            }\n        });\n    },\n\n    createHandler: function(fn, c) {\n        return function(e) {\n            fn.call(this, e, c);\n        };\n    }\n});\n\nvar combo = new Ext.form.ComboBox({\n\n    // Collapse combo when its element is clicked on\n    plugins: [ new Ext.DomObserver({\n        click: function(evt, comp) {\n            comp.collapse();\n        }\n    })],\n    store: myStore,\n    typeAhead: true,\n    mode: 'local',\n    triggerAction: 'all'\n});\n

\n\n\n

Ext.tree.TreePanel
view source

loader : Ext.tree.TreeLoader

A Ext.tree.TreeLoader for use with this TreePanel

margins : Object

Note: this config is only used when this BoxComponent is rendered\nby a Container which has been configured to use the...

Note: this config is only used when this BoxComponent is rendered\nby a Container which has been configured to use the BorderLayout\nor one of the two BoxLayout subclasses.

\n\n\n

An object containing margins to apply to this BoxComponent in the\nformat:

\n\n\n

{\n    top: (top margin),\n    right: (right margin),\n    bottom: (bottom margin),\n    left: (left margin)\n}

\n\n\n

May also be a string containing space-separated, numeric margin values. The order of the\nsides associated with each value matches the way CSS processes margin values:

\n\n\n

If there is only one value, it applies to all sides.
If there are two values, the top and bottom borders are set to the first value and the\nright and left are set to the second.
If there are three values, the top is set to the first value, the left and right are set\nto the second, and the bottom is set to the third.
If there are four values, they apply to the top, right, bottom, and left, respectively.

\n\n\n

Defaults to:

\n\n\n

{top:0, right:0, bottom:0, left:0}\n

\n\n

maskDisabled : Boolean

true to mask the panel when it is disabled, false to not mask it (defaults\nto true). ...

true to mask the panel when it is disabled, false to not mask it (defaults\nto true). Either way, the panel will always tell its contained elements to disable themselves\nwhen it is disabled, but masking the panel can provide an additional visual cue that the panel is\ndisabled.

Defaults to: true

minButtonWidth : Number

Minimum width in pixels of all buttons in this panel (defaults to 75) ...

Minimum width in pixels of all buttons in this panel (defaults to 75)

Defaults to: 75

overCls : String

An optional extra CSS class that will be added to this component's Element when the mouse moves\nover the Element, and...

An optional extra CSS class that will be added to this component's Element when the mouse moves\nover the Element, and removed when the mouse moves out. (defaults to ''). This can be\nuseful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.

padding : Number/String

A shortcut for setting a padding style on the body element. ...

A shortcut for setting a padding style on the body element. The value can either be\na number to be applied to all sides, or a normal css string describing padding.\nDefaults to undefined.

pageX : Number

The page level x coordinate for this component if contained within a positioning container.

pageY : Number

The page level y coordinate for this component if contained within a positioning container.

Ext.tree.TreePanel
view source

pathSeparator : String

The token used to separate sub-paths in path strings (defaults to '/')

plugins : Object/Array

An object or array of objects that will provide custom functionality for this component. ...

An object or array of objects that will provide custom functionality for this component. The only\nrequirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component.\nWhen a component is created, if any plugins are available, the component will call the init method on each\nplugin, passing a reference to itself. Each plugin can then call methods or respond to events on the\ncomponent as needed to provide its functionality.

ptype : String

The registered ptype to create. ...

The registered ptype to create. This config option is not used when passing\na config object into a constructor. This config option is used only when\nlazy instantiation is being used, and a Plugin is being\nspecified not as a fully instantiated Component, but as a Component config\nobject. The ptype will be looked up at render time up to determine what\ntype of Plugin to create.

\nIf you create your own Plugins, you may register them using\nExt.ComponentMgr.registerPlugin in order to be able to\ntake advantage of lazy instantiation and rendering.

ref : String

A path specification, relative to the Component's ownerCt\nspecifying into which ancestor Container to place a named r...

A path specification, relative to the Component's ownerCt\nspecifying into which ancestor Container to place a named reference to this Component.

\n\n\n

The ancestor axis can be traversed by using '/' characters in the path.\nFor example, to put a reference to a Toolbar Button into the Panel which owns the Toolbar:

\n\n\n

var myGrid = new Ext.grid.EditorGridPanel({\n    title: 'My EditorGridPanel',\n    store: myStore,\n    colModel: myColModel,\n    tbar: [{\n        text: 'Save',\n        handler: saveChanges,\n        disabled: true,\n        ref: '../saveButton'\n    }],\n    listeners: {\n        afteredit: function() {\n//          The button reference is in the GridPanel\n            myGrid.saveButton.enable();\n        }\n    }\n});\n

\n\n\n

In the code above, if the ref had been 'saveButton'\nthe reference would have been placed into the Toolbar. Each '/' in the ref\nmoves up one level from the Component's ownerCt.

\n\n\n

Also see the added and removed events.

\n\n

region : String

Note: this config is only used when this BoxComponent is rendered\nby a Container which has been configured to use the...

Note: this config is only used when this BoxComponent is rendered\nby a Container which has been configured to use the BorderLayout\nlayout manager (e.g. specifying layout:'border').

\n\n\n
\n\n\n

See Ext.layout.BorderLayout also.

\n\n

renderTo : Mixed

Specify the id of the element, a DOM element or an existing Element that this component\nwill be rendered into. ...

Specify the id of the element, a DOM element or an existing Element that this component\nwill be rendered into.

\n\n\n

Notes :

\n\n\n

See render also.

\n\n

Ext.tree.TreePanel
view source

requestMethod : String

The HTTP request method for loading data (defaults to the value of Ext.Ajax.method).

resizeEvent : String

The event to listen to for resizing in layouts. ...

The event to listen to for resizing in layouts. Defaults to 'bodyresize'.

Defaults to: 'bodyresize'

Overrides: Ext.Container.resizeEvent

Ext.tree.TreePanel
view source

root : Ext.tree.TreeNode

The root node for the tree.

Ext.tree.TreePanel
view source

rootVisible : Boolean

false to hide the root node (defaults to true)

Ext.tree.TreePanel
view source

selModel : Object

A tree selection model to use with this TreePanel (defaults to an Ext.tree.DefaultSelectionModel)

shadow : Boolean/String

true (or a valid Ext.Shadow Ext.Shadow.mode value) to display a shadow behind the\npanel, false to display no shadow (...

true (or a valid Ext.Shadow Ext.Shadow.mode value) to display a shadow behind the\npanel, false to display no shadow (defaults to 'sides'). Note that this option\nonly applies when floating = true.

shadowOffset : Number

The number of pixels to offset the shadow if displayed (defaults to 4). ...

The number of pixels to offset the shadow if displayed (defaults to 4). Note that this\noption only applies when floating = true.

shim : Boolean

false to disable the iframe shim in browsers which need one (defaults to true). ...

false to disable the iframe shim in browsers which need one (defaults to true).\nNote that this option only applies when floating = true.

Ext.tree.TreePanel
view source

singleExpand : Boolean

true if only 1 node per branch may be expanded

stateEvents : Array

An array of events that, when fired, should trigger this component to\nsave its state (defaults to none). ...

An array of events that, when fired, should trigger this component to\nsave its state (defaults to none). stateEvents may be any type\nof event supported by this component, including browser or custom events\n(e.g., ['click', 'customerchange']).

\n\n\n

See stateful for an explanation of saving and\nrestoring Component state.

\n\n

stateId : String

The unique id for this component to use for state management purposes\n(defaults to the component id if one was set, o...

The unique id for this component to use for state management purposes\n(defaults to the component id if one was set, otherwise null if the\ncomponent is using a generated id).

\n\n

See stateful for an explanation of saving and\nrestoring Component state.

\n\n

stateful : Boolean

A flag which causes the Component to attempt to restore the state of\ninternal properties from a saved state on startup. ...

A flag which causes the Component to attempt to restore the state of\ninternal properties from a saved state on startup. The component must have\neither a stateId or id assigned\nfor state to be managed. Auto-generated ids are not guaranteed to be stable\nacross page loads and cannot be relied upon to save and restore the same\nstate for a component.

For state saving to work, the state manager's provider must have been\nset to an implementation of Ext.state.Provider which overrides the\nset and get\nmethods to save and recall name/value pairs. A built-in implementation,\nExt.state.CookieProvider is available.

To set the state provider for the current page:

Ext.state.Manager.setProvider(new Ext.state.CookieProvider({\n    expires: new Date(new Date().getTime()+(1000*60*60*24*7)), //7 days from now\n}));\n

A stateful Component attempts to save state when one of the events\nlisted in the stateEvents configuration fires.

To save state, a stateful Component first serializes its state by\ncalling getState. By default, this function does\nnothing. The developer must provide an implementation which returns an\nobject hash which represents the Component's restorable state.

The value yielded by getState is passed to Ext.state.Manager.set\nwhich uses the configured Ext.state.Provider to save the object\nkeyed by the Component's stateId, or, if that is not\nspecified, its id.

During construction, a stateful Component attempts to restore\nits state by calling Ext.state.Manager.get passing the\nstateId, or, if that is not specified, the\nid.

The resulting object is passed to applyState.\nThe default implementation of applyState simply copies\nproperties into the object, but a developer may override this to support\nmore behaviour.

You can perform extra processing on state save and restore by attaching\nhandlers to the beforestaterestore, staterestore,\nbeforestatesave and statesave events.

\n\n

style : String

A custom style specification to be applied to this component's Element. ...

A custom style specification to be applied to this component's Element. Should be a valid argument to\nExt.Element.applyStyles.

\n\n

new Ext.Panel({\n    title: 'Some Title',\n    renderTo: Ext.getBody(),\n    width: 400, height: 300,\n    layout: 'form',\n    items: [{\n        xtype: 'textarea',\n        style: {\n            width: '95%',\n            marginBottom: '10px'\n        }\n    },\n        new Ext.Button({\n            text: 'Send',\n            minWidth: '100',\n            style: {\n                marginBottom: '10px'\n            }\n        })\n    ]\n});\n

\n\n

tabTip : String

Note: this config is only used when this BoxComponent is a child item of a TabPanel. ...

Note: this config is only used when this BoxComponent is a child item of a TabPanel.

\n\n\n

A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over\nthe associated tab selector element. Ext.QuickTips.init()\nmust be called in order for the tips to render.

tbar : Object/Array

The top toolbar of the panel. ...

The top toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of\nbuttons/button configs to be added to the toolbar. Note that this is not available as a property after render.\nTo access the top toolbar after render, use getTopToolbar.

\n\n\n

\n\n

tbarCfg : Object

A DomHelper element specification object specifying the element structure\nof this Panel's tbar Element. ...

A DomHelper element specification object specifying the element structure\nof this Panel's tbar Element. See bodyCfg also.

\n\n

title : String

The title text to be used as innerHTML (html tags are accepted) to display in the panel\nheader (defaults to ''). ...

The title text to be used as innerHTML (html tags are accepted) to display in the panel\nheader (defaults to ''). When a title is specified the\nheader element will automatically be created and displayed unless\nheader is explicitly set to false. If you do not want to specify a\ntitle at config time, but you may want one later, you must either specify a non-empty\ntitle (a blank space ' ' will do) or header:true so that the container\nelement will get created.

titleCollapse : Boolean

true to allow expanding and collapsing the panel (when collapsible = true)\nby clicking anywhere in the header bar, fa...

true to allow expanding and collapsing the panel (when collapsible = true)\nby clicking anywhere in the header bar, false) to allow it only by clicking to tool button\n(defaults to false)). If this panel is a child item of a border layout also see the\nBorderLayout.Region\nfloatable config option.

toolTemplate : Ext.Template/Ext.XTemplate

A Template used to create tools in the header Element. ...

A Template used to create tools in the header Element. Defaults to:

\n\n\n

new Ext.Template('<div class=\"x-tool x-tool-{id}\">&#160;</div>')

\n\n\n

This may may be overridden to provide a custom DOM structure for tools based upon a more\ncomplex XTemplate. The template's data is a single tool configuration object (Not the entire Array)\nas specified in tools. In the following example an <a> tag is used to provide a\nvisual indication when hovering over the tool:

\n\n\n

var win = new Ext.Window({\n    tools: [{\n        id: 'download',\n        href: '/MyPdfDoc.pdf'\n    }],\n    toolTemplate: new Ext.XTemplate(\n        '<tpl if=\"id==\\'download\\'\">',\n            '<a class=\"x-tool x-tool-pdf\" href=\"{href}\"></a>',\n        '</tpl>',\n        '<tpl if=\"id!=\\'download\\'\">',\n            '<div class=\"x-tool x-tool-{id}\">&#160;</div>',\n        '</tpl>'\n    ),\n    width:500,\n    height:300,\n    closeAction:'hide'\n});

\n\n\n

Note that the CSS class 'x-tool-pdf' should have an associated style rule which provides an\nappropriate background image, something like:

\n\n\n\n\n

    a.x-tool-pdf {background-image: url(../shared/extjs/images/pdf.gif)!important;}\n

\n\n

tools : Array

An array of tool button configs to be added to the header tool area. ...

An array of tool button configs to be added to the header tool area. When rendered, each tool is\nstored as an Element referenced by a public property called tools.<tool-type>

\n\n

Each tool config may contain the following properties:\n

id : String
Required. The type\nof tool to create. By default, this assigns a CSS class of the form x-tool-<tool-type> to the\nresulting tool Element. Ext provides CSS rules, and an icon sprite containing images for the tool types listed below.\nThe developer may implement custom tools by supplying alternate CSS rules and background images:\n
handler : Function
Required. The function to\ncall when clicked. Arguments passed are:
- event : Ext.EventObject
  The click event.
- toolEl : Ext.Element
  The tool Element.
- panel : Ext.Panel
  The host Panel
- tc : Object
  The tool configuration object
stopEvent : Boolean
Defaults to true. Specify as false to allow click event to propagate.
scope : Object
The scope in which to call the handler.
qtip : String/Object
A tip string, or\na config argument to Ext.QuickTip.register
hidden : Boolean
True to initially render hidden.
on : Object
A listener config object specifiying\nevent listeners in the format of an argument to addListener

Note that, apart from the toggle tool which is provided when a panel is collapsible, these\ntools only provide the visual button. Any required functionality must be provided by adding\nhandlers that implement the necessary behavior.

Example usage:

tools:[{\n    id:'refresh',\n    qtip: 'Refresh form Data',\n    // hidden:true,\n    handler: function(event, toolEl, panel){\n        // refresh logic\n    }\n},\n{\n    id:'help',\n    qtip: 'Get Help',\n    handler: function(event, toolEl, panel){\n        // whatever\n    }\n}]\n

For the custom id of 'help' define two relevant css classes with a link to\na 15x15 image:

.x-tool-help {background-image: url(images/help.png);}\n.x-tool-help-over {background-image: url(images/help_over.png);}\n// if using an image sprite:\n.x-tool-help {background-image: url(images/help.png) no-repeat 0 0;}\n.x-tool-help-over {background-position:-15px 0;}\n

\n\n

Ext.tree.TreePanel
view source

trackMouseOver : Boolean

false to disable mouse over highlighting

unstyled : Boolean

Overrides the baseCls setting to baseCls = 'x-plain' which renders\nthe panel unstyled except for required attributes ...

Overrides the baseCls setting to baseCls = 'x-plain' which renders\nthe panel unstyled except for required attributes for Ext layouts to function (e.g. overflow:hidden).

Ext.tree.TreePanel
view source

useArrows : Boolean

true to use Vista-style arrows in the tree (defaults to false)

width : Number

The width of this component in pixels (defaults to auto). ...

The width of this component in pixels (defaults to auto).\nNote to express this dimension as a percentage or offset see Ext.Component.anchor.

x : Number

The local x (left) coordinate for this component if contained within a positioning container.

xtype : String

The registered xtype to create. ...

The registered xtype to create. This config option is not used when passing\na config object into a constructor. This config option is used only when\nlazy instantiation is being used, and a child item of a Container is being\nspecified not as a fully instantiated Component, but as a Component config\nobject. The xtype will be looked up at render time up to determine what\ntype of child Component to create.

\nThe predefined xtypes are listed here.

\n\n

\n\n\n

If you subclass Components to create your own Components, you may register\nthem using Ext.ComponentMgr.registerType in order to be able to\ntake advantage of lazy instantiation and rendering.

y : Number

The local y (top) coordinate for this component if contained within a positioning container.

Defined By

Properties

Ext.tree.TreePanel
view source

animate : Objectprivate

body : Ext.Element

The Panel's body Element which may be used to contain HTML content. ...

The Panel's body Element which may be used to contain HTML content.\nThe content may be specified in the html config, or it may be loaded using the\nautoLoad config, or through the Panel's Updater. Read-only.

\n\n

If this is used to load visible HTML elements in either way, then\nthe Panel may not be used as a Layout for hosting nested Panels.

\n\n\n

If this Panel is intended to be used as the host of a Layout (See layout\nthen the body Element must not be loaded or changed - it is under the control\nof the Panel's Layout.\n

Note: see the Note for el also.

\n\n

boxReady : Booleanprivate

private, set in afterRender to signify that the component has been rendered ...

private, set in afterRender to signify that the component has been rendered

Defaults to: false

buttons : Array

This Panel's Array of buttons as created from the buttons\nconfig property. ...

This Panel's Array of buttons as created from the buttons\nconfig property. Read only.

bwrap : Ext.Element

The Panel's bwrap Element used to contain other Panel elements\n(tbar, body, bbar, footer). ...

The Panel's bwrap Element used to contain other Panel elements\n(tbar, body, bbar, footer). See bodyCfg. Read-only.

collapseDefaults : Objectprivate

private ...

private

Defaults to: {duration: 0.25}

collapseEl : Stringprivate

...

Defaults to: 'bwrap'

collapsed : Boolean

True if this panel is collapsed. ...

True if this panel is collapsed. Read-only.

dd : Ext.dd.DragSource

If this Panel is configured draggable, this property will contain\nan instance of Ext.dd.DragSource which handles drag...

If this Panel is configured draggable, this property will contain\nan instance of Ext.dd.DragSource which handles dragging the Panel.

\n\n\n

The developer must provide implementations of the abstract methods of Ext.dd.DragSource\nin order to supply behaviour for each stage of the drag/drop process. See draggable.

dragZone : Ext.tree.TreeDragZone

deferHeight : Booleanprivate

private, notify box this class will handle heights ...

private, notify box this class will handle heights

Defaults to: true

Overrides: Ext.BoxComponent.deferHeight

Ext.tree.TreePanel
view source

The dragZone used by this tree if drag is enabled (see enableDD or enableDrag)

Ext.tree.TreePanel
view source

dropZone : Ext.tree.TreeDropZone

The dropZone used by this tree if drop is enabled (see enableDD or enableDrop)

el : Ext.Element

The Ext.Element which encapsulates this Component. ...

The Ext.Element which encapsulates this Component. Read-only.

\n\n\n

This will usually be a <DIV> element created by the class's onRender method, but\nthat may be overridden using the autoEl config.

\n\n\n

Note: this element will not be available until this Component has been rendered.

\n\n\n

To add listeners for DOM events to this Component (as opposed to listeners\nfor this Component's own Observable events), see the listeners\nconfig for a suggestion, or use a render listener directly:

\n\n\n

new Ext.Panel({\n    title: 'The Clickable Panel',\n    listeners: {\n        render: function(p) {\n            // Append the Panel to the click handler's argument list.\n            p.getEl().on('click', handlePanelClick.createDelegate(null, [p], true));\n        },\n        single: true  // Remove the listener after first invocation\n    }\n});\n

\n\n\n

Methods

Ext.tree.TreePanel
view source

newExt.tree.TreePanel( config ) : Ext.tree.TreePanel

...

Parameters

config : Object
\n

Returns

Ext.tree.TreePanel
\n

Overrides: Ext.Panel.constructor

add( component ) : Ext.Component/Array

Adds Component(s) to this Container. ...

Adds Component(s) to this Container.

\n\n\n

Description :\n\n\n

Fires the beforeadd event before adding
The Container's default config values will be applied\naccordingly (see defaults for details).
Fires the add event after the component has been added.

\n\n\n

Notes :\n\n\n

If the Container is already rendered when add\nis called, you may need to call doLayout to refresh the view which causes\nany unrendered child Components to be rendered. This is required so that you can\nadd multiple child components if needed while only refreshing the layout\nonce. For example:\n
```
var tb = new Ext.Toolbar();\ntb.render(document.body);  // toolbar is rendered\ntb.add({text:'Button 1'}); // add multiple items (defaultType for Toolbar is 'button')\ntb.add({text:'Button 2'});\ntb.doLayout();             // refresh the layout\n
```
Warning: Containers directly managed by the BorderLayout layout manager\nmay not be removed or added. See the Notes for BorderLayout\nfor more details.

\n\n

Parameters

component : ...Object/Array
Either one or more Components to add or an Array of Components to add. See\nitems for additional information.
\n\n

Returns

Ext.Component/Array
The Components that were added.
\n

addButton( config, handler, scope ) : Ext.Button

Adds a button to this panel. ...

Adds a button to this panel. Note that this method must be called prior to rendering. The preferred\napproach is to add buttons via the buttons config.

Parameters

config : String/Object
A valid Ext.Button config. A string will become the text for a default\nbutton config, an object will be treated as a button config object.
\n
handler : Function
The function to be called on button Ext.Button.click
\n
scope : Object
The scope (this reference) in which the button handler function is executed. Defaults to the Button.
\n

Returns

Ext.Button
The button that was added
\n

addClass( cls ) : Ext.Componentchainable

Adds a CSS class to the component's underlying element. ...

Adds a CSS class to the component's underlying element.

Parameters

cls : string
The CSS class name to add
\n

Returns

Ext.Component
this
\n

addEvents( o, Optional )

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\nor the first event name string if multiple event names are being passed as separate parameters.
\n
Optional : string
. Event name if multiple event names are being passed as separate parameters.\nUsage:
\n\n
```
this.addEvents('storeloaded', 'storecleared');\n
```
\n\n

addListener( eventName, handler, [scope], [options] )

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.
\n
handler : Function
The method the event invokes.
\n
scope : Object (optional)
The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
\n
options : Object (optional)
An object containing handler configuration.\nproperties. This may contain any of the following properties:
- scope : Object
  The scope (this reference) in which the handler function is executed.\nIf 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\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler 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\nif the event was bubbled up from a child Observable.
\n\n
\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA delayed, one-time listener.\n
```
myDataView.on('click', this.onClick, this, {\nsingle: true,\ndelay: 100\n});
```
\n
\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n
\n
```
myGridPanel.on({\n'click' : {\n    fn: this.onClick,\n    scope: this,\n    delay: 100\n},\n'mouseover' : {\n    fn: this.onMouseOver,\n    scope: this\n},\n'mouseout' : {\n    fn: this.onMouseOut,\n    scope: this\n}\n});
```
\n
\nOr a shorthand syntax:
\n
```
myGridPanel.on({\n'click' : this.onClick,\n'mouseover' : this.onMouseOver,\n'mouseout' : this.onMouseOut,\n scope: this\n});
```
\n\n

addTool( )private

private ...

private

adjustBodyHeight( h )private

deprecate ...

deprecate

Parameters

h : Object
\n

adjustBodyWidth( w )private

private ...

private

Parameters

w : Object
\n

adjustPosition( x, y )private

private ...

private

Parameters

x : Object
\n
y : Object
\n

adjustSize( w, h )private

private ...

private

Parameters

w : Object
\n
h : Object
\n

afterCollapse( anim )private

private ...

private

Parameters

anim : Object
\n

afterEffect( anim )private

private ...

private

Parameters

anim : Object
\n

afterExpand( anim )private

private ...

private

Parameters

anim : Object
\n

Ext.tree.TreePanel
view source

afterRender( )private

private ...

private

Overrides: Ext.Panel.afterRender

applyDefaults( c )private

private ...

private

Parameters

c : Object
\n

Ext.tree.TreePanel
view source

beforeDestroy( )private

...

Overrides: Ext.Panel.beforeDestroy

beforeEffect( anim )private

private ...

private

Parameters

anim : Object
\n

bubble( fn, [scope], [args] ) : Ext.Componentchainable

Bubbles up the component/container heirarchy, calling the specified function with each component. ...

Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of\nfunction call will be the scope provided or the current component. The arguments to the function\nwill be the args provided or the current component. If the function returns false at any point,\nthe bubble is stopped.

Parameters

fn : Function
The function to call
\n
scope : Object (optional)
The scope of the function (defaults to current node)
\n
args : Array (optional)
The args to call the function with (default to passing the current component)
\n

Returns

Ext.Component
this
\n

canLayout( )private

We can only lay out if there is a view area in which to layout. ...

We can only lay out if there is a view area in which to layout.\ndisplay:none on the layout target, or any of its parent elements will mean it has no view area.

Ext.tree.TreePanel
view source

clearInnerCt( )private

...

cloneConfig( overrides ) : Ext.Component

Clone the current component using the original config values passed into this instance by default. ...

Clone the current component using the original config values passed into this instance by default.

Parameters

overrides : Object
A new config containing any properties to override in the cloned version.\nAn id property can be passed on this object, otherwise one will be generated to avoid duplicates.
\n

Returns

Ext.Component
clone The cloned copy of this component
\n

collapse( animate ) : Ext.Panelchainable

Collapses the panel body so that it becomes hidden. ...

Collapses the panel body so that it becomes hidden. Fires the beforecollapse event which will\ncancel the collapse action if it returns false.

Parameters

animate : Boolean
True to animate the transition, else false (defaults to the value of the\nanimCollapse panel config)
\n

Returns

Ext.Panel
this
\n

Ext.tree.TreePanel
view source

collapseAll( )

Collapse all nodes ...

Collapse all nodes

createClasses( )private

private ...

private

createComponent( config, defaultType )private

private ...

private

Parameters

config : Object
\n
defaultType : Object
\n

createEffect( a, cb, scope )private

private - wraps up an animation param with internal callbacks ...

private - wraps up an animation param with internal callbacks

Parameters

a : Object
\n
cb : Object
\n
scope : Object
\n

createElement( name, pnode )private

private ...

private

Parameters

name : Object
\n
pnode : Object
\n

createFbar( fbar )private

private ...

private

Parameters

fbar : Object
\n

createGhost( cls, useShim, appendTo )private

private ...

private

Parameters

cls : Object
\n
useShim : Object
\n
appendTo : Object
\n

createToolHandler( t, tc, overCls, panel )private

private ...

private

Parameters

t : Object
\n
tc : Object
\n
overCls : Object
\n
panel : Object
\n

createToolbar( tb, options )private

private ...

private

Parameters

tb : Object
\n
options : Object
\n

destroy( )

Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the c...

Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its Ext.Container (if applicable) and unregistering it from\nExt.ComponentMgr. Destruction is generally handled automatically by the framework and this method\nshould usually not need to be called directly.

Ext.tree.TreePanel
view source

destroyRoot( )private

Destroy the root node. ...

Destroy the root node. Not included by itself because we need to pass the silent parameter.

doAutoLoad( )private

private ...

private

doRemove( c, autoDestroy )private

private ...

private

Parameters

c : Object
\n
autoDestroy : Object
\n

enableBubble( events )

Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present. ...

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

\n\n\n

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default\nimplementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.

\n\n\n

Example:

\n\n\n

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

\n\n

Parameters

events : String/Array
The event name to bubble, or an Array of event names.
\n

expand( animate ) : Ext.Panelchainable

Expands the panel body so that it becomes visible. ...

Expands the panel body so that it becomes visible. Fires the beforeexpand event which will\ncancel the expand action if it returns false.

Parameters

animate : Boolean
True to animate the transition, else false (defaults to the value of the\nanimCollapse panel config)
\n

Returns

Ext.Panel
this
\n

Ext.tree.TreePanel
view source

expandAll( )

Expand all nodes ...

Expand all nodes

Ext.tree.TreePanel
view source

expandPath( path, [attr], [callback] )

Expands a specified path in this TreePanel. ...

Expands a specified path in this TreePanel. A path can be retrieved from a node with Ext.data.Node.getPath

Parameters

path : String
\n
attr : String (optional)
The attribute used in the path (see Ext.data.Node.getPath for more info)
\n
callback : Function (optional)
The callback to call when the expand is complete. The callback will be called with\n(bSuccess, oLastNode) where bSuccess is if the expand was successful and oLastNode is the last node that was expanded.
\n

findParentBy( fn ) : Ext.Container

Find a container above this component at any level by a custom function. ...

Find a container above this component at any level by a custom function. If the passed function returns\ntrue, the container will be returned.

Parameters

fn : Function
The custom function to call with the arguments (container, this component).
\n

Returns

Ext.Container
The first Container for which the custom function returns true
\n

findParentByType( xtype, [shallow] ) : Ext.Container

Find a container above this component at any level by xtype or class ...

Find a container above this component at any level by xtype or class

Parameters

xtype : String/Ext.Component/Class
The xtype to check for this Component. Note that the the component can either be an instance\nor a component class:
\n
shallow : Boolean (optional)
False to check whether this Component is descended from the xtype (this is\nthe default), or true to check whether this Component is directly of the specified xtype.
\n

Returns

Ext.Container
The first Container which matches the given xtype or class
\n

fireEvent( eventName, args ) : Boolean

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

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

\n\n\n

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

\n\n

Parameters

eventName : String
The name of the event to fire.
\n
args : Object...
Variable number of parameters are passed to handlers.
\n

Returns

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

focus( [selectText], [delay] ) : Ext.Componentchainable

Try to focus this component. ...

Try to focus this component.

Parameters

selectText : Boolean (optional)
If applicable, true to also select the text in this component
\n
delay : Boolean/Number (optional)
Delay the focus this number of milliseconds (true for 10 milliseconds)
\n

Returns

Ext.Component
this
\n

get( key ) : Ext.Componentdeprecated

Get a component contained by this container (alias for items.get(key)) ...

Get a component contained by this container (alias for items.get(key))

This method has been deprecated

Should be removed in 4.0, since getComponent does the same thing.

\n\n

Parameters

key : String/Number
The index or id of the component
\n

Returns

Ext.Component
Ext.Component
\n

getBottomToolbar( ) : Ext.Toolbar

Returns the toolbar from the bottom (bbar) section of the panel. ...

Returns the toolbar from the bottom (bbar) section of the panel.

Returns

Ext.Toolbar
The toolbar
\n

getBox( [local] ) : Object

Gets the current box measurements of the component's underlying element. ...

Gets the current box measurements of the component's underlying element.

Parameters

local : Boolean (optional)
If true the element's left and top are returned instead of page XY (defaults to false)
\n

Returns

Object
box An object in the format {x, y, width, height}
\n

getBubbleTarget( ) : Ext.Container

Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. ...

Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.

Returns

Ext.Container
the Container which owns this Component.
\n

Ext.tree.TreePanel
view source

getChecked( [attribute], [startNode] ) : Array

Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. ...

Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. 'id')

Parameters

attribute : String (optional)
Defaults to null (return the actual nodes)
\n
startNode : TreeNode (optional)
The node to start from, defaults to the root
\n

Returns

Array
\n

getComponentId( comp )private

private - used as the key lookup function for the items collection ...

private - used as the key lookup function for the items collection

Parameters

comp : Object
\n

getContentTarget( )private

private ...

private

getEl( ) : Ext.Element

Returns the Ext.Element which encapsulates this Component. ...

Returns the Ext.Element which encapsulates this Component.

\n\n\n

This will usually be a <DIV> element created by the class's onRender method, but\nthat may be overridden using the autoEl config.

\n\n\n

Note: this element will not be available until this Component has been rendered.

\n\n\n

To add listeners for DOM events to this Component (as opposed to listeners\nfor this Component's own Observable events), see the listeners config for a suggestion,\nor use a render listener directly:

\n\n\n

new Ext.Panel({\n    title: 'The Clickable Panel',\n    listeners: {\n        render: function(p) {\n            // Append the Panel to the click handler's argument list.\n            p.getEl().on('click', handlePanelClick.createDelegate(null, [p], true));\n        },\n        single: true  // Remove the listener after first invocation\n    }\n});\n

\n\n

Returns

Ext.Element
The Element which encapsulates this Component.
\n

getFooterToolbar( ) : Ext.Toolbar

Returns the toolbar from the footer (fbar) section of the panel. ...

Returns the toolbar from the footer (fbar) section of the panel.

Returns

Ext.Toolbar
The toolbar
\n

getFrameHeight( ) : Number

Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and\nheader and ...

Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and\nheader and footer elements, but not including the body height). To retrieve the body height see getInnerHeight.

Returns

Number
The frame height
\n

getFrameWidth( ) : Number

Returns the width in pixels of the framing elements of this panel (not including the body width). ...

Returns the width in pixels of the framing elements of this panel (not including the body width). To\nretrieve the body width see getInnerWidth.

Returns

Number
The frame width
\n

getHeight( ) : Number

Gets the current height of the component's underlying element. ...

Gets the current height of the component's underlying element.

Returns

Number
\n

getId( ) : String

Returns the id of this component or automatically generates and\nreturns an id if an id is not defined yet:\n\n'ext-comp...

Returns the id of this component or automatically generates and\nreturns an id if an id is not defined yet:

\n\n

'ext-comp-' + (++Ext.Component.AUTO_ID)\n

\n\n

Returns

String
id
\n

getInnerHeight( ) : Number

Returns the height in pixels of the body element (not including the height of any framing elements). ...

Returns the height in pixels of the body element (not including the height of any framing elements).\nFor the frame height see getFrameHeight.

Returns

Number
The body height
\n

getInnerWidth( ) : Number

Returns the width in pixels of the body element (not including the width of any framing elements). ...

Returns the width in pixels of the body element (not including the width of any framing elements).\nFor the frame width see getFrameWidth.

Returns

Number
The body width
\n

getItemId( ) : String

Returns the itemId of this component. ...

Returns the itemId of this component. If an\nitemId was not assigned through configuration the\nid is returned using getId.

Returns

String
\n

getKeyMap( )private

private ...

private

getLayoutTarget( ) : Ext.Element

private\n\nReturns the Element to be used to contain the child Components of this Container. ...

private

\n\n

Returns the Element to be used to contain the child Components of this Container.

\n\n\n

An implementation is provided which returns the Container's Element, but\nif there is a more complex structure to a Container, this may be overridden to return\nthe element into which the layout renders child Components.

\n\n

Returns

Ext.Element
The Element to render child Components into.
\n\n

Overrides: Ext.Container.getLayoutTarget

Ext.tree.TreePanel
view source

getLoader( ) : Ext.tree.TreeLoader

Returns the default Ext.tree.TreeLoader for this TreePanel. ...

Returns the default Ext.tree.TreeLoader for this TreePanel.

Returns

Ext.tree.TreeLoader
The TreeLoader for this TreePanel.
\n

Ext.tree.TreePanel
view source

getNodeById( id ) : Node

Gets a node in this tree by its id ...

Gets a node in this tree by its id

Parameters

id : String
\n

Returns

Node
\n

getOuterSize( ) : Object

Gets the current size of the component's underlying element, including space taken by its margins. ...

Gets the current size of the component's underlying element, including space taken by its margins.

Returns

Object
An object containing the element's size {width: (element width + left/right margins), height: (element height + top/bottom margins)}
\n

getPosition( [local] ) : Array

Gets the current XY position of the component's underlying element. ...

Gets the current XY position of the component's underlying element.

Parameters

local : Boolean (optional)
If true the element's left and top are returned instead of page XY (defaults to false)
\n

Returns

Array
The XY position of the element (e.g., [100, 200])
\n

getResizeEl( ) : Ext.Element

Returns the outermost Element of this Component which defines the Components overall size. ...

Returns the outermost Element of this Component which defines the Components overall size.

\n\n\n

Usually this will return the same Element as getEl,\nbut in some cases, a Component may have some more wrapping Elements around its main\nactive Element.

\n\n\n

An example is a ComboBox. It is encased in a wrapping Element which\ncontains both the <input> Element (which is what would be returned\nby its getEl method, and the trigger button Element.\nThis Element is returned as the resizeEl.\n\n

Returns

Ext.Element
The Element which is to be resized by size managing layouts.
\n

Ext.tree.TreePanel
view source

getRootNode( ) : Node

Returns this root node for this tree ...

Returns this root node for this tree

Returns

Node
\n

Ext.tree.TreePanel
view source

getSelectionModel( ) : TreeSelectionModel

Returns the selection model used by this TreePanel. ...

Returns the selection model used by this TreePanel.

Returns

TreeSelectionModel
The selection model used by this TreePanel
\n

getSize( ) : Object

Gets the current size of the component's underlying element. ...

Gets the current size of the component's underlying element.

Returns

Object
An object containing the element's size {width: (element width), height: (element height)}
\n

getTool( id ) : Object

Retrieve a tool by id. ...

Retrieve a tool by id.

Parameters

id : String
\n

Returns

Object
tool
\n

getToolbarHeight( )private

private ...

private

getTopToolbar( ) : Ext.Toolbar

Returns the toolbar from the top (tbar) section of the panel. ...

Returns the toolbar from the top (tbar) section of the panel.

Returns

Ext.Toolbar
The toolbar
\n

Ext.tree.TreePanel
view source

getTreeEl( ) : Ext.Element

Returns the underlying Element for this tree ...

Returns the underlying Element for this tree

Returns

Ext.Element
The Element
\n

getWidth( ) : Number

Gets the current width of the component's underlying element. ...

Gets the current width of the component's underlying element.

Returns

Number
\n

getXType( ) : String

Gets the xtype for this component as registered with Ext.ComponentMgr. ...

Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all\navailable xtypes, see the Ext.Component header. Example usage:

\n\n

var t = new Ext.form.TextField();\nalert(t.getXType());  // alerts 'textfield'\n

\n\n

Returns

String
The xtype
\n

getXTypes( ) : String

Returns this Component's xtype hierarchy as a slash-delimited string. ...

Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all\navailable xtypes, see the Ext.Component header.

\n\n\n

If using your own subclasses, be aware that a Component must register its own xtype\nto participate in determination of inherited xtypes.

\n\n\n

Example usage:

\n\n\n

var t = new Ext.form.TextField();\nalert(t.getXTypes());  // alerts 'component/box/field/textfield'\n

\n\n

Returns

String
The xtype hierarchy string
\n

hasLayoutPending( )private

private ...

private

hasListener( 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
\n

Returns

Boolean
True if the event is being listened for, else false
\n

hide( ) : Ext.Componentchainable

Hide this component. ...

Hide this component. Listen to the 'beforehide' event and return\nfalse to cancel hiding the component. Fires the 'hide'\nevent after hiding the component. Note this method is called internally if\nthe component is configured to be hidden.

Returns

Ext.Component
this
\n

Ext.tree.TreePanel
view source

initComponent( )private

...

Overrides: Ext.Panel.initComponent

initDraggable( )private

private ...

private

Ext.tree.TreePanel
view source

initEvents( )private

private ...

private

Overrides: Ext.Panel.initEvents

initItems( )private

private ...

private

initRef( )private

Method to establish a reference to a component. ...

Method to establish a reference to a component.

isVisible( ) : Boolean

Returns true if this component is visible. ...

Returns true if this component is visible.

Returns

Boolean
True if this component is visible, false otherwise.
\n

isXType( xtype, [shallow] ) : Boolean

Tests whether or not this Component is of a specific xtype. ...

Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended\nfrom the xtype (default) or whether it is directly of the xtype specified (shallow = true).

\n\n\n

If using your own subclasses, be aware that a Component must register its own xtype\nto participate in determination of inherited xtypes.

\n\n\n

For a list of all available xtypes, see the Ext.Component header.

\n\n\n

Example usage:

\n\n\n

var t = new Ext.form.TextField();\nvar isText = t.isXType('textfield');        // true\nvar isBoxSubclass = t.isXType('box');       // true, descended from BoxComponent\nvar isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instance\n

\n\n

Parameters

xtype : String/Ext.Component/Class
The xtype to check for this Component. Note that the the component can either be an instance\nor a component class:
\n\n
```
var c = new Ext.Component();\nconsole.log(c.isXType(c));\nconsole.log(c.isXType(Ext.Component));\n
```
\n\n
shallow : Boolean (optional)
False to check whether this Component is descended from the xtype (this is\nthe default), or true to check whether this Component is directly of the specified xtype.
\n

Returns

Boolean
True if this component descends from the specified xtype, false otherwise.
\n

lookupComponent( comp )private

private ...

private

Parameters

comp : Object
\n

makeFloating( cfg )private

private ...

private

Parameters

cfg : Object
\n

mon( item, ename, fn, scope, opt )

Adds listeners to any Observable object (or Elements) which are automatically removed when this Component\nis destroyed. ...

Adds listeners to any Observable object (or Elements) which are automatically removed when this Component\nis destroyed. Usage:

\n\n\n

\n\nmyGridPanel.mon(myGridPanel.getSelectionModel(), 'selectionchange', handleSelectionChange, null, {buffer: 50});\n
\n\n\n

\n\n

or:

\n\n\n

\n\nmyGridPanel.mon(myGridPanel.getSelectionModel(), {\n    selectionchange: handleSelectionChange,\n    buffer: 50\n});\n
\n\n\n

Parameters

item : Observable|Element
The item to which to add a listener/listeners.
\n
ename : Object|String
The event name, or an object containing event name properties.
\n
fn : Function
Optional. If the ename parameter was an event name, this\nis the handler function.
\n
scope : Object
Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.
\n
opt : Object
Optional. If the ename parameter was an event name, this\nis the addListener options.
\n

mun( item, ename, fn, scope )

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.
\n
ename : Object|String
The event name, or an object containing event name properties.
\n
fn : Function
Optional. If the ename parameter was an event name, this\nis the handler function.
\n
scope : Object
Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.
\n

nextSibling( ) : Object

Returns the next component in the owning container ...

Returns the next component in the owning container

Returns

Object
Ext.Component
\n

on( eventName, handler, [scope], [options] )

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
\n
handler : Function
The method the event invokes
\n
scope : Object (optional)
The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
\n
options : Object (optional)
An object containing handler configuration.
\n

onAdd( c )private

...

Parameters

c : Object
\n

onAdded( container, pos )private

private\n\nMethod to manage awareness of when components are added to their\nrespective Container, firing an added event. ...

private

\n\n

Method to manage awareness of when components are added to their\nrespective Container, firing an added event.\nReferences are established at add time rather than at render time.

Parameters

container : Ext.Container
Container which holds the component
\n
pos : number
Position at which the component was added
\n

Overrides: Ext.Component.onAdded

onBeforeAdd( item )private

private ...

private

Parameters

item : Object
\n

onBodyResize( w, h )private

private ...

private

Parameters

w : Object
\n
h : Object
\n

onCollapse( doAnim, animArg )private

private ...

private

Parameters

doAnim : Object
\n
animArg : Object
\n

onDisable( )private

private ...

private

onEnable( )private

private ...

private

onExpand( doAnim, animArg )private

private ...

private

Parameters

doAnim : Object
\n
animArg : Object
\n

onHide( )private

private ...

private

onLayout( shallow, force )private

...

Parameters

shallow : Object
\n
force : Object
\n

Overrides: Ext.Container.onLayout

onPosition( )private

private ...

private

Overrides: Ext.BoxComponent.onPosition

onRemove( c )private

...

Parameters

c : Object
\n

onRemoved( )private

Method to manage awareness of when components are removed from their\nrespective Container, firing an removed event. ...

Method to manage awareness of when components are removed from their\nrespective Container, firing an removed event. References are properly\ncleaned up after removing a component from its owning container.

Ext.tree.TreePanel
view source

onRender( ct, position )private

private ...

private

Parameters

ct : Object
\n
position : Object
\n

Overrides: Ext.Panel.onRender

onResize( adjWidth, adjHeight, rawWidth, rawHeight )private

private ...

private

Parameters

adjWidth : Object
\n
adjHeight : Object
\n
rawWidth : Object
\n
rawHeight : Object
\n

Overrides: Ext.BoxComponent.onResize

onShow( )private

private ...

private

Overrides: Ext.Container.onShow

previousSibling( ) : Object

Returns the previous component in the owning container ...

Returns the previous component in the owning container

Returns

Object
Ext.Component
\n

Ext.tree.TreePanel
view source

proxyNodeEvent( ename, a1, a2, a3, a4, a5, a6 )private

private ...

private

Parameters

ename : Object
\n
a1 : Object
\n
a2 : Object
\n
a3 : Object
\n
a4 : Object
\n
a5 : Object
\n
a6 : Object
\n

purgeListeners( )

Removes all listeners for this object ...

Removes all listeners for this object

Ext.tree.TreePanel
view source

registerNode( node )private

private ...

private

Parameters

node : Object
\n

relayEvents( o, events )

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

o : Object
The Observable whose events this object is to relay.
\n
events : Array
Array of event names to relay.
\n

removeClass( cls ) : Ext.Componentchainable

Removes a CSS class from the component's underlying element. ...

Removes a CSS class from the component's underlying element.

Parameters

cls : string
The CSS class name to remove
\n

Returns

Ext.Component
this
\n

removeListener( eventName, handler, [scope] )

Removes an event handler. ...

Removes an event handler.

Parameters

eventName : String
The type of event the handler was associated with.
\n
handler : Function
The handler to remove. This must be a reference to the function passed into the addListener call.
\n
scope : Object (optional)
The scope originally specified for the handler.
\n

render( [container], [position] ) : Ext.Componentchainable

Render this Component into the passed HTML element. ...

Render this Component into the passed HTML element.

\n\n\n

If you are using a Container object to house this Component, then\ndo not use the render method.

\n\n\n

A Container's child Components are rendered by that Container's\nlayout manager when the Container is first rendered.

\n\n\n

Certain layout managers allow dynamic addition of child components. Those that do\ninclude Ext.layout.CardLayout, Ext.layout.AnchorLayout,\nExt.layout.FormLayout, Ext.layout.TableLayout.

\n\n\n

If the Container is already rendered when a new child Component is added, you may need to call\nthe Container's doLayout to refresh the view which causes any\nunrendered child Components to be rendered. This is required so that you can add multiple\nchild components if needed while only refreshing the layout once.

\n\n\n

When creating complex UIs, it is important to remember that sizing and positioning\nof child items is the responsibility of the Container's layout manager.\nIf you expect child items to be sized in response to user interactions, you must\nconfigure the Container with a layout manager which creates and manages the type of layout you\nhave in mind.

\n\n\n

Omitting the Container's layout config means that a basic\nlayout manager is used which does nothing but render child components sequentially into the\nContainer. No sizing or positioning will be performed in this situation.

\n\n

Parameters

container : Element/HTMLElement/String (optional)
The element this Component should be\nrendered into. If it is being created from existing markup, this should be omitted.
\n
position : String/Number (optional)
The element ID or DOM node index within the container before\nwhich this component will be inserted (defaults to appending to the end of the container)
\n

Returns

Ext.Component
this
\n

Ext.tree.TreePanel
view source

renderRoot( )private

private ...

private

Ext.tree.TreePanel
view source

restrictExpand( node )private

private ...

private

Parameters

node : Object
\n

resumeEvents( )

Resume firing events. ...

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

Ext.tree.TreePanel
view source

selectPath( path, [attr], [callback] )

Selects the node in this tree at the specified path. ...

Selects the node in this tree at the specified path. A path can be retrieved from a node with Ext.data.Node.getPath

Parameters

path : String
\n
attr : String (optional)
The attribute used in the path (see Ext.data.Node.getPath for more info)
\n
callback : Function (optional)
The callback to call when the selection is complete. The callback will be called with\n(bSuccess, oSelNode) where bSuccess is if the selection was successful and oSelNode is the selected node.
\n

setAutoScroll( scroll ) : Ext.BoxComponentchainable

Sets the overflow on the content element of the component. ...

Sets the overflow on the content element of the component.

Parameters

scroll : Boolean
True to allow the Component to auto scroll.
\n

Returns

Ext.BoxComponent
this
\n

setHeight( height ) : Ext.BoxComponentchainable

Sets the height of the component. ...

Sets the height of the component. This method fires the resize event.

Parameters

height : Mixed
The new height to set. This may be one of:
- A Number specifying the new height in the Element's defaultUnits (by default, pixels).
- A String used to set the CSS height style.
- undefined to leave the height unchanged.
\n

Returns

Ext.BoxComponent
this
\n

setIconClass( cls )

Sets the CSS class that provides the icon image for this panel. ...

Sets the CSS class that provides the icon image for this panel. This method will replace any existing\nicon class if one has already been set and fire the iconchange event after completion.

Parameters

cls : String
The new CSS class name
\n

setLayout( layout )private

private ...

private

Parameters

layout : Object
\n

setPagePosition( x, y ) : Ext.BoxComponentchainable

Sets the page XY position of the component. ...

Sets the page XY position of the component. To set the left and top instead, use setPosition.\nThis method fires the move event.

Parameters

x : Number
The new x position
\n
y : Number
The new y position
\n

Returns

Ext.BoxComponent
this
\n

setPosition( left, top ) : Ext.BoxComponentchainable

Sets the left and top of the component. ...

Sets the left and top of the component. To set the page XY position instead, use setPagePosition.\nThis method fires the move event.

Parameters

left : Number
The new left
\n
top : Number
The new top
\n

Returns

Ext.BoxComponent
this
\n

Ext.tree.TreePanel
view source

setRootNode( node ) : Node

Sets the root node for this tree. ...

Sets the root node for this tree. If the TreePanel has already rendered a root node, the\nprevious root node (and all of its descendants) are destroyed before the new root node is rendered.

Parameters

node : Node
\n

Returns

Node
\n

setSize( width, height ) : Ext.BoxComponentchainable

Sets the width and height of this BoxComponent. ...

Sets the width and height of this BoxComponent. This method fires the resize event. This method can accept\neither width and height as separate arguments, or you can pass a size object like {width:10, height:20}.

Parameters

width : Mixed
The new width to set. This may be one of:
- A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels).
- A String used to set the CSS width style.
- A size object in the format {width: widthValue, height: heightValue}.
- undefined to leave the width unchanged.
\n
height : Mixed
The new height to set (not required if a size object is passed as the first arg).\nThis may be one of:
- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
- A String used to set the CSS height style. Animation may not be used.
- undefined to leave the height unchanged.
\n

Returns

Ext.BoxComponent
this
\n

setTitle( title, [iconCls] ) : Ext.Panelchainable

Sets the title text for the panel and optionally the icon class. ...

Sets the title text for the panel and optionally the icon class.

\n\n\n

In order to be able to set the title, a header element must have been created\nfor the Panel. This is triggered either by configuring the Panel with a non-blank title,\nor configuring it with header: true.

\n\n

Parameters

title : String
The title text to set
\n
iconCls : String (optional)
iconCls A user-defined CSS class that provides the icon image for this panel
\n

Returns

Ext.Panel
this
\n

setVisible( visible ) : Ext.Componentchainable

Convenience function to hide or show this component by boolean. ...

Convenience function to hide or show this component by boolean.

Parameters

visible : Boolean
True to show, false to hide
\n

Returns

Ext.Component
this
\n

setWidth( width ) : Ext.BoxComponentchainable

Sets the width of the component. ...

Sets the width of the component. This method fires the resize event.

Parameters

width : Mixed
The new width to set. This may be one of:
- A Number specifying the new width in the Element's defaultUnits (by default, pixels).
- A String used to set the CSS width style.
\n

Returns

Ext.BoxComponent
this
\n

shouldBufferLayout( )private

private ...

private

show( ) : Ext.Componentchainable

Show this component. ...

Show this component. Listen to the 'beforeshow' event and return\nfalse to cancel showing the component. Fires the 'show'\nevent after showing the component.

Returns

Ext.Component
this
\n

suspendEvents( queueSuspended )

Suspend the firing of all events. ...

Suspend the firing of all events. (see resumeEvents)

Parameters

queueSuspended : Boolean
Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events;
\n

syncHeight( )private

...

syncShadow( )private

private ...

private

syncSize( ) : Ext.BoxComponentchainable

Force the component's size to recalculate based on the underlying element's current height and width. ...

Force the component's size to recalculate based on the underlying element's current height and width.

Returns

Ext.BoxComponent
this
\n

Ext.tree.TreePanel
view source

toString( )private

private ...

private

toggleCollapse( animate ) : Ext.Panelchainable

Shortcut for performing an expand or collapse based on the current state of the panel. ...

Shortcut for performing an expand or collapse based on the current state of the panel.

Parameters

animate : Boolean
True to animate the transition, else false (defaults to the value of the\nanimCollapse panel config)
\n

Returns

Ext.Panel
this
\n

un( eventName, handler, [scope] )

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.
\n
handler : Function
The handler to remove. This must be a reference to the function passed into the addListener call.
\n
scope : Object (optional)
The scope originally specified for the handler.
\n

Ext.tree.TreePanel
view source

unregisterNode( node )private

private ...

private

Parameters

node : Object
\n

update( htmlOrData, loadScripts, callback )

Update the content area of a component. ...

Update the content area of a component.

Parameters

htmlOrData : Mixed
If this component has been configured with a template via the tpl config\nthen it will use this argument as data to populate the template.\nIf this component was not configured with a template, the components\ncontent area will be updated via Ext.Element update
\n
loadScripts : Boolean
(optional) Only legitimate when using the html configuration. Defaults to false
\n
callback : Function
(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading
\n

updateBox( box ) : Ext.BoxComponentchainable

Sets the current box measurements of the component's underlying element. ...

Sets the current box measurements of the component's underlying element.

Parameters

box : Object
An object in the format {x, y, width, height}
\n

Returns

Ext.BoxComponent
this
\n

Defined By

Events

activate( p )

Fires after the Panel has been visually activated. ...

Fires after the Panel has been visually activated.\nNote that Panels do not directly support being activated, but some Panel subclasses\ndo (like Ext.Window). Panels which are child Components of a TabPanel fire the\nactivate and deactivate events under the control of the TabPanel.

Parameters

p : Ext.Panel
The Panel that has been activated.
\n

added( this, ownerCt, index )

Fires when a component is added to an Ext.Container ...

Fires when a component is added to an Ext.Container

Parameters

this : Ext.Component
\n
ownerCt : Ext.Container
Container which holds the component
\n
index : number
Position at which the component was added
\n

afterlayout( this, layout )

Fires when the components in this container are arranged by the associated layout manager. ...

Fires when the components in this container are arranged by the associated layout manager.

Parameters

this : Ext.Container
\n
layout : ContainerLayout
The ContainerLayout implementation for this container
\n

afterrender( this )

Fires after the component rendering is finished. ...

Fires after the component rendering is finished.

\n\n\n

The afterrender event is fired after this Component has been rendered, been postprocesed\nby any afterRender method defined for the Component, and, if stateful, after state\nhas been restored.

\n\n

Parameters

this : Ext.Component
\n

Ext.tree.TreePanel
view source

append( tree, parent, node, 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
\n
parent : Node
The parent node
\n
node : Node
The newly appended node
\n
index : Number
The index of the newly appended node
\n

Ext.tree.TreePanel
view source

beforeappend( tree, parent, 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
\n
parent : Node
The parent node
\n
node : Node
The child node to be appended
\n

Ext.tree.TreePanel
view source

beforechildrenrendered( node )

Fires right before the child nodes for a node are rendered ...

Fires right before the child nodes for a node are rendered

Parameters

node : Node
The node
\n

Ext.tree.TreePanel
view source

beforeclick( node, e )

Fires before click processing on a node. ...

Fires before click processing on a node. Return false to cancel the default action.

Parameters

node : Node
The node
\n
e : Ext.EventObject
The event object
\n

beforeclose( p )

Fires before the Panel is closed. ...

Fires before the Panel is closed. Note that Panels do not directly support being closed, but some\nPanel subclasses do (like Ext.Window) or a Panel within a Ext.TabPanel. This event only\napplies to such subclasses.\nA handler can return false to cancel the close.

Parameters

p : Ext.Panel
The Panel being closed.
\n

beforecollapse( p, animate )

Fires before the Panel is collapsed. ...

Fires before the Panel is collapsed. A handler can return false to cancel the collapse.

Parameters

p : Ext.Panel
the Panel being collapsed.
\n
animate : Boolean
True if the collapse is animated, else false.
\n

Ext.tree.TreePanel
view source

beforecollapsenode( node, deep, anim )

Fires before a node is collapsed, return false to cancel. ...

Fires before a node is collapsed, return false to cancel.

Parameters

node : Node
The node
\n
deep : Boolean
\n
anim : Boolean
\n

Ext.tree.TreePanel
view source

beforedblclick( node, e )

Fires before double click processing on a node. ...

Fires before double click processing on a node. Return false to cancel the default action.

Parameters

node : Node
The node
\n
e : Ext.EventObject
The event object
\n

beforedestroy( this )

Fires before the component is destroyed. ...

Fires before the component is destroyed. Return false from an event handler to stop the destroy.

Parameters

this : Ext.Component
\n

beforeexpand( p, animate )

Fires before the Panel is expanded. ...

Fires before the Panel is expanded. A handler can return false to cancel the expand.

Parameters

p : Ext.Panel
The Panel being expanded.
\n
animate : Boolean
True if the expand is animated, else false.
\n

Ext.tree.TreePanel
view source

beforeexpandnode( node, deep, anim )

Fires before a node is expanded, return false to cancel. ...

Fires before a node is expanded, return false to cancel.

Parameters

node : Node
The node
\n
deep : Boolean
\n
anim : Boolean
\n

beforehide( this )

Fires before the component is hidden by calling the hide method. ...

Fires before the component is hidden by calling the hide method.\nReturn false from an event handler to stop the hide.

Parameters

this : Ext.Component
\n

Ext.tree.TreePanel
view source

beforeinsert( tree, parent, 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
\n
parent : Node
The parent node
\n
node : Node
The child node to be inserted
\n
refNode : Node
The child node the node is being inserted before
\n

Ext.tree.TreePanel
view source

beforeload( node )

Fires before a node is loaded, return false to cancel ...

Fires before a node is loaded, return false to cancel

Parameters

node : Node
The node being loaded
\n

Ext.tree.TreePanel
view source

beforemovenode( tree, node, oldParent, newParent, index )

Fires before a node is moved to a new location in the tree. ...

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
\n
node : Node
The node being moved
\n
oldParent : Node
The parent of the node
\n
newParent : Node
The new parent the node is moving to
\n
index : Number
The index it is being moved to
\n

Ext.tree.TreePanel
view source

beforenodedrop( dropEvent )

Fires when a DD object is dropped on a node in this tree for preprocessing. ...

Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The dropEvent\npassed to handlers has the following properties:

\n\n

tree - The TreePanel
target - The node being targeted for the drop
data - The drag data from the drag source
point - The point of the drop - append, above or below
source - The drag source
rawEvent - Raw mouse event
dropNode - Drop node(s) provided by the source OR you can supply node(s)\nto be inserted by setting them on this object.
cancel - Set this to true to cancel the drop.
dropStatus - If the default drop action is cancelled but the drop is valid, setting this to true\nwill prevent the animated 'repair' from appearing.

\n\n

Parameters

dropEvent : Object
\n

Ext.tree.TreePanel
view source

beforeremove( tree, parent, 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
\n
parent : Node
The parent node
\n
node : Node
The child node to be removed
\n

Overrides: Ext.Container.beforeremove

beforerender( this )

Fires before the component is rendered. ...

Fires before the component is rendered. Return false from an\nevent handler to stop the render.

Parameters

this : Ext.Component
\n

beforeshow( this )

Fires before the component is shown by calling the show method. ...

Fires before the component is shown by calling the show method.\nReturn false from an event handler to stop the show.

Parameters

this : Ext.Component
\n

beforestaterestore( this, state )

Fires before the state of the component is restored. ...

Fires before the state of the component is restored. Return false from an event handler to stop the restore.

Parameters

this : Ext.Component
\n
state : Object
The hash of state values returned from the StateProvider. If this\nevent is not vetoed, then the state object is passed to applyState. By default,\nthat simply copies property values into this Component. The method maybe overriden to\nprovide custom state restoration.
\n

beforestatesave( this, state )

Fires before the state of the component is saved to the configured state provider. ...

Fires before the state of the component is saved to the configured state provider. Return false to stop the save.

Parameters

this : Ext.Component
\n
state : Object
The hash of state values. This is determined by calling\ngetState() on the Component. This method must be provided by the\ndeveloper to return whetever representation of state is required, by default, Ext.Component\nhas a null implementation.
\n

bodyresize( p, width, height )

Fires after the Panel has been resized. ...

Fires after the Panel has been resized.

Parameters

p : Ext.Panel
the Panel which has been resized.
\n
width : Number
The Panel body's new width.
\n
height : Number
The Panel body's new height.
\n

Ext.tree.TreePanel
view source

checkchange( this, checked )

Fires when a node with a checkbox's checked property changes ...

Fires when a node with a checkbox's checked property changes

Parameters

this : Node
This node
\n
checked : Boolean
\n

Ext.tree.TreePanel
view source

click( node, e )

Fires when a node is clicked ...

Fires when a node is clicked

Parameters

node : Node
The node
\n
e : Ext.EventObject
The event object
\n

close( p )

Fires after the Panel is closed. ...

Fires after the Panel is closed. Note that Panels do not directly support being closed, but some\nPanel subclasses do (like Ext.Window) or a Panel within a Ext.TabPanel.

Parameters

p : Ext.Panel
The Panel that has been closed.
\n

collapse( p )

Fires after the Panel has been collapsed. ...

Fires after the Panel has been collapsed.

Parameters

p : Ext.Panel
the Panel that has been collapsed.
\n

Ext.tree.TreePanel
view source

collapsenode( node )

Fires when a node is collapsed ...

Fires when a node is collapsed

Parameters

node : Node
The node
\n

Ext.tree.TreePanel
view source

containerclick( this, e )

Fires when the tree container is clicked ...

Fires when the tree container is clicked

Parameters

this : Tree
\n
e : Ext.EventObject
The event object
\n

Ext.tree.TreePanel
view source

containercontextmenu( this, e )

Fires when the tree container is right clicked ...

Fires when the tree container is right clicked

Parameters

this : Tree
\n
e : Ext.EventObject
The event object
\n

Ext.tree.TreePanel
view source

containerdblclick( this, e )

Fires when the tree container is double clicked ...

Fires when the tree container is double clicked

Parameters

this : Tree
\n
e : Ext.EventObject
The event object
\n

Ext.tree.TreePanel
view source

contextmenu( node, e )

Fires when a node is right clicked. ...

Fires when a node is right clicked. To display a context menu in response to this\nevent, first create a Menu object (see Ext.menu.Menu for details), then add\na handler for this event:

\n\n

new Ext.tree.TreePanel({\n    title: 'My TreePanel',\n    root: new Ext.tree.AsyncTreeNode({\n        text: 'The Root',\n        children: [\n            { text: 'Child node 1', leaf: true },\n            { text: 'Child node 2', leaf: true }\n        ]\n    }),\n    contextMenu: new Ext.menu.Menu({\n        items: [{\n            id: 'delete-node',\n            text: 'Delete Node'\n        }],\n        listeners: {\n            itemclick: function(item) {\n                switch (item.id) {\n                    case 'delete-node':\n                        var n = item.parentMenu.contextNode;\n                        if (n.parentNode) {\n                            n.remove();\n                        }\n                        break;\n                }\n            }\n        }\n    }),\n    listeners: {\n        contextmenu: function(node, e) {\n//          Register the context node with the menu so that a Menu Item's handler function can access\n//          it via its parentMenu property.\n            node.select();\n            var c = node.getOwnerTree().contextMenu;\n            c.contextNode = node;\n            c.showAt(e.getXY());\n        }\n    }\n});\n

\n\n

Parameters

node : Node
The node
\n
e : Ext.EventObject
The event object
\n

Ext.tree.TreePanel
view source

dblclick( node, e )

Fires when a node is double clicked ...

Fires when a node is double clicked

Parameters

node : Node
The node
\n
e : Ext.EventObject
The event object
\n

deactivate( p )

Fires after the Panel has been visually deactivated. ...

Fires after the Panel has been visually deactivated.\nNote that Panels do not directly support being deactivated, but some Panel subclasses\ndo (like Ext.Window). Panels which are child Components of a TabPanel fire the\nactivate and deactivate events under the control of the TabPanel.

Parameters

p : Ext.Panel
The Panel that has been deactivated.
\n

destroy( this )

Fires after the component is destroyed. ...

Fires after the component is destroyed.

Parameters

this : Ext.Component
\n

disable( this )

Fires after the component is disabled. ...

Fires after the component is disabled.

Parameters

this : Ext.Component
\n

Ext.tree.TreePanel
view source

disabledchange( node, disabled )

Fires when the disabled status of a node changes ...

Fires when the disabled status of a node changes

Parameters

node : Node
The node
\n
disabled : Boolean
\n

Ext.tree.TreePanel
view source

dragdrop( this, node, dd, e )

Fires when a dragged node is dropped on a valid DD target ...

Fires when a dragged node is dropped on a valid DD target

Parameters

this : Ext.tree.TreePanel
\n
node : Ext.tree.TreeNode
\n
dd : DD
The dd it was dropped on
\n
e : event
The raw browser event
\n

enable( this )

Fires after the component is enabled. ...

Fires after the component is enabled.

Parameters

this : Ext.Component
\n

Ext.tree.TreePanel
view source

enddrag( this, node, e )

Fires when a drag operation is complete ...

Fires when a drag operation is complete

Parameters

this : Ext.tree.TreePanel
\n
node : Ext.tree.TreeNode
\n
e : event
The raw browser event
\n

expand( p )

Fires after the Panel has been expanded. ...

Fires after the Panel has been expanded.

Parameters

p : Ext.Panel
The Panel that has been expanded.
\n

Ext.tree.TreePanel
view source

expandnode( node )

Fires when a node is expanded ...

Fires when a node is expanded

Parameters

node : Node
The node
\n

hide( this )

Fires after the component is hidden. ...

Fires after the component is hidden.\nFires after the component is hidden when calling the hide method.

Parameters

this : Ext.Component
\n

iconchange( p, newIcon, oldIcon )

Fires after the Panel icon class has been set or changed. ...

Fires after the Panel icon class has been set or changed.

Parameters

p : Ext.Panel
the Panel which has had its icon class changed.
\n
newIcon : String
The new icon class.
\n
oldIcon : String
The old icon class.
\n

Ext.tree.TreePanel
view source

insert( tree, parent, 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
\n
parent : Node
The parent node
\n
node : Node
The child node inserted
\n
refNode : Node
The child node the node was inserted before
\n

Ext.tree.TreePanel
view source

load( node )

Fires when a node is loaded ...

Fires when a node is loaded

Parameters

node : Node
The node that was loaded
\n

move( this, x, y )

Fires after the component is moved. ...

Fires after the component is moved.

Parameters

this : Ext.Component
\n
x : Number
The new x position
\n
y : Number
The new y position
\n

Ext.tree.TreePanel
view source

movenode( tree, node, oldParent, newParent, 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
\n
node : Node
The node moved
\n
oldParent : Node
The old parent of this node
\n
newParent : Node
The new parent of this node
\n
index : Number
The index it was moved to
\n

Ext.tree.TreePanel
view source

nodedragover( dragOverEvent )

Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. ...

Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent\npassed to handlers has the following properties:

\n\n

tree - The TreePanel
target - The node being targeted for the drop
data - The drag data from the drag source
point - The point of the drop - append, above or below
source - The drag source
rawEvent - Raw mouse event
dropNode - Drop node(s) provided by the source.
cancel - Set this to true to signal drop not allowed.

\n\n

Parameters

dragOverEvent : Object
\n

Ext.tree.TreePanel
view source

nodedrop( dropEvent )

Fires after a DD object is dropped on a node in this tree. ...

Fires after a DD object is dropped on a node in this tree. The dropEvent\npassed to handlers has the following properties:

\n\n

tree - The TreePanel
target - The node being targeted for the drop
data - The drag data from the drag source
point - The point of the drop - append, above or below
source - The drag source
rawEvent - Raw mouse event
dropNode - Dropped node(s).

\n\n

Parameters

dropEvent : Object
\n

Ext.tree.TreePanel
view source

remove( tree, parent, 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
\n
parent : Node
The parent node
\n
node : Node
The child node removed
\n

Overrides: Ext.Container.remove

removed( this, ownerCt )

Fires when a component is removed from an Ext.Container ...

Fires when a component is removed from an Ext.Container

Parameters

this : Ext.Component
\n
ownerCt : Ext.Container
Container which holds the component
\n

render( this )

Fires after the component markup is rendered. ...

Fires after the component markup is rendered.

Parameters

this : Ext.Component
\n

resize( this, adjWidth, adjHeight, rawWidth, rawHeight )

Fires after the component is resized. ...

Fires after the component is resized.

Parameters

this : Ext.Component
\n
adjWidth : Number
The box-adjusted width that was set
\n
adjHeight : Number
The box-adjusted height that was set
\n
rawWidth : Number
The width that was originally specified
\n
rawHeight : Number
The height that was originally specified
\n

show( this )

Fires after the component is shown when calling the show method. ...

Fires after the component is shown when calling the show method.

Parameters

this : Ext.Component
\n

Ext.tree.TreePanel
view source

startdrag( this, node, e )

Fires when a node starts being dragged ...

Fires when a node starts being dragged

Parameters

this : Ext.tree.TreePanel
\n
node : Ext.tree.TreeNode
\n
e : event
The raw browser event
\n

staterestore( this, state )

Fires after the state of the component is restored. ...

Fires after the state of the component is restored.

Parameters

this : Ext.Component
\n
state : Object
The hash of state values returned from the StateProvider. This is passed\nto applyState. By default, that simply copies property values into this\nComponent. The method maybe overriden to provide custom state restoration.
\n

statesave( this, state )

Fires after the state of the component is saved to the configured state provider. ...

Fires after the state of the component is saved to the configured state provider.

Parameters

this : Ext.Component
\n
state : Object
The hash of state values. This is determined by calling\ngetState() on the Component. This method must be provided by the\ndeveloper to return whetever representation of state is required, by default, Ext.Component\nhas a null implementation.
\n

Ext.tree.TreePanel
view source

textchange( node, text, oldText )

Fires when the text for a node is changed ...

Fires when the text for a node is changed

Parameters

node : Node
The node
\n
text : String
The new text
\n
oldText : String
The old text
\n