Standard form container.
+
Standard form container.
Layout
By default, FormPanel is configured with layout:'form' to use an Ext.layout.FormLayout
layout manager, which styles and renders fields and labels correctly. When nesting additional Containers
@@ -30,18 +30,18 @@ container's...
Container | | allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component |
| anchor : String | Container |
| 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 : Booleantrue to animate the transition when the panel is collapsed, false to skip the
-animation (defaults to true if the Ext.... true to animate the transition when the panel is collapsed, false to skip the
-animation (defaults to true if the Ext.Fx class is available, otherwise false). | Panel |
| applyTo : MixedThe id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in
+ See Ext.layout.AnchorLayout.anchor also. | BoxComponent |
| animCollapse : Booleantrue to animate the transition when the panel is collapsed, false to skip the
+animation (defaults to true if the Ext.... true to animate the transition when the panel is collapsed, false to skip the
+animation (defaults to true if the Ext.Fx class is available, otherwise false ). | Panel |
| applyTo : MixedThe id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in
the document ... The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in
-the document that specifies some panel-specific structural markup. When applyTo is used,
+the document that specifies some panel-specific structural markup. When applyTo is used,
constituent parts of the panel can be specified by CSS class name within the main element, and the panel
will automatically create those components from that markup. Any required components not specified in the
markup will be autogenerated if necessary.
@@ -57,49 +57,20 @@ markup will be autogenerated if necessary.
renderTo will be ignored and the target element's parent node will automatically be used as the
panel's container. | Panel |
| 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
@@ -132,19 +103,19 @@ child items when the browser changes its width: var myPanel = <
title: 'Box 3'
}],
});
| BoxComponent |
| baseCls : StringThe base CSS class to apply to this panel's element (defaults to 'x-panel').
-Another option available by default is t... The base CSS class to apply to this panel's element (defaults to 'x-panel').
- Another option available by default is to specify 'x-plain' which strips all styling
+Another option available by default is t... The base CSS class to apply to this panel's element (defaults to 'x-panel' ).
+ Another option available by default is to specify 'x-plain' which strips all styling
except for required attributes for Ext layouts to function (e.g. overflow:hidden).
-See unstyled also. | Panel |
| bbar : Object/ArrayThe bottom toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of
+See unstyled also. | Panel |
| bbar : Object/ArrayThe bottom toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of
buttons/button co... The bottom toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of
buttons/button configs to be added to the toolbar. Note that this is not available as a property after render.
To access the bottom toolbar after render, use getBottomToolbar.
- Note: Although a Toolbar may contain Field components, these will not be updated by a load
+ Note: Although a Toolbar may contain Field components, these will not be updated by a load
of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and
so are not scanned to collect form items. However, the values will be submitted because form
submission parameters are collected from the DOM tree. | Panel |
| bbarCfg : ObjectA DomHelper element specification object specifying the element structure
of this Panel's bbar Element. See bodyCfg ... A DomHelper element specification object specifying the element structure
-of this Panel's bbar Element. See bodyCfg also. | Panel |
| bodyBorder : BooleanTrue to display an interior border on the body element of the panel, false to hide it (defaults to true).
+of this Panel's bbar Element. See bodyCfg also. | Panel |
| bodyBorder : BooleanTrue to display an interior border on the body element of the panel, false to hide it (defaults to true).
This only a... True to display an interior border on the body element of the panel, false to hide it (defaults to true).
This only applies when border == true. If border == true and bodyBorder == false, the border will display
as a 1px wide inset border, giving the entire body element an inset appearance. | Panel |
| bodyCfg : ObjectA DomHelper element specification object may be specified for any
@@ -152,8 +123,8 @@ Panel Element.
By default, the Default element in t... A DomHelper element specification object may be specified for any
Panel Element.
By default, the Default element in the table below will be used for the html markup to
-create a child element with the commensurate Default class name (baseCls will be
-replaced by baseCls):
+create a child element with the commensurate Default class name ( baseCls will be
+replaced by baseCls ):
Panel Default Default Custom Additional Additional
Element element class element class style
@@ -187,25 +158,36 @@ element:
footerCssClass: 'custom-footer', // additional css class, see addClass
footerStyle: 'background-color:red' // see bodyStyle
});
- The example above also explicitly creates a footer with custom markup and
+ The example above also explicitly creates a footer with custom markup and
styling applied. | Panel |
| bodyCssClass : String/Object/FunctionAdditional css class selector to be applied to the body element in the format expected by
Ext.Element.addClass (defau... | Panel |
| bodyStyle : String/Object/FunctionCustom CSS styles to be applied to the body element in the format expected by
Ext.Element.applyStyles (defaults to nu... | Panel |
| border : BooleanTrue to display the borders of the panel's body element, false to hide them (defaults to true). By default,
the bord... True to display the borders of the panel's body element, false to hide them (defaults to true). By default,
-the border is a 2px wide inset border, but this can be further altered by setting bodyBorder to false. | Panel |
| bufferResize : Boolean/NumberWhen set to true (100 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
-t... When set to true (100 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
+the border is a 2px wide inset border, but this can be further altered by setting bodyBorder to false. | Panel |
| boxMaxHeight : NumberThe maximum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size mana... The maximum value in pixels which this BoxComponent will set its height to.
+ Warning: This will override any size management applied by layout managers. | BoxComponent |
| boxMaxWidth : NumberThe maximum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size manag... The maximum value in pixels which this BoxComponent will set its width to.
+ Warning: This will override any size management applied by layout managers. | BoxComponent |
| boxMinHeight : NumberThe minimum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size mana... The minimum value in pixels which this BoxComponent will set its height to.
+ Warning: This will override any size management applied by layout managers. | BoxComponent |
| boxMinWidth : NumberThe minimum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size manag... The minimum value in pixels which this BoxComponent will set its width to.
+ Warning: This will override any size management applied by layout managers. | BoxComponent |
| bubbleEvents : ArrayAn array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.... | Container |
| bufferResize : Boolean/NumberWhen set to true (50 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
+th... When set to true (50 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
the frequency it calculates and does a re-layout of components. This is useful for heavy containers or containers
-with a large quantity of sub-components for which frequent layout calls would be expensive. | 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 : ArrayAn array of Ext.Buttons or Ext.Button configs used to add buttons to the footer of this FormPanel.
+with a large quantity of sub-components for which frequent layout calls would be expensive. Defaults to 50 . | 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 : ArrayAn array of Ext.Buttons or Ext.Button configs used to add buttons to the footer of this FormPanel.
Buttons in the foo... An array of Ext.Buttons or Ext.Button configs used to add buttons to the footer of this FormPanel.
Buttons in the footer of a FormPanel may be configured with the option formBind: true. This causes
the form's valid state monitor task to enable/disable those Buttons depending on
the form's valid/invalid state. | FormPanel |
| bwrapCfg : ObjectA DomHelper element specification object specifying the element structure
of this Panel's bwrap Element. See bodyCfg... A DomHelper element specification object specifying the element structure
-of this Panel's bwrap Element. See bodyCfg also. | Panel |
| clearCls : StringThe CSS class used to to apply to the special clearing div rendered
+of this Panel's bwrap Element. See bodyCfg also. | Panel |
| clearCls : StringThe CSS class used to to apply to the special clearing div rendered
directly after each form field wrapper to provide... The CSS class used to to apply to the special clearing div rendered
directly after each form field wrapper to provide field clearing (defaults to
'x-form-clear-left').
@@ -215,37 +197,30 @@ manager (e.g. fieldLabel is specified or isFormField=true is specified.
See Ext.layout.FormLayout.fieldTpl also. | Component |
| closable : BooleanPanels themselves do not directly support being closed, but some Panel subclasses do (like
Ext.Window) or a Panel Cla... Panels themselves do not directly support being closed, but some Panel subclasses do (like
- Ext.Window) or a Panel Class within an Ext.TabPanel. Specify true
-to enable closing in such situations. Defaults to false. | Panel |
| cls : StringAn optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
+ Ext.Window) or a Panel Class within an Ext.TabPanel. Specify true
+to enable closing in such situations. Defaults to false . | Panel |
| cls : StringAn optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
useful for ... An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
useful for adding customized styles to the component or any of its children using standard CSS rules. | Component |
| collapseFirst : Booleantrue to make sure the collapse/expand toggle button always renders first (to the left of)
-any other tools in the pane... true to make sure the collapse/expand toggle button always renders first (to the left of)
-any other tools in the panel's title bar, false to render it last (defaults to true). | Panel |
| collapsed : Boolean true to render the panel collapsed, false to render it expanded (defaults to
-false). | Panel |
| collapsedCls : String A CSS class to add to the panel's element after it has been collapsed (defaults to
-'x-panel-collapsed'). | Panel |
| collapsible : BooleanTrue to make the panel collapsible and have the expand/collapse toggle button automatically rendered into
+any other tools in the pane... true to make sure the collapse/expand toggle button always renders first (to the left of)
+any other tools in the panel's title bar, false to render it last (defaults to true ).
| Panel |
| collapsed : Boolean true to render the panel collapsed, false to render it expanded (defaults to
+false ).
| Panel |
| collapsedCls : String A CSS class to add to the panel's element after it has been collapsed (defaults to
+'x-panel-collapsed' ). | Panel |
| collapsible : BooleanTrue to make the panel collapsible and have the expand/collapse toggle button automatically rendered into
the header ... True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into
-the header tool button area, false to keep the panel statically sized with no button (defaults to false). | Panel |
| 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
+the header tool button area, false to keep the panel statically sized with no button (defaults to false). | Panel |
| 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.
@@ -256,18 +231,23 @@ 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 |
| defaultType : StringThe default xtype of child Components to create in this Container when
+ | Component |
| data : MixedThe initial set of data to apply to the tpl to
+update the content area of the Component. | Component |
| defaultType : StringThe default xtype of child Components to create in this Container when
a child item is specified as a raw configurati... The default xtype of child Components to create in this Container when
a child item is specified as a raw configuration object, rather than as an instantiated Component.
- Defaults to 'panel', except Ext.menu.Menu which defaults to 'menuitem',
-and Ext.Toolbar and Ext.ButtonGroup which default to 'button'. | Container |
| 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
+Defaults to 'panel' , except Ext.menu.Menu which defaults to 'menuitem' ,
+and Ext.Toolbar and Ext.ButtonGroup which default to 'button' .
| Container |
| 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: [
@@ -281,7 +261,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
@@ -297,9 +277,9 @@ the disabled state:
}
}
}); | Panel |
| disabledClass : String CSS class added to the component when it is disabled (defaults to 'x-item-disabled'). | Component |
| 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.:
@@ -343,18 +323,18 @@ generated automatically based on the items added to the panel at config time, bu
make sure a structural element is rendered even if not specified at config time (for example, you may want
to add a button or toolbar dynamically after the panel has been rendered). Adding those elements to this
list will allocate the required placeholders in the panel when it is rendered. Valid values are
-- header
-- tbar (top bar)
-- body
-- bbar (bottom bar)
-- footer
+header
+tbar (top bar)
+body
+bbar (bottom bar)
+footer
-Defaults to ' body'. | Panel |
| fbar : Object/ArrayA Toolbar object, a Toolbar config, or an array of
+Defaults to 'body '. | Panel |
| fbar : Object/ArrayA Toolbar object, a Toolbar config, or an array of
Buttons/Button configs, describing a Toolbar to be rendered into t... A Toolbar object, a Toolbar config, or an array of
Buttons/Button configs, describing a Toolbar to be rendered into this Panel's footer element.
After render, the 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,
@@ -365,7 +345,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'
@@ -373,7 +353,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 '').
@@ -390,31 +370,37 @@ Example use: new Ext.FormPanel({
xtype: 'textfield',
fieldLabel: 'Name'
}]
-});
| Component |
| floating : MixedThis property is used to configure the underlying Ext.Layer. Acceptable values for this
+}); | Component |
| flex : NumberNote: this config is only used when this Component is rendered
+by a Container which has been configured to use a BoxL... Note: this config is only used when this Component is rendered
+by a Container which has been configured to use a BoxLayout.
+Each child Component with a flex property will be flexed either vertically (by a VBoxLayout)
+or horizontally (by an HBoxLayout) according to the item's relative flex value
+compared to the sum of all Components with flex value specified. Any child items that have
+either a flex = 0 or flex = undefined will not be 'flexed' (the initial size will not be changed). | BoxComponent |
| floating : MixedThis property is used to configure the underlying Ext.Layer. Acceptable values for this
configuration property are:<d... This property is used to configure the underlying Ext.Layer. Acceptable values for this
configuration property are:
-- false : Default.
Display the panel inline where it is
+ false : Default.Display the panel inline where it is
rendered.
- - true :
Float the panel (absolute position it with automatic
+ true : Float the panel (absolute position it with automatic
shimming and shadow).
Setting floating to true will create an Ext.Layer for this panel and display the
panel at negative offsets so that it is hidden.
Since the panel will be absolute positioned, the position must be set explicitly
-after render (e.g., myPanel.setPosition(100,100);).
+after render (e.g., myPanel.setPosition(100,100); ).
Note: when floating a panel you should always assign a fixed width,
otherwise it will be auto width and will expand to fill to the right edge of the viewport.
- - object :
The specified object will be used
+ object : The specified object will be used
as the configuration object for the Ext.Layer that will be created.
| Panel |
| footer : Booleantrue to create the footer element explicitly, false to skip creating it. The footer
-will be created automatically if ... true to create the footer element explicitly, false to skip creating it. The footer
-will be created automatically if buttons or a fbar have
-been configured. See bodyCfg for an example. | Panel |
| footerCfg : ObjectA DomHelper element specification object specifying the element structure
+will be created automatically if ... true to create the footer element explicitly, false to skip creating it. The footer
+will be created automatically if buttons or a fbar have
+been configured. See bodyCfg for an example. | Panel |
| footerCfg : ObjectA DomHelper element specification object specifying the element structure
of this Panel's footer Element. See bodyCf... A DomHelper element specification object specifying the element structure
-of this Panel's footer Element. See bodyCfg also. | Panel |
| forceLayout : BooleanIf true the container will force a layout initially even if hidden or collapsed. This option
+of this Panel's footer Element. See bodyCfg also. | Panel |
| forceLayout : BooleanIf true the container will force a layout initially even if hidden or collapsed. This option
is useful for forcing fo... If true the container will force a layout initially even if hidden or collapsed. This option
is useful for forcing forms to render in collapsed or hidden containers. (defaults to false). | Container |
| formId : String The id of the FORM tag (defaults to an auto-generated id). | FormPanel |
| frame : Booleanfalse by default to render with plain 1px square borders. true to render with
-9 elements, complete with custom rounde... false by default to render with plain 1px square borders. true to render with
+9 elements, complete with custom rounde... false by default to render with plain 1px square borders. true to render with
9 elements, complete with custom rounded corners (also see Ext.Element.boxWrap).
The template generated for each condition is depicted below: // frame = false
<div id="developer-specified-id-goes-here" class="x-panel">
@@ -440,19 +426,19 @@ is useful for forcing forms to render in collapsed or hidden containers. (defaul
<div class="x-panel-bl"><div class="x-panel-br"><div class="x-panel-bc"/>
</div></div></div>
</div>
| Panel |
| header : Booleantrue to create the Panel's header element explicitly, false to skip creating
-it. If a title is set the header will b... true to create the Panel's header element explicitly, false to skip creating
-it. If a title is set the header will be created automatically, otherwise it will not.
-If a title is set but header is explicitly set to false, the header
-will not be rendered. | Panel |
| headerAsText : Booleantrue to display the panel title in the header,
- false to hide it (defaults to true). | Panel |
| headerCfg : ObjectA DomHelper element specification object specifying the element structure
+it. If a title is set the header will b... true to create the Panel's header element explicitly, false to skip creating
+it. If a title is set the header will be created automatically, otherwise it will not.
+If a title is set but header is explicitly set to false , the header
+will not be rendered. | Panel |
| headerAsText : Booleantrue to display the panel title in the header ,
+ false to hide it (defaults to true ). | Panel |
| headerCfg : ObjectA DomHelper element specification object specifying the element structure
of this Panel's header Element. See bodyCf... A DomHelper element specification object specifying the element structure
-of this Panel's header Element. See bodyCfg also. | Panel |
| height : NumberThe height of this component in pixels (defaults to auto).
+of this Panel's header Element. See bodyCfg also. | Panel |
| height : NumberThe height of this component in pixels (defaults to auto).
Note to express this dimension as a percentage or offset s... The height of this component in pixels (defaults to auto).
Note to express this dimension as a percentage or offset see Ext.Component.anchor. | BoxComponent |
| hidden : BooleanRender this component hidden (default is false). If true, the
hide method will be called internally. | Component |
| 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 |
| hideCollapseTool : Booleantrue to hide the expand/collapse toggle button when collapsible == true ,
- false to display it (defaults to false). | Panel |
| hideLabel : Booleantrue to completely hide the label element
+border settings (defaults to false). | Container |
| hideCollapseTool : Booleantrue to hide the expand/collapse toggle button when collapsible == true ,
+ false to display it (defaults to false ). | Panel |
| hideLabel : Booleantrue to completely hide the label element
(label and separator). Defaults to false.
By default, even if you do not sp... true to completely hide the label element
(label and separator). Defaults to false.
@@ -478,11 +464,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 |
| iconCls : StringThe CSS class selector that specifies a background image to be used as the header icon (defaults to '').
+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 |
| iconCls : StringThe CSS class selector that specifies a background image to be used as the header icon (defaults to '').
An example o... The CSS class selector that specifies a background image to be used as the header icon (defaults to '').
An example of specifying a custom icon class would be something like:
// specify the property in the config for the class:
@@ -564,7 +550,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 |
| labelAlign : StringThe label alignment value used for the text-align specification
+used to assign custom key handling to this panel (defaults to null ). | Panel |
| labelAlign : StringThe label alignment value used for the text-align specification
for the container. Valid values are "left", "top" or ... The label alignment value used for the text-align specification
for the container. Valid values are "left", "top" or "right"
(defaults to "left"). This property cascades to child containers and can be
@@ -589,8 +575,8 @@ Example use: new Ext.FormPanel({
});
| Component |
| labelWidth : NumberThe width of labels in pixels. This property cascades to child containers
and can be overridden on any child containe... The width of labels in pixels. This property cascades to child containers
and can be overridden on any child container (e.g., a fieldset can specify a different labelWidth
-for its fields) (defaults to 100). | FormPanel |
| layout : StringDefaults to 'form'. Normally this configuration property should not be altered.
-For additional details see Ext.layo... Defaults to 'form'. Normally this configuration property should not be altered.
+for its fields) (defaults to 100). | FormPanel |
| layout : StringDefaults to 'form'. Normally this configuration property should not be altered.
+For additional details see Ext.layou... | FormPanel |
| 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
@@ -670,8 +656,8 @@ 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 : Number Minimum width of all buttons in pixels (defaults to 75). | FormPanel |
| monitorPoll : Number The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200) | FormPanel |
| 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
@@ -684,13 +670,16 @@ regularly fires the form is valid or not. Defaults to false | FormPanel |
| 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
@@ -702,9 +691,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',
@@ -723,9 +712,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').
@@ -741,14 +731,14 @@ to render and manage its child items.
When using this config, a call to render() is not required.
-See render also. | Component |
| shadow : Boolean/Stringtrue (or a valid Ext.Shadow Ext.Shadow.mode value) to display a shadow behind the
-panel, false to display no shadow (... true (or a valid Ext.Shadow Ext.Shadow.mode value) to display a shadow behind the
-panel, false to display no shadow (defaults to 'sides'). Note that this option
-only applies when floating = true. | Panel |
| shadowOffset : NumberThe number of pixels to offset the shadow if displayed (defaults to 4). Note that this
-option only applies when float... The number of pixels to offset the shadow if displayed (defaults to 4). Note that this
-option only applies when floating = true. | Panel |
| shim : Booleanfalse to disable the iframe shim in browsers which need one (defaults to true).
-Note that this option only applies wh... false to disable the iframe shim in browsers which need one (defaults to true).
-Note that this option only applies when floating = true. | Panel |
| 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 |
| shadow : Boolean/Stringtrue (or a valid Ext.Shadow Ext.Shadow.mode value) to display a shadow behind the
+panel, false to display no shadow (... true (or a valid Ext.Shadow Ext.Shadow.mode value) to display a shadow behind the
+panel, false to display no shadow (defaults to 'sides' ). Note that this option
+only applies when floating = true . | Panel |
| shadowOffset : NumberThe number of pixels to offset the shadow if displayed (defaults to 4). Note that this
+option only applies when float... The number of pixels to offset the shadow if displayed (defaults to 4 ). Note that this
+option only applies when floating = true . | Panel |
| shim : Booleanfalse to disable the iframe shim in browsers which need one (defaults to true).
+Note that this option only applies wh... false to disable the iframe shim in browsers which need one (defaults to true ).
+Note that this option only applies when floating = true . | Panel |
| 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
@@ -818,10 +808,11 @@ Ext.Element.ap... A custom style specification to be appl
}
})
]
-}); | Component |
| tabTip : StringA string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over
-the tab of a Ext.Pan... A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over
-the tab of a Ext.Panel which is an item of a Ext.TabPanel. Ext.QuickTips.init()
-must be called in order for the tips to render. | Panel |
| tbar : Object/ArrayThe top toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of
+}); | Component |
| tabTip : StringNote: this config is only used when this BoxComponent is a child item of a TabPanel.
+A string to be used as innerHTML... Note: this config is only used when this BoxComponent is a child item of a TabPanel.
+A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over
+the associated tab selector element. Ext.QuickTips.init()
+must be called in order for the tips to render. | BoxComponent |
| tbar : Object/ArrayThe top toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of
buttons/button confi... The top toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of
buttons/button configs to be added to the toolbar. Note that this is not available as a property after render.
To access the top toolbar after render, use getTopToolbar.
@@ -830,19 +821,19 @@ of an ancestor FormPanel. A Panel's toolbars are not part of the standard Contai
so are not scanned to collect form items. However, the values will be submitted because form
submission parameters are collected from the DOM tree. | Panel |
| tbarCfg : ObjectA DomHelper element specification object specifying the element structure
of this Panel's tbar Element. See bodyCfg ... A DomHelper element specification object specifying the element structure
-of this Panel's tbar Element. See bodyCfg also. | Panel |
| title : StringThe title text to be used as innerHTML (html tags are accepted) to display in the panel
+of this Panel's tbar Element. See bodyCfg also. | Panel |
| title : StringThe title text to be used as innerHTML (html tags are accepted) to display in the panel
header (defaults to ''). When... The title text to be used as innerHTML (html tags are accepted) to display in the panel
- header (defaults to ''). When a title is specified the
- header element will automatically be created and displayed unless
- header is explicitly set to false. If you do not want to specify a
- title at config time, but you may want one later, you must either specify a non-empty
- title (a blank space ' ' will do) or header:true so that the container
+ header (defaults to ''). When a title is specified the
+ header element will automatically be created and displayed unless
+ header is explicitly set to false . If you do not want to specify a
+ title at config time, but you may want one later, you must either specify a non-empty
+ title (a blank space ' ' will do) or header:true so that the container
element will get created. | Panel |
| titleCollapse : Booleantrue to allow expanding and collapsing the panel (when collapsible = true)
-by clicking anywhere in the header bar, fa... true to allow expanding and collapsing the panel (when collapsible = true)
-by clicking anywhere in the header bar, false) to allow it only by clicking to tool button
-(defaults to false)). If this panel is a child item of a border layout also see the
+by clicking anywhere in the header bar, fa... true to allow expanding and collapsing the panel (when collapsible = true )
+by clicking anywhere in the header bar, false ) to allow it only by clicking to tool button
+(defaults to false )). If this panel is a child item of a border layout also see the
BorderLayout.Region
- floatable config option. | Panel |
| toolTemplate : Ext.Template/Ext.XTemplateA Template used to create tools in the header Element. Defaults to:new Ext.Template('<div class="x-tool x-tool-{id... A Template used to create tools in the header Element. Defaults to: new Ext.Template('<div class="x-tool x-tool-{id}"> </div>')
+ floatable config option. | Panel |
| toolTemplate : Ext.Template/Ext.XTemplateA Template used to create tools in the header Element. Defaults to:new Ext.Template('<div class="x-tool x-tool-{id... A Template used to create tools in the header Element. Defaults to: new Ext.Template('<div class="x-tool x-tool-{id}"> </div>')
This may may be overridden to provide a custom DOM structure for tools based upon a more
complex XTemplate. The template's data is a single tool configuration object (Not the entire Array)
as specified in tools. In the following example an <a> tag is used to provide a
@@ -863,44 +854,44 @@ visual indication when hovering over the tool: var win = 'hide'
});
- Note that the CSS class "x-tool-pdf" should have an associated style rule which provides an
+ Note that the CSS class 'x-tool-pdf' should have an associated style rule which provides an
appropriate background image, something like:
a.x-tool-pdf {background-image: url(../shared/extjs/images/pdf.gif)!important;}
| Panel |
| tools : ArrayAn array of tool button configs to be added to the header tool area. When rendered, each tool is
stored as an Element... An array of tool button configs to be added to the header tool area. When rendered, each tool is
-stored as an Element referenced by a public property called tools.<tool-type>
+stored as an Element referenced by a public property called tools.<tool-type>
Each tool config may contain the following properties:
- id : String
Required. The type
-of tool to create. By default, this assigns a CSS class of the form x-tool-<tool-type> to the
+of tool to create. By default, this assigns a CSS class of the form x-tool-<tool-type> to the
resulting tool Element. Ext provides CSS rules, and an icon sprite containing images for the tool types listed below.
The developer may implement custom tools by supplying alternate CSS rules and background images:
-
- close
- minimize
- maximize
- restore
- gear
- pin
- unpin
- right
- left
- up
- down
- refresh
- minus
- plus
- help
- search
- save
- print
+
+ close
+ minimize
+ maximize
+ restore
+ gear
+ pin
+ unpin
+ right
+ left
+ up
+ down
+ refresh
+ minus
+ plus
+ help
+ search
+ save
+ print
- handler : Function
Required. The function to
call when clicked. Arguments passed are:
- stopEvent : Boolean
Defaults to true. Specify as false to allow click event to propagate.
- scope : Object
The scope in which to call the handler.
@@ -929,14 +920,23 @@ handlers that implement the necessary behavior.
// whatever
}
}]
-For the custom id of 'help' define two relevant css classes with a link to
+ For the custom id of 'help' define two relevant css classes with a link to
a 15x15 image:
.x-tool-help {background-image: url(images/help.png);}
.x-tool-help-over {background-image: url(images/help_over.png);}
// if using an image sprite:
.x-tool-help {background-image: url(images/help.png) no-repeat 0 0;}
-.x-tool-help-over {background-position:-15px 0;}
| Panel |
| 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
+.x-tool-help-over {background-position:-15px 0;} | 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 |
| xtype : StringThe registered xtype to create. This config option is not used when passing
@@ -959,7 +959,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
@@ -985,18 +985,22 @@ config for a suggestion, or use a render listener directly: new
See also getEl
| Component |
| footer : Ext.ElementThe Panel's footer Element. Read-only.
This Element is used to house the Panel's buttons or fbar.
Note: see the Note ... The Panel's footer Element. Read-only.
- This Element is used to house the Panel's buttons or fbar.
- Note: see the Note for el also. | Panel |
| header : Ext.ElementThe Panel's header Element. Read-only.
+ This Element is used to house the Panel's buttons or fbar .
+ Note: see the Note for el also. | Panel |
| header : Ext.ElementThe Panel's header Element. Read-only.
This Element is used to house the title and tools
Note: see the Note for el al... The Panel's header Element. Read-only.
This Element is used to house the title and tools
- Note: see the Note for el also. | Panel |
| hidden : Boolean True if this component is hidden. Read-only. | Component |
| initialConfig : Object This Component's initial configuration specification. Read-only. | Component |
| 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
|
| FormPanel( Object config )
- Parameters:config : ObjectConfiguration options Returns: | FormPanel |
| add( Object/Array component , Object (Optional) , Object (Optional) )
- :
- Ext.ComponentAdds Component(s) to this Container.
+ Note: see the Note for el also. | Panel |
| hidden : Boolean True if this component is hidden. Read-only. | Component |
| initialConfig : Object This Component's initial configuration specification. Read-only. | Component |
| 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
|
| FormPanel( Object config )
+ Parameters:config : ObjectConfiguration options Returns: | FormPanel |
| add( ...Object/Array component )
+ :
+ Ext.Component/ArrayAdds Component(s) to this Container.
Description :
<ul class="mdetail-params">
Fires the beforeadd event before addin... Parameters:component : Object/ArrayEither a single component or an Array of components to add. See
-items for additional information. (Optional) : Objectcomponent_2 (Optional) : Objectcomponent_n Returns: | Container |
| addButton( String/Object config , Function handler , Object scope )
+Parameters:component : ...Object/ArrayEither one or more Components to add or an Array of Components to add. See
+items for additional information. Returns: | Container |
| addButton( String/Object config , Function handler , Object scope )
:
Ext.ButtonAdds a button to this panel. Note that this method must be called prior to rendering. The preferred
approach is to ... Adds a button to this panel. Note that this method must be called prior to rendering. The preferred
approach is to add buttons via the buttons config. | Panel |
| addClass( string cls )
+button config, an object will be treated as a button config object.handler : Functionscope : ObjectThe scope (this reference) in which the button handler function is executed. Defaults to the Button. Returns: | Panel |
| addClass( string cls )
:
- Ext.ComponentAdds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. | Component |
| addEvents( Object object )
+ Ext.ComponentAdds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. | Component |
| addEvents( Object|String o , string Optional. )
:
- voidUsed to define events on this Observable Used to define events on this Observable | Observable |
| addListener( String eventName , Function handler , [Object scope ], [Object options ] )
+ voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. | Observable |
| addListener( String eventName , Function handler , [Object scope ], [Object options ] )
:
voidAppends an event handler to this object. Appends an event handler to this object. Parameters:eventName : StringThe name of the event to listen for. handler : FunctionThe method the event invokes. scope : Object(optional) The scope (this reference) in which the handler function is executed.
If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration.
@@ -1052,8 +1058,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
@@ -1061,27 +1067,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 ] )
@@ -1118,9 +1124,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 |
| getBottomToolbar()
:
- Ext.ToolbarReturns the toolbar from the bottom (bbar) section of the panel. Returns the toolbar from the bottom ( bbar) section of the panel. | Panel |
| getBox( [Boolean local ] )
+ Ext.ToolbarReturns the toolbar from the bottom (bbar) section of the panel. Returns the toolbar from the bottom ( bbar ) section of the panel. | Panel |
| getBox( [Boolean local ] )
:
ObjectGets the current box measurements of the component's underlying element. Gets the current box measurements of the component's underlying element. | BoxComponent |
| getBubbleTarget()
:
@@ -1163,9 +1201,9 @@ by calling Examines this container's items property
and gets a direct child component of this container.Parameters:comp : String/NumberThis parameter may be any of the following:
-- a String : representing the
itemId
+ - a
String : representing the itemId
or id of the child component
-- a Number : representing the position of the child component
+
- a
Number : representing the position of the child component
within the items property
For additional information see Ext.util.MixedCollection.get. Returns: | Container |
| getEl()
@@ -1186,7 +1224,9 @@ or use a render listener directly:new Ext.Panel({
},
single: true // Remove the listener after first invocation
}
-});
| Component |
| getForm()
+}); | Component |
| getFooterToolbar()
+ :
+ Ext.ToolbarReturns the toolbar from the footer (fbar) section of the panel. Returns the toolbar from the footer ( fbar ) section of the panel. | Panel |
| getForm()
:
Ext.form.BasicFormProvides access to the Form which this Panel contains. Provides access to the Form which this Panel contains. | FormPanel |
| getFrameHeight()
:
@@ -1232,7 +1272,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
@@ -1240,13 +1280,13 @@ 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 )
:
Object | Panel |
| getTopToolbar()
:
- Ext.ToolbarReturns the toolbar from the top (tbar) section of the panel. Returns the toolbar from the top ( tbar) section of the panel. | Panel |
| getUpdater()
+ Ext.ToolbarReturns the toolbar from the top (tbar) section of the panel. Returns the toolbar from the top ( tbar ) section of the panel. | 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()
:
@@ -1305,7 +1345,26 @@ to participate in determination of inherited xtypes.
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 options )
:
- voidThis is a proxy for the underlying BasicForm's Ext.form.BasicForm.load call. | FormPanel |
| nextSibling()
+ voidThis is a proxy for the underlying BasicForm's Ext.form.BasicForm.load call. | FormPanel |
| 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 ] )
:
@@ -1358,12 +1417,14 @@ 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.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. | Component |
| setHeight( Number height )
+ 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.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:
| Component |
| setHeight( Mixed height )
+ :
+ Ext.BoxComponentSets the height of the component. This method fires the resize event. Sets the height of the component. This method fires the resize event. Parameters:height : MixedThe new height to set. This may be one of:
+- A Number specifying the new height in the Element's defaultUnits (by default, pixels).
- A String used to set the CSS height style.
- undefined to leave the height unchanged.
Returns: | BoxComponent |
| setIconClass( String cls )
@@ -1397,13 +1458,13 @@ This may be one of: | Panel |
| setVisible( Boolean visible )
+for the Panel. This is triggered either by configuring the Panel with a non-blank title ,
+or configuring it with header: true .Parameters:title : StringThe title text to set iconCls : String(optional) iconCls A user-defined CSS class that provides the icon image for this panel Returns: | Panel |
| setVisible( Boolean visible )
:
- Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. | Component |
| setWidth( Number width )
+ Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. | Component |
| setWidth( Mixed width )
:
- Ext.BoxComponentSets the width of the component. This method fires the resize event. Sets the width of the component. This method fires the resize event. Parameters:width : NumberThe new width to setThis may be one of:
| BoxComponent |
| show()
:
@@ -1426,7 +1487,12 @@ after the Shortcut for performing an expand or collapse based on the current state of the panel. Shortcut for performing an expand or collapse based on the current state of the panel. Parameters:animate : BooleanTrue to animate the transition, else false (defaults to the value of the
animCollapse panel config) Returns: | Panel |
| un( String eventName , Function handler , [Object scope ] )
:
- voidRemoves an event handler (shorthand for removeListener.) | Observable |
| updateBox( Object box )
+ voidRemoves an event handler (shorthand for removeListener.) | Observable |
| update( Mixed htmlOrData , [Boolean loadScripts ], [Function callback ] )
+ :
+ voidUpdate the content area of a component. Update the content area of a component. Parameters:htmlOrData : MixedIf this component has been configured with a template via the tpl config
+then it will use this argument as data to populate the template.
+If this component was not configured with a template, the components
+content area will be updated via Ext.Element update loadScripts : Boolean(optional) Only legitimate when using the html configuration. Defaults to false callback : Function(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading Returns: | Component |
| updateBox( Object box )
:
Ext.BoxComponentSets the current box measurements of the component's underlying element. Sets the current box measurements of the component's underlying element. | BoxComponent |
Public Events
|
| activate :
( Ext.Panel p )
@@ -1436,7 +1502,9 @@ Note that Panels do not directly support being activated, but some Panel subclas
do (like Ext.Window). Panels which are child Components of a TabPanel fire the
activate and deactivate events under the control of the TabPanel.Listeners will be called with the following arguments: | Panel |
| 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 )
@@ -1488,7 +1556,7 @@ provide custom state restoration. | | Component |
| bodyresize :
( Ext.Panel p , Number width , Number height )
- Fires after the Panel has been resized. Fires after the Panel has been resized. Listeners will be called with the following arguments: | Panel |
| clientvalidation :
+ Fires after the Panel has been resized. Fires after the Panel has been resized. Listeners will be called with the following arguments:p : Ext.Panelthe Panel which has been resized. width : NumberThe Panel body's new width. height : NumberThe Panel body's new height.
| Panel |
| clientvalidation :
( Ext.form.FormPanel this , Boolean valid )
If the monitorValid config option is true, this event fires repetitively to notify of valid state If the monitorValid config option is true, this event fires repetitively to notify of valid state Listeners will be called with the following arguments: | FormPanel |
| close :
( Ext.Panel p )
@@ -1520,7 +1588,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 )
|