| | anchor : StringNote: this config is only used when this Component is rendered
+}); Config Options|
| | allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component | | | 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 : Boolean true to animate the transition when the panel is collapsed, false to skip the
-animation (defaults to false). | FieldSet | | | autoDestroy : Boolean | BoxComponent | | | animCollapse : Boolean true to animate the transition when the panel is collapsed, false to skip the
+animation (defaults to false). | FieldSet | | | autoDestroy : BooleanIf true the container will automatically destroy any contained component that is removed from it, else
destruction mu... If true the container will automatically destroy any contained component that is removed from it, else
-destruction must be handled manually (defaults to true). | Container | | | autoHeight : Booleantrue to use height:'auto', false to use fixed height (defaults to false).
+destruction must be handled manually (defaults to true). | Container | | | 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
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 | | | autoLoad : Object/String/FunctionA valid url spec according to the Updater Ext.Updater.update method.
+on the height of its contents rather than the height required by the Ext layout. | Panel | | | autoLoad : Object/String/FunctionA valid url spec according to the Updater Ext.Updater.update method.
If autoLoad is not null, the panel will attempt ... A valid url spec according to the Updater Ext.Updater.update method.
If autoLoad is not null, the panel will attempt to load its contents
immediately upon render.
The URL will become the default URL for this panel's body element,
-so it may be refreshed at any time. | Panel | | | autoScroll : Booleantrue to use overflow:'auto' on the components layout element and show scroll bars automatically when
+so it may be refreshed at any time. | 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
+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 | | | autoWidth : BooleanTrue to use width:'auto', false to use fixed width (or allow it to be managed by its parent
+them on render (defaults to false). | Component | | | autoWidth : BooleanTrue to use width:'auto', false to use fixed width (or allow it to be managed by its parent
Container's layout manage... True to use width:'auto', false to use fixed width (or allow it to be managed by its parent
Container's layout manager. Defaults to false.
Note: Although many components inherit this config option, not all will
@@ -104,17 +104,17 @@ child items when the browser changes its width: var myPanel = <
}, {
title: 'Box 3'
}],
-});
| BoxComponent | | | baseCls : String The base CSS class applied to the fieldset (defaults to 'x-fieldset'). | FieldSet | | | bbar : Object/ArrayThe bottom toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of
+}); | BoxComponent | | | baseCls : String The base CSS class applied to the fieldset (defaults to 'x-fieldset'). | FieldSet | | | 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
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
+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 | | | bodyCfg : ObjectA DomHelper element specification object may be specified for any
-Panel Element.
+of this Panel's bbar Element. See bodyCfg also. | Panel | | | bodyCfg : ObjectA 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
@@ -154,38 +154,38 @@ element:
footerStyle: 'background-color:red' // see bodyStyle
});
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
+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/Function | 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 | | | boxMaxHeight : Number | 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 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 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 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.
+ 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.... | Container | | | buttonAlign : StringThe alignment of any buttons added to this panel. Valid values are 'right',
+Defaults to ['add', 'remove']. | Container | | | 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
+'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,
-that width will be applied to the item. | Panel | | | bwrapCfg : ObjectA DomHelper element specification object specifying the element structure
+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 | | | checkboxName : StringThe name to assign to the fieldset's checkbox if checkboxToggle = true
-(defaults to '[checkbox id]-checkbox'). | FieldSet | | | checkboxToggle : Mixedtrue to render a checkbox into the fieldset frame just
+(defaults to '[checkbox id]-checkbox'). | FieldSet | | | checkboxToggle : Mixedtrue to render a checkbox into the fieldset frame just
in front of the legend to expand/collapse the fieldset when t... true to render a checkbox into the fieldset frame just
in front of the legend to expand/collapse the fieldset when the checkbox is toggled. (defaults
to false).
A DomHelper element spec may also be specified to create the checkbox.
If true is specified, the default DomHelper config object used to create the element
-is: {tag: 'input', type: 'checkbox', name: this.checkboxName || this.id+'-checkbox'}
| FieldSet | | | clearCls : StringThe CSS class used to to apply to the special clearing div rendered
+is: {tag: 'input', type: 'checkbox', name: this.checkboxName || this.id+'-checkbox'}
| FieldSet | | | 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').
@@ -193,17 +193,17 @@ directly after each form field wrapper to provide field clearing (defaults to
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 | 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
+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 | | | 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 fieldset collapsible and have the expand/collapse toggle button automatically
+'x-panel-collapsed'). | Panel | | | collapsible : Booleantrue to make the fieldset collapsible and have the expand/collapse toggle button automatically
rendered into the leg... true to make the fieldset collapsible and have the expand/collapse toggle button automatically
rendered into the legend element, false to keep the fieldset statically sized with no collapse
-button (defaults to false). Another option is to configure checkboxToggle. | FieldSet | | | contentEl : StringOptional. Specify an existing HTML element, or the id of an existing HTML element to use as the content
+button (defaults to false). Another option is to configure checkboxToggle. | FieldSet | | | contentEl : StringOptional. Specify an existing HTML element, or the id of an existing HTML element to use as the content
for this comp... Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content
for this component.
@@ -217,7 +217,7 @@ of a new component (it simply moves the specified DOM element after the Compo
scheme that the Component may use. It is just HTML. Layouts operate on child items. Add either the x-hidden or the x-hide-display CSS class to
prevent a brief flicker of the content before it is rendered to the panel.
- | Component | | | ctCls : StringAn optional extra CSS class that will be added to this component's container. This can be useful for
+ | Component | | | 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
adding customized styles to the container or any of its children using standard CSS rules. See
Ext.layout.ContainerLayout.extraCls also.
@@ -229,7 +229,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 | | | data : MixedThe initial set of data to apply to the tpl to
-update the content area of the Component. | Component | | | defaults : Object|FunctionThis option is a means of applying default settings to all added items whether added through the items
+update the content area of the Component. | Component | | | defaults : Object|FunctionThis option is a means of applying default settings to all added items whether added through the items
config or via ... This option is a means of applying default settings to all added items whether added through the items
config or via the add or insert methods.
If an added item is a config object, and not an instantiated Component, then the default properties are
@@ -253,7 +253,7 @@ items: [
id: 'panel2', // options in components, so the defaults
autoScroll: false // will be applied here, panel2 will be autoScroll:true.
})
-] | Container | | | disabled : BooleanRender this panel disabled (default is false). An important note when using the disabled
+] | Container | | | 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 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.
@@ -269,7 +269,7 @@ the disabled state:
single: true // important, as many layouts can occur
}
}
-}); | Panel | | | draggable : Boolean/Objecttrue to enable dragging of this Panel (defaults to false).
+}); | Panel | | | 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 config could also be passed
in this config instead of true. Ext.Panel.DD is an internal, undocumented class which
@@ -310,7 +310,7 @@ added by implementing the interface methods of Panel | | | fbar : Object/ArrayA Toolbar object, a Toolbar config, or an array of
+}).show(); | Panel | | | fbar : Object/ArrayA Toolbar object, a Toolbar config, or an array of
Buttons/Button configs, describing a Toolbar to be rendered into t... | Panel | | | fieldLabel : StringThe label text to display next to this Component (defaults to '').
+submission parameters are collected from the DOM tree. | Panel | | | fieldLabel : StringThe 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.
@@ -351,19 +351,25 @@ Example use: new Ext.FormPanel({
xtype: 'textfield',
fieldLabel: 'Name'
}]
-});
| Component | | | footerCfg : ObjectA DomHelper element specification object specifying the element structure
+}); | 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 | | | 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 | | | headerCfg : ObjectA DomHelper element specification object specifying the element structure
+is useful for forcing forms to render in collapsed or hidden containers. (defaults to false). | Container | | | 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 | | | hideBorders : BooleanTrue to hide the borders of each contained component, false to defer to the component's existing
+ hide method will be called internally. | Component | | | hideBorders : BooleanTrue to hide the borders of each contained component, false to defer to the component's existing
border settings (def... True to hide the borders of each contained component, false to defer to the component's existing
-border settings (defaults to false). | Container | | | hideLabel : Booleantrue to completely hide the label element
-(label and separator). Defaults to false.
+border settings (defaults to false). | Container | | | 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.
By default, even if you do not specify a fieldLabel the space will still be
@@ -377,20 +383,20 @@ Example use: new Ext.FormPanel({
xtype: 'textfield'
hideLabel: true
}]
-});
| Component | | | hideMode : StringHow this component should be hidden. Supported values are 'visibility'
+}); | Component | | | hideMode : StringHow 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 : BooleanTrue to hide and show the component's container when hide/show is called on the component, false to hide
+is done while hidden). | Component | | | hideParent : BooleanTrue 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 | | | html : String/ObjectAn HTML fragment, or a DomHelper specification to use as the layout element
+button on a window by setting hide:true on the button when adding it to its parent container. | Component | | | html : String/ObjectAn HTML fragment, or a DomHelper specification to use as the layout element
content (defaults to ''). The HTML conten... An HTML fragment, or a DomHelper specification to use as the layout element
content (defaults to ''). The HTML content is added after the component is rendered,
so the document will not contain this HTML at the time the render event is fired.
-This content is inserted into the body before any configured contentEl is appended. | Component | | | id : StringThe unique id of this component (defaults to an auto-assigned id).
+This content is inserted into the body before any configured contentEl is appended. | Component | | | id : StringThe 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).
@@ -400,11 +406,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 : StringA css class to apply to the x-form-item of fields (see
-Ext.layout.FormLayout.fieldTpl for details).
+ Note: to access the container of an item see ownerCt. | Component | | | itemCls : StringA css class to apply to the x-form-item of fields (see
+Ext.layout.FormLayout.fieldTpl for details).
This property ... | FieldSet | | | itemId : StringAn itemId can be used as an alternative way to get a reference to a component
+This property cascades to child containers. | FieldSet | | | 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
Ext.getCmp, use itemId with
@@ -433,7 +439,7 @@ avoiding potential conflicts with getComponent('p1'); // not the same as Ext.getCmp()
p2 = p1.ownerCt.getComponent('p2'); // reference via a sibling
Also see id and ref.
- Note: to access the container of an item see ownerCt. | Component | | | items : Object/Array** IMPORTANT: be sure to specify a layout if needed ! **
+ Note: to access the container of an item see ownerCt. | Component | | | items : Object/Array** IMPORTANT: be sure to specify a layout if needed ! **
A single item, or an array of child Components to be added t... ** IMPORTANT: be sure to specify a layout if needed ! **
A single item, or an array of child Components to be added to this container,
for example:
@@ -466,10 +472,10 @@ should it become necessary. Items are automatically laid out when they are first
shown (no sizing is done while hidden), or in response to a doLayout call.
Do not specify contentEl/
html with items.
- | Container | | | keys : Object/ArrayA Ext.KeyMap config object (in the format expected by Ext.KeyMap.addBinding
+ | Container | | | 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
-fieldLabel. This property may be configured at various levels.
+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.
The order of precedence is:
@@ -497,7 +503,7 @@ Example use: new Ext.FormPanel({
xtype: 'textfield',
fieldLabel: 'Field 2' // labelSeparator will be '='
}]
-});
| Component | | | labelStyle : StringA CSS style specification string to apply directly to this field's
+}); | Component | | | labelStyle : StringA 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 '').
@@ -514,7 +520,7 @@ Example use: new Ext.FormPanel({
}]
});
| Component | | | labelWidth : Number The width of labels. This property cascades to child containers. | FieldSet | | | layout : String | FieldSet | | | layoutConfig : ObjectThis is a config object containing properties specific to the chosen
layout if layout
-has been specified as a string. | Container | | | listeners : ObjectA config object containing one or more event handlers to be added to this
+has been specified as a string. | Container | | | listeners : ObjectA config object containing one or more event handlers to be added to this
object during initialization. This should ... A config object containing one or more event handlers to be added to this
object during initialization. This should be a valid listeners config object as specified in the
addListener example for attaching multiple handlers at once.
@@ -569,7 +575,7 @@ Ext.DomObserver = Ext.extend(Object, {
typeAhead: true,
mode: 'local',
triggerAction: 'all'
-}); | Observable | | | margins : ObjectNote: this config is only used when this BoxComponent is rendered
+}); | Observable | | | margins : ObjectNote: 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.
@@ -590,29 +596,29 @@ right and left are set to the second.
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
+ 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
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 | | | monitorResize : BooleanTrue to automatically monitor window resize events to handle anything that is sensitive to the current size
+disabled. | Panel | | | minButtonWidth : NumberMinimum width in pixels of all buttons in this panel (defaults to 75) | Panel | | | monitorResize : BooleanTrue to automatically monitor window resize events to handle anything that is sensitive to the current size
of the vi... True to automatically monitor window resize events to handle anything that is sensitive to the current size
of the viewport. This value is typically managed by the chosen layout and should not need
-to be set manually. | Container | | | overCls : StringAn optional extra CSS class that will be added to this component's Element when the mouse moves
+to be set manually. | Container | | | 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 | | | padding : Number/StringA shortcut for setting a padding style on the body element. The value can either be
+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 | | | plugins : Object/ArrayAn object or array of objects that will provide custom functionality for this component. The only
+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 | | | 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
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 | | | preventBodyReset : BooleanDefaults to false. When set to true, an extra css class 'x-panel-normal'
+component as needed to provide its functionality. | Component | | | preventBodyReset : BooleanDefaults to false. When set to true, an extra css class 'x-panel-normal'
will be added to the panel's element, effec... Defaults to false. When set to true, an extra css class 'x-panel-normal'
will be added to the panel's element, effectively applying css styles suggested by the W3C
(see http://www.w3.org/TR/CSS21/sample.html) to the Panel's body element (not the header,
-footer, etc.). | Panel | | | ptype : StringThe registered ptype to create. This config option is not used when passing
+footer, etc.). | Panel | | | ptype : StringThe 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
@@ -621,7 +627,7 @@ 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
+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.
@@ -645,12 +651,12 @@ 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.
- Also see the added and removed events. | Component | | | region : StringNote: this config is only used when this BoxComponent is rendered
+ 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').
- See Ext.layout.BorderLayout also. | BoxComponent | | | renderTo : MixedSpecify the id of the element, a DOM element or an existing Element that this component
-will be rendered into.
+ See Ext.layout.BorderLayout also. | BoxComponent | | | renderTo : MixedSpecify 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.
- Notes :
@@ -661,18 +667,18 @@ to render and manage its child items. When using this config, a call to render() is not required.
- See render also. | Component | | | resizeEvent : String The event to listen to for resizing in layouts. Defaults to 'bodyresize'. | Panel | | | stateEvents : ArrayAn array of events that, when fired, should trigger this component to
+ See render also. | Component | | | resizeEvent : String The event to listen to for resizing in layouts. Defaults to 'bodyresize'. | Panel | | | 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
(e.g., ['click', 'customerchange']).
See stateful for an explanation of saving and
-restoring Component state. | Component | | | stateId : StringThe unique id for this component to use for state management purposes
+restoring Component state. | Component | | | stateId : StringThe 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 stateful for an explanation of saving and
-restoring Component state. | Component | | | stateful : BooleanA flag which causes the Component to attempt to restore the state of
+restoring Component state. | Component | | | stateful : BooleanA 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 stateId or id assigned
@@ -708,7 +714,7 @@ properties into the object, but a developer may override this to support
more behaviour.
You can perform extra processing on state save and restore by attaching
handlers to the beforestaterestore, staterestore,
-beforestatesave and statesave events. | Component | | | style : StringA custom style specification to be applied to this component's Element. Should be a valid argument to
+ beforestatesave and statesave events. | Component | | | style : StringA 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.
new Ext.Panel({
@@ -731,38 +737,38 @@ Ext.Element.ap...
A custom style specification to be appl
}
})
]
-}); | Component | | | tabTip : StringNote: this config is only used when this BoxComponent is a child item of a TabPanel.
+}); | 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 | | | tbarCfg : ObjectA DomHelper element specification object specifying the element structure
+must be called in order for the tips to render. | BoxComponent | | | 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
-element will get created. | Panel | | | titleCollapse : Booleantrue to allow expanding and collapsing the panel (when collapsible = true)
+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
BorderLayout.Region
- floatable config option. | Panel | | | tpl : MixedAn Ext.Template, Ext.XTemplate
-or an array of strings to form an Ext.XTemplate.
+ floatable config option. | Panel | | | tpl : MixedAn Ext.Template, Ext.XTemplate
+or an array of strings to form an Ext.XTemplate.
Used in conjunction with the data and... | Component | | | tplWriteMode : StringThe Ext.(X)Template method to use when
-updating the content area of the Component. Defaults to 'overwrite'
+Used in conjunction with the data and
+ tplWriteMode configurations. | Component | | | tplWriteMode : StringThe Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
(see Ext.X... The Ext.(X)Template method to use when
updating the content area of the Component. Defaults to 'overwrite'
-(see Ext.XTemplate.overwrite). | Component | | | unstyled : Boolean | Component | | | 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 for Ext layouts to function (e.g. overflow:hidden). | Panel | | | width : NumberThe width of this component in pixels (defaults to auto).
+the panel unstyled except for required attributes for Ext layouts to function (e.g. overflow:hidden). | Panel | | | 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 | | | y : Number The local y (top) coordinate for this component if contained within a positioning container. | BoxComponent |
Public Properties|
| | body : Ext.ElementThe Panel's body Element which may be used to contain HTML content.
+ 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 | | | y : Number The local y (top) coordinate for this component if contained within a positioning container. | BoxComponent |
Public Properties|
| | body : Ext.ElementThe 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.
@@ -773,11 +779,11 @@ 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
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
+(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
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 | | | disabled : Boolean True if this component is disabled. Read-only. | Component | | | el : Ext.ElementThe Ext.Element which encapsulates this Component. Read-only.
+in order to supply behaviour for each stage of the drag/drop process. See draggable. | Panel | | | disabled : Boolean True if this component is disabled. Read-only. | Component | | | el : Ext.ElementThe 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 autoEl config.
@@ -794,17 +800,19 @@ config for a suggestion, or use a render listener directly: new
single: true // Remove the listener after first invocation
}
});
- See also getEl | Component | | | hidden : Boolean True if this component is hidden. Read-only. | Component | | | initialConfig : Object This Component's initial configuration specification. Read-only. | Component | | | items : MixedCollection | Container | | | ownerCt : Ext.ContainerThis Component's owner Container (defaults to undefined, and is set automatically when
+ See also getEl | Component | | | hidden : Boolean True if this component is hidden. Read-only. | Component | | | initialConfig : Object This Component's initial configuration specification. Read-only. | Component | | | items : MixedCollection | Container | | | 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
+ Note: to access items within the Container see itemId. | Component | | | private : ObjectWe can only lay out if there is a view area in which to layout.
+display:none on the layout target, *or any of its par... We can only lay out if there is a view area in which to layout.
+display:none on the layout target, *or any of its parent elements* will mean it has no view area. | Container | | | 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 |
Public Methods|
| | FieldSet( Object config )
- Parameters:config : ObjectConfiguration options
Returns: | FieldSet | | | add( Object/Array component, Object (Optional), Object (Optional) )
- :
- Ext.ComponentAdds Component(s) to this Container.
-Description :
-<ul class="mdetail-params">
+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 |
Public Methods|
| | FieldSet( Object config )
+ Parameters:config : ObjectConfiguration options
Returns: | FieldSet | | | add( Object/Array component, Object (Optional), Object (Optional) )
+ :
+ Ext.ComponentAdds Component(s) to this Container.
+Description :
+<ul class="mdetail-params">
Fires the beforeadd event before addin... Adds Component(s) to this Container.
Description :
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 )
- :
- Ext.ButtonAdds a button to this panel. Note that this method must be called prior to rendering. The preferred
+ items for additional information. (Optional) : Objectcomponent_2 (Optional) : Objectcomponent_n 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 )
- :
- 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. )
- :
+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|String o, string Optional. )
+ :
voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. | Observable | | | addListener( String eventName, Function handler, [Object scope], [Object options] )
- :
+Usage:this.addEvents('storeloaded', 'storecleared');
Returns: | Observable | | | addListener( String eventName, Function handler, [Object scope], [Object options] )
+ :
voidAppends an event handler to this object. Appends an event handler to this object. Parameters:eventName : StringThe name of the event to listen for. handler : FunctionThe method the event invokes. scope : Object(optional) The scope (this reference) in which the handler function is executed.
If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration.
properties. This may contain any of the following properties:
@@ -890,49 +898,45 @@ Or a shorthand syntax:
'mouseover' : this.onMouseOver,
'mouseout' : this.onMouseOut,
scope: this
-});
Returns: | Observable | | | applyToMarkup( String/HTMLElement el )
- :
- voidApply this component to existing markup that is valid. With this function, no call to render() is required. Apply this component to existing markup that is valid. With this function, no call to render() is required. | Component | | | bubble( Function fn, [Object scope], [Array args] )
- :
+});Returns: | Observable | | | applyToMarkup( String/HTMLElement el )
+ :
+ voidApply this component to existing markup that is valid. With this function, no call to render() is required. Apply this component to existing markup that is valid. With this function, no call to render() is required. | Component | | | 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. | Container | | | canLayout()
- :
- voidWe can only lay out if there is a view area in which to layout.
-display:none on the layout target, *or any of its par... We can only lay out if there is a view area in which to layout.
-display:none on the layout target, *or any of its parent elements* will mean it has no view area. | Container | | | cascade( Function fn, [Object scope], [Array args] )
- :
+the bubble is stopped. | Container | | | cascade( Function fn, [Object scope], [Array args] )
+ :
Ext.ContainerCascades down the component/container heirarchy from this component (called first), calling the specified function wi... Cascades down the component/container heirarchy from this component (called first), 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 cascade is stopped on that branch. | Container | | | cloneConfig( Object overrides )
- :
+the cascade is stopped on that branch. | 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. | Component | | | collapse( Boolean animate )
- :
- Ext.PanelCollapses the panel body so that it becomes hidden. Fires the beforecollapse event which will
+An id property can be passed on this object, otherwise one will be generated to avoid duplicates. Returns: | 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:animate : BooleanTrue to animate the transition, else false (defaults to the value of the
- animCollapse panel config)
Returns: | Panel | | | destroy()
- :
- voidDestroys this component by purging any event listeners, removing the component's element from the DOM,
+ animCollapse panel config) | Panel | | | destroy()
+ :
+ voidDestroys 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. | Component | | | disable()
- :
- Ext.ComponentDisable this component and fire the 'disable' event. Disable this component and fire the 'disable' event. | Component | | | doLayout( [Boolean shallow], [Boolean force] )
- :
- Ext.ContainerForce this container's layout to be recalculated. A call to this function is required after adding a new component
+should usually not need to be called directly. | Component | | | disable()
+ :
+ Ext.ComponentDisable this component and fire the 'disable' event. Disable this component and fire the 'disable' event. | Component | | | doLayout( [Boolean shallow], [Boolean force] )
+ :
+ Ext.ContainerForce this container's layout to be recalculated. A call to this function is required after adding a new component
to... Force this container's layout to be recalculated. A call to this function is required after adding a new component
to an already rendered container, or possibly after changing sizing/position properties of child components. Parameters:shallow : Boolean(optional) True to only calc the layout of this component, and let child components auto
-calc layouts as required (defaults to false, which calls doLayout recursively for each subcontainer) force : Boolean(optional) True to force a layout to occur, even if the item is hidden.
Returns: | Container | | | enable()
- :
- Ext.ComponentEnable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. | Component | | | enableBubble( String/Array events )
- :
- voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
+calc layouts as required (defaults to false, which calls doLayout recursively for each subcontainer) force : Boolean(optional) True to force a layout to occur, even if the item is hidden. Returns: | Container | | | enable()
+ :
+ Ext.ComponentEnable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. | 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
@@ -964,42 +968,42 @@ access the required target more quickly.
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
+}); | 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:animate : BooleanTrue to animate the transition, else false (defaults to the value of the
- animCollapse panel config)
Returns: | Panel | | | find( String prop, String value )
- :
- ArrayFind a component under this container at any level by property Find a component under this container at any level by property Parameters:prop : Stringvalue : String
Returns:ArrayArray of Ext.Components
| Container | | | findBy( Function fn, [Object scope] )
- :
- ArrayFind a component under this container at any level by a custom function. If the passed function returns
+ animCollapse panel config) | Panel | | | find( String prop, String value )
+ :
+ ArrayFind a component under this container at any level by property Find a component under this container at any level by property Parameters:prop : Stringvalue : String
Returns:ArrayArray of Ext.Components
| Container | | | findBy( Function fn, [Object scope] )
+ :
+ ArrayFind a component under this container at any level by a custom function. If the passed function returns
true, the com... Find a component under this container at any level by a custom function. If the passed function returns
-true, the component will be included in the results. The passed function is called with the arguments (component, this container). Parameters:fn : FunctionThe function to call scope : Object(optional)
Returns:ArrayArray of Ext.Components
| Container | | | findById( String id )
- :
- Ext.ComponentFind a component under this container at any level by id Find a component under this container at any level by id | Container | | | findByType( String/Class xtype, [Boolean shallow] )
- :
+true, the component will be included in the results. The passed function is called with the arguments (component, this container).Parameters:fn : FunctionThe function to call scope : Object(optional)
Returns:ArrayArray of Ext.Components
| Container | | | findById( String id )
+ :
+ Ext.ComponentFind a component under this container at any level by id Find a component under this container at any level by id | Container | | | findByType( String/Class xtype, [Boolean shallow] )
+ :
ArrayFind a component under this container at any level by xtype or class Find a component under this container at any level by xtype or class Parameters:xtype : String/ClassThe xtype string for a component, or the class of the component directly 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:ArrayArray of Ext.Components
| Container | | | findParentBy( Function fn )
- :
- Ext.ContainerFind a container above this component at any level by a custom function. If the passed function returns
+the default), or true to check whether this Component is directly of the specified xtype. Returns:ArrayArray of Ext.Components
| Container | | | 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. | 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 | Component | | | fireEvent( String eventName, Object... args )
- :
- BooleanFires the specified event with the passed parameters (minus the event name).
+true, the container will be returned. | 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 | 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... | Observable | | | 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:Returns:Ext.ComponentExt.Component
| Container | | | 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 | | | getComponent( String/Number comp )
- :
- Ext.ComponentExamines this container's items property
+by calling enableBubble. | Observable | | | 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:Returns:Ext.ComponentExt.Component
| Container | | | 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 | | | getComponent( String/Number comp )
+ :
+ Ext.ComponentExamines this container's items property
and gets a direct child component of this container. Examines this container's items property
and gets a direct child component of this container. | Container | | | getEl()
- :
- Ext.Element | Container | | | 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.
@@ -1026,51 +1030,51 @@ or use a render listener directly: new Ext.Panel({
},
single: true // Remove the listener after first invocation
}
-});
| Component | | | getFrameHeight()
- :
- NumberReturns the height in pixels of the framing elements of this panel (including any top and bottom bars and
+}); | Component | | | getFrameHeight()
+ :
+ NumberReturns 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. | Panel | | | getFrameWidth()
- :
- NumberReturns the width in pixels of the framing elements of this panel (not including the body width). To
+header and footer elements, but not including the body height). To retrieve the body height see getInnerHeight. | Panel | | | getFrameWidth()
+ :
+ NumberReturns 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. | Panel | | | getHeight()
- :
- NumberGets the current height of the component's underlying element. Gets the current height of the component's underlying element. | BoxComponent | | | getId()
- :
- StringReturns the id of this component or automatically generates and
+retrieve the body width see getInnerWidth. | Panel | | | getHeight()
+ :
+ NumberGets the current height of the component's underlying element. Gets the current height of the component's underlying element. | BoxComponent | | | getId()
+ :
+ StringReturns 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: 'ext-comp-' + (++Ext.Component.AUTO_ID)
| Component | | | getInnerHeight()
- :
- NumberReturns the height in pixels of the body element (not including the height of any framing elements).
+returns an id if an id is not defined yet: 'ext-comp-' + (++Ext.Component.AUTO_ID)
| Component | | | getInnerHeight()
+ :
+ NumberReturns 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. | Panel | | | getInnerWidth()
- :
- NumberReturns the width in pixels of the body element (not including the width of any framing elements).
+For the frame height see getFrameHeight. | Panel | | | getInnerWidth()
+ :
+ NumberReturns 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. | Panel | | | getItemId()
- :
- StringReturns the itemId of this component. If an
-itemId was not assigned through configuration the
+For the frame width see getFrameWidth. | Panel | | | getItemId()
+ :
+ StringReturns the itemId of this component. If an
+itemId was not assigned through configuration the
id is returned using g... Returns the itemId of this component. If an
itemId was not assigned through configuration the
- id is returned using getId. | Component | | | getLayout()
- :
- ContainerLayoutReturns the layout currently in use by the container. If the container does not currently have a layout
+ id is returned using getId. | Component | | | getLayout()
+ :
+ ContainerLayoutReturns the layout currently in use by the container. If the container does not currently have a layout
set, a defau... Returns the layout currently in use by the container. If the container does not currently have a layout
-set, a default Ext.layout.ContainerLayout will be created and set as the container's layout. | Container | | | getLayoutTarget()
- :
- Ext.ElementReturns the Element to be used to contain the child Components of this Container.
+set, a default Ext.layout.ContainerLayout will be created and set as the container's layout. | Container | | | getLayoutTarget()
+ :
+ Ext.ElementReturns 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. | Container | | | getOuterSize()
- :
- ObjectGets 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. | 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. | BoxComponent | | | getResizeEl()
- :
- Ext.ElementReturns the outermost Element of this Component which defines the Components overall size.
+the element into which the layout renders child Components. | Container | | | getOuterSize()
+ :
+ ObjectGets 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. | 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. | BoxComponent | | | getResizeEl()
+ :
+ Ext.ElementReturns 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
@@ -1078,40 +1082,40 @@ 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 | | | getSize()
- :
- ObjectGets the current size of the component's underlying element. Gets the current size of the component's underlying element. | BoxComponent | | | getTool( String id )
- :
- Object | Panel | | | getUpdater()
- :
- Ext.UpdaterGet the Ext.Updater for this panel. Enables you to perform Ajax updates of this panel's body. Get the Ext.Updater for this panel. Enables you to perform Ajax updates of this panel's body. | Panel | | | getWidth()
- :
- NumberGets the current width of the component's underlying element. Gets the current width of the component's underlying element. | BoxComponent | | | getXType()
- :
- StringGets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
+This Element is returned as the resizeEl. | BoxComponent | | | getSize()
+ :
+ ObjectGets the current size of the component's underlying element. Gets the current size of the component's underlying element. | BoxComponent | | | getTool( String id )
+ :
+ Object | Panel | | | getUpdater()
+ :
+ Ext.UpdaterGet the Ext.Updater for this panel. Enables you to perform Ajax updates of this panel's body. Get the Ext.Updater for this panel. Enables you to perform Ajax updates of this panel's body. | Panel | | | getWidth()
+ :
+ NumberGets the current width of the component's underlying element. Gets the current width of the component's underlying element. | BoxComponent | | | getXType()
+ :
+ StringGets 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:
var t = new Ext.form.TextField();
-alert(t.getXType()); // alerts 'textfield'
| Component | | | getXTypes()
- :
- StringReturns this Component's xtype hierarchy as a slash-delimited string. For a list of all
+alert(t.getXType()); // alerts 'textfield' | Component | | | getXTypes()
+ :
+ StringReturns 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:
var t = new Ext.form.TextField();
-alert(t.getXTypes()); // alerts 'component/box/field/textfield'
| 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 | Observable | | | hide()
- :
- Ext.ComponentHide this component. Listen to the 'beforehide' event and return
+alert(t.getXTypes()); // alerts 'component/box/field/textfield' | 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 | Observable | | | hide()
+ :
+ Ext.ComponentHide 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. | Component | | | insert( Number index, Ext.Component component )
- :
- Ext.ComponentInserts a Component into this Container at a specified index. Fires the
+the component is configured to be hidden. | Component | | | insert( Number index, Ext.Component component )
+ :
+ Ext.ComponentInserts a Component into this Container at a specified index. Fires the
beforeadd event before inserting, then fires ... Inserts a Component into this Container at a specified index. Fires the
beforeadd event before inserting, then fires the add event after the
Component has been inserted. Parameters:index : NumberThe index at which the Component will be inserted
@@ -1123,12 +1127,12 @@ constructing a real Component object if lazy rendering might mean that the
inserted Component will not be rendered immediately. To take advantage of
this 'lazy instantiation', set the Ext.Component.xtype config
property to the registered type of the Component wanted.
-For a list of all available xtypes, see Ext.Component.
Returns: | Container | | | isVisible()
- :
- BooleanReturns true if this component is visible. Returns true if this component is visible. | 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
+For a list of all available xtypes, see Ext.Component. | Container | | | isVisible()
+ :
+ BooleanReturns true if this component is visible. Returns true if this component is visible. | 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
@@ -1139,8 +1143,8 @@ 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 | | | load( Object/String/Function config )
- :
+the default), or true to check whether this Component is directly of the specified xtype.Returns: | Component | | | load( Object/String/Function config )
+ :
Ext.PanelLoads this content panel immediately with content returned from an XHR call. Loads this content panel immediately with content returned from an XHR call. Parameters:config : Object/String/FunctionA config object containing any of the following options:
panel.load({
url: 'your-url.php',
@@ -1155,9 +1159,9 @@ the default), or true to check whether this Component is directly of the specifi
});
The only required property is url. The optional properties nocache, text and scripts
are shorthand for disableCaching, indicatorText and loadScripts and are used to set their
-associated property on this panel Updater instance.
Returns: | Panel | | | 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
+associated property on this panel Updater instance. Returns: | Panel | | | 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});
@@ -1170,41 +1174,41 @@ myGridPanel.mon(myGridPanel.getSelectionModel(), {
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 )
- :
+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] )
- :
+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] )
+ :
voidAppends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:eventName : StringThe type of event to listen for handler : FunctionThe method the event invokes scope : Object(optional) The scope (this reference) in which the handler function is executed.
-If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration.
Returns: | Observable | | | onCheckClick()
- :
- voidThis function is called by the fieldset's checkbox when it is toggled (only applies when
+If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration. Returns: | Observable | | | onCheckClick()
+ :
+ voidThis function is called by the fieldset's checkbox when it is toggled (only applies when
checkboxToggle = true). Th... This function is called by the fieldset's checkbox when it is toggled (only applies when
checkboxToggle = true). This method should never be called externally, but can be
-overridden to provide custom behavior when the checkbox is toggled if needed. | FieldSet | | | previousSibling()
- :
- Ext.ComponentReturns the previous component in the owning container Returns the previous component in the owning container | Component | | | purgeListeners()
- :
- voidRemoves all listeners for this object Removes all listeners for this object | Observable | | | relayEvents( Object o, Array events )
- :
- voidRelays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by this. | Observable | | | remove( Component/String component, [Boolean autoDestroy] )
- :
- Ext.ComponentRemoves a component from this container. Fires the beforeremove event before removing, then fires
+overridden to provide custom behavior when the checkbox is toggled if needed. | FieldSet | | | previousSibling()
+ :
+ Ext.ComponentReturns the previous component in the owning container Returns the previous component in the owning container | Component | | | purgeListeners()
+ :
+ voidRemoves all listeners for this object Removes all listeners for this object | Observable | | | relayEvents( Object o, Array events )
+ :
+ voidRelays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by this. | Observable | | | remove( Component/String component, [Boolean autoDestroy] )
+ :
+ Ext.ComponentRemoves a component from this container. Fires the beforeremove event before removing, then fires
the remove event a... Removes a component from this container. Fires the beforeremove event before removing, then fires
the remove event after the component has been removed. | Container | | | removeAll( [Boolean autoDestroy] )
- :
+Defaults to the value of this Container's autoDestroy config.Returns: | Container | | | removeAll( [Boolean autoDestroy] )
+ :
ArrayRemoves all components from this container. Removes all components from this container. | Container | | | removeClass( string cls )
- :
- Ext.ComponentRemoves a CSS class from the component's underlying element. Removes a CSS class from the component's underlying element. | Component | | | removeListener( String eventName, Function handler, [Object scope] )
- :
- voidRemoves an event handler. Removes an event handler. | Observable | | | render( [Element/HTMLElement/String container], [String/Number position] )
- :
- voidRender this Component into the passed HTML element.
+Defaults to the value of this Container's autoDestroy config. | Container | | | removeClass( string cls )
+ :
+ Ext.ComponentRemoves a CSS class from the component's underlying element. Removes a CSS class from the component's underlying element. | Component | | | removeListener( String eventName, Function handler, [Object scope] )
+ :
+ voidRemoves an event handler. Removes an event handler. | 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.
@@ -1226,33 +1230,33 @@ have in mind.
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:container : Element/HTMLElement/String(optional) The element this Component should be
rendered into. If it is being created from existing markup, this should be omitted. position : String/Number(optional) The element ID or DOM node index within the container before
-which this component will be inserted (defaults to appending to the end of the container)
Returns: | Component | | | resumeEvents()
- :
- voidResume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
+which this component will be inserted (defaults to appending to the end of the container) Returns: | Component | | | resumeEvents()
+ :
+ voidResume firing events. (see suspendEvents)
+If events were suspended using the queueSuspended parameter, then all
event... Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
-events fired during event suspension will be sent to any listeners now. | Observable | | | setAutoScroll( Boolean scroll )
- :
- Ext.BoxComponentSets the overflow on the content element of the component. Sets the overflow on the content element of the component. | BoxComponent | | | setDisabled( Boolean disabled )
- :
- Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. | Component | | | setHeight( Number height )
- :
+events fired during event suspension will be sent to any listeners now. | Observable | | | setAutoScroll( Boolean scroll )
+ :
+ Ext.BoxComponentSets the overflow on the content element of the component. Sets the overflow on the content element of the component. | BoxComponent | | | setDisabled( Boolean disabled )
+ :
+ Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. | Component | | | setHeight( Number 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 : NumberThe new height to set. This may be one of:
- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
- A String used to set the CSS height style.
- undefined to leave the height unchanged.
-
Returns: | BoxComponent | | | setPagePosition( Number x, Number y )
- :
- Ext.BoxComponentSets the page XY position of the component. To set the left and top instead, use setPosition.
+ | BoxComponent | | | 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:x : NumberThe new x position y : NumberThe new y position
Returns: | 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 the move event. Parameters:x : NumberThe new x position y : NumberThe new y position
Returns: | 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:left : NumberThe new left top : NumberThe new top
Returns: | BoxComponent | | | setSize( Mixed width, Mixed height )
- :
- Ext.BoxComponentSets the width and height of this BoxComponent. This method fires the resize event. This method can accept
+This method fires the move event. Parameters:left : NumberThe new left top : NumberThe new top
Returns: | BoxComponent | | | 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:width : MixedThe new width to set. This may be one of:
- A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels).
@@ -1264,126 +1268,126 @@ This may be one of:
- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
- A String used to set the CSS height style. Animation may not be used.
undefined to leave the height unchanged.
| BoxComponent | | | setTitle( String title, [String iconCls] )
- :
- voidSets the title text for the panel and optionally the icon class.
+ | 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 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 )
- :
+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.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:
Returns: | BoxComponent | | | show()
- :
- Ext.ComponentShow this component. Listen to the 'beforeshow' event and return
+ | BoxComponent | | | show()
+ :
+ Ext.ComponentShow 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. | Component | | | suspendEvents( Boolean queueSuspended )
- :
+event after showing the component. | Component | | | suspendEvents( Boolean queueSuspended )
+ :
voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:queueSuspended : BooleanPass as true to queue up suspended events to be fired
-after the resumeEvents call instead of discarding all suspended events;
Returns: | Observable | | | syncSize()
- :
- Ext.BoxComponentForce 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. | BoxComponent | | | toggleCollapse( Boolean animate )
- :
+after the resumeEvents call instead of discarding all suspended events;Returns: | Observable | | | syncSize()
+ :
+ Ext.BoxComponentForce 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. | 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: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 | | | update( Mixed htmlOrData, [Boolean loadScripts], [Function callback] )
- :
+animCollapse panel config)Returns: | Panel | | | un( String eventName, Function handler, [Object scope] )
+ :
+ 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|
| | add :
- ( Ext.Container this, Ext.Component component, Number index )
- Listeners will be called with the following arguments: | Container | | | 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.
+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|
| | add :
+ ( Ext.Container this, Ext.Component component, Number index )
+ Listeners will be called with the following arguments: | Container | | | 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 | | | beforeadd :
- ( Ext.Container this, Ext.Component component, Number index )
- Fires before any Ext.Component is added or inserted into the container.
+has been restored. Listeners will be called with the following arguments: | Component | | | beforeadd :
+ ( Ext.Container this, Ext.Component component, Number index )
+ Fires before any Ext.Component is added or inserted into the container.
A handler can return false to cancel the add. Fires before any Ext.Component is added or inserted into the container.
-A handler can return false to cancel the add. Listeners will be called with the following arguments: | Container | | | 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 | | | 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 )
- 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 | | | beforehide :
- ( Ext.Component this )
- Fires before the component is hidden by calling the hide method.
+A handler can return false to cancel the add. Listeners will be called with the following arguments: | Container | | | 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 | | | 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 )
+ 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 | | | 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 | | | beforeremove :
- ( Ext.Container this, Ext.Component component )
- Fires before any Ext.Component is removed from the container. A handler can return
+Return false from an event handler to stop the hide. Listeners will be called with the following arguments: | Component | | | beforeremove :
+ ( Ext.Container this, Ext.Component component )
+ Fires before any Ext.Component is removed from the container. A handler can return
false to cancel the remove. Fires before any Ext.Component is removed from the container. A handler can return
-false to cancel the remove. Listeners will be called with the following arguments: | Container | | | beforerender :
- ( Ext.Component this )
- Fires before the component is rendered. Return false from an
+false to cancel the remove. Listeners will be called with the following arguments: | Container | | | beforerender :
+ ( Ext.Component this )
+ Fires before the component is rendered. Return false from an
event handler to stop the render. Fires before the component is rendered. Return false from an
-event handler to stop the render. Listeners will be called with the following arguments: | Component | | | beforeshow :
- ( Ext.Component this )
- Fires before the component is shown by calling the show method.
+event handler to stop the render. Listeners will be called with the following arguments: | 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 )
+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:this : Ext.Componentstate : ObjectThe hash of state values returned from the StateProvider. If this
event is not vetoed, then the state object is passed to applyState. By default,
that simply copies property values into this Component. The method maybe overriden to
-provide custom state restoration.
| Component | | | beforestatesave :
- ( Ext.Component this, Object state )
+provide custom state restoration. | 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:this : Ext.Componentstate : ObjectThe hash of state values. This is determined by calling
getState() on the Component. This method must be provided by the
developer to return whetever representation of state is required, by default, Ext.Component
-has a null implementation.
| Component | | | 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 | | | 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 | | | 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 | | | 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 | | | hide :
- ( Ext.Component this )
- Fires after the component is hidden.
+has a null implementation. | Component | | | 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 | | | 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 | | | 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 | | | 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 | | | 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:p : Ext.PanelThe : Stringnew icon class. The : Stringold icon class.
| Panel | | | 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:this : Ext.Componentx : NumberThe new x position y : NumberThe new y position
| BoxComponent | | | remove :
- ( Ext.Container this, Ext.Component component )
- Listeners will be called with the following arguments: | Container | | | 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:this : Ext.ComponentadjWidth : NumberThe box-adjusted width that was set adjHeight : NumberThe box-adjusted height that was set rawWidth : NumberThe width that was originally specified rawHeight : NumberThe height that was originally specified
| 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 | | | staterestore :
- ( Ext.Component this, Object state )
+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:p : Ext.PanelThe : Stringnew icon class. The : Stringold icon class.
| Panel | | | 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:this : Ext.Componentx : NumberThe new x position y : NumberThe new y position
| BoxComponent | | | remove :
+ ( Ext.Container this, Ext.Component component )
+ Listeners will be called with the following arguments: | Container | | | 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:this : Ext.ComponentadjWidth : NumberThe box-adjusted width that was set adjHeight : NumberThe box-adjusted height that was set rawWidth : NumberThe width that was originally specified rawHeight : NumberThe height that was originally specified
| 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 | | | 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 )
+Component. The method maybe overriden to provide custom state restoration. | 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:this : Ext.Componentstate : ObjectThe hash of state values. This is determined by calling
getState() on the Component. This method must be provided by the
developer to return whetever representation of state is required, by default, Ext.Component
-has a null implementation.
| Component | | | titlechange :
- ( Ext.Panel p, String The )
+has a null implementation. | Component | | | titlechange :
+ ( Ext.Panel p, String The )
Fires after the Panel title has been set or changed. Fires after the Panel title has been set or changed. Listeners will be called with the following arguments: | Panel |
|