| anchor : StringNote: this config is only used when this Component is rendered
+ 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|
| anchor : StringNote: 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
+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. | Component | | animCollapse : Booleantrue 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 : Booleantrue to enable animated expand/collapse (defaults to the value of Ext.enableFx) | TreePanel | | autoHeight : Booleantrue to use height:'auto', false to use fixed height (defaults to false).
-Note: Setting autoHeight:true means that th... 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
+ See Ext.layout.AnchorLayout.anchor also. | BoxComponent | | animCollapse : Booleantrue 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 : Booleantrue to enable animated expand/collapse (defaults to the value of Ext.enableFx) | TreePanel | | autoHeight : Booleantrue 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
+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 : Booleantrue to use overflow:'auto' on the panel's body element and show scroll bars automatically when
-necessary, false to c... true to use overflow:'auto' on the panel's body element and show scroll bars automatically when
-necessary, false to clip any overflowing content (defaults to false). | Panel | | autoShow : BooleanTrue if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
+on the height of its contents rather than the height required by the Ext layout. | Panel | | autoScroll : Booleantrue 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 : BooleanTrue 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 : StringThe 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 'x-plain' which strips all styling
+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 'x-plain' which strips all styling
except for required attributes for Ext layouts to function (e.g. overflow:hidden).
-See unstyled also. | Panel | | bbar : Object/ArrayThe bottom toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of
+See unstyled also. | Panel | | bbar : Object/ArrayThe 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
+ 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 : ObjectA DomHelper element specification object specifying the element structure
of this Panel's bbar Element. See bodyCfg ... A DomHelper element specification object specifying the element structure
-of this Panel's bbar Element. See bodyCfg also. | Panel | | bodyBorder : BooleanTrue to display an interior border on the body element of the panel, false to hide it (defaults to true).
+of this Panel's bbar Element. See bodyCfg also. | Panel | | bodyBorder : BooleanTrue 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 : ObjectA DomHelper element specification object may be specified for any
@@ -112,8 +112,8 @@ 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 (baseCls will be
-replaced by baseCls):
+create a child element with the commensurate Default class name ( baseCls will be
+replaced by baseCls ):
Panel Default Default Custom Additional Additional
Element element class element class style
@@ -147,23 +147,34 @@ element:
footerCssClass: 'custom-footer', // additional css class, see addClass
footerStyle: 'background-color:red' // see bodyStyle
});
- The example above also explicitly creates a footer with custom markup and
+ The example above also explicitly creates a footer with custom markup and
styling applied. | Panel | | bodyCssClass : String/Object/FunctionAdditional css class selector to be applied to the body element in the format expected by
Ext.Element.addClass (defau... | Panel | | bodyStyle : String/Object/FunctionCustom CSS styles to be applied to the body element in the format expected by
Ext.Element.applyStyles (defaults to nu... | Panel | | border : BooleanTrue 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 | | buttonAlign : StringThe 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 : Arraybuttons 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
+the border is a 2px wide inset border, but this can be further altered by setting bodyBorder to false. | Panel | | boxMaxHeight : NumberThe 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 : NumberThe 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 : NumberThe 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 : NumberThe 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 : ArrayAn array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.... | TreePanel | | buttonAlign : StringThe 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 : Arraybuttons 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,
+If an item is configured with minWidth or the Panel is configured with minButtonWidth ,
that width will be applied to the item. | Panel | | bwrapCfg : ObjectA DomHelper element specification object specifying the element structure
of this Panel's bwrap Element. See bodyCfg... A DomHelper element specification object specifying the element structure
-of this Panel's bwrap Element. See bodyCfg also. | Panel | | clearCls : StringThe CSS class used to to apply to the special clearing div rendered
+of this Panel's bwrap Element. See bodyCfg also. | Panel | | clearCls : StringThe 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').
@@ -173,14 +184,14 @@ manager (e.g. fieldLabel is specified or isFormField=true is specified.
See Ext.layout.FormLayout.fieldTpl also. | Component | | closable : BooleanPanels 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 : StringAn optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
+ Ext.Window) or a Panel Class within an Ext.TabPanel. Specify true
+to enable closing in such situations. Defaults to false . | Panel | | cls : StringAn 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 : Booleantrue 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 : Boolean true 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 : BooleanTrue to make the panel collapsible and have the expand/collapse toggle button automatically rendered into
+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 : Boolean true 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 : BooleanTrue 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 : StringAn 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
@@ -194,7 +205,7 @@ which assigns a value by default:
To configure the above Class with an extra CSS class append to the default. For example,
for BoxLayout (Hbox and Vbox): ctCls: 'x-box-layout-ct custom-class'
| 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 : BooleanRender 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 ... 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
@@ -210,9 +221,9 @@ the disabled state:
}
}
}); | Panel | | dragConfig : Object | TreePanel | | draggable : Boolean/Objecttrue to enable dragging of this Panel (defaults to false).
-For custom drag/drop implementations, an Ext.Panel.DD conf... true to enable dragging of this Panel (defaults to false).
+For custom drag/drop implementations, an Ext.Panel.DD conf... true to enable dragging of this Panel (defaults to false ).
For custom drag/drop implementations, an Ext.Panel.DD config could also be passed
-in this config instead of true. Ext.Panel.DD is an internal, undocumented class which
+in this config instead of true . Ext.Panel.DD is an internal, undocumented class which
moves a proxy Element around in place of the Panel's element, but provides no other behaviour
during dragging or on drop. It is a subclass of Ext.dd.DragSource, so behaviour may be
added by implementing the interface methods of Ext.dd.DragDrop e.g.:
@@ -254,8 +265,8 @@ added by implementing the interface methods of 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 fbar property will be an Toolbar instance.
-If buttons are specified, they will supersede the fbar configuration property.
-The Panel's buttonAlign configuration affects the layout of these items, for example:
+If buttons are specified, they will supersede the fbar configuration property.
+The Panel's buttonAlign configuration affects the layout of these items, for example:
var w = new Ext.Window({
height: 250,
width: 500,
@@ -266,7 +277,7 @@ The Panel's 'bbar Right'
}]
}),
- buttonAlign: 'left', // anything but 'center' or 'right' and you can use "-", and "->"
+ buttonAlign: 'left', // anything but 'center' or 'right' and you can use '-', and '->'
// to control the alignment of fbar items
fbar: [{
text: 'fbar Left'
@@ -274,7 +285,7 @@ The Panel's 'fbar Right'
}]
}).show();
-Note: Although a Toolbar may contain Field components, these will not be updated by a load
+ 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 : StringThe label text to display next to this Component (defaults to '').
@@ -291,31 +302,37 @@ Example use: new Ext.FormPanel({
xtype: 'textfield',
fieldLabel: 'Name'
}]
-});
| Component | | floating : MixedThis property is used to configure the underlying Ext.Layer. Acceptable values for this
+}); | Component | | flex : NumberNote: 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 flex property will be flexed either vertically (by a VBoxLayout)
+or horizontally (by an HBoxLayout) according to the item's relative flex value
+compared to the sum of all Components with flex value specified. Any child items that have
+either a flex = 0 or flex = undefined will not be 'flexed' (the initial size will not be changed). | BoxComponent | | floating : MixedThis 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:
-- false : Default.
Display the panel inline where it is
+ false : Default.Display the panel inline where it is
rendered.
- - true :
Float the panel (absolute position it with automatic
+ true : Float the panel (absolute position it with automatic
shimming and shadow).
Setting floating to true will create an Ext.Layer for this panel and display the
panel at negative offsets so that it is hidden.
Since the panel will be absolute positioned, the position must be set explicitly
-after render (e.g., myPanel.setPosition(100,100);).
+after render (e.g., myPanel.setPosition(100,100); ).
Note: when floating a panel you should always assign a fixed width,
otherwise it will be auto width and will expand to fill to the right edge of the viewport.
- - object :
The specified object will be used
+ object : The specified object will be used
as the configuration object for the Ext.Layer that will be created.
| Panel | | footer : Booleantrue to create the footer element explicitly, false to skip creating it. The footer
-will be created automatically if ... true to create the footer element explicitly, false to skip creating it. The footer
-will be created automatically if buttons or a fbar have
-been configured. See bodyCfg for an example. | Panel | | footerCfg : ObjectA DomHelper element specification object specifying the element structure
+will be created automatically if ... true to create the footer element explicitly, false to skip creating it. The footer
+will be created automatically if buttons or a fbar have
+been configured. See bodyCfg for an example. | Panel | | footerCfg : ObjectA DomHelper element specification object specifying the element structure
of this Panel's footer Element. See bodyCf... A DomHelper element specification object specifying the element structure
-of this Panel's footer Element. See bodyCfg also. | Panel | | forceLayout : BooleanIf true the container will force a layout initially even if hidden or collapsed. This option
+of this Panel's footer Element. See bodyCfg also. | Panel | | forceLayout : BooleanIf 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 : Booleanfalse 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 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: // frame = false
<div id="developer-specified-id-goes-here" class="x-panel">
@@ -341,17 +358,17 @@ is useful for forcing forms to render in collapsed or hidden containers. (defaul
<div class="x-panel-bl"><div class="x-panel-br"><div class="x-panel-bc"/>
</div></div></div>
</div>
| Panel | | header : Booleantrue to create the Panel's header element explicitly, false to skip creating
-it. If a title is set the header will b... true to create the Panel's header element explicitly, false to skip creating
-it. If a title is set the header will be created automatically, otherwise it will not.
-If a title is set but header is explicitly set to false, the header
-will not be rendered. | Panel | | headerAsText : Booleantrue to display the panel title in the header,
- false to hide it (defaults to true). | Panel | | headerCfg : ObjectA DomHelper element specification object specifying the element structure
+it. If a title is set the header will b... true to create the Panel's header element explicitly, false to skip creating
+it. If a title is set the header will be created automatically, otherwise it will not.
+If a title is set but header is explicitly set to false , the header
+will not be rendered. | Panel | | headerAsText : Booleantrue to display the panel title in the header ,
+ false to hide it (defaults to true ). | Panel | | headerCfg : ObjectA DomHelper element specification object specifying the element structure
of this Panel's header Element. See bodyCf... A DomHelper element specification object specifying the element structure
-of this Panel's header Element. See bodyCfg also. | Panel | | height : NumberThe height of this component in pixels (defaults to auto).
+of this Panel's header Element. See bodyCfg also. | Panel | | height : NumberThe 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 : BooleanRender 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 : Booleantrue to completely hide the label element
+ 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 : Booleantrue 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.
@@ -393,8 +410,11 @@ rules to style the specific instance of this component uniquely, and also to sel
sub-elements using this component's id as the parent.
Note: to avoid complications imposed by a unique id also see
itemId and ref .
- Note: to access the container of an item see ownerCt . | Component | | itemCls : StringAn additional CSS class to apply to the div wrapping the form item
-element of this field. If supplied, itemCls at th... An additional CSS class to apply to the div wrapping the form item
+ Note: to access the container of an item see ownerCt . | Component | | itemCls : StringNote: 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').
@@ -403,22 +423,22 @@ the default itemCls supplied at the container level. The value s
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: // Apply a style to the field's label:
+Example use:// Apply a style to the field's label:
<style>
.required .x-form-item-label {font-weight:bold;color:red;}
</style>
new Ext.FormPanel({
- height: 100,
- renderTo: Ext.getBody(),
- items: [{
- xtype: 'textfield',
- fieldLabel: 'Name',
- itemCls: 'required' //this label will be styled
- },{
- xtype: 'textfield',
- fieldLabel: 'Favorite Color'
- }]
+ height: 100,
+ renderTo: Ext.getBody(),
+ items: [{
+ xtype: 'textfield',
+ fieldLabel: 'Name',
+ itemCls: 'required' //this label will be styled
+ },{
+ xtype: 'textfield',
+ fieldLabel: 'Favorite Color'
+ }]
});
| Component | | itemId : StringAn 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 id with
@@ -450,7 +470,7 @@ p2 = p1.id and ref .
Note: to access the container of an item see ownerCt. | Component | | keys : Object/ArrayA Ext.KeyMap config object (in the format expected by Ext.KeyMap.addBinding
used to assign custom key handling to thi... | Panel | | labelSeparator : StringThe separator to display after the text of each
+used to assign custom key handling to this panel (defaults to null ). | Panel | | labelSeparator : StringThe 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.
@@ -571,13 +591,16 @@ to 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.
Defaults to: {top:0, right:0, bottom:0, left:0}
| BoxComponent | | maskDisabled : Booleantrue 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
+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 : NumberMinimum width in pixels of all buttons in this panel (defaults to 75) | Panel | | overCls : StringAn optional extra CSS class that will be added to this component's Element when the mouse moves
+disabled. | Panel | | minButtonWidth : NumberMinimum width in pixels of all buttons in this panel (defaults to 75 ) | Panel | | overCls : StringAn 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 | | 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/ArrayAn object or array of objects that will provide custom functionality for this component. The only
+useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules. | Component | | padding : Number/StringA 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/ArrayAn 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
@@ -591,9 +614,9 @@ object. The ptype will be looked up at render time up to determine
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 : StringA 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 ownerCt specifying into which
-ancestor Container to place a named reference to this Component.
+take advantage of lazy instantiation and rendering. | Component | | ref : StringA 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 ownerCt
+specifying into which ancestor Container to place a named reference to this Component.
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: var myGrid = new Ext.grid.EditorGridPanel({
title: 'My EditorGridPanel',
@@ -612,9 +635,10 @@ For example, to put a reference to a Toolbar Button into the Panel which owns
}
}
});
- In the code above, if the ref had been 'saveButton' the reference would
-have been placed into the Toolbar. Each '/' in the ref moves up one level from the
-Component's ownerCt. | Component | | region : StringNote: this config is only used when this BoxComponent is rendered
+ In the code above, if the ref had been 'saveButton'
+the reference would have been placed into the Toolbar. Each '/' in the ref
+moves up one level from the Component's ownerCt .
+ Also see the added and removed events. | Component | | region : StringNote: 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').
@@ -630,14 +654,14 @@ to render and manage its child items.
When using this config, a call to render() is not required.
-See render also. | Component | | requestMethod : StringThe HTTP request method for loading data (defaults to the value of Ext.Ajax.method). | TreePanel | | 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 | TreePanel | | shadow : Boolean/Stringtrue (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 : NumberThe 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 : Booleanfalse 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 : ArrayAn array of events that, when fired, should trigger this component to
+ See render also. | Component | | requestMethod : StringThe 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 | TreePanel | | shadow : Boolean/Stringtrue (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 : NumberThe 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 : Booleanfalse 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 : ArrayAn 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). stateEvents may be any type
of event supported by this component, including browser or custom events
@@ -707,10 +731,11 @@ Ext.Element.ap... A custom style specification to be appl
}
})
]
-}); | Component | | tabTip : StringA string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over
-the tab of a Ext.Pan... A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over
-the tab of a Ext.Panel which is an item of a Ext.TabPanel. Ext.QuickTips.init()
-must be called in order for the tips to render. | Panel | | tbar : Object/ArrayThe top toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of
+}); | Component | | tabTip : StringNote: 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/ArrayThe 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.
@@ -719,19 +744,19 @@ of an ancestor FormPanel. A Panel's toolbars are not part of the standard Contai
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 : ObjectA DomHelper element specification object specifying the element structure
of this Panel's tbar Element. See bodyCfg ... A DomHelper element specification object specifying the element structure
-of this Panel's tbar Element. See bodyCfg also. | Panel | | title : StringThe title text to be used as innerHTML (html tags are accepted) to display in the panel
+of this Panel's tbar Element. See bodyCfg also. | Panel | | title : StringThe 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
+ 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 : Booleantrue 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
+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.XTemplateA 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: new Ext.Template('<div class="x-tool x-tool-{id}"> </div>')
+ floatable config option. | Panel | | toolTemplate : Ext.Template/Ext.XTemplateA 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: new Ext.Template('<div class="x-tool x-tool-{id}"> </div>')
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
@@ -752,44 +777,44 @@ visual indication when hovering over the tool: var win = 'hide'
});
- Note that the CSS class "x-tool-pdf" should have an associated style rule which provides an
+ Note that the CSS class 'x-tool-pdf' should have an associated style rule which provides an
appropriate background image, something like:
a.x-tool-pdf {background-image: url(../shared/extjs/images/pdf.gif)!important;}
| Panel | | tools : ArrayAn 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>
+stored as an Element referenced by a public property called tools.<tool-type>
Each tool config may contain the following properties:
- id : String
Required. The type
-of tool to create. By default, this assigns a CSS class of the form x-tool-<tool-type> to the
+of tool to create. By default, this assigns a CSS class of the form x-tool-<tool-type> to the
resulting tool Element. Ext provides CSS rules, and an icon sprite containing images for the tool types listed below.
The developer may implement custom tools by supplying alternate CSS rules and background images:
-
- close
- minimize
- maximize
- restore
- gear
- pin
- unpin
- right
- left
- up
- down
- refresh
- minus
- plus
- help
- search
- save
- print
+
+ close
+ minimize
+ maximize
+ restore
+ gear
+ pin
+ unpin
+ right
+ left
+ up
+ down
+ refresh
+ minus
+ plus
+ help
+ search
+ save
+ print
- handler : Function
Required. The function to
call when clicked. Arguments passed are:
- stopEvent : Boolean
Defaults to true. Specify as false to allow click event to propagate.
- scope : Object
The scope in which to call the handler.
@@ -818,14 +843,14 @@ handlers that implement the necessary behavior.
// whatever
}
}]
-For the custom id of 'help' define two relevant css classes with a link to
+ For the custom id of 'help' define two relevant css classes with a link to
a 15x15 image:
.x-tool-help {background-image: url(images/help.png);}
.x-tool-help-over {background-image: url(images/help_over.png);}
// if using an image sprite:
.x-tool-help {background-image: url(images/help.png) no-repeat 0 0;}
.x-tool-help-over {background-position:-15px 0;}
| Panel | | trackMouseOver : Boolean false to disable mouse over highlighting | TreePanel | | unstyled : BooleanOverrides the baseCls setting to baseCls = 'x-plain' which renders
-the panel unstyled except for required attributes ... Overrides the baseCls setting to baseCls = 'x-plain' which renders
+the panel unstyled except for required attributes ... Overrides the baseCls setting to baseCls = 'x-plain' which renders
the panel unstyled except for required attributes for Ext layouts to function (e.g. overflow:hidden). | Panel | | useArrows : Boolean true to use Vista-style arrows in the tree (defaults to false) | TreePanel | | width : NumberThe 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 : StringThe registered xtype to create. This config option is not used when passing
@@ -848,7 +873,7 @@ 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 el also. | Panel | | buttons : ArrayThis Panel's Array of buttons as created from the buttons
+ Note: see the Note for el also. | Panel | | buttons : ArrayThis Panel's Array of buttons as created from the buttons
config property. Read only. | Panel | | bwrap : Ext.ElementThe Panel's bwrap Element used to contain other Panel elements
(tbar, body, bbar, footer). See bodyCfg. Read-only. | 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
@@ -874,18 +899,20 @@ config for a suggestion, or use a render listener directly: new
See also getEl
| Component | | footer : Ext.ElementThe Panel's footer Element. Read-only.
This Element is used to house the Panel's buttons or fbar.
Note: see the Note ... The Panel's footer Element. Read-only.
- This Element is used to house the Panel's buttons or fbar.
- Note: see the Note for el also. | Panel | | header : Ext.ElementThe Panel's header Element. Read-only.
+ This Element is used to house the Panel's buttons or fbar .
+ Note: see the Note for el also. | Panel | | header : Ext.ElementThe Panel's header Element. Read-only.
This Element is used to house the title and tools
Note: see the Note for el al... The Panel's header Element. Read-only.
This Element is used to house the title and tools
- Note: see the Note for el also. | 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.ContainerThe component's owner Ext.Container (defaults to undefined, and is set automatically when
-the component is added to a... The component's owner Ext.Container (defaults to undefined, and is set automatically when
-the component is added to a container). Read-only.
- Note: to access items within the container see itemId. | Component | | rendered : Boolean True if this component has been rendered. Read-only. | Component | | root : Ext.tree.TreeNode The root node of this tree. | TreePanel |
Public Methods|
| TreePanel( Object config )
- | TreePanel | | add( Object/Array component , Object (Optional) , Object (Optional) )
- :
- Ext.ComponentAdds Component(s) to this Container.
+ Note: see the Note for el also. | 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.ContainerThis Component's owner Container (defaults to undefined, and is set automatically when
+this Component is added to a C... This Component's owner Container (defaults to undefined, and is set automatically when
+this Component is added to a Container). Read-only.
+ Note: to access items within the Container see itemId. | Component | | refOwner : Ext.ContainerThe 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 |
Public Methods|
| TreePanel( Object config )
+ | TreePanel | | add( ...Object/Array component )
+ :
+ Ext.Component/ArrayAdds Component(s) to this Container.
Description :
<ul class="mdetail-params">
Fires the beforeadd event before addin... Parameters:component : Object/ArrayEither a single component or an Array of components to add. See
-items for additional information. (Optional) : Objectcomponent_2 (Optional) : Objectcomponent_n Returns: | Container | | addButton( String/Object config , Function handler , Object scope )
+Parameters:component : ...Object/ArrayEither one or more Components to add or an Array of Components to add. See
+items for additional information. Returns: | 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. | Panel | | addClass( string cls )
+button config, an object will be treated as a button config object.handler : Functionscope : ObjectThe scope (this reference) in which the button handler function is executed. Defaults to the Button. Returns: | 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. | Component | | addEvents( Object object )
+ Ext.ComponentAdds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. | Component | | addEvents( Object|String o , string Optional. )
:
- voidUsed to define events on this Observable Used to define events on this Observable | Observable | | addListener( String eventName , Function handler , [Object scope ], [Object options ] )
+ voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. | Observable | | addListener( String eventName , Function handler , [Object scope ], [Object options ] )
:
voidAppends an event handler to this object. Appends an event handler to this object. Parameters:eventName : StringThe name of the event to listen for. handler : FunctionThe method the event invokes. scope : Object(optional) The scope (this reference) in which the handler function is executed.
If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration.
@@ -941,8 +970,8 @@ Using the options argument, it is possible to combine different types of listene
A delayed, one-time listener.
myDataView.on('click', this.onClick, this, {
- single: true,
- delay: 100
+single: true,
+delay: 100
});
Attaching multiple handlers in 1 call
@@ -950,27 +979,27 @@ The method also allows for a single argument to be passed which is a config obje
which specify multiple handlers.
myGridPanel.on({
- 'click' : {
- fn: this.onClick,
- scope: this,
- delay: 100
- },
- 'mouseover' : {
- fn: this.onMouseOver,
- scope: this
- },
- 'mouseout' : {
- fn: this.onMouseOut,
- scope: this
- }
+'click' : {
+ fn: this.onClick,
+ scope: this,
+ delay: 100
+},
+'mouseover' : {
+ fn: this.onMouseOver,
+ scope: this
+},
+'mouseout' : {
+ fn: this.onMouseOut,
+ scope: this
+}
});
Or a shorthand syntax:
myGridPanel.on({
- 'click' : this.onClick,
- 'mouseover' : this.onMouseOver,
- 'mouseout' : this.onMouseOut,
- scope: this
+'click' : this.onClick,
+'mouseover' : this.onMouseOver,
+'mouseout' : this.onMouseOut,
+ scope: this
});
Returns: | 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
@@ -992,9 +1021,41 @@ cancel the collapse action if it returns false. 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. | Component | | enableBubble( Object events )
- :
- voidUsed to enable bubbling of events Used to enable bubbling of events | Observable | | expand( Boolean animate )
+should usually not need to be called directly. | 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.getBubbleTarget() if present. There is no implementation in the Observable base class.
+ This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default
+implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
+access the required target more quickly.
+ Example: Ext.override(Ext.form.Field, {
+ // Add functionality to Field's initComponent to enable the change event to bubble
+ initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
+ this.enableBubble('change');
+ }),
+
+ // We know that we want Field's events to bubble directly to the FormPanel.
+ getBubbleTarget : function() {
+ if (!this.formPanel) {
+ this.formPanel = this.findParentByType('form');
+ }
+ return this.formPanel;
+ }
+});
+
+var myForm = new Ext.formPanel({
+ title: 'User Details',
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: function() {
+ // Title goes red if form has been modified.
+ myForm.header.setStyle('color', 'red');
+ }
+ }
+});
| Observable | | 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
@@ -1003,7 +1064,7 @@ cancel the expand action if it returns false. | 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.getPathParameters:path : Stringattr : Stringcallback : Function(optional) The callback to call when the expand is complete. The callback will be called with
+ void Expands 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
| TreePanel | | findParentBy( Function fn )
:
Ext.Container | Container | | getBottomToolbar()
:
- Ext.ToolbarReturns the toolbar from the bottom (bbar) section of the panel. Returns the toolbar from the bottom ( bbar) section of the panel. | Panel | | getBox( [Boolean local ] )
+ Ext.ToolbarReturns the toolbar from the bottom (bbar) section of the panel. Returns the toolbar from the bottom ( bbar ) section of the panel. | 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. | BoxComponent | | getBubbleTarget()
:
Ext.ContainerProvides 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. | 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:attribute : String(optional) Defaults to null (return the actual nodes) startNode : TreeNode(optional) The node to start from, defaults to the root Returns: | TreePanel | | getEl()
+ 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:attribute : String(optional) Defaults to null (return the actual nodes) startNode : TreeNode(optional) The node to start from, defaults to the root Returns: | TreePanel | | getEl()
+ :
+ Ext.ElementReturns 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: new Ext.Panel({
+ title: 'The Clickable Panel',
+ listeners: {
+ render: function(p) {
+ // Append the Panel to the click handler's argument list.
+ p.getEl().on('click', handlePanelClick.createDelegate(null, [p], true));
+ },
+ single: true // Remove the listener after first invocation
+ }
+});
| Component | | getFooterToolbar()
:
- ElementReturns the container element for this TreePanel. Returns the container element for this TreePanel. | TreePanel | | getFrameHeight()
+ Ext.ToolbarReturns the toolbar from the footer (fbar) section of the panel. Returns the toolbar from the footer ( fbar ) section of the panel. | Panel | | getFrameHeight()
:
NumberReturns the height in pixels of the framing elements of this panel (including any top and bottom bars and
header and ... | BoxComponent | | getResizeEl()
:
- voidReturns the outermost Element of this Component which defines the Components overall size.
+ 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 getEl ,
but in some cases, a Component may have some more wrapping Elements around its main
@@ -1081,7 +1160,7 @@ active Element.
An example is a ComboBox. It is encased in a wrapping Element which
contains both the <input> Element (which is what would be returned
by its getEl method, and the trigger button Element.
-This Element is returned as the resizeEl . | BoxComponent | | getRootNode()
+This Element is returned as the resizeEl . | BoxComponent | | getRootNode()
:
NodeReturns this root node for this tree Returns this root node for this tree | TreePanel | | getSelectionModel()
:
@@ -1091,7 +1170,7 @@ This Element is returned as the resizeEl . | Panel | | getTopToolbar()
:
- Ext.ToolbarReturns the toolbar from the top (tbar) section of the panel. Returns the toolbar from the top ( tbar) section of the panel. | Panel | | getTreeEl()
+ Ext.ToolbarReturns the toolbar from the top (tbar) section of the panel. Returns the toolbar from the top ( tbar ) section of the panel. | Panel | | getTreeEl()
:
Ext.ElementReturns the underlying Element for this tree Returns the underlying Element for this tree | TreePanel | | getWidth()
:
@@ -1133,7 +1212,26 @@ to participate in determination of inherited xtypes.
var isText = t.isXType('textfield'); // true
var isBoxSubclass = t.isXType('box'); // true, descended from BoxComponent
var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instanceParameters:xtype : StringThe xtype to check for this Component shallow : Boolean(optional) False to check whether this Component is descended from the xtype (this is
-the default), or true to check whether this Component is directly of the specified xtype. Returns: | Component | | nextSibling()
+the default), or true to check whether this Component is directly of the specified xtype.Returns: | 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:
+myGridPanel.mon(myGridPanel.getSelectionModel(), 'selectionchange', handleSelectionChange, null, {buffer: 50});
+
+ or:
+myGridPanel.mon(myGridPanel.getSelectionModel(), {
+ selectionchange: handleSelectionChange,
+ buffer: 50
+});
+
Parameters:item : Observable|ElementThe item to which to add a listener/listeners. ename : Object|StringThe event name, or an object containing event name properties. fn : FunctionOptional. If the ename parameter was an event name, this
+is the handler function. scope : ObjectOptional. If the ename parameter was an event name, this
+is the scope (this reference) in which the handler function is executed. opt : ObjectOptional. If the ename parameter was an event name, this
+is the addListener options. Returns: | 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:item : Observable|ElementThe item from which to remove a listener/listeners. ename : Object|StringThe event name, or an object containing event name properties. fn : FunctionOptional. If the ename parameter was an event name, this
+is the handler function. scope : ObjectOptional. If the ename parameter was an event name, this
+is the scope (this reference) in which the handler function is executed. Returns: | Component | | nextSibling()
:
Ext.ComponentReturns the next component in the owning container Returns the next component in the owning container | Component | | on( String eventName , Function handler , [Object scope ], [Object options ] )
:
@@ -1180,11 +1278,13 @@ event... | 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 | TreePanel | | setHeight( Number height )
+ 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 | TreePanel | | setAutoScroll( Boolean scroll )
:
- 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:height : NumberThe new height to set. This may be one of:
| 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:height : MixedThe 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.
Returns: | BoxComponent | | setIconClass( String cls )
@@ -1201,8 +1301,8 @@ This method fires the Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
This method fires the move event.Parameters:left : NumberThe new left top : NumberThe new top Returns: | 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
+ Node Sets 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. | 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
@@ -1222,13 +1322,13 @@ This may be one of: | Panel | | setVisible( Boolean visible )
+for the Panel. This is triggered either by configuring the Panel with a non-blank title ,
+or configuring it with header: true .Parameters:title : StringThe title text to set iconCls : String(optional) iconCls A user-defined CSS class that provides the icon image for this panel Returns: | 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. | Component | | setWidth( Number width )
+ Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. | 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:width : NumberThe new width to setThis may be one of:
| BoxComponent | | show()
:
@@ -1245,7 +1345,12 @@ after the 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 : BooleanTrue to animate the transition, else false (defaults to the value of the
animCollapse panel config) Returns: | Panel | | un( String eventName , Function handler , [Object scope ] )
:
- voidRemoves an event handler (shorthand for removeListener.) | Observable | | updateBox( Object box )
+ voidRemoves an event handler (shorthand for removeListener.) | Observable | | update( Mixed htmlOrData , [Boolean loadScripts ], [Function callback ] )
+ :
+ voidUpdate the content area of a component. Update the content area of a component. Parameters:htmlOrData : MixedIf this component has been configured with a template via the tpl config
+then it will use this argument as data to populate the template.
+If this component was not configured with a template, the components
+content area will be updated via Ext.Element update loadScripts : Boolean(optional) Only legitimate when using the html configuration. Defaults to false callback : Function(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading Returns: | 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. | BoxComponent |
Public Events|
| activate :
( Ext.Panel p )
@@ -1253,7 +1358,9 @@ after the 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 | | afterlayout :
+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 )
@@ -1279,7 +1386,9 @@ A handler can return false to cancel the close.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:node : NodeThe node deep : Booleananim : Boolean
| TreePanel | | beforedestroy :
+ 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:node : NodeThe node deep : Booleananim : Boolean
| 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:node : NodeThe node e : Ext.EventObjectThe event object
| TreePanel | | beforedestroy :
( Ext.Component this )
Fires before the component is destroyed. Return false from an event handler to stop the destroy. Fires before the component is destroyed. Return false from an event handler to stop the destroy. Listeners will be called with the following arguments: | Component | | beforeexpand :
( Ext.Panel p , Boolean animate )
@@ -1297,20 +1406,20 @@ Return false from an event handler to stop the hide.
( 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:
- | 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 :
@@ -1333,7 +1442,7 @@ provide custom state restoration. | | 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 :
+ Fires after the Panel has been resized. Fires after the Panel has been resized. Listeners will be called with the following arguments:p : Ext.Panelthe Panel which has been resized. width : NumberThe Panel body's new width. height : NumberThe Panel body's new height.
| 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:this : NodeThis node checked : Boolean
| TreePanel | | click :
( Node node , Ext.EventObject e )
@@ -1345,48 +1454,54 @@ Panel subclasses do (like
( 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 | | contextmenu :
+ 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:this : Treee : Ext.EventObjectThe event object
| 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:this : Treee : Ext.EventObjectThe event object
| 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:this : Treee : Ext.EventObjectThe event object
| 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: new Ext.tree.TreePanel({
- title: 'My TreePanel',
- root: new Ext.tree.AsyncTreeNode({
- text: 'The Root',
- children: [
- { text: 'Child node 1', leaf: true },
- { text: 'Child node 2', leaf: true }
- ]
- }),
- contextMenu: new Ext.menu.Menu({
- items: [{
- id: 'delete-node',
- text: 'Delete Node'
- }],
- listeners: {
- itemclick: function(item) {
- switch (item.id) {
- case 'delete-node':
- var n = item.parentMenu.contextNode;
- if (n.parentNode) {
- n.remove();
- }
- break;
- }
- }
- }
- }),
- listeners: {
- contextmenu: function(node, e) {
-// Register the context node with the menu so that a Menu Item's handler function can access
-// it via its parentMenu property.
- node.select();
- var c = node.getOwnerTree().contextMenu;
- c.contextNode = node;
- c.showAt(e.getXY());
- }
- }
+ 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: new Ext.tree.TreePanel({
+ title: 'My TreePanel',
+ root: new Ext.tree.AsyncTreeNode({
+ text: 'The Root',
+ children: [
+ { text: 'Child node 1', leaf: true },
+ { text: 'Child node 2', leaf: true }
+ ]
+ }),
+ contextMenu: new Ext.menu.Menu({
+ items: [{
+ id: 'delete-node',
+ text: 'Delete Node'
+ }],
+ listeners: {
+ itemclick: function(item) {
+ switch (item.id) {
+ case 'delete-node':
+ var n = item.parentMenu.contextNode;
+ if (n.parentNode) {
+ n.remove();
+ }
+ break;
+ }
+ }
+ }
+ }),
+ listeners: {
+ contextmenu: function(node, e) {
+// Register the context node with the menu so that a Menu Item's handler function can access
+// it via its parentMenu property.
+ node.select();
+ var c = node.getOwnerTree().contextMenu;
+ c.contextNode = node;
+ c.showAt(e.getXY());
+ }
+ }
});
Listeners will be called with the following arguments:node : NodeThe node e : Ext.EventObjectThe event object
| 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:node : NodeThe node e : Ext.EventObjectThe event object
| TreePanel | | deactivate :
@@ -1427,33 +1542,36 @@ Fires after the component is hidden when calling the 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:tree : TreeThe owner tree node : NodeThe node moved oldParent : NodeThe old parent of this node newParent : NodeThe new parent of this node index : NumberThe index it was moved to
| 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:
- | 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 proper... Fires after a DD object is dropped on a node in this tree. The dropEvent
-passed to handlers has the following properties:
- | 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:tree : TreeThe owner tree parent : NodeThe parent node node : NodeThe child node removed
| TreePanel | | render :
+ 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:tree : TreeThe owner tree parent : NodeThe parent node node : NodeThe child node removed
| 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 )
|
|