X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/b37ceabb82336ee82757cd32efe353cfab8ec267..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/output/Ext.tree.TreePanel.html?ds=inline diff --git a/docs/output/Ext.tree.TreePanel.html b/docs/output/Ext.tree.TreePanel.html deleted file mode 100644 index ef4fb92f..00000000 --- a/docs/output/Ext.tree.TreePanel.html +++ /dev/null @@ -1,1595 +0,0 @@ -
Observable Component BoxComponent Container Panel TreePanel
Package: | Ext.tree |
Defined In: | TreePanel.js |
Class: | TreePanel |
Extends: | Panel |
The TreePanel provides tree-structured UI representation of tree-structured data.
-TreeNodes added to the TreePanel may each contain metadata -used by your application in their attributes property.
-A TreePanel must have a root node before it is rendered. This may either be -specified using the root config option, or using the setRootNode method. -
An example of tree rendered to an existing div:
var tree = new Ext.tree.TreePanel({
- renderTo: 'tree-div',
- useArrows: true,
- autoScroll: true,
- animate: true,
- enableDD: true,
- containerScroll: true,
- border: false,
- // auto create TreeLoader
- dataUrl: 'get-nodes.php',
-
- root: {
- nodeType: 'async',
- text: 'Ext JS',
- draggable: false,
- id: 'source'
- }
-});
-
-tree.getRootNode().expand();
-The example above would work with a data packet similar to this:
[{
- "text": "adapter",
- "id": "source\/adapter",
- "cls": "folder"
-}, {
- "text": "dd",
- "id": "source\/dd",
- "cls": "folder"
-}, {
- "text": "debug.js",
- "id": "source\/debug.js",
- "leaf": true,
- "cls": "file"
-}]
-An example of tree within a Viewport:
new Ext.Viewport({
- layout: 'border',
- items: [{
- region: 'west',
- collapsible: true,
- title: 'Navigation',
- xtype: 'treepanel',
- width: 200,
- autoScroll: true,
- split: true,
- loader: new Ext.tree.TreeLoader(),
- root: new Ext.tree.AsyncTreeNode({
- expanded: true,
- children: [{
- text: 'Menu Option 1',
- leaf: true
- }, {
- text: 'Menu Option 2',
- leaf: true
- }, {
- text: 'Menu Option 3',
- leaf: true
- }]
- }),
- rootVisible: false,
- listeners: {
- click: function(n) {
- Ext.Msg.alert('Navigation Tree Click', 'You clicked: "' + n.attributes.text + '"');
- }
- }
- }, {
- region: 'center',
- xtype: 'tabpanel',
- // remaining code not shown ...
- }]
-});
Config Options | Defined By | |
---|---|---|
anchor : String Note: this config is only used when this Component is rendered
-by a Container which has been configured to use an Anc... Note: this config is only used when this Component is rendered -by a Container which has been configured to use an AnchorLayout (or subclass thereof). -based layout manager, for example:
See Ext.layout.AnchorLayout.anchor also. | BoxComponent | |
animCollapse : Boolean true to animate the transition when the panel is collapsed, false to skip the
-animation (defaults to true if the Ext.... true to animate the transition when the panel is collapsed, false to skip the
-animation (defaults to true if the Ext.Fx class is available, otherwise false ). | Panel | |
animate : Boolean true to enable animated expand/collapse (defaults to the value of Ext.enableFx) | TreePanel | |
autoHeight : Boolean true to use height:'auto', false to use fixed height (defaults to false).
-Note: Setting autoHeight: true means that t... true to use height:'auto', false to use fixed height (defaults to false ).
-Note: Setting autoHeight: true means that the browser will manage the panel's height
-based on its contents, and that Ext will not manage it at all. If the panel is within a layout that
-manages dimensions (fit , border , etc.) then setting autoHeight: true
-can cause issues with scrolling and will not generally work as expected since the panel will take
-on the height of its contents rather than the height required by the Ext layout. | Panel | |
autoScroll : Boolean true to use overflow:'auto' on the components layout element and show scroll bars automatically when
-necessary, false... true to use overflow:'auto' on the components layout element and show scroll bars automatically when
-necessary, false to clip any overflowing content (defaults to false ). | BoxComponent | |
autoShow : Boolean True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
-them on render... True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
-them on render (defaults to false). | Component | |
baseCls : String The base CSS class to apply to this panel's element (defaults to 'x-panel').
-Another option available by default is t... The base CSS class to apply to this panel's element (defaults to 'x-panel' ).
-Another option available by default is to specify | Panel | |
bbar : Object/Array The bottom toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of
-buttons/button co... The bottom toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of -buttons/button configs to be added to the toolbar. Note that this is not available as a property after render. -To access the bottom toolbar after render, use getBottomToolbar. -Note: Although a Toolbar may contain Field components, these will not be updated by a load -of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and -so are not scanned to collect form items. However, the values will be submitted because form -submission parameters are collected from the DOM tree. | Panel | |
bbarCfg : Object | Panel | |
bodyBorder : Boolean True to display an interior border on the body element of the panel, false to hide it (defaults to true).
-This only a... True to display an interior border on the body element of the panel, false to hide it (defaults to true).
-This only applies when border == true. If border == true and bodyBorder == false, the border will display
-as a 1px wide inset border, giving the entire body element an inset appearance. | Panel | |
bodyCfg : Object A DomHelper element specification object may be specified for any
-Panel Element.
-By default, the Default element in t... A DomHelper element specification object may be specified for any -Panel Element. -By default, the Default element in the table below will be used for the html markup to
-create a child element with the commensurate Default class name ( -Panel Default Default Custom Additional Additional -Element element class element class style -======== ========================== ========= ============== =========== -header div baseCls+'-header' headerCfg headerCssClass headerStyle -bwrap div baseCls+'-bwrap' bwrapCfg bwrapCssClass bwrapStyle -+ tbar div baseCls+'-tbar' tbarCfg tbarCssClass tbarStyle -+ body div baseCls+'-body' bodyCfg bodyCssClass bodyStyle -+ bbar div baseCls+'-bbar' bbarCfg bbarCssClass bbarStyle -+ footer div baseCls+'-footer' footerCfg footerCssClass footerStyle -- Configuring a Custom element may be used, for example, to force the body Element -to use a different form of markup than is created by default. An example of this might be -to create a child Panel containing a custom content, such as -a header, or forcing centering of all Panel content by having the body be a <center> -element: -
-The example above also explicitly creates a | Panel | |
bodyCssClass : String/Object/Function Additional css class selector to be applied to the body element in the format expected by
-Ext.Element.addClass (defau... Additional css class selector to be applied to the body element in the format expected by
-Ext.Element.addClass (defaults to null). See bodyCfg. | Panel | |
bodyStyle : String/Object/Function Custom CSS styles to be applied to the body element in the format expected by
-Ext.Element.applyStyles (defaults to nu... Custom CSS styles to be applied to the body element in the format expected by
-Ext.Element.applyStyles (defaults to null). See bodyCfg. | Panel | |
border : Boolean True to display the borders of the panel's body element, false to hide them (defaults to true). By default,
-the bord... True to display the borders of the panel's body element, false to hide them (defaults to true). By default,
-the border is a 2px wide inset border, but this can be further altered by setting bodyBorder to false. | Panel | |
boxMaxHeight : Number The maximum value in pixels which this BoxComponent will set its height to.
-Warning: This will override any size mana... The maximum value in pixels which this BoxComponent will set its height to. -Warning: This will override any size management applied by layout managers. | BoxComponent | |
boxMaxWidth : Number The maximum value in pixels which this BoxComponent will set its width to.
-Warning: This will override any size manag... The maximum value in pixels which this BoxComponent will set its width to. -Warning: This will override any size management applied by layout managers. | BoxComponent | |
boxMinHeight : Number The minimum value in pixels which this BoxComponent will set its height to.
-Warning: This will override any size mana... The minimum value in pixels which this BoxComponent will set its height to. -Warning: This will override any size management applied by layout managers. | BoxComponent | |
boxMinWidth : Number The minimum value in pixels which this BoxComponent will set its width to.
-Warning: This will override any size manag... The minimum value in pixels which this BoxComponent will set its width to. -Warning: This will override any size management applied by layout managers. | BoxComponent | |
bubbleEvents : Array An array of events that, when fired, should be bubbled to any parent container.
-See Ext.util.Observable.enableBubble.... An array of events that, when fired, should be bubbled to any parent container. -See Ext.util.Observable.enableBubble. -Defaults to []. | TreePanel | |
buttonAlign : String The alignment of any buttons added to this panel. Valid values are 'right',
-'left' and 'center' (defaults to 'right'... The alignment of any buttons added to this panel. Valid values are 'right' ,
-'left' and 'center' (defaults to 'right' ). | Panel | |
buttons : Array buttons will be used as items for the toolbar in
-the footer (fbar). Typically the value of this configuration propert... buttons will be used as items for the toolbar in
-the footer (fbar ). Typically the value of this configuration property will be
-an array of Ext.Buttons or Ext.Button configuration objects.
-If an item is configured with minWidth or the Panel is configured with minButtonWidth ,
-that width will be applied to the item. | Panel | |
bwrapCfg : Object | Panel | |
clearCls : String The CSS class used to to apply to the special clearing div rendered
-directly after each form field wrapper to provide... The CSS class used to to apply to the special clearing div rendered -directly after each form field wrapper to provide field clearing (defaults to -'x-form-clear-left'). -Note: this config is only used when this Component is rendered by a Container -which has been configured to use the FormLayout layout -manager (e.g. Ext.form.FormPanel or specifying layout:'form') and either a -fieldLabel is specified or isFormField=true is specified. - See Ext.layout.FormLayout.fieldTpl also. | Component | |
closable : Boolean Panels themselves do not directly support being closed, but some Panel subclasses do (like
-Ext.Window) or a Panel Cla... Panels themselves do not directly support being closed, but some Panel subclasses do (like
-Ext.Window) or a Panel Class within an Ext.TabPanel. Specify true
-to enable closing in such situations. Defaults to false . | Panel | |
cls : String An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
-useful for ... An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
-useful for adding customized styles to the component or any of its children using standard CSS rules. | Component | |
collapseFirst : Boolean true to make sure the collapse/expand toggle button always renders first (to the left of)
-any other tools in the pane... true to make sure the collapse/expand toggle button always renders first (to the left of)
-any other tools in the panel's title bar, false to render it last (defaults to true ). | Panel | |
collapsed : Booleantrue to render the panel collapsed, false to render it expanded (defaults to
-false ). | Panel | |
collapsedCls : String A CSS class to add to the panel's element after it has been collapsed (defaults to
- 'x-panel-collapsed' ). | Panel | |
collapsible : Boolean True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into
-the header ... True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into
-the header tool button area, false to keep the panel statically sized with no button (defaults to false). | Panel | |
containerScroll : Boolean true to register this container with ScrollManager | TreePanel | |
ctCls : String An optional extra CSS class that will be added to this component's container. This can be useful for
-adding customize... An optional extra CSS class that will be added to this component's container. This can be useful for -adding customized styles to the container or any of its children using standard CSS rules. See -Ext.layout.ContainerLayout.extraCls also. -Note: ctCls defaults to '' except for the following class -which assigns a value by default: -
- | Component | |
ddAppendOnly : Boolean true if the tree should only allow append drops (use for trees which are sorted) | TreePanel | |
ddGroup : String The DD group this TreePanel belongs to | TreePanel | |
ddScroll : Boolean true to enable body scrolling | TreePanel | |
disabled : Boolean Render this panel disabled (default is false). An important note when using the disabled
-config on panels is that IE ... Render this panel disabled (default is false ). An important note when using the disabled
-config on panels is that IE will often fail to initialize the disabled mask element correectly if
-the panel's layout has not yet completed by the time the Panel is disabled during the render process.
-If you experience this issue, you may need to instead use the afterlayout event to initialize
-the disabled state:
-
| Panel | |
dragConfig : Object Custom config to pass to the Ext.tree.TreeDragZone instance | TreePanel | |
draggable : Boolean/Object true to enable dragging of this Panel (defaults to false).
-For custom drag/drop implementations, an Ext.Panel.DD conf...
For custom drag/drop implementations, an Ext.Panel.DD config could also be passed
-in this config instead of
| Panel | |
dropConfig : Object Custom config to pass to the Ext.tree.TreeDropZone instance | TreePanel | |
enableDD : Boolean true to enable drag and drop | TreePanel | |
enableDrag : Boolean true to enable just drag | TreePanel | |
enableDrop : Boolean true to enable just drop | TreePanel | |
fbar : Object/Array A Toolbar object, a Toolbar config, or an array of
-Buttons/Button configs, describing a Toolbar to be rendered into t... A Toolbar object, a Toolbar config, or an array of -Buttons/Button configs, describing a Toolbar to be rendered into this Panel's footer element. -After render, the If buttonAlign configuration affects the layout of these items, for example:
-
-Note: Although a Toolbar may contain Field components, these will not be updated by a load -of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and -so are not scanned to collect form items. However, the values will be submitted because form -submission parameters are collected from the DOM tree. | Panel | |
fieldLabel : String The label text to display next to this Component (defaults to '').
-Note: this config is only used when this Component... The label text to display next to this Component (defaults to ''). -Note: this config is only used when this Component is rendered by a Container which -has been configured to use the FormLayout layout manager (e.g. -Ext.form.FormPanel or specifying layout:'form'). - Also see hideLabel and -Ext.layout.FormLayout.fieldTpl. -Example use:
| Component | |
flex : Number Note: this config is only used when this Component is rendered
-by a Container which has been configured to use a BoxL... Note: this config is only used when this Component is rendered
-by a Container which has been configured to use a BoxLayout.
-Each child Component with a | BoxComponent | |
floating : Mixed This property is used to configure the underlying Ext.Layer. Acceptable values for this
-configuration property are:<d... This property is used to configure the underlying Ext.Layer. Acceptable values for this -configuration property are:
| Panel | |
footer : Boolean true to create the footer element explicitly, false to skip creating it. The footer
-will be created automatically if ... | Panel | |
footerCfg : Object | Panel | |
forceLayout : Boolean If true the container will force a layout initially even if hidden or collapsed. This option
-is useful for forcing fo... If true the container will force a layout initially even if hidden or collapsed. This option
-is useful for forcing forms to render in collapsed or hidden containers. (defaults to false). | Container | |
frame : Boolean false by default to render with plain 1px square borders. true to render with
-9 elements, complete with custom rounde... false by default to render with plain 1px square borders. true to render with
-9 elements, complete with custom rounded corners (also see Ext.Element.boxWrap).
-The template generated for each condition is depicted below:
| Panel | |
header : Boolean true to create the Panel's header element explicitly, false to skip creating
-it. If a title is set the header will b... | Panel | |
headerAsText : Boolean | Panel | |
headerCfg : Object | Panel | |
height : Number The height of this component in pixels (defaults to auto).
-Note to express this dimension as a percentage or offset s... The height of this component in pixels (defaults to auto).
-Note to express this dimension as a percentage or offset see Ext.Component.anchor. | BoxComponent | |
hidden : Boolean Render this component hidden (default is false). If true, the
-hide method will be called internally. | Component | |
hideCollapseTool : Booleantrue to hide the expand/collapse toggle button when collapsible == true ,
-false to display it (defaults to false ). | Panel | |
hideLabel : Boolean true to completely hide the label element
-(label and separator). Defaults to false.
-By default, even if you do not sp... true to completely hide the label element -(label and separator). Defaults to false. -By default, even if you do not specify a fieldLabel the space will still be -reserved so that the field will line up with other fields that do have labels. -Setting this to true will cause the field to not reserve that space. -Note: see the note for clearCls. -Example use:
| Component | |
hideMode : String How this component should be hidden. Supported values are 'visibility'
-(css visibility), 'offsets' (negative offset p... How this component should be hidden. Supported values are 'visibility' -(css visibility), 'offsets' (negative offset position) and 'display' -(css display). -Note: the default of 'display' is generally preferred -since items are automatically laid out when they are first shown (no sizing -is done while hidden). | Component | |
hideParent : Boolean True to hide and show the component's container when hide/show is called on the component, false to hide
-and show the... True to hide and show the component's container when hide/show is called on the component, false to hide
-and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide
-button on a window by setting hide:true on the button when adding it to its parent container. | Component | |
hlColor : String The color of the node highlight (defaults to 'C3DAF9') | TreePanel | |
hlDrop : Boolean false to disable node highlight on drop (defaults to the value of Ext.enableFx) | TreePanel | |
iconCls : String The CSS class selector that specifies a background image to be used as the header icon (defaults to '').
-An example o... The CSS class selector that specifies a background image to be used as the header icon (defaults to '').
- An example of specifying a custom icon class would be something like: -
| Panel | |
id : String The unique id of this component (defaults to an auto-assigned id).
-You should assign an id if you need to be able to ... The unique id of this component (defaults to an auto-assigned id). -You should assign an id if you need to be able to access the component later and you do -not have an object reference available (e.g., using Ext.getCmp). -Note that this id will also be used as the element id for the containing HTML element -that is rendered to the page for this component. This allows you to write id-based CSS -rules to style the specific instance of this component uniquely, and also to select -sub-elements using this component's id as the parent. -Note: to avoid complications imposed by a unique id also see
- Note: to access the container of an item see | Component | |
itemCls : String Note: this config is only used when this Component is rendered by a Container which
-has been configured to use the Fo... Note: this config is only used when this Component is rendered by a Container which -has been configured to use the FormLayout layout manager (e.g. -Ext.form.FormPanel or specifying layout:'form'). - An additional CSS class to apply to the div wrapping the form item -element of this field. If supplied, itemCls at the field level will override -the default itemCls supplied at the container level. The value specified for -itemCls will be added to the default class ('x-form-item'). -Since it is applied to the item wrapper (see -Ext.layout.FormLayout.fieldTpl), it allows -you to write standard CSS rules that can apply to the field, the label (if specified), or -any other element within the markup for the field. -Note: see the note for fieldLabel. -Example use:
| Component | |
itemId : String An itemId can be used as an alternative way to get a reference to a component
-when no object reference is available. ... An itemId can be used as an alternative way to get a reference to a component
-when no object reference is available. Instead of using an
-
-Note: to access the container of an item see ownerCt. | Component | |
keys : Object/Array A Ext.KeyMap config object (in the format expected by Ext.KeyMap.addBinding
-used to assign custom key handling to thi... A Ext.KeyMap config object (in the format expected by Ext.KeyMap.addBinding
-used to assign custom key handling to this panel (defaults to null ). | Panel | |
labelSeparator : String The separator to display after the text of each
-fieldLabel. This property may be configured at various levels.
-The o... The separator to display after the text of each -fieldLabel. This property may be configured at various levels. -The order of precedence is: -
Note: see the note for clearCls. - Also see hideLabel and -Ext.layout.FormLayout.fieldTpl. -Example use:
| Component | |
labelStyle : String A CSS style specification string to apply directly to this field's
-label. Defaults to the container's labelStyle val... A CSS style specification string to apply directly to this field's -label. Defaults to the container's labelStyle value if set (e.g., -Ext.layout.FormLayout.labelStyle , or ''). -Note: see the note for - Also see
| Component | |
lines : Boolean false to disable tree lines (defaults to true) | TreePanel | |
listeners : Object A config object containing one or more event handlers to be added to this
-object during initialization. This should ... A config object containing one or more event handlers to be added to this -object during initialization. This should be a valid listeners config object as specified in the -addListener example for attaching multiple handlers at once. -DOM events from ExtJs Components -While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
-is usually only done when extra value can be added. For example the DataView's
-
| Observable | |
loader : Ext.tree.TreeLoader A Ext.tree.TreeLoader for use with this TreePanel | TreePanel | |
margins : Object Note: this config is only used when this BoxComponent is rendered
-by a Container which has been configured to use the... Note: this config is only used when this BoxComponent is rendered -by a Container which has been configured to use the BorderLayout -or one of the two BoxLayout subclasses. -An object containing margins to apply to this BoxComponent in the -format:
-May also be a string containing space-separated, numeric margin values. The order of the -sides associated with each value matches the way CSS processes margin values: -
Defaults to:
| BoxComponent | |
maskDisabled : Boolean true to mask the panel when it is disabled, false to not mask it (defaults
-to true). Either way, the panel will alwa... true to mask the panel when it is disabled, false to not mask it (defaults
-to true ). Either way, the panel will always tell its contained elements to disable themselves
-when it is disabled, but masking the panel can provide an additional visual cue that the panel is
-disabled. | Panel | |
minButtonWidth : Number Minimum width in pixels of all buttons in this panel (defaults to 75 ) | Panel | |
overCls : String An optional extra CSS class that will be added to this component's Element when the mouse moves
-over the Element, and... An optional extra CSS class that will be added to this component's Element when the mouse moves
-over the Element, and removed when the mouse moves out. (defaults to ''). This can be
-useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules. | Component | |
padding : Number/String A shortcut for setting a padding style on the body element. The value can either be
-a number to be applied to all sid... A shortcut for setting a padding style on the body element. The value can either be
-a number to be applied to all sides, or a normal css string describing padding.
-Defaults to undefined. | Panel | |
pageX : Number The page level x coordinate for this component if contained within a positioning container. | BoxComponent | |
pageY : Number The page level y coordinate for this component if contained within a positioning container. | BoxComponent | |
pathSeparator : String The token used to separate sub-paths in path strings (defaults to '/') | TreePanel | |
plugins : Object/Array An object or array of objects that will provide custom functionality for this component. The only
-requirement for a ... An object or array of objects that will provide custom functionality for this component. The only
-requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component.
-When a component is created, if any plugins are available, the component will call the init method on each
-plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the
-component as needed to provide its functionality. | Component | |
ptype : String The registered ptype to create. This config option is not used when passing
-a config object into a constructor. This ... The registered ptype to create. This config option is not used when passing
-a config object into a constructor. This config option is used only when
-lazy instantiation is being used, and a Plugin is being
-specified not as a fully instantiated Component, but as a Component config
-object. The ptype will be looked up at render time up to determine what
-type of Plugin to create. -If you create your own Plugins, you may register them using -Ext.ComponentMgr.registerPlugin in order to be able to -take advantage of lazy instantiation and rendering. | Component | |
ref : String A path specification, relative to the Component's ownerCt
-specifying into which ancestor Container to place a named r... A path specification, relative to the Component's The ancestor axis can be traversed by using '/' characters in the path. -For example, to put a reference to a Toolbar Button into the Panel which owns the Toolbar:
-In the code above, if the | Component | |
region : String Note: this config is only used when this BoxComponent is rendered
-by a Container which has been configured to use the... Note: this config is only used when this BoxComponent is rendered -by a Container which has been configured to use the BorderLayout -layout manager (e.g. specifying layout:'border'). - See Ext.layout.BorderLayout also. | BoxComponent | |
renderTo : Mixed Specify the id of the element, a DOM element or an existing Element that this component
-will be rendered into.
-Notes ... Specify the id of the element, a DOM element or an existing Element that this component -will be rendered into.
See render also. | Component | |
requestMethod : String The HTTP request method for loading data (defaults to the value of Ext.Ajax.method). | TreePanel | |
resizeEvent : String The event to listen to for resizing in layouts. Defaults to 'bodyresize'. | Panel | |
root : Ext.tree.TreeNode The root node for the tree. | TreePanel | |
rootVisible : Boolean false to hide the root node (defaults to true) | TreePanel | |
selModel : Object A tree selection model to use with this TreePanel (defaults to an Ext.tree.DefaultSelectionModel) | TreePanel | |
shadow : Boolean/String true (or a valid Ext.Shadow Ext.Shadow.mode value) to display a shadow behind the
-panel, false to display no shadow (... true (or a valid Ext.Shadow Ext.Shadow.mode value) to display a shadow behind the
-panel, false to display no shadow (defaults to 'sides' ). Note that this option
-only applies when floating = true . | Panel | |
shadowOffset : Number The number of pixels to offset the shadow if displayed (defaults to 4). Note that this
-option only applies when float... The number of pixels to offset the shadow if displayed (defaults to 4 ). Note that this
-option only applies when floating = true . | Panel | |
shim : Boolean false to disable the iframe shim in browsers which need one (defaults to true).
-Note that this option only applies wh... false to disable the iframe shim in browsers which need one (defaults to true ).
-Note that this option only applies when floating = true . | Panel | |
singleExpand : Boolean true if only 1 node per branch may be expanded | TreePanel | |
stateEvents : Array An array of events that, when fired, should trigger this component to
-save its state (defaults to none). stateEvents ... An array of events that, when fired, should trigger this component to
-save its state (defaults to none). See | Component | |
stateId : String The unique id for this component to use for state management purposes
-(defaults to the component id if one was set, o... The unique id for this component to use for state management purposes
-(defaults to the component id if one was set, otherwise null if the
-component is using a generated id).
- See | Component | |
stateful : Boolean A flag which causes the Component to attempt to restore the state of
-internal properties from a saved state on startu... A flag which causes the Component to attempt to restore the state of
-internal properties from a saved state on startup. The component must have
-either a - For state saving to work, the state manager's provider must have been -set to an implementation of Ext.state.Provider which overrides the -set and get -methods to save and recall name/value pairs. A built-in implementation, -Ext.state.CookieProvider is available. -To set the state provider for the current page: -
-A stateful Component attempts to save state when one of the events
-listed in the To save state, a stateful Component first serializes its state by
-calling The value yielded by getState is passed to Ext.state.Manager.set
-which uses the configured Ext.state.Provider to save the object
-keyed by the Component's During construction, a stateful Component attempts to restore
-its state by calling Ext.state.Manager.get passing the
- The resulting object is passed to You can perform extra processing on state save and restore by attaching -handlers to the beforestaterestore, staterestore, -beforestatesave and statesave events. | Component | |
style : String A custom style specification to be applied to this component's Element. Should be a valid argument to
-Ext.Element.ap... A custom style specification to be applied to this component's Element. Should be a valid argument to
-Ext.Element.applyStyles.
-
| Component | |
tabTip : String Note: this config is only used when this BoxComponent is a child item of a TabPanel.
-A string to be used as innerHTML... Note: this config is only used when this BoxComponent is a child item of a TabPanel. -A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over -the associated tab selector element. Ext.QuickTips.init() -must be called in order for the tips to render. | BoxComponent | |
tbar : Object/Array The top toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of
-buttons/button confi... The top toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of -buttons/button configs to be added to the toolbar. Note that this is not available as a property after render. -To access the top toolbar after render, use getTopToolbar. -Note: Although a Toolbar may contain Field components, these will not be updated by a load -of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and -so are not scanned to collect form items. However, the values will be submitted because form -submission parameters are collected from the DOM tree. | Panel | |
tbarCfg : Object | Panel | |
title : String The title text to be used as innerHTML (html tags are accepted) to display in the panel
-header (defaults to ''). When... The title text to be used as innerHTML (html tags are accepted) to display in the panel
- header (defaults to ''). When a title is specified the
-header element will automatically be created and displayed unless
-header is explicitly set to false . If you do not want to specify a
-title at config time, but you may want one later, you must either specify a non-empty
-title (a blank space ' ' will do) or header:true so that the container
-element will get created. | Panel | |
titleCollapse : Boolean true to allow expanding and collapsing the panel (when collapsible = true)
-by clicking anywhere in the header bar, fa... true to allow expanding and collapsing the panel (when collapsible = true )
-by clicking anywhere in the header bar, false ) to allow it only by clicking to tool button
-(defaults to false )). If this panel is a child item of a border layout also see the
-BorderLayout.Region
-floatable config option. | Panel | |
toolTemplate : Ext.Template/Ext.XTemplate A Template used to create tools in the header Element. Defaults to:new Ext.Template('<div class="x-tool x-tool-{id... A Template used to create tools in the header Element. Defaults to:
-This may may be overridden to provide a custom DOM structure for tools based upon a more -complex XTemplate. The template's data is a single tool configuration object (Not the entire Array) -as specified in tools. In the following example an <a> tag is used to provide a -visual indication when hovering over the tool:
-Note that the CSS class 'x-tool-pdf' should have an associated style rule which provides an -appropriate background image, something like: -
| Panel | |
tools : Array An array of tool button configs to be added to the header tool area. When rendered, each tool is
-stored as an Element... An array of tool button configs to be added to the header tool area. When rendered, each tool is
-stored as an Element referenced by a public property called tools.<tool-type>
-Each tool config may contain the following properties: -
Note that, apart from the toggle tool which is provided when a panel is collapsible, these -tools only provide the visual button. Any required functionality must be provided by adding -handlers that implement the necessary behavior. -Example usage: -
-For the custom id of
| Panel | |
trackMouseOver : Boolean false to disable mouse over highlighting | TreePanel | |
unstyled : Boolean | Panel | |
useArrows : Boolean true to use Vista-style arrows in the tree (defaults to false) | TreePanel | |
width : Number The width of this component in pixels (defaults to auto).
-Note to express this dimension as a percentage or offset se... The width of this component in pixels (defaults to auto).
-Note to express this dimension as a percentage or offset see Ext.Component.anchor. | BoxComponent | |
x : Number The local x (left) coordinate for this component if contained within a positioning container. | BoxComponent | |
xtype : String The registered xtype to create. This config option is not used when passing
-a config object into a constructor. This ... The registered xtype to create. This config option is not used when passing
-a config object into a constructor. This config option is used only when
-lazy instantiation is being used, and a child item of a Container is being
-specified not as a fully instantiated Component, but as a Component config
-object. The xtype will be looked up at render time up to determine what
-type of child Component to create. -The predefined xtypes are listed here. - -If you subclass Components to create your own Components, you may register -them using Ext.ComponentMgr.registerType in order to be able to -take advantage of lazy instantiation and rendering. | Component | |
y : Number The local y (top) coordinate for this component if contained within a positioning container. | BoxComponent |
Property | Defined By | |
---|---|---|
body : Ext.Element The Panel's body Element which may be used to contain HTML content.
-The content may be specified in the html config, ... The Panel's body Element which may be used to contain HTML content.
-The content may be specified in the html config, or it may be loaded using the
-autoLoad config, or through the Panel's Updater. Read-only.
- If this is used to load visible HTML elements in either way, then -the Panel may not be used as a Layout for hosting nested Panels. -If this Panel is intended to be used as the host of a Layout (See layout
-then the body Element must not be loaded or changed - it is under the control
-of the Panel's Layout.
- Note: see the Note for | Panel | |
buttons : Array This Panel's Array of buttons as created from the buttons
-config property. Read only. | Panel | |
bwrap : Ext.Element | Panel | |
collapsed : Boolean True if this panel is collapsed. Read-only. | Panel | |
dd : Ext.dd.DragSource. If this Panel is configured draggable, this property will contain
-an instance of Ext.dd.DragSource which handles drag... If this Panel is configured draggable, this property will contain -an instance of Ext.dd.DragSource which handles dragging the Panel. -The developer must provide implementations of the abstract methods of Ext.dd.DragSource -in order to supply behaviour for each stage of the drag/drop process. See draggable. | Panel | |
dragZone : Ext.tree.TreeDragZone The dragZone used by this tree if drag is enabled (see enableDD or enableDrag) | TreePanel | |
dropZone : Ext.tree.TreeDropZone The dropZone used by this tree if drop is enabled (see enableDD or enableDrop) | TreePanel | |
el : Ext.Element The Ext.Element which encapsulates this Component. Read-only.
-This will usually be a <DIV> element created by the ... The Ext.Element which encapsulates this Component. Read-only. -This will usually be a <DIV> element created by the class's onRender method, but
-that may be overridden using the Note: this element will not be available until this Component has been rendered. - To add listeners for DOM events to this Component (as opposed to listeners -for this Component's own Observable events), see the listeners -config for a suggestion, or use a render listener directly:
-See also getEl | Component | |
footer : Ext.Element | Panel | |
header : Ext.Element | Panel | |
hidden : Boolean True if this component is hidden. Read-only. | Component | |
initialConfig : Object This Component's initial configuration specification. Read-only. | Component | |
ownerCt : Ext.Container This Component's owner Container (defaults to undefined, and is set automatically when
-this Component is added to a C... | Component | |
refOwner : Ext.Container The ancestor Container into which the ref reference was inserted if this Component
-is a child of a Container, and has... The ancestor Container into which the ref reference was inserted if this Component
-is a child of a Container, and has been configured with a ref . | Component | |
rendered : Boolean True if this component has been rendered. Read-only. | Component | |
root : Ext.tree.TreeNode The root node of this tree. | TreePanel |
Method | Defined By | |
---|---|---|
TreePanel( Object config )
- Parameters:
| TreePanel | |
add( ...Object/Array component )
- :
- Ext.Component/ArrayAdds Component(s) to this Container.
-Description :
-<ul class="mdetail-params">
-Fires the beforeadd event before addin... Adds Component(s) to this Container. -Description : -
Notes : -
Parameters:
| Container | |
addButton( String/Object config , Function handler , Object scope )
- :
- Ext.ButtonAdds a button to this panel. Note that this method must be called prior to rendering. The preferred
-approach is to ... Adds a button to this panel. Note that this method must be called prior to rendering. The preferred
-approach is to add buttons via the buttons config. Parameters:
| Panel | |
addClass( string cls )
- :
- Ext.ComponentAdds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. Parameters:
| Component | |
addEvents( Object|String o , string Optional. )
- :
- voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. Parameters:
| Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] )
- :
- voidAppends an event handler to this object. Appends an event handler to this object. Parameters:
| Observable | |
bubble( Function fn , [Object scope ], [Array args ] )
- :
- Ext.ContainerBubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of... Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of
-function call will be the scope provided or the current component. The arguments to the function
-will be the args provided or the current component. If the function returns false at any point,
-the bubble is stopped. Parameters:
| Container | |
cloneConfig( Object overrides )
- :
- Ext.ComponentClone 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:
| Component | |
collapse( Boolean animate )
- :
- Ext.PanelCollapses the panel body so that it becomes hidden. Fires the beforecollapse event which will
-cancel the collapse ac... Collapses the panel body so that it becomes hidden. Fires the beforecollapse event which will
-cancel the collapse action if it returns false. Parameters:
| Panel | |
collapseAll()
- :
- void Collapse all nodes Collapse all nodes Parameters:
| TreePanel | |
destroy()
- :
- void Destroys this component by purging any event listeners, removing the component's element from the DOM,
-removing the c... Destroys this component by purging any event listeners, removing the component's element from the DOM,
-removing the component from its Ext.Container (if applicable) and unregistering it from
-Ext.ComponentMgr. Destruction is generally handled automatically by the framework and this method
-should usually not need to be called directly. Parameters:
| Component | |
enableBubble( String/Array events )
- :
- voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
-this.getBubbleTarget() if present.... Enables events fired by this Observable to bubble up an owner hierarchy by calling
- This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default -implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to -access the required target more quickly. -Example:
Parameters:
| Observable | |
expand( Boolean animate )
- :
- Ext.PanelExpands the panel body so that it becomes visible. Fires the beforeexpand event which will
-cancel the expand action ... Expands the panel body so that it becomes visible. Fires the beforeexpand event which will
-cancel the expand action if it returns false. Parameters:
| Panel | |
expandAll()
- :
- void Expand all nodes Expand all nodes Parameters:
| TreePanel | |
expandPath( String path , [String attr ], [Function callback ] )
- :
- voidExpands a specified path in this TreePanel. A path can be retrieved from a node with Ext.data.Node.getPath Expands a specified path in this TreePanel. A path can be retrieved from a node with Ext.data.Node.getPath Parameters:
| TreePanel | |
findParentBy( Function fn )
- :
- Ext.ContainerFind a container above this component at any level by a custom function. If the passed function returns
-true, the con... Find a container above this component at any level by a custom function. If the passed function returns
-true, the container will be returned. Parameters:
| Component | |
findParentByType( String/Class xtype )
- :
- Ext.ContainerFind 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:
| Component | |
fireEvent( String eventName , Object... args )
- :
- BooleanFires the specified event with the passed parameters (minus the event name).
-An event may be set to bubble up an Obse... Fires the specified event with the passed parameters (minus the event name). -An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) -by calling enableBubble. Parameters:
| Observable | |
focus( [Boolean selectText ], [Boolean/Number delay ] )
- :
- Ext.ComponentTry to focus this component. Try to focus this component. Parameters:
| Component | |
get( String/Number key )
- :
- Ext.ComponentGet a component contained by this container (alias for items.get(key)) Get a component contained by this container (alias for items.get(key)) Parameters:
| Container | |
getBottomToolbar() - : - Ext.Toolbar | Panel | |
getBox( [Boolean local ] )
- :
- ObjectGets the current box measurements of the component's underlying element. Gets the current box measurements of the component's underlying element. Parameters:
| BoxComponent | |
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. Parameters:
| Component | |
getChecked( [String attribute ], [TreeNode startNode ] )
- :
- ArrayRetrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. 'id') Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. 'id') Parameters:
| TreePanel | |
getEl()
- :
- Ext.Element Returns the Ext.Element which encapsulates this Component.
-This will usually be a <DIV> element created by the cla... Returns the Ext.Element which encapsulates this Component. -This will usually be a <DIV> element created by the class's onRender method, but -that may be overridden using the autoEl config. -Note: this element will not be available until this Component has been rendered. - To add listeners for DOM events to this Component (as opposed to listeners -for this Component's own Observable events), see the listeners config for a suggestion, -or use a render listener directly:
Parameters:
| Component | |
getFooterToolbar() - : - Ext.Toolbar | Panel | |
getFrameHeight()
- :
- Number Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and
-header and ... Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and
-header and footer elements, but not including the body height). To retrieve the body height see getInnerHeight. Parameters:
| Panel | |
getFrameWidth()
- :
- Number Returns the width in pixels of the framing elements of this panel (not including the body width). To
-retrieve the bo... Returns the width in pixels of the framing elements of this panel (not including the body width). To
-retrieve the body width see getInnerWidth. Parameters:
| Panel | |
getHeight()
- :
- Number Gets the current height of the component's underlying element. Gets the current height of the component's underlying element. Parameters:
| BoxComponent | |
getId()
- :
- String Returns the id of this component or automatically generates and
-returns an id if an id is not defined yet:'ext-comp-'... Returns the id of this component or automatically generates and
-returns an id if an id is not defined yet:
Parameters:
| Component | |
getInnerHeight()
- :
- Number Returns the height in pixels of the body element (not including the height of any framing elements).
-For the frame he... Returns the height in pixels of the body element (not including the height of any framing elements).
-For the frame height see getFrameHeight. Parameters:
| Panel | |
getInnerWidth()
- :
- Number Returns the width in pixels of the body element (not including the width of any framing elements).
-For the frame widt... Returns the width in pixels of the body element (not including the width of any framing elements).
-For the frame width see getFrameWidth. Parameters:
| Panel | |
getItemId() - : - String | Component | |
getLayoutTarget()
- :
- Ext.Element Returns the Element to be used to contain the child Components of this Container.
-An implementation is provided which... Returns the Element to be used to contain the child Components of this Container. -An implementation is provided which returns the Container's Element, but -if there is a more complex structure to a Container, this may be overridden to return -the element into which the layout renders child Components. Parameters:
| Container | |
getLoader()
- :
- Ext.tree.TreeLoader Returns the default Ext.tree.TreeLoader for this TreePanel. Returns the default Ext.tree.TreeLoader for this TreePanel. Parameters:
| TreePanel | |
getNodeById( String id )
- :
- NodeGets a node in this tree by its id Gets a node in this tree by its id Parameters:
| TreePanel | |
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. Parameters:
| BoxComponent | |
getPosition( [Boolean local ] )
- :
- ArrayGets the current XY position of the component's underlying element. Gets the current XY position of the component's underlying element. Parameters:
| BoxComponent | |
getResizeEl()
- :
- Ext.Element Returns the outermost Element of this Component which defines the Components overall size.
-Usually this will return t... Returns the outermost Element of this Component which defines the Components overall size. -Usually this will return the same Element as An example is a ComboBox. It is encased in a wrapping Element which
-contains both the Parameters:
| BoxComponent | |
getRootNode()
- :
- Node Returns this root node for this tree Returns this root node for this tree Parameters:
| TreePanel | |
getSelectionModel()
- :
- TreeSelectionModel Returns the selection model used by this TreePanel. Returns the selection model used by this TreePanel. Parameters:
| TreePanel | |
getSize()
- :
- Object Gets the current size of the component's underlying element. Gets the current size of the component's underlying element. Parameters:
| BoxComponent | |
getTool( String id )
- :
- ObjectRetrieve a tool by id. Retrieve a tool by id. Parameters:
| Panel | |
getTopToolbar() - : - Ext.Toolbar | Panel | |
getTreeEl()
- :
- Ext.Element Returns the underlying Element for this tree Returns the underlying Element for this tree Parameters:
| TreePanel | |
getWidth()
- :
- Number Gets the current width of the component's underlying element. Gets the current width of the component's underlying element. Parameters:
| BoxComponent | |
getXType()
- :
- String Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
-available xtypes, see the Ex... Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
-available xtypes, see the Ext.Component header. Example usage:
-
Parameters:
| Component | |
getXTypes()
- :
- String Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
-available xtypes, see the Ext... Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all -available xtypes, see the Ext.Component header. -If using your own subclasses, be aware that a Component must register its own xtype -to participate in determination of inherited xtypes. -Example usage: -
Parameters:
| Component | |
hasListener( String eventName )
- :
- BooleanChecks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event Parameters:
| Observable | |
hide()
- :
- Ext.Component Hide this component. Listen to the 'beforehide' event and return
-false to cancel hiding the component. Fires the 'h... Hide this component. Listen to the 'beforehide' event and return
-false to cancel hiding the component. Fires the 'hide'
-event after hiding the component. Note this method is called internally if
-the component is configured to be hidden .Parameters:
| Component | |
isVisible()
- :
- Boolean Returns true if this component is visible. Returns true if this component is visible. Parameters:
| Component | |
isXType( String xtype , [Boolean shallow ] )
- :
- BooleanTests whether or not this Component is of a specific xtype. This can test whether this Component is descended
-from th... Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended -from the xtype (default) or whether it is directly of the xtype specified (shallow = true). -If using your own subclasses, be aware that a Component must register its own xtype -to participate in determination of inherited xtypes. -For a list of all available xtypes, see the Ext.Component header. -Example usage: -
Parameters:
| Component | |
mon( Observable|Element item , Object|String ename , Function fn , Object scope , Object opt )
- :
- voidAdds listeners to any Observable object (or Elements) which are automatically removed when this Component
-is destroye... Adds listeners to any Observable object (or Elements) which are automatically removed when this Component -is destroyed. Usage:
-or:
Parameters:
| Component | |
mun( Observable|Element item , Object|String ename , Function fn , Object scope )
- :
- voidRemoves listeners that were added by the mon method. Removes listeners that were added by the mon method. Parameters:
| Component | |
nextSibling()
- :
- Ext.Component Returns the next component in the owning container Returns the next component in the owning container Parameters:
| Component | |
on( String eventName , Function handler , [Object scope ], [Object options ] )
- :
- voidAppends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:
| Observable | |
previousSibling()
- :
- Ext.Component Returns the previous component in the owning container Returns the previous component in the owning container Parameters:
| Component | |
purgeListeners()
- :
- void Removes all listeners for this object Removes all listeners for this object Parameters:
| Observable | |
relayEvents( Object o , Array events )
- :
- voidRelays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by this. Parameters:
| Observable | |
removeClass( string cls )
- :
- Ext.ComponentRemoves a CSS class from the component's underlying element. Removes a CSS class from the component's underlying element. Parameters:
| Component | |
removeListener( String eventName , Function handler , [Object scope ] )
- :
- voidRemoves an event handler. Removes an event handler. Parameters:
| Observable | |
render( [Element/HTMLElement/String container ], [String/Number position ] )
- :
- voidRender this Component into the passed HTML element.
-If you are using a Container object to house this Component, then... Render this Component into the passed HTML element. -If you are using a Container object to house this Component, then -do not use the render method. -A Container's child Components are rendered by that Container's -layout manager when the Container is first rendered. -Certain layout managers allow dynamic addition of child components. Those that do -include Ext.layout.CardLayout, Ext.layout.AnchorLayout, -Ext.layout.FormLayout, Ext.layout.TableLayout. -If the Container is already rendered when a new child Component is added, you may need to call -the Container's doLayout to refresh the view which causes any -unrendered child Components to be rendered. This is required so that you can add multiple -child components if needed while only refreshing the layout once. -When creating complex UIs, it is important to remember that sizing and positioning -of child items is the responsibility of the Container's layout manager. -If you expect child items to be sized in response to user interactions, you must -configure the Container with a layout manager which creates and manages the type of layout you -have in mind. -Omitting the Container's layout config means that a basic -layout manager is used which does nothing but render child components sequentially into the -Container. No sizing or positioning will be performed in this situation. Parameters:
| Component | |
resumeEvents()
- :
- void Resume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
-event... Resume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
-events fired during event suspension will be sent to any listeners now. Parameters:
| Observable | |
selectPath( String path , [String attr ], [Function callback ] )
- :
- voidSelects the node in this tree at the specified path. A path can be retrieved from a node with Ext.data.Node.getPath Selects the node in this tree at the specified path. A path can be retrieved from a node with Ext.data.Node.getPath Parameters:
| TreePanel | |
setAutoScroll( Boolean scroll )
- :
- Ext.BoxComponentSets the overflow on the content element of the component. Sets the overflow on the content element of the component. Parameters:
| BoxComponent | |
setHeight( Mixed height )
- :
- Ext.BoxComponentSets the height of the component. This method fires the resize event. Sets the height of the component. This method fires the resize event. Parameters:
| BoxComponent | |
setIconClass( String cls )
- :
- voidSets the CSS class that provides the icon image for this panel. This method will replace any existing
-icon class if ... Sets the CSS class that provides the icon image for this panel. This method will replace any existing
-icon class if one has already been set and fire the iconchange event after completion. Parameters:
| Panel | |
setPagePosition( Number x , Number y )
- :
- Ext.BoxComponentSets the page XY position of the component. To set the left and top instead, use setPosition.
-This method fires the ... Sets the page XY position of the component. To set the left and top instead, use setPosition.
-This method fires the move event. Parameters:
| BoxComponent | |
setPosition( Number left , Number top )
- :
- Ext.BoxComponentSets the left and top of the component. To set the page XY position instead, use setPagePosition.
-This method fires ... Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
-This method fires the move event. Parameters:
| BoxComponent | |
setRootNode( Node node )
- :
- NodeSets the root node for this tree. If the TreePanel has already rendered a root node, the
-previous root node (and all ... Sets the root node for this tree. If the TreePanel has already rendered a root node, the
-previous root node (and all of its descendants) are destroyed before the new root node is rendered. Parameters:
| TreePanel | |
setSize( Mixed width , Mixed height )
- :
- Ext.BoxComponentSets the width and height of this BoxComponent. This method fires the resize event. This method can accept
-either wid... Sets the width and height of this BoxComponent. This method fires the resize event. This method can accept
-either width and height as separate arguments, or you can pass a size object like {width:10, height:20} .Parameters:
| BoxComponent | |
setTitle( String title , [String iconCls ] )
- :
- voidSets the title text for the panel and optionally the icon class.
-In order to be able to set the title, a header eleme... Sets the title text for the panel and optionally the icon class. -In order to be able to set the title, a header element must have been created
-for the Panel. This is triggered either by configuring the Panel with a non-blank Parameters:
| Panel | |
setVisible( Boolean visible )
- :
- Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. Parameters:
| Component | |
setWidth( Mixed width )
- :
- Ext.BoxComponentSets the width of the component. This method fires the resize event. Sets the width of the component. This method fires the resize event. Parameters:
| BoxComponent | |
show()
- :
- Ext.Component Show this component. Listen to the 'beforeshow' event and return
-false to cancel showing the component. Fires the '... Show this component. Listen to the 'beforeshow' event and return
-false to cancel showing the component. Fires the 'show'
-event after showing the component. Parameters:
| Component | |
suspendEvents( Boolean queueSuspended )
- :
- voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:
| Observable | |
syncSize()
- :
- Ext.BoxComponent 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. Parameters:
| BoxComponent | |
toggleCollapse( Boolean animate )
- :
- Ext.PanelShortcut 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:
| Panel | |
un( String eventName , Function handler , [Object scope ] )
- :
- voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable | |
update( Mixed htmlOrData , [Boolean loadScripts ], [Function callback ] )
- :
- voidUpdate the content area of a component. Update the content area of a component. Parameters:
| Component | |
updateBox( Object box )
- :
- Ext.BoxComponentSets the current box measurements of the component's underlying element. Sets the current box measurements of the component's underlying element. Parameters:
| BoxComponent |
Event | Defined By | |
---|---|---|
activate :
- ( Ext.Panel p )
- Fires after the Panel has been visually activated.
-Note that Panels do not directly support being activated, but some... Fires after the Panel has been visually activated.
-Note that Panels do not directly support being activated, but some Panel subclasses
-do (like Ext.Window). Panels which are child Components of a TabPanel fire the
-activate and deactivate events under the control of the TabPanel. Listeners will be called with the following arguments:
| Panel | |
added :
- ( Ext.Component this , Ext.Container ownerCt , number index )
- Fires when a component is added to an Ext.Container Fires when a component is added to an Ext.Container Listeners will be called with the following arguments:
| Component | |
afterlayout :
- ( Ext.Container this , ContainerLayout 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. Listeners will be called with the following arguments:
| Container | |
afterrender :
- ( Ext.Component this )
- Fires after the component rendering is finished.
-The afterrender event is fired after this Component has been rendere... Fires after the component rendering is finished. -The afterrender event is fired after this Component has been rendered, been postprocesed -by any afterRender method defined for the Component, and, if stateful, after state -has been restored. Listeners will be called with the following arguments:
| Component | |
append :
- ( Tree tree , Node parent , Node node , Number index )
- Fires when a new child node is appended to a node in this tree. Fires when a new child node is appended to a node in this tree. Listeners will be called with the following arguments:
| TreePanel | |
beforeappend :
- ( Tree tree , Node parent , Node node )
- Fires before a new child is appended to a node in this tree, return false to cancel the append. Fires before a new child is appended to a node in this tree, return false to cancel the append. Listeners will be called with the following arguments:
| TreePanel | |
beforechildrenrendered :
- ( Node node )
- Fires right before the child nodes for a node are rendered Fires right before the child nodes for a node are rendered Listeners will be called with the following arguments:
| TreePanel | |
beforeclick :
- ( Node node , Ext.EventObject e )
- Fires before click processing on a node. Return false to cancel the default action. Fires before click processing on a node. Return false to cancel the default action. Listeners will be called with the following arguments:
| TreePanel | |
beforeclose :
- ( Ext.Panel p )
- Fires before the Panel is closed. Note that Panels do not directly support being closed, but some
-Panel subclasses d... Fires before the Panel is closed. Note that Panels do not directly support being closed, but some
-Panel subclasses do (like Ext.Window) or a Panel within a Ext.TabPanel. This event only
-applies to such subclasses.
-A handler can return false to cancel the close. Listeners will be called with the following arguments:
| Panel | |
beforecollapse :
- ( Ext.Panel p , Boolean animate )
- Fires before the Panel is collapsed. A handler can return false to cancel the collapse. Fires before the Panel is collapsed. A handler can return false to cancel the collapse. Listeners will be called with the following arguments:
| Panel | |
beforecollapsenode :
- ( Node node , Boolean deep , Boolean anim )
- Fires before a node is collapsed, return false to cancel. Fires before a node is collapsed, return false to cancel. Listeners will be called with the following arguments:
| TreePanel | |
beforedblclick :
- ( Node node , Ext.EventObject e )
- Fires before double click processing on a node. Return false to cancel the default action. Fires before double click processing on a node. Return false to cancel the default action. Listeners will be called with the following arguments:
| TreePanel | |
beforedestroy :
- ( Ext.Component this )
- | Component | |
beforeexpand :
- ( Ext.Panel p , Boolean animate )
- Fires before the Panel is expanded. A handler can return false to cancel the expand. Fires before the Panel is expanded. A handler can return false to cancel the expand. Listeners will be called with the following arguments:
| Panel | |
beforeexpandnode :
- ( Node node , Boolean deep , Boolean anim )
- Fires before a node is expanded, return false to cancel. Fires before a node is expanded, return false to cancel. Listeners will be called with the following arguments:
| TreePanel | |
beforehide :
- ( Ext.Component this )
- Fires before the component is hidden by calling the hide method.
-Return false from an event handler to stop the hide. Fires before the component is hidden by calling the hide method.
-Return false from an event handler to stop the hide. Listeners will be called with the following arguments:
| Component | |
beforeinsert :
- ( Tree tree , Node parent , Node node , Node refNode )
- Fires before a new child is inserted in a node in this tree, return false to cancel the insert. Fires before a new child is inserted in a node in this tree, return false to cancel the insert. Listeners will be called with the following arguments:
| TreePanel | |
beforeload :
- ( Node node )
- Fires before a node is loaded, return false to cancel Fires before a node is loaded, return false to cancel Listeners will be called with the following arguments:
| TreePanel | |
beforemovenode :
- ( Tree tree , Node node , Node oldParent , Node newParent , Number index )
- Fires before a node is moved to a new location in the tree. Return false to cancel the move. Fires before a node is moved to a new location in the tree. Return false to cancel the move. Listeners will be called with the following arguments:
| TreePanel | |
beforenodedrop :
- ( Object dropEvent )
- Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The drop... Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The dropEvent
-passed to handlers has the following properties: -
Listeners will be called with the following arguments:
| TreePanel | |
beforeremove :
- ( Tree tree , Node parent , Node node )
- Fires before a child is removed from a node in this tree, return false to cancel the remove. Fires before a child is removed from a node in this tree, return false to cancel the remove. Listeners will be called with the following arguments:
| TreePanel | |
beforerender :
- ( Ext.Component this )
- | Component | |
beforeshow :
- ( Ext.Component this )
- Fires before the component is shown by calling the show method.
-Return false from an event handler to stop the show. Fires before the component is shown by calling the show method.
-Return false from an event handler to stop the show. Listeners will be called with the following arguments:
| Component | |
beforestaterestore :
- ( Ext.Component this , Object state )
- Fires before the state of the component is restored. Return false from an event handler to stop the restore. Fires before the state of the component is restored. Return false from an event handler to stop the restore. Listeners will be called with the following arguments:
| Component | |
beforestatesave :
- ( Ext.Component this , Object state )
- Fires before the state of the component is saved to the configured state provider. Return false to stop the save. Fires before the state of the component is saved to the configured state provider. Return false to stop the save. Listeners will be called with the following arguments:
| Component | |
bodyresize :
- ( Ext.Panel p , Number width , Number height )
- Fires after the Panel has been resized. Fires after the Panel has been resized. Listeners will be called with the following arguments:
| Panel | |
checkchange :
- ( Node this , Boolean checked )
- Fires when a node with a checkbox's checked property changes Fires when a node with a checkbox's checked property changes Listeners will be called with the following arguments:
| TreePanel | |
click :
- ( Node node , Ext.EventObject e )
- Fires when a node is clicked Fires when a node is clicked Listeners will be called with the following arguments:
| TreePanel | |
close :
- ( Ext.Panel p )
- Fires after the Panel is closed. Note that Panels do not directly support being closed, but some
-Panel subclasses do... Fires after the Panel is closed. Note that Panels do not directly support being closed, but some
-Panel subclasses do (like Ext.Window) or a Panel within a Ext.TabPanel. Listeners will be called with the following arguments:
| Panel | |
collapse :
- ( Ext.Panel p )
- Fires after the Panel has been collapsed. Fires after the Panel has been collapsed. Listeners will be called with the following arguments:
| Panel | |
collapsenode :
- ( Node node )
- Fires when a node is collapsed Fires when a node is collapsed Listeners will be called with the following arguments:
| TreePanel | |
containerclick :
- ( Tree this , Ext.EventObject e )
- Fires when the tree container is clicked Fires when the tree container is clicked Listeners will be called with the following arguments:
| TreePanel | |
containercontextmenu :
- ( Tree this , Ext.EventObject e )
- Fires when the tree container is right clicked Fires when the tree container is right clicked Listeners will be called with the following arguments:
| TreePanel | |
containerdblclick :
- ( Tree this , Ext.EventObject e )
- Fires when the tree container is double clicked Fires when the tree container is double clicked Listeners will be called with the following arguments:
| TreePanel | |
contextmenu :
- ( Node node , Ext.EventObject e )
- Fires when a node is right clicked. To display a context menu in response to this
-event, first create a Menu object (... Fires when a node is right clicked. To display a context menu in response to this
-event, first create a Menu object (see Ext.menu.Menu for details), then add
-a handler for this event:
Listeners will be called with the following arguments:
| TreePanel | |
dblclick :
- ( Node node , Ext.EventObject e )
- Fires when a node is double clicked Fires when a node is double clicked Listeners will be called with the following arguments:
| TreePanel | |
deactivate :
- ( Ext.Panel p )
- Fires after the Panel has been visually deactivated.
-Note that Panels do not directly support being deactivated, but ... Fires after the Panel has been visually deactivated.
-Note that Panels do not directly support being deactivated, but some Panel subclasses
-do (like Ext.Window). Panels which are child Components of a TabPanel fire the
-activate and deactivate events under the control of the TabPanel. Listeners will be called with the following arguments:
| Panel | |
destroy :
- ( Ext.Component this )
- Fires after the component is destroyed. Fires after the component is destroyed. Listeners will be called with the following arguments:
| Component | |
disable :
- ( Ext.Component this )
- Fires after the component is disabled. Fires after the component is disabled. Listeners will be called with the following arguments:
| Component | |
disabledchange :
- ( Node node , Boolean disabled )
- Fires when the disabled status of a node changes Fires when the disabled status of a node changes Listeners will be called with the following arguments:
| TreePanel | |
dragdrop :
- ( Ext.tree.TreePanel this , Ext.tree.TreeNode node , DD dd , event 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 Listeners will be called with the following arguments:
| TreePanel | |
enable :
- ( Ext.Component this )
- Fires after the component is enabled. Fires after the component is enabled. Listeners will be called with the following arguments:
| Component | |
enddrag :
- ( Ext.tree.TreePanel this , Ext.tree.TreeNode node , event e )
- Fires when a drag operation is complete Fires when a drag operation is complete Listeners will be called with the following arguments:
| TreePanel | |
expand :
- ( Ext.Panel p )
- Fires after the Panel has been expanded. Fires after the Panel has been expanded. Listeners will be called with the following arguments:
| Panel | |
expandnode :
- ( Node node )
- Fires when a node is expanded Fires when a node is expanded Listeners will be called with the following arguments:
| TreePanel | |
hide :
- ( Ext.Component this )
- Fires after the component is hidden.
-Fires after the component is hidden when calling the hide method. Fires after the component is hidden.
-Fires after the component is hidden when calling the hide method. Listeners will be called with the following arguments:
| Component | |
iconchange :
- ( Ext.Panel p , String The , String The )
- Fires after the Panel icon class has been set or changed. Fires after the Panel icon class has been set or changed. Listeners will be called with the following arguments:
| Panel | |
insert :
- ( Tree tree , Node parent , Node node , Node refNode )
- Fires when a new child node is inserted in a node in this tree. Fires when a new child node is inserted in a node in this tree. Listeners will be called with the following arguments:
| TreePanel | |
load :
- ( Node node )
- Fires when a node is loaded Fires when a node is loaded Listeners will be called with the following arguments:
| TreePanel | |
move :
- ( Ext.Component this , Number x , Number y )
- Fires after the component is moved. Fires after the component is moved. Listeners will be called with the following arguments:
| BoxComponent | |
movenode :
- ( Tree tree , Node node , Node oldParent , Node newParent , Number index )
- Fires when a node is moved to a new location in the tree Fires when a node is moved to a new location in the tree Listeners will be called with the following arguments:
| TreePanel | |
nodedragover :
- ( Object dragOverEvent )
- Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent
-... Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent
-passed to handlers has the following properties: -
Listeners will be called with the following arguments:
| TreePanel | |
nodedrop :
- ( Object dropEvent )
- Fires after a DD object is dropped on a node in this tree. The dropEvent
-passed to handlers has the following propert... Fires after a DD object is dropped on a node in this tree. The dropEvent
-passed to handlers has the following properties: -
Listeners will be called with the following arguments:
| TreePanel | |
remove :
- ( Tree tree , Node parent , Node node )
- Fires when a child node is removed from a node in this tree. Fires when a child node is removed from a node in this tree. Listeners will be called with the following arguments:
| TreePanel | |
removed :
- ( Ext.Component this , Ext.Container ownerCt )
- Fires when a component is removed from an Ext.Container Fires when a component is removed from an Ext.Container Listeners will be called with the following arguments:
| Component | |
render :
- ( Ext.Component this )
- Fires after the component markup is rendered. Fires after the component markup is rendered. Listeners will be called with the following arguments:
| Component | |
resize :
- ( Ext.Component this , Number adjWidth , Number adjHeight , Number rawWidth , Number rawHeight )
- Fires after the component is resized. Fires after the component is resized. Listeners will be called with the following arguments:
| BoxComponent | |
show :
- ( Ext.Component this )
- Fires after the component is shown when calling the show method. Fires after the component is shown when calling the show method. Listeners will be called with the following arguments:
| Component | |
startdrag :
- ( Ext.tree.TreePanel this , Ext.tree.TreeNode node , event e )
- Fires when a node starts being dragged Fires when a node starts being dragged Listeners will be called with the following arguments:
| TreePanel | |
staterestore :
- ( Ext.Component this , Object state )
- Fires after the state of the component is restored. Fires after the state of the component is restored. Listeners will be called with the following arguments:
| Component | |
statesave :
- ( Ext.Component this , Object 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. Listeners will be called with the following arguments:
| Component | |
textchange :
- ( Node node , String text , String oldText )
- Fires when the text for a node is changed Fires when the text for a node is changed Listeners will be called with the following arguments:
| TreePanel | |
titlechange :
- ( Ext.Panel p , String The )
- | Panel |