X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..c8256059947f3aa8f5b0a9a2acf55e2142bb4742:/docs/output/Ext.ButtonGroup.html diff --git a/docs/output/Ext.ButtonGroup.html b/docs/output/Ext.ButtonGroup.html index 6cbe3623..77c83fa5 100644 --- a/docs/output/Ext.ButtonGroup.html +++ b/docs/output/Ext.ButtonGroup.html @@ -1,54 +1,54 @@ -
Observable Component BoxComponent Container Panel ButtonGroup
Package: | Ext |
Defined In: | ButtonGroup.js |
Class: | ButtonGroup |
Extends: | Panel |
xtype: | buttongroup |
var p = new Ext.Panel({
- title: 'Panel with Button Group',
- width: 300,
- height:200,
- renderTo: document.body,
- html: 'whatever',
- tbar: [{
- xtype: 'buttongroup',
- columns: 3,
- title: 'Clipboard',
- items: [{
- text: 'Paste',
- scale: 'large',
- rowspan: 3, iconCls: 'add',
- iconAlign: 'top',
- cls: 'x-btn-as-arrow'
- },{
- xtype:'splitbutton',
- text: 'Menu Button',
- scale: 'large',
- rowspan: 3,
- iconCls: 'add',
- iconAlign: 'top',
- arrowAlign:'bottom',
- menu: [{text: 'Menu Item 1'}]
- },{
- xtype:'splitbutton', text: 'Cut', iconCls: 'add16', menu: [{text: 'Cut Menu Item'}]
- },{
- text: 'Copy', iconCls: 'add16'
- },{
- text: 'Format', iconCls: 'add16'
- }]
- }]
+Observable
Component
BoxComponent
Container
Panel
ButtonGroup
Class Ext.ButtonGroup
Package: Ext Defined In: ButtonGroup.js Class: ButtonGroup Extends: Panel
Container for a group of buttons. Example usage:
+var p = new Ext.Panel({
+ title: 'Panel with Button Group',
+ width: 300,
+ height:200,
+ renderTo: document.body,
+ html: 'whatever',
+ tbar: [{
+ xtype: 'buttongroup',
+ columns: 3,
+ title: 'Clipboard',
+ items: [{
+ text: 'Paste',
+ scale: 'large',
+ rowspan: 3, iconCls: 'add',
+ iconAlign: 'top',
+ cls: 'x-btn-as-arrow'
+ },{
+ xtype:'splitbutton',
+ text: 'Menu Button',
+ scale: 'large',
+ rowspan: 3,
+ iconCls: 'add',
+ iconAlign: 'top',
+ arrowAlign:'bottom',
+ menu: [{text: 'Menu Item 1'}]
+ },{
+ xtype:'splitbutton', text: 'Cut', iconCls: 'add16', menu: [{text: 'Cut Menu Item'}]
+ },{
+ text: 'Copy', iconCls: 'add16'
+ },{
+ text: 'Format', iconCls: 'add16'
+ }]
+ }]
});
Config Options
Config Options Defined By activeItem : String/NumberA string component id or the numeric index of the component that should be initially activated within the
container's...A string component id or the numeric index of the component that should be initially activated within the
container's layout on render. For example, activeItem: 'item-1' or activeItem: 0 (index 0 = the first
item in the container's collection). activeItem only applies to layout styles that can display
items one at a time (like Ext.layout.AccordionLayout, Ext.layout.CardLayout and
-Ext.layout.FitLayout). Related to Ext.layout.ContainerLayout.activeItem. Container allowDomMove : BooleanWhether 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
+Ext.layout.FitLayout). Related to Ext.layout.ContainerLayout.activeItem. Container allowDomMove : BooleanWhether 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:
- Ext.form.FormPanel
- specifying
layout: 'anchor' // or 'form', or 'absolute'
-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.
@@ -64,49 +64,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
@@ -142,12 +113,12 @@ 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 : Object Panel bodyBorder : Boolean 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
@@ -155,8 +126,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
@@ -190,26 +161,37 @@ 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...Additional css class selector to be applied to the body element in the format expected by
Ext.Element.addClass (defaults to null). See bodyCfg. Panel bodyStyle : String/Object/FunctionCustom CSS styles to be applied to the body element in the format expected by
Ext.Element.applyStyles (defaults to nu...Custom CSS styles to be applied to the body element in the format expected by
Ext.Element.applyStyles (defaults to null). See bodyCfg. Panel border : 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....An array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.
+Defaults to ['add', 'remove']
.
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 : Arraybuttons will be used as items for the toolbar in
-the footer (fbar). Typically the value of this configuration propert... 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 : Object Panel clearCls : String 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').
@@ -219,38 +201,31 @@ 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 : Booleantrue to render the panel collapsed, false to render it expanded (defaults to
-false). Panel collapsedCls : StringA 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 : Booleantrue
to render the panel collapsed, false
to render it expanded (defaults to
+false
). Panel collapsedCls : StringA 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 columns : NumberThe columns configuration property passed to the
-configured layout manager. See Ext.layout.TableLayout.columns. ButtonGroup 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 columns : NumberThe columns configuration property passed to the
+configured layout manager. See Ext.layout.TableLayout.columns. ButtonGroup 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.
@@ -261,18 +236,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: [
@@ -286,7 +266,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
@@ -302,9 +282,9 @@ the disabled state:
}
}
}); Panel disabledClass : StringCSS 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.:
@@ -348,18 +328,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,
@@ -370,7 +350,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'
@@ -378,7 +358,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 '').
@@ -395,43 +375,49 @@ 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 :
Panel footer : Booleantrue to create the footer element explicitly, false to skip creating it. The footer
-will be created automatically if ... Panel footerCfg : Object Panel footerCfg : Object Panel forceLayout : Boolean Panel forceLayout : BooleanIf true the container will force a layout initially even if hidden or collapsed. This option
is useful for forcing fo...If true the container will force a layout initially even if hidden or collapsed. This option
is useful for forcing forms to render in collapsed or hidden containers. (defaults to false). Container frame : BooleanDefaults to true. See Ext.Panel.frame. ButtonGroup header : Booleantrue to create the Panel's header element explicitly, false to skip creating
-it. If a title is set the header will b... Panel headerAsText : Boolean Panel headerCfg : ObjectA DomHelper element specification object specifying the element structure
+it. If a title is set the header will b... Panel headerAsText : Boolean Panel headerCfg : Object Panel height : Number 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... 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:
@@ -477,8 +463,11 @@ rules to style the specific instance of this component uniquely, and also to sel
sub-elements using this component's id as the parent.
Note: to avoid complications imposed by a unique id also see
itemId
and ref
.
-Note: to access the container of an item see ownerCt
.
Component itemCls : StringAn additional CSS class to apply to the div wrapping the form item
-element of this field. If supplied, itemCls at th...An additional CSS class to apply to the div wrapping the form item
+
Note: to access the container of an item see ownerCt
.
Component itemCls : StringNote: this config is only used when this Component is rendered by a Container which
+has been configured to use the Fo...Note: this config is only used when this Component is rendered by a Container which
+has been configured to use the FormLayout layout manager (e.g.
+Ext.form.FormPanel or specifying layout:'form').
+An additional CSS class to apply to the div wrapping the form item
element of this field. If supplied, itemCls at the field level will override
the default itemCls supplied at the container level. The value specified for
itemCls will be added to the default class ('x-form-item').
@@ -487,22 +476,22 @@ the default itemCls supplied at the container level. The value s
you to write standard CSS rules that can apply to the field, the label (if specified), or
any other element within the markup for the field.
Note: see the note for fieldLabel.
-Example use:// Apply a style to the field's label:
+Example use:// Apply a style to the field's label:
<style>
.required .x-form-item-label {font-weight:bold;color:red;}
</style>
new Ext.FormPanel({
- height: 100,
- renderTo: Ext.getBody(),
- items: [{
- xtype: 'textfield',
- fieldLabel: 'Name',
- itemCls: 'required' //this label will be styled
- },{
- xtype: 'textfield',
- fieldLabel: 'Favorite Color'
- }]
+ height: 100,
+ renderTo: Ext.getBody(),
+ items: [{
+ xtype: 'textfield',
+ fieldLabel: 'Name',
+ itemCls: 'required' //this label will be styled
+ },{
+ xtype: 'textfield',
+ fieldLabel: 'Favorite Color'
+ }]
});
Component itemId : StringAn itemId can be used as an alternative way to get a reference to a component
when no object reference is available. ... Container keys : Object/ArrayA Ext.KeyMap config object (in the format expected by Ext.KeyMap.addBinding
used to assign custom key handling to thi...A Ext.KeyMap config object (in the format expected by Ext.KeyMap.addBinding
-used to assign custom key handling to this panel (defaults to null). Panel labelSeparator : 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.
@@ -690,22 +679,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 : NumberThe page level x coordinate for this component if contained within a positioning container. BoxComponent pageY : NumberThe 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 : NumberThe page level x coordinate for this component if contained within a positioning container. BoxComponent pageY : NumberThe 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
@@ -717,9 +709,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',
@@ -738,9 +730,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 : String 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').
@@ -756,14 +749,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 : StringThe 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
@@ -833,10 +826,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.
@@ -845,19 +839,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 : Object Panel title : String 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.XTemplate 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
@@ -878,10 +872,19 @@ 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 unstyled : Boolean Panel tpl : MixedAn Ext.Template, Ext.XTemplate
+or an array of strings to form an Ext.XTemplate.
+Used in conjunction with the data and...An Ext.Template , Ext.XTemplate
+or an array of strings to form an Ext.XTemplate.
+Used in conjunction with the data
and
+tplWriteMode
configurations. Component tplWriteMode : StringThe Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
+(see Ext.X...The Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
+(see Ext.XTemplate.overwrite
). Component unstyled : Boolean 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 : NumberThe 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
@@ -904,7 +907,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 : Array Panel buttons : ArrayThis Panel's Array of buttons as created from the buttons
config property. Read only. Panel bwrap : Ext.Element Panel collapsed : BooleanTrue if this panel is collapsed. Read-only. Panel dd : Ext.dd.DragSource. Component footer : Ext.Element Panel header : Ext.Element Panel header : Ext.Element Panel hidden : BooleanTrue if this component is hidden. Read-only. Component initialConfig : ObjectThis Component's initial configuration specification. Read-only. Component items : MixedCollectionThe collection of components in this container as a Ext.util.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 : BooleanTrue if this component has been rendered. Read-only. Component
Public Methods
Method Defined By add( Object/Array component
, Object (Optional)
, Object (Optional)
)
- :
- Ext.ComponentAdds Component(s) to this Container.
+
Note: see the Note for el
also.
Panel hidden : BooleanTrue if this component is hidden. Read-only. Component initialConfig : ObjectThis Component's initial configuration specification. Read-only. Component items : MixedCollectionThe collection of components in this container as a Ext.util.MixedCollection Container ownerCt : Ext.ContainerThis Component's owner Container (defaults to undefined, and is set automatically when
+this Component is added to a C... Component refOwner : Ext.ContainerThe ancestor Container into which the ref reference was inserted if this Component
+is a child of a Container, and has...The ancestor Container into which the ref reference was inserted if this Component
+is a child of a Container, and has been configured with a ref
. Component rendered : BooleanTrue if this component has been rendered. Read-only. Component
Public Methods
Method Defined By ButtonGroup( Object config
)
+ Create a new ButtonGroup.Create a new ButtonGroup.Parameters:config
: ObjectThe config object
Returns:- void
ButtonGroup add( ...Object/Array component
)
+ :
+ Ext.Component/ArrayAdds Component(s) to this Container.
Description :
<ul class="mdetail-params">
Fires the beforeadd event before addin...Adds Component(s) to this Container.
@@ -953,10 +959,10 @@ accordingly (see
-If the Container is already rendered when add
+ If the Container is already rendered when add
is called, you may need to call doLayout to refresh the view which causes
any unrendered child Components to be rendered. This is required so that you can
-add multiple child components if needed while only refreshing the layout
+add
multiple child components if needed while only refreshing the layout
once. For example:var tb = new Ext.Toolbar();
tb.render(document.body); // toolbar is rendered
tb.add({text:'Button 1'}); // add multiple items (defaultType for Toolbar is 'button')
@@ -965,17 +971,19 @@ tb.BorderLayout
for more details.
-
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:Ext.Component
component The Component (or config object) that was added.
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:Ext.Component/Array
The Components that were added.
Container addButton( String/Object config
, Function handler
, Object scope
)
:
Ext.ButtonAdds a button to this panel. Note that this method must be called prior to rendering. The preferred
approach is to ...Adds a button to this panel. Note that this method must be called prior to rendering. The preferred
approach is to add buttons via the buttons config.Parameters:config
: String/ObjectA valid Ext.Button config. A string will become the text for a default
-button config, an object will be treated as a button config object.handler
: FunctionThe function to be called on button Ext.Button.clickscope
: ObjectThe scope to use for the button handler function
Returns:Ext.Button
The button that was added
Panel addClass( string cls
)
+button config, an object will be treated as a button config object.handler
: FunctionThe function to be called on button Ext.Button.clickscope
: ObjectThe scope (this
reference) in which the button handler function is executed. Defaults to the Button. Returns:Ext.Button
The button that was added
Panel addClass( string cls
)
:
- Ext.ComponentAdds a CSS class to the component's underlying element.Adds a CSS class to the component's underlying element.Parameters:cls
: stringThe CSS class name to add
Returns:Ext.Component
this
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.Parameters:cls
: stringThe CSS class name to add
Returns:Ext.Component
this
Component addEvents( Object|String o
, string Optional.
)
:
- voidUsed to define events on this ObservableUsed to define events on this ObservableParameters:object
: ObjectThe object with the events defined
Returns:- void
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.Parameters:o
: Object|StringEither an object with event names as properties with a value of true
+or the first event name string if multiple event names are being passed as separate parameters.Optional.
: stringEvent name if multiple event names are being passed as separate parameters.
+Usage:this.addEvents('storeloaded', 'storecleared');
Returns:- void
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.
@@ -996,8 +1004,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
@@ -1005,27 +1013,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:- void
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.Parameters:el
: String/HTMLElement
Returns:- void
Component bubble( Function fn
, [Object scope
], [Array args
] )
@@ -1062,9 +1070,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:Ext.Container
this
Container enable()
:
- Ext.ComponentEnable this component and fire the 'enable' event.Enable this component and fire the 'enable' event.Parameters:- None.
Returns:Ext.Component
this
Component enableBubble( Object events
)
- :
- voidUsed to enable bubbling of eventsUsed to enable bubbling of eventsParameters:events
: Object
Returns:- void
Observable expand( Boolean animate
)
+ Ext.ComponentEnable this component and fire the 'enable' event.Enable this component and fire the 'enable' event.Parameters:- None.
Returns:Ext.Component
this
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');
+ }
+ }
+});
Parameters:events
: String/ArrayThe event name to bubble, or an Array of event names.
Returns:- void
Observable expand( Boolean animate
)
:
Ext.PanelExpands the panel body so that it becomes visible. Fires the beforeexpand event which will
cancel the expand action ...Expands the panel body so that it becomes visible. Fires the beforeexpand event which will
@@ -1097,7 +1137,7 @@ by calling Get a component contained by this container (alias for items.get(key))Get a component contained by this container (alias for items.get(key))Parameters:key
: String/NumberThe index or id of the component
Returns:Ext.Component
Ext.Component
Container getBottomToolbar()
:
- Ext.Toolbar Panel getBox( [Boolean local
] )
+ Ext.Toolbar Panel getBox( [Boolean local
] )
:
ObjectGets the current box measurements of the component's underlying element.Gets the current box measurements of the component's underlying element.Parameters:local
: Boolean(optional) If true the element's left and top are returned instead of page XY (defaults to false)
Returns:Object
box An object in the format {x, y, width, height}
BoxComponent getBubbleTarget()
:
@@ -1107,9 +1147,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:
For additional information see Ext.util.MixedCollection.get.
Returns:Ext.Component
The component (if found).
Container getEl()
@@ -1130,7 +1170,9 @@ or use a render listener directly:new Ext.Panel({
},
single: true // Remove the listener after first invocation
}
-});
Parameters:- None.
Returns:Ext.Element
The Element which encapsulates this Component.
Component getFrameHeight()
+});Parameters:- None.
Returns:Ext.Element
The Element which encapsulates this Component.
Component getFooterToolbar()
+ :
+ Ext.Toolbar Panel getFrameHeight()
:
NumberReturns the height in pixels of the framing elements of this panel (including any top and bottom bars and
header and ...Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and
@@ -1174,7 +1216,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.Parameters:local
: Boolean(optional) If true the element's left and top are returned instead of page XY (defaults to false)
Returns:Array
The XY position of the element (e.g., [100, 200])
BoxComponent getResizeEl()
:
- voidReturns the outermost Element of this Component which defines the Components overall size.
+ Ext.ElementReturns the outermost Element of this Component which defines the Components overall size.
Usually this will return t...Returns the outermost Element of this Component which defines the Components overall size.
Usually this will return the same Element as getEl
,
but in some cases, a Component may have some more wrapping Elements around its main
@@ -1182,13 +1224,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
.
Parameters:- None.
Returns:- void
BoxComponent getSize()
+This Element is returned as the resizeEl
.Parameters:- None.
Returns:Ext.Element
The Element which is to be resized by size managing layouts.
BoxComponent getSize()
:
ObjectGets the current size of the component's underlying element.Gets the current size of the component's underlying element.Parameters:- None.
Returns:Object
An object containing the element's size {width: (element width), height: (element height)}
BoxComponent getTool( String id
)
:
ObjectRetrieve a tool by id.Retrieve a tool by id.Parameters:id
: String
Returns:Object
tool
Panel getTopToolbar()
:
- Ext.Toolbar Panel getUpdater()
+ Ext.Toolbar 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.Parameters:- None.
Returns:Ext.Updater
The Updater
Panel getWidth()
:
@@ -1249,19 +1291,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:Ext.Panel
this
Panel nextSibling()
+associated property on this panel Updater instance.Returns:Ext.Panel
this
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:- void
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:- void
Component nextSibling()
:
Ext.ComponentReturns the next component in the owning containerReturns the next component in the owning containerParameters:- None.
Returns:Ext.Component
Component on( String eventName
, Function handler
, [Object scope
], [Object options
] )
:
@@ -1314,12 +1375,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.Parameters:- None.
Returns:- void
Observable setDisabled( Boolean disabled
)
+events fired during event suspension will be sent to any listeners now.Parameters:- None.
Returns:- void
Observable setAutoScroll( Boolean scroll
)
:
- Ext.ComponentConvenience function for setting disabled/enabled by boolean.Convenience function for setting disabled/enabled by boolean.Parameters:disabled
: Boolean
Returns:Ext.Component
this
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.Parameters:scroll
: BooleanTrue to allow the Component to auto scroll.
Returns:Ext.BoxComponent
this
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:
-- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
+ Ext.ComponentConvenience function for setting disabled/enabled by boolean.Convenience function for setting disabled/enabled by boolean.Parameters:disabled
: Boolean
Returns:Ext.Component
this
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:Ext.BoxComponent
this
BoxComponent setIconClass( String cls
)
@@ -1353,13 +1416,13 @@ This may be one of:
voidSets the title text for the panel and optionally the icon class.
In order to be able to set the title, a header eleme...Sets the title text for the panel and optionally the icon class.
In order to be able to set the title, a header element must have been created
-for the Panel. This is triggered either by configuring the Panel with a non-blank title,
-or configuring it with header: true.
Parameters:title
: StringThe title text to seticonCls
: String(optional) iconCls A user-defined CSS class that provides the icon image for this panel
Returns:- void
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 seticonCls
: String(optional) iconCls A user-defined CSS class that provides the icon image for this panel
Returns:- void
Panel setVisible( Boolean visible
)
:
- Ext.ComponentConvenience function to hide or show this component by boolean.Convenience function to hide or show this component by boolean.Parameters:visible
: BooleanTrue to show, false to hide
Returns:Ext.Component
this
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.Parameters:visible
: BooleanTrue to show, false to hide
Returns:Ext.Component
this
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:
-- A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels).
+ 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
: MixedThe new width to set. This may be one of:
+- A Number specifying the new width in the Element's defaultUnits (by default, pixels).
- A String used to set the CSS width style.
Returns:Ext.BoxComponent
this
BoxComponent show()
:
@@ -1376,7 +1439,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:Ext.Panel
this
Panel un( String eventName
, Function handler
, [Object scope
] )
:
- voidRemoves an event handler (shorthand for removeListener.)Removes an event handler (shorthand for removeListener.)Parameters:eventName
: StringThe type of event the handler was associated with.handler
: FunctionThe handler to remove. This must be a reference to the function passed into the addListener call.scope
: Object(optional) The scope originally specified for the handler.
Returns:- void
Observable updateBox( Object box
)
+ voidRemoves an event handler (shorthand for removeListener.)Removes an event handler (shorthand for removeListener.)Parameters:eventName
: StringThe type of event the handler was associated with.handler
: FunctionThe handler to remove. This must be a reference to the function passed into the addListener call.scope
: Object(optional) The scope originally specified for the handler.
Returns:- void
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 updateloadScripts
: Boolean(optional) Only legitimate when using the html configuration. Defaults to falsecallback
: Function(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading
Returns:- void
Component updateBox( Object box
)
:
Ext.BoxComponentSets the current box measurements of the component's underlying element.Sets the current box measurements of the component's underlying element.Parameters:box
: ObjectAn object in the format {x, y, width, height}
Returns:Ext.BoxComponent
this
BoxComponent
Public Events
Event Defined By activate :
( Ext.Panel p
)
@@ -1386,7 +1454,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:p
: Ext.PanelThe Panel that has been activated.
Panel add :
( Ext.Container this
, Ext.Component component
, Number index
)
- Listeners will be called with the following arguments:this
: Ext.Containercomponent
: Ext.ComponentThe component that was addedindex
: NumberThe index at which the component was added to the container's items collection
Container afterlayout :
+ Listeners will be called with the following arguments:this
: Ext.Containercomponent
: Ext.ComponentThe component that was addedindex
: NumberThe index at which the component was added to the container's items collection
Container added :
+ ( Ext.Component this
, Ext.Container ownerCt
, number index
)
+ Fires when a component is added to an Ext.ContainerFires when a component is added to an Ext.ContainerListeners will be called with the following arguments:this
: Ext.ComponentownerCt
: Ext.ContainerContainer which holds the componentindex
: numberPosition at which the component was added
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:this
: Ext.Containerlayout
: ContainerLayoutThe ContainerLayout implementation for this container
Container afterrender :
( Ext.Component this
)
@@ -1438,7 +1508,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:p
: Ext.Panelthe Panel which has been resized.width
: NumberThe Panel's new width.height
: NumberThe Panel's new height.
Panel close :
+ 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 close :
( Ext.Panel p
)
Fires after the Panel is closed. Note that Panels do not directly support being closed, but some
Panel subclasses do...Fires after the Panel is closed. Note that Panels do not directly support being closed, but some
@@ -1468,7 +1538,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 positiony
: NumberThe new y position
BoxComponent remove :
( Ext.Container this
, Ext.Component component
)
- Listeners will be called with the following arguments:this
: Ext.Containercomponent
: Ext.ComponentThe component that was removed
Container render :
+ Listeners will be called with the following arguments:this
: Ext.Containercomponent
: Ext.ComponentThe component that was removed
Container removed :
+ ( Ext.Component this
, Ext.Container ownerCt
)
+ Fires when a component is removed from an Ext.ContainerFires when a component is removed from an Ext.ContainerListeners will be called with the following arguments:this
: Ext.ComponentownerCt
: Ext.ContainerContainer which holds the component
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:this
: Ext.Component
Component resize :
( Ext.Component this
, Number adjWidth
, Number adjHeight
, Number rawWidth
, Number rawHeight
)