| 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 | 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 | | autoEl : MixedA tag name or DomHelper spec used to create the Element which will
-encapsulate this Component.
-You do not normally ne... A tag name or DomHelper spec used to create the Element which will
-encapsulate this Component.
- You do not normally need to specify this. For the base classes Ext.Component, Ext.BoxComponent,
-and Ext.Container, this defaults to 'div'. The more complex Ext classes use a more complex
-DOM structure created by their own onRender methods.
- This is intended to allow the developer to create application-specific utility Components encapsulated by
-different DOM elements. Example usage: {
- xtype: 'box',
- autoEl: {
- tag: 'img',
- src: 'http://www.example.com/example.jpg'
- }
-}, {
- xtype: 'box',
- autoEl: {
- tag: 'blockquote',
- html: 'autoEl is cool!'
- }
-}, {
- xtype: 'container',
- autoEl: 'ul',
- cls: 'ux-unordered-list',
- items: {
- xtype: 'box',
- autoEl: 'li',
- html: 'First list item'
- }
-}
| Component | | autoHeight : Booleantrue to use height:'auto', false to use fixed height (defaults to false).
-Note: Setting autoHeight:true means that th... true to use height:'auto', false to use fixed height (defaults to false).
-Note: Setting autoHeight:true means that the browser will manage the panel's height
+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
+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.
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 panel's body element and show scroll bars automatically when
-necessary, false to c... true to use overflow:'auto' on the panel's body element and show scroll bars automatically when
-necessary, false to clip any overflowing content (defaults to false). | Panel | | autoShow : BooleanTrue if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
+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
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
Container's layout manage... True to use width:'auto', false to use fixed width (or allow it to be managed by its parent
@@ -137,18 +108,18 @@ child items when the browser changes its width: var myPanel = <
buttons/button co...
The bottom toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of
buttons/button configs to be added to the toolbar. Note that this is not available as a property after render.
To access the bottom toolbar after render, use getBottomToolbar.
- Note: Although a Toolbar may contain Field components, these will not be updated by a load
+ Note: Although a Toolbar may contain Field components, these will not be updated by a load
of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and
so are not scanned to collect form items. However, the values will be submitted because form
submission parameters are collected from the DOM tree. | Panel | | bbarCfg : ObjectA DomHelper element specification object specifying the element structure
of this Panel's bbar Element. See bodyCfg ... A DomHelper element specification object specifying the element structure
-of this Panel's bbar Element. See bodyCfg also. | Panel | | bodyCfg : ObjectA DomHelper element specification object may be specified for any
+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
-create a child element with the commensurate Default class name (baseCls will be
-replaced by baseCls):
+create a child element with the commensurate Default class name ( baseCls will be
+replaced by baseCls ):
Panel Default Default Custom Additional Additional
Element element class element class style
@@ -182,21 +153,32 @@ element:
footerCssClass: 'custom-footer', // additional css class, see addClass
footerStyle: 'background-color:red' // see bodyStyle
});
- The example above also explicitly creates a footer with custom markup and
+ The example above also explicitly creates a footer with custom markup and
styling applied. | Panel | | bodyCssClass : String/Object/FunctionAdditional css class selector to be applied to the body element in the format expected by
Ext.Element.addClass (defau... | Panel | | bodyStyle : String/Object/FunctionCustom CSS styles to be applied to the body element in the format expected by
Ext.Element.applyStyles (defaults to nu... | Panel | | buttonAlign : StringThe alignment of any buttons added to this panel. Valid values are 'right',
-'left' and 'center' (defaults to 'right'... The alignment of any buttons added to this panel. Valid values are 'right',
- 'left' and 'center' (defaults to 'right'). | Panel | | buttons : Arraybuttons will be used as items for the toolbar in
-the footer (fbar). Typically the value of this configuration propert... | Panel | | boxMaxHeight : NumberThe maximum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size mana... The maximum value in pixels which this BoxComponent will set its height to.
+ Warning: This will override any size management applied by layout managers. | BoxComponent | | boxMaxWidth : NumberThe maximum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size manag... The maximum value in pixels which this BoxComponent will set its width to.
+ Warning: This will override any size management applied by layout managers. | BoxComponent | | boxMinHeight : NumberThe minimum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size mana... The minimum value in pixels which this BoxComponent will set its height to.
+ Warning: This will override any size management applied by layout managers. | BoxComponent | | boxMinWidth : NumberThe minimum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size manag... The minimum value in pixels which this BoxComponent will set its width to.
+ Warning: This will override any size management applied by layout managers. | BoxComponent | | bubbleEvents : ArrayAn array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.... | 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
+the footer (fbar). Typically the value of this configuration propert... buttons will be used as items for the toolbar in
+the footer ( fbar ). Typically the value of this configuration property will be
an array of Ext.Buttons or Ext.Button configuration objects.
-If an item is configured with minWidth or the Panel is configured with minButtonWidth,
+If an item is configured with minWidth or the Panel is configured with minButtonWidth ,
that width will be applied to the item. | Panel | | bwrapCfg : ObjectA DomHelper element specification object specifying the element structure
of this Panel's bwrap Element. See bodyCfg... A DomHelper element specification object specifying the element structure
-of this Panel's bwrap Element. See bodyCfg also. | Panel | | checkboxName : String | 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
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
@@ -213,36 +195,29 @@ manager (e.g. fieldLabel is specified or isFormField=true is specified.
See Ext.layout.FormLayout.fieldTpl also. | Component | | closable : BooleanPanels themselves do not directly support being closed, but some Panel subclasses do (like
Ext.Window) or a Panel Cla... Panels themselves do not directly support being closed, but some Panel subclasses do (like
- Ext.Window) or a Panel Class within an Ext.TabPanel. Specify true
-to enable closing in such situations. Defaults to false. | Panel | | cls : StringAn optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
+ Ext.Window) or a Panel Class within an Ext.TabPanel. Specify true
+to enable closing in such situations. Defaults to false . | Panel | | cls : StringAn optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
useful for ... An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
-useful for adding customized styles to the component or any of its children using standard CSS rules. | Component | | 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
+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
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 : StringSpecify the id of an existing HTML node to use as the panel's body content
-(defaults to '').
-Description :
-<div clas... Specify the id of an existing HTML node to use as the panel's body content
-(defaults to '').
-- Description :
-This config option is used to take an existing HTML element and place it in the body
-of a new panel (it simply moves the specified DOM element into the body element of the Panel
-when the Panel is rendered to use as the content (it is not going to be the
-actual panel itself).
-
-- Notes :
-The specified HTML Element is appended to the Panel's body Element by the
-Panel's afterRender method after any configured HTML has
-been inserted, and so the document will not contain this HTML at the time the
- render event is fired.
-The specified HTML element used will not participate in any layout scheme that the
-Panel may use. It's 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.
-
- | Panel | | ctCls : StringAn optional extra CSS class that will be added to this component's container. This can be useful for
+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.
+
+- Description :
+
This config option is used to take an existing HTML element and place it in the layout element
+of a new component (it simply moves the specified DOM element after the Component is rendered to use as the content.
+- Notes :
+
The specified HTML element is appended to the layout element of the component after any configured
+HTML has been inserted, and so the document will not contain this element at the time the render event is fired.
+The specified HTML element used will not participate in any layout
+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
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.
@@ -253,14 +228,19 @@ 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 | | defaults : ObjectA config object that will be applied to all components added to this container either via the items
-config or via the... A config object that will be applied to all components added to this container either via the items
-config or via the add or insert methods. The defaults config can contain any
-number of name/value property pairs to be added to each item, and should be valid for the types of items
-being added to the container. For example, to automatically apply padding to the body of each of a set of
-contained Ext.Panel items, you could pass: defaults: {bodyStyle:'padding:15px'}.
- Note: defaults will not be applied to config objects if the option is already specified.
-For example: defaults: { // defaults are applied to items, not the container
+
| 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
+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
+unconditionally applied. If the added item is an instantiated Component, then the default properties are
+applied conditionally so as not to override existing properties in the item.
+ If the defaults option is specified as a function, then the function will be called using this Container as the
+scope (this reference) and passing the added item as the first parameter. Any resulting object
+from that call is then applied to the item as default properties.
+ For example, to automatically apply padding to the body of each of a set of
+contained Ext.Panel items, you could pass: defaults: {bodyStyle:'padding:15px'} .
+ Usage: defaults: { // defaults are applied to items, not the container
autoScroll:true
},
items: [
@@ -274,7 +254,7 @@ items: [
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
-config on panels is that IE ... Render this panel disabled (default is false). An important note when using the disabled
+config on panels is that IE ... Render this panel disabled (default is false ). An important note when using the disabled
config on panels is that IE will often fail to initialize the disabled mask element correectly if
the panel's layout has not yet completed by the time the Panel is disabled during the render process.
If you experience this issue, you may need to instead use the afterlayout event to initialize
@@ -290,9 +270,9 @@ the disabled state:
}
}
}); | 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 conf... true to enable dragging of this Panel (defaults to false ).
For custom drag/drop implementations, an Ext.Panel.DD config could also be passed
-in this config instead of true. Ext.Panel.DD is an internal, undocumented class which
+in this config instead of true . Ext.Panel.DD is an internal, undocumented class which
moves a proxy Element around in place of the Panel's element, but provides no other behaviour
during dragging or on drop. It is a subclass of Ext.dd.DragSource, so behaviour may be
added by implementing the interface methods of Ext.dd.DragDrop e.g.:
@@ -334,8 +314,8 @@ added by implementing the interface methods of A Toolbar object, a Toolbar config, or an array of
Buttons/Button configs, describing a Toolbar to be rendered into this Panel's footer element.
After render, the fbar property will be an Toolbar instance.
-If buttons are specified, they will supersede the fbar configuration property.
-The Panel's buttonAlign configuration affects the layout of these items, for example:
+If buttons are specified, they will supersede the fbar configuration property.
+The Panel's buttonAlign configuration affects the layout of these items, for example:
var w = new Ext.Window({
height: 250,
width: 500,
@@ -346,7 +326,7 @@ The Panel's 'bbar Right'
}]
}),
- buttonAlign: 'left', // anything but 'center' or 'right' and you can use "-", and "->"
+ buttonAlign: 'left', // anything but 'center' or 'right' and you can use '-', and '->'
// to control the alignment of fbar items
fbar: [{
text: 'fbar Left'
@@ -354,7 +334,7 @@ The Panel's 'fbar Right'
}]
}).show();
-Note: Although a Toolbar may contain Field components, these will not be updated by a load
+ Note: Although a Toolbar may contain Field components, these will not be updated by a load
of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and
so are not scanned to collect form items. However, the values will be submitted because form
submission parameters are collected from the DOM tree. | Panel | | fieldLabel : StringThe label text to display next to this Component (defaults to '').
@@ -371,13 +351,19 @@ 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
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
@@ -406,11 +392,11 @@ 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
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 panel's body
-content (defaults to ''). The HTML content ... An HTML fragment, or a DomHelper specification to use as the panel's body
-content (defaults to ''). The HTML content is added by the Panel's afterRender method,
-and 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. | Panel | | id : StringThe unique id of this component (defaults to an auto-assigned id).
+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).
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).
@@ -488,7 +474,7 @@ shown (no sizing is done while hidden), or in response to a html with items .
| 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
+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.
@@ -611,22 +597,25 @@ to the second, and the bottom is set to the third.
If there are four values, they apply to the top, right, bottom, and left, respectively.
Defaults to: {top:0, right:0, bottom:0, left:0}
| BoxComponent | | maskDisabled : Booleantrue to mask the panel when it is disabled, false to not mask it (defaults
-to true). Either way, the panel will alwa... true to mask the panel when it is disabled, false to not mask it (defaults
-to true). Either way, the panel will always tell its contained elements to disable themselves
+to true). Either way, the panel will alwa... true to mask the panel when it is disabled, false to not mask it (defaults
+to true ). Either way, the panel will always tell its contained elements to disable themselves
when it is disabled, but masking the panel can provide an additional visual cue that the panel is
-disabled. | Panel | | minButtonWidth : NumberMinimum width in pixels of all buttons in this panel (defaults to 75) | Panel | | 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
over the Element, and... An optional extra CSS class that will be added to this component's Element when the mouse moves
over the Element, and removed when the mouse moves out. (defaults to ''). This can be
-useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules. | Component | | pageX : Number The page level x coordinate for this component if contained within a positioning container. | BoxComponent | | pageY : Number The page level y coordinate for this component if contained within a positioning container. | BoxComponent | | plugins : Object/ArrayAn object or array of objects that will provide custom functionality for this component. The only
+useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules. | Component | | padding : Number/StringA shortcut for setting a padding style on the body element. The value can either be
+a number to be applied to all sid... A shortcut for setting a padding style on the body element. The value can either be
+a number to be applied to all sides, or a normal css string describing padding.
+Defaults to undefined. | Panel | | pageX : Number The page level x coordinate for this component if contained within a positioning container. | BoxComponent | | pageY : Number The page level y coordinate for this component if contained within a positioning container. | BoxComponent | | 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'
-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, 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
@@ -638,9 +627,9 @@ object. The ptype will be looked up at render time up to determine
type of Plugin to create.
If you create your own Plugins, you may register them using
Ext.ComponentMgr.registerPlugin in order to be able to
-take advantage of lazy instantiation and rendering. | Component | | ref : StringA path specification, relative to the Component's ownerCt specifying into which
-ancestor Container to place a named r... A path specification, relative to the Component's ownerCt specifying into which
-ancestor Container to place a named reference to this Component.
+take advantage of lazy instantiation and rendering. | Component | | ref : StringA path specification, relative to the Component's ownerCt
+specifying into which ancestor Container to place a named r... A path specification, relative to the Component's ownerCt
+specifying into which ancestor Container to place a named reference to this Component.
The ancestor axis can be traversed by using '/' characters in the path.
For example, to put a reference to a Toolbar Button into the Panel which owns the Toolbar: var myGrid = new Ext.grid.EditorGridPanel({
title: 'My EditorGridPanel',
@@ -659,9 +648,10 @@ For example, to put a reference to a Toolbar Button into the Panel which owns
}
}
});
- In the code above, if the ref had been 'saveButton' the reference would
-have been placed into the Toolbar. Each '/' in the ref moves up one level from the
-Component's ownerCt. | Component | | region : StringNote: this config is only used when this BoxComponent is rendered
+ In the code above, if the ref had been 'saveButton'
+the reference would have been placed into the Toolbar. Each '/' in the ref
+moves up one level from the Component's ownerCt .
+ Also see the added and removed events. | Component | | region : StringNote: this config is only used when this BoxComponent is rendered
by a Container which has been configured to use the... Note: this config is only used when this BoxComponent is rendered
by a Container which has been configured to use the BorderLayout
layout manager (e.g. specifying layout:'border').
@@ -677,7 +667,7 @@ to render and manage its child items.
When using this config, a call to render() is not required.
-See render also. | Component | | 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
@@ -747,17 +737,35 @@ Ext.Element.ap... A custom style specification to be appl
}
})
]
-}); | Component | | tbarCfg : ObjectA DomHelper element specification object specifying the element structure
+}); | 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
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 | | 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
+ header (defaults to ''). When a title is specified the
+ header element will automatically be created and displayed unless
+ header is explicitly set to false . If you do not want to specify a
+ title at config time, but you may want one later, you must either specify a non-empty
+ title (a blank space ' ' will do) or header:true so that the container
+element will get created. | Panel | | titleCollapse : Booleantrue to allow expanding and collapsing the panel (when collapsible = true)
+by clicking anywhere in the header bar, fa... true to allow expanding and collapsing the panel (when collapsible = true )
+by clicking anywhere in the header bar, false ) to allow it only by clicking to tool button
+(defaults to false )). If this panel is a child item of a border layout also see the
+ BorderLayout.Region
+ 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'
+(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 : 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).
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.
@@ -769,7 +777,7 @@ the Panel may not be used as a Layout for hosting nested Panels.
If this Panel is intended to be used as the host of a Layout (See layout
then the body Element must not be loaded or changed - it is under the control
of the Panel's Layout.
-
Note: see the Note for el also. | Panel | | buttons : ArrayThis Panel's Array of buttons as created from the buttons
+ Note: see the Note for el also. | Panel | | buttons : ArrayThis Panel's Array of buttons as created from the buttons
config property. Read only. | Panel | | bwrap : Ext.ElementThe Panel's bwrap Element used to contain other Panel elements
(tbar, body, bbar, footer). See bodyCfg. Read-only. | Panel | | collapsed : Boolean True if this panel is collapsed. Read-only. | Panel | | dd : Ext.dd.DragSource.If this Panel is configured draggable, this property will contain
an instance of Ext.dd.DragSource which handles drag... If this Panel is configured draggable, this property will contain
@@ -792,11 +800,15 @@ 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.ContainerThe component's owner Ext.Container (defaults to undefined, and is set automatically when
-the component is added to a... The component's owner Ext.Container (defaults to undefined, and is set automatically when
-the component is added to a container). Read-only.
- Note: to access items within the container see itemId. | Component | | rendered : Boolean True if this component has been rendered. Read-only. | Component |
Public Methods|
| FieldSet( Object config )
- Parameters:config : ObjectConfiguration options Returns: | FieldSet | | add( Object/Array component , Object (Optional) , Object (Optional) )
+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 | | 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.Component | Panel | | addClass( string cls )
+button config, an object will be treated as a button config object.handler : Functionscope : ObjectThe scope (this reference) in which the button handler function is executed. Defaults to the Button. Returns: | Panel | | addClass( string cls )
:
- Ext.ComponentAdds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. | Component | | addEvents( Object object )
+ Ext.ComponentAdds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. | Component | | addEvents( Object|String o , string Optional. )
:
- voidUsed to define events on this Observable Used to define events on this Observable | Observable | | addListener( String eventName , Function handler , [Object scope ], [Object options ] )
+ voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. | Observable | | addListener( String eventName , Function handler , [Object scope ], [Object options ] )
:
voidAppends an event handler to this object. Appends an event handler to this object. Parameters:eventName : StringThe name of the event to listen for. handler : FunctionThe method the event invokes. scope : Object(optional) The scope (this reference) in which the handler function is executed.
If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration.
@@ -854,8 +868,8 @@ Using the options argument, it is possible to combine different types of listene
A delayed, one-time listener.
myDataView.on('click', this.onClick, this, {
- single: true,
- delay: 100
+single: true,
+delay: 100
});
Attaching multiple handlers in 1 call
@@ -863,27 +877,27 @@ The method also allows for a single argument to be passed which is a config obje
which specify multiple handlers.
myGridPanel.on({
- 'click' : {
- fn: this.onClick,
- scope: this,
- delay: 100
- },
- 'mouseover' : {
- fn: this.onMouseOver,
- scope: this
- },
- 'mouseout' : {
- fn: this.onMouseOut,
- scope: this
- }
+'click' : {
+ fn: this.onClick,
+ scope: this,
+ delay: 100
+},
+'mouseover' : {
+ fn: this.onMouseOver,
+ scope: this
+},
+'mouseout' : {
+ fn: this.onMouseOut,
+ scope: this
+}
});
Or a shorthand syntax:
myGridPanel.on({
- 'click' : this.onClick,
- 'mouseover' : this.onMouseOver,
- 'mouseout' : this.onMouseOut,
- scope: this
+'click' : this.onClick,
+'mouseover' : this.onMouseOver,
+'mouseout' : this.onMouseOut,
+ scope: this
});
Returns: | Observable | | 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 ] )
@@ -920,9 +934,41 @@ to...Force this container's layout to be recalculated. A
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( Object events )
- :
- voidUsed to enable bubbling of events Used to enable bubbling of events | Observable | | expand( Boolean animate )
+ 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
+implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
+access the required target more quickly.
+ Example: Ext.override(Ext.form.Field, {
+ // Add functionality to Field's initComponent to enable the change event to bubble
+ initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
+ this.enableBubble('change');
+ }),
+
+ // We know that we want Field's events to bubble directly to the FormPanel.
+ getBubbleTarget : function() {
+ if (!this.formPanel) {
+ this.formPanel = this.findParentByType('form');
+ }
+ return this.formPanel;
+ }
+});
+
+var myForm = new Ext.formPanel({
+ title: 'User Details',
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: function() {
+ // Title goes red if form has been modified.
+ myForm.header.setStyle('color', 'red');
+ }
+ }
+});
| Observable | | expand( Boolean animate )
:
Ext.PanelExpands the panel body so that it becomes visible. Fires the beforeexpand event which will
cancel the expand action ... | Container | | getEl()
@@ -1028,7 +1074,7 @@ the element into which the Gets the current XY position of the component's underlying element. Gets the current XY position of the component's underlying element. | BoxComponent | | getResizeEl()
:
- voidReturns the outermost Element of this Component which defines the Components overall size.
+ Ext.Element Returns the outermost Element of this Component which defines the Components overall size.
Usually this will return t... Returns the outermost Element of this Component which defines the Components overall size.
Usually this will return the same Element as getEl ,
but in some cases, a Component may have some more wrapping Elements around its main
@@ -1036,7 +1082,7 @@ active Element.
An example is a ComboBox. It is encased in a wrapping Element which
contains both the <input> Element (which is what would be returned
by its getEl method, and the trigger button Element.
-This Element is returned as the resizeEl . | BoxComponent | | getSize()
+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 )
:
@@ -1101,19 +1147,38 @@ the default), or true to check whether this Component is directly of the specifi
:
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",
- params: {param1: "foo", param2: "bar"}, // or a URL encoded string
+ url: 'your-url.php',
+ params: {param1: 'foo', param2: 'bar'}, // or a URL encoded string
callback: yourFunction,
scope: yourObject, // optional scope for the callback
discardUrl: false,
nocache: false,
- text: "Loading...",
+ text: 'Loading...',
timeout: 30,
scripts: false
});
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 | | nextSibling()
+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});
+
+ or:
+myGridPanel.mon(myGridPanel.getSelectionModel(), {
+ selectionchange: handleSelectionChange,
+ buffer: 50
+});
+
Parameters:item : Observable|ElementThe item to which to add a listener/listeners. ename : Object|StringThe event name, or an object containing event name properties. fn : FunctionOptional. If the ename parameter was an event name, this
+is the handler function. scope : ObjectOptional. If the ename parameter was an event name, this
+is the scope (this reference) in which the handler function is executed. opt : ObjectOptional. If the ename parameter was an event name, this
+is the addListener options. Returns: | Component | | mun( Observable|Element item , Object|String ename , Function fn , Object scope )
+ :
+ voidRemoves listeners that were added by the mon method. Removes listeners that were added by the mon method. Parameters:item : Observable|ElementThe item from which to remove a listener/listeners. ename : Object|StringThe event name, or an object containing event name properties. fn : FunctionOptional. If the ename parameter was an event name, this
+is the handler function. scope : ObjectOptional. If the ename parameter was an event name, this
+is the scope (this reference) in which the handler function is executed. Returns: | Component | | nextSibling()
:
Ext.ComponentReturns the next component in the owning container Returns the next component in the owning container | Component | | on( String eventName , Function handler , [Object scope ], [Object options ] )
:
@@ -1171,7 +1236,9 @@ which this component will be inserted (defaults to appending to the end of the c
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 | | setDisabled( Boolean disabled )
+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 )
:
@@ -1206,8 +1273,8 @@ This may be one of: | Panel | | setVisible( Boolean visible )
+for the Panel. This is triggered either by configuring the Panel with a non-blank title ,
+or configuring it with header: true .Parameters:title : StringThe title text to set iconCls : String(optional) iconCls A user-defined CSS class that provides the icon image for this panel Returns: | Panel | | setVisible( Boolean visible )
:
Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. | Component | | setWidth( Number width )
:
@@ -1229,11 +1296,18 @@ after the Shortcut for performing an expand or collapse based on the current state of the panel. Shortcut for performing an expand or collapse based on the current state of the panel. Parameters:animate : BooleanTrue to animate the transition, else false (defaults to the value of the
animCollapse panel config) Returns: | Panel | | un( String eventName , Function handler , [Object scope ] )
:
- voidRemoves an event handler (shorthand for removeListener.) | Observable | | updateBox( Object box )
+ voidRemoves an event handler (shorthand for removeListener.) | Observable | | update( Mixed htmlOrData , [Boolean loadScripts ], [Function callback ] )
+ :
+ voidUpdate the content area of a component. Update the content area of a component. Parameters:htmlOrData : MixedIf this component has been configured with a template via the tpl config
+then it will use this argument as data to populate the template.
+If this component was not configured with a template, the components
+content area will be updated via Ext.Element update loadScripts : Boolean(optional) Only legitimate when using the html configuration. Defaults to false callback : Function(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading Returns: | Component | | updateBox( Object box )
:
Ext.BoxComponentSets the current box measurements of the component's underlying element. Sets the current box measurements of the component's underlying element. | BoxComponent |
Public Events|
| add :
( Ext.Container this , Ext.Component component , Number index )
- Listeners will be called with the following arguments: | Container | | afterlayout :
+ 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 )
@@ -1297,7 +1371,9 @@ Fires after the component is hidden when calling the 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 | | render :
+ 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 )
|
|