| | anchor : StringNote: this config is only used when this Component is rendered
+}); Config Options|
| | activeItem : String/NumberA string component id or the numeric index of the component that should be initially activated within the
+container's... | 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 (or subclass thereof).
based layout manager, for example: | 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 | | | autoEncode : Boolean True to automatically HTML encode and decode values pre and post edit (defaults to false) | EditorGridPanel | | | autoExpandColumn : StringThe id of a column in
+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,
+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.
+ The following class names are supported (baseCls will be replaced by baseCls):
+ - baseCls + '-header'
+- baseCls + '-header-text'
+- baseCls + '-bwrap'
+- baseCls + '-tbar'
+- baseCls + '-body'
+- baseCls + '-bbar'
+- baseCls + '-footer'
+ Using this config, a call to render() is not required. If applyTo is specified, any value passed for
+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 | | | autoEncode : Boolean True to automatically HTML encode and decode values pre and post edit (defaults to false) | EditorGridPanel | | | autoExpandColumn : StringThe id of a column in
this grid that should expand to fill unused space. This value specified here can not
be 0.
Note... The id of a column in
@@ -40,9 +63,46 @@ Note: Setting autoHeight: true means that t... true
based on its contents, and that Ext will not manage it at all. If the panel is within a layout that
manages dimensions (fit, border, etc.) then setting autoHeight: true
can cause issues with scrolling and will not generally work as expected since the panel will take
-on the height of its contents rather than the height required by the Ext layout.
| Panel | | | autoShow : BooleanTrue if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
+on the height of its contents rather than the height required by the Ext layout. | Panel | | | autoLoad : Object/String/FunctionA valid url spec according to the Updater Ext.Updater.update method.
+If autoLoad is not null, the panel will attempt ... A valid url spec according to the Updater Ext.Updater.update method.
+If autoLoad is not null, the panel will attempt to load its contents
+immediately upon render.
+The URL will become the default URL for this panel's body element,
+so it may be refreshed at any time. | Panel | | | autoScroll : Booleantrue to use overflow:'auto' on the components layout element and show scroll bars automatically when
+necessary, false... true to use overflow:'auto' on the components layout element and show scroll bars automatically when
+necessary, false to clip any overflowing content (defaults to false).
| BoxComponent | | | autoShow : BooleanTrue if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
them on render... True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
-them on render (defaults to false). | Component | | | baseCls : StringThe base CSS class to apply to this panel's element (defaults to 'x-panel').
+them on render (defaults to false). | Component | | | autoWidth : BooleanTrue to use width:'auto', false to use fixed width (or allow it to be managed by its parent
+Container's layout manage... True to use width:'auto', false to use fixed width (or allow it to be managed by its parent
+Container's layout manager. Defaults to false.
+ Note: Although many components inherit this config option, not all will
+function as expected with a width of 'auto'. Setting autoWidth:true means that the
+browser will manage width based on the element's contents, and that Ext will not manage it at all.
+ If the browser is managing the width, be aware that resizes performed by the browser in response
+to changes within the structure of the Component cannot be detected. Therefore changes to the width might
+result in elements needing to be synchronized with the new width. For example, where the target element is: <div id='grid-container' style='margin-left:25%;width:50%'></div>
+A Panel rendered into that target element must listen for browser window resize in order to relay its
+child items when the browser changes its width: var myPanel = new Ext.Panel({
+ renderTo: 'grid-container',
+ monitorResize: true, // relay on browser resize
+ title: 'Panel',
+ height: 400,
+ autoWidth: true,
+ layout: 'hbox',
+ layoutConfig: {
+ align: 'stretch'
+ },
+ defaults: {
+ flex: 1
+ },
+ items: [{
+ title: 'Box 1',
+ }, {
+ title: 'Box 2'
+ }, {
+ 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
except for required attributes for Ext layouts to function (e.g. overflow:hidden).
@@ -55,7 +115,10 @@ 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 | | | bbarCfg : ObjectA DomHelper element specification object specifying the element structure
of this Panel's bbar Element. See bodyCfg ... A DomHelper element specification object specifying the element structure
-of this Panel's bbar Element. See bodyCfg also. | Panel | | | bodyCfg : ObjectA DomHelper element specification object may be specified for any
+of this Panel's bbar Element. See bodyCfg also. | Panel | | | 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
Panel Element.
By default, the Default element in t... A DomHelper element specification object may be specified for any
Panel Element.
@@ -89,7 +152,7 @@ element:
},
footerCfg: {
tag: 'h2',
- cls: 'x-panel-footer' // same as the Default class
+ cls: 'x-panel-footer', // same as the Default class
html: 'footer html'
},
footerCssClass: 'custom-footer', // additional css class, see addClass
@@ -98,7 +161,9 @@ element:
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 | | | border : BooleanTrue to display the borders of the panel's body element, false to hide them (defaults to true). By default,
+ 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... | 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 | | | 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.
@@ -111,7 +176,10 @@ Warning: This will override any size manag... The mini
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.... | GridPanel | | | buttonAlign : StringThe alignment of any buttons added to this panel. Valid values are 'right',
+Defaults to []. | GridPanel | | | 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. 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 : 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
@@ -147,7 +215,21 @@ Default is false. | An array of columns to auto create a
Ext.grid.ColumnModel. The ColumnModel may be explicitly created via the
-colModel configuration property. | GridPanel | | | ctCls : StringAn optional extra CSS class that will be added to this component's container. This can be useful for
+ colModel configuration property. | GridPanel | | | 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.
@@ -197,7 +279,35 @@ update the content area of the Component. | Configures the text in the drag proxy. Defaults to:
ddText : '{0} selected row{1}'
- {0} is replaced with the number of selected rows. | GridPanel | | | deferRowRender : BooleanDefaults to true to enable deferred row rendering.
+{0} is replaced with the number of selected rows. | GridPanel | | | 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 : 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: [
+ {
+ xtype: 'panel', // defaults do not have precedence over
+ id: 'panel1', // options in config objects, so the defaults
+ autoScroll: false // will not be applied here, panel1 will be autoScroll:false
+ },
+ new Ext.Panel({ // defaults do have precedence over options
+ id: 'panel2', // options in components, so the defaults
+ autoScroll: false // will be applied here, panel2 will be autoScroll:true.
+ })
+]
| Container | | | deferRowRender : BooleanDefaults to true to enable deferred row rendering.
This allows the GridPanel to be initially rendered empty, with the... Defaults to true to enable deferred row rendering.
This allows the GridPanel to be initially rendered empty, with the expensive update of the row
structure deferred so that layouts with GridPanels appear more quickly. | GridPanel | | | disableSelection : Booleantrue to disable selections in the grid. Defaults to false.
@@ -217,7 +327,7 @@ the disabled state:
single: true // important, as many layouts can occur
}
}
-}); | Panel | | | draggable : Boolean/Objecttrue to enable dragging of this Panel (defaults to false).
+}); | Panel | | | 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 config could also be passed
in this config instead of true. Ext.Panel.DD is an internal, undocumented class which
@@ -258,7 +368,19 @@ added by implementing the interface methods of Panel | | | enableColumnHide : Boolean | Panel | | | elements : StringA comma-delimited list of panel elements to initialize when the panel is rendered. Normally, this list will be
+gener... A comma-delimited list of panel elements to initialize when the panel is rendered. Normally, this list will be
+generated automatically based on the items added to the panel at config time, but sometimes it might be useful to
+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
+headertbar (top bar)bodybbar (bottom bar)footer
+Defaults to ' body'. | Panel | | | enableColumnHide : Boolean | GridPanel | | | enableColumnMove : Boolean Defaults to true to enable drag and drop reorder of columns. false
to turn off column reordering via drag drop. | GridPanel | | | enableColumnResize : Boolean false to turn off column resizing for the whole grid. Defaults to true. | GridPanel | | | enableDragDrop : BooleanEnables dragging of the selected rows of the GridPanel. Defaults to false.
Setting this to true causes this GridPanel... Enables dragging of the selected rows of the GridPanel. Defaults to false.
@@ -375,7 +497,9 @@ of this Panel's header Element. See bodyCf... | Panel | | | height : NumberThe height of this component in pixels (defaults to auto).
Note to express this dimension as a percentage or offset s... The height of this component in pixels (defaults to auto).
Note to express this dimension as a percentage or offset see Ext.Component.anchor. | BoxComponent | | | hidden : BooleanRender this component hidden (default is false). If true, the
- hide method will be called internally. | Component | | | hideCollapseTool : Booleantrue to hide the expand/collapse toggle button when collapsible == true,
+ 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 | | | hideHeaders : Boolean True to hide the grid's header. Defaults to false. | GridPanel | | | 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
@@ -400,7 +524,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 | | | 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:
@@ -476,7 +604,40 @@ avoiding potential conflicts with getComponent('p1'); // not the same as Ext.getCmp()
p2 = p1.ownerCt.getComponent('p2'); // reference via a sibling
Also see id and ref.
- Note: to access the container of an item see ownerCt. | Component | | | keys : Object/ArrayA Ext.KeyMap config object (in the format expected by Ext.KeyMap.addBinding
+ Note: to access the container of an item see ownerCt. | Component | | | items : Object/Array** IMPORTANT: be sure to specify a layout if needed ! **
+A single item, or an array of child Components to be added t... ** IMPORTANT: be sure to specify a layout if needed ! **
+ A single item, or an array of child Components to be added to this container,
+for example:
+ // specifying a single item
+items: {...},
+layout: 'fit', // specify a layout!
+
+// specifying multiple items
+items: [{...}, {...}],
+layout: 'anchor', // specify a layout!
+ Each item may be:
+
+- any type of object based on Ext.Component
+- a fully instanciated object or
+- an object literal that:
+
+- has a specified
xtype
+- the Ext.Component.xtype specified is associated with the Component
+desired and should be chosen from one of the available xtypes as listed
+in Ext.Component.
+- If an
xtype is not explicitly
+specified, the defaultType for that Container is used.
+- will be "lazily instanciated", avoiding the overhead of constructing a fully
+instanciated Component object
+
+ Notes:
+
+- Ext uses lazy rendering. Child Components will only be rendered
+should it become necessary. Items are automatically laid out when they are first
+shown (no sizing is done while hidden), or in response to a doLayout call.
+- Do not specify
contentEl/
+html with items.
+ | Container | | | keys : Object/ArrayA Ext.KeyMap config object (in the format expected by Ext.KeyMap.addBinding
used to assign custom key handling to thi... | Panel | | | labelSeparator : StringThe separator to display after the text of each
fieldLabel. This property may be configured at various levels.
@@ -522,7 +683,82 @@ Example use: new Ext.FormPanel({
fieldLabel: 'Name',
labelStyle: 'font-weight:bold;'
}]
-});
| Component | | | listeners : ObjectA config object containing one or more event handlers to be added to this
+}); | Component | | | layout : String/Object*Important: In order for child items to be correctly sized and
+positioned, typically a layout manager must be specifi... *Important: In order for child items to be correctly sized and
+positioned, typically a layout manager must be specified through
+the layout configuration option.
+ The sizing and positioning of child items is the responsibility of
+the Container's layout manager which creates and manages the type of layout
+you have in mind. For example: new Ext.Window({
+ width:300, height: 300,
+ layout: 'fit', // explicitly set layout manager: override the default (layout:'auto')
+ items: [{
+ title: 'Panel inside a Window'
+ }]
+}).show();
+ If the layout configuration is not explicitly specified for
+a general purpose container (e.g. Container or Panel) the
+default layout manager will be used
+which does nothing but render child components sequentially into the
+Container (no sizing or positioning will be performed in this situation).
+Some container classes implicitly specify a default layout
+(e.g. FormPanel specifies layout:'form'). Other specific
+purpose classes internally specify/manage their internal layout (e.g.
+GridPanel, TabPanel, TreePanel, Toolbar, Menu, etc.).
+ layout may be specified as either as an Object or
+as a String:
+- Specify as an Object
+layout: {
+ type: 'vbox',
+ padding: '5',
+ align: 'left'
+}
+ type
+ The layout type to be used for this container. If not specified,
+a default Ext.layout.ContainerLayout will be created and used.
+ Valid layout type values are:
+
+ - Layout specific configuration properties
+ Additional layout specific configuration properties may also be
+specified. For complete details regarding the valid config options for
+each layout type, see the layout class corresponding to the type
+specified.
+ - Specify as a String
+layout: 'vbox',
+layoutConfig: {
+ padding: '5',
+ align: 'left'
+}
+ layout
+ The layout type to be used for this container (see list
+of valid layout type values above).
+ layoutConfig
+ Additional layout specific configuration properties. For complete
+details regarding the valid config options for each layout type, see the
+layout class corresponding to the layout specified.
+ | Container | | | 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
object during initialization. This should ... A config object containing one or more event handlers to be added to this
object during initialization. This should be a valid listeners config object as specified in the
addListener example for attaching multiple handlers at once.
@@ -603,7 +839,10 @@ to the second, and the bottom is set to the third.
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 | | | maxHeight : Number Sets the maximum height of the grid - ignored if autoHeight is not on. | GridPanel | | | minButtonWidth : NumberMinimum width in pixels of all buttons in this panel (defaults to 75) | Panel | | | minColumnWidth : Number The minimum width a column can be resized to. Defaults to 25. | GridPanel | | | overCls : StringAn optional extra CSS class that will be added to this component's Element when the mouse moves
+disabled. | Panel | | | maxHeight : Number Sets the maximum height of the grid - ignored if autoHeight is not on. | GridPanel | | | minButtonWidth : NumberMinimum width in pixels of all buttons in this panel (defaults to 75) | Panel | | | minColumnWidth : Number The minimum width a column can be resized to. Defaults to 25. | GridPanel | | | 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 | | | padding : Number/StringA shortcut for setting a padding style on the body element. The value can either be
@@ -614,7 +853,11 @@ requirement for a ... An object or array of objects that
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 | | | propertyNames : ObjectAn object containing property name/display name pairs.
+component as needed to provide its functionality. | Component | | | preventBodyReset : BooleanDefaults to false. When set to true, an extra css class 'x-panel-normal'
+will be added to the panel's element, effec... Defaults to false. When set to true, an extra css class 'x-panel-normal'
+will be added to the panel's element, effectively applying css styles suggested by the W3C
+(see http://www.w3.org/TR/CSS21/sample.html) to the Panel's body element (not the header,
+footer, etc.). | Panel | | | propertyNames : ObjectAn object containing property name/display name pairs.
If specified, the display name will be shown in the name colum... An object containing property name/display name pairs.
If specified, the display name will be shown in the name column instead of the property name. | PropertyGrid | | | ptype : StringThe registered ptype to create. This config option is not used when passing
a config object into a constructor. This ... The registered ptype to create. This config option is not used when passing
@@ -911,7 +1154,7 @@ config property. Read only. | If this Panel is configured draggable, this property will contain
an instance of Ext.dd.DragSource which handles dragging the Panel.
The developer must provide implementations of the abstract methods of Ext.dd.DragSource
-in order to supply behaviour for each stage of the drag/drop process. See draggable. | Panel | | | el : Ext.ElementThe Ext.Element which encapsulates this Component. Read-only.
+in order to supply behaviour for each stage of the drag/drop process. See draggable. | Panel | | | disabled : Boolean True if this component is disabled. Read-only. | Component | | | el : Ext.ElementThe Ext.Element which encapsulates this Component. Read-only.
This will usually be a <DIV> element created by the ... The Ext.Element which encapsulates this Component. Read-only.
This will usually be a <DIV> element created by the class's onRender method, but
that may be overridden using the autoEl config.
@@ -936,15 +1179,41 @@ Note: see the Note ... | Panel | | | hidden : Boolean True if this component is hidden. Read-only. | Component | | | initialConfig : Object This Component's initial configuration specification. Read-only. | Component | | | ownerCt : Ext.ContainerThis Component's owner Container (defaults to undefined, and is set automatically when
+ 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
+ Note: to access items within the Container see itemId. | Component | | | refOwner : Ext.ContainerThe ancestor Container into which the ref reference was inserted if this Component
is a child of a Container, and has... The ancestor Container into which the ref reference was inserted if this Component
is a child of a Container, and has been configured with a ref. | Component | | | rendered : Boolean True if this component has been rendered. Read-only. | Component |
Public Methods|
| | PropertyGrid( Object config )
- Parameters:config : ObjectThe grid config object
Returns: | PropertyGrid | | | addButton( String/Object config, Function handler, Object scope )
+ Parameters:config : ObjectThe grid config object
Returns: | PropertyGrid | | | 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.
+ Description :
+
+ Notes :
+ 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
@@ -1006,12 +1275,20 @@ Or a shorthand syntax:
'mouseover' : this.onMouseOver,
'mouseout' : this.onMouseOut,
scope: this
-}); Returns: | Observable | | | bubble( Function fn, [Object scope], [Array args] )
+});Returns: | Observable | | | applyToMarkup( String/HTMLElement el )
+ :
+ voidApply this component to existing markup that is valid. With this function, no call to render() is required. Apply this component to existing markup that is valid. With this function, no call to render() is required. | Component | | | bubble( Function fn, [Object scope], [Array args] )
:
Ext.ContainerBubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of... Bubbles up the component/container heirarchy, calling the specified function with each component. The scope ( this) of
function call will be the scope provided or the current component. The arguments to the function
will be the args provided or the current component. If the function returns false at any point,
-the bubble is stopped. | Container | | | cloneConfig( Object overrides )
+the bubble is stopped. | Container | | | cascade( Function fn, [Object scope], [Array args] )
+ :
+ Ext.ContainerCascades down the component/container heirarchy from this component (called first), calling the specified function wi... Cascades down the component/container heirarchy from this component (called first), calling the specified function with
+each component. The scope ( this) of
+function call will be the scope provided or the current component. The arguments to the function
+will be the args provided or the current component. If the function returns false at any point,
+the cascade is stopped on that branch. | Container | | | cloneConfig( Object overrides )
:
Ext.ComponentClone the current component using the original config values passed into this instance by default. Clone the current component using the original config values passed into this instance by default. | Component | | | collapse( Boolean animate )
@@ -1025,7 +1302,16 @@ cancel the collapse action if it returns false.Destroys this component by purging any event listeners, removing the component's element from the DOM,
removing the component from its Ext.Container (if applicable) and unregistering it from
Ext.ComponentMgr. Destruction is generally handled automatically by the framework and this method
-should usually not need to be called directly. | Component | | | enableBubble( String/Array events )
+should usually not need to be called directly. | Component | | | disable()
+ :
+ Ext.ComponentDisable this component and fire the 'disable' event. Disable this component and fire the 'disable' event. | Component | | | doLayout( [Boolean shallow], [Boolean force] )
+ :
+ Ext.ContainerForce this container's layout to be recalculated. A call to this function is required after adding a new component
+to... Force this container's layout to be recalculated. A call to this function is required after adding a new component
+to an already rendered container, or possibly after changing sizing/position properties of child components. Parameters:shallow : Boolean(optional) True to only calc the layout of this component, and let child components auto
+calc layouts as required (defaults to false, which calls doLayout recursively for each subcontainer) force : Boolean(optional) True to force a layout to occur, even if the item is hidden.
Returns: | Container | | | enable()
+ :
+ Ext.ComponentEnable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. | Component | | | enableBubble( String/Array events )
:
voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
this.getBubbleTarget() if present.... Enables events fired by this Observable to bubble up an owner hierarchy by calling
@@ -1064,7 +1350,18 @@ access the required target more quickly.
Ext.Panel Expands the panel body so that it becomes visible. Fires the beforeexpand event which will
cancel the expand action ... Expands the panel body so that it becomes visible. Fires the beforeexpand event which will
cancel the expand action if it returns false. Parameters:animate : BooleanTrue to animate the transition, else false (defaults to the value of the
- animCollapse panel config)
Returns: | Panel | | | findParentBy( Function fn )
+animCollapse panel config)Returns: | Panel | | | find( String prop, String value )
+ :
+ ArrayFind a component under this container at any level by property Find a component under this container at any level by property Parameters:prop : Stringvalue : String
Returns:ArrayArray of Ext.Components
| Container | | | findBy( Function fn, [Object scope] )
+ :
+ ArrayFind a component under this container at any level by a custom function. If the passed function returns
+true, the com... Find a component under this container at any level by a custom function. If the passed function returns
+true, the component will be included in the results. The passed function is called with the arguments (component, this container). Parameters:fn : FunctionThe function to call scope : Object(optional)
Returns:ArrayArray of Ext.Components
| Container | | | findById( String id )
+ :
+ Ext.ComponentFind a component under this container at any level by id Find a component under this container at any level by id | Container | | | findByType( String/Class xtype, [Boolean shallow] )
+ :
+ ArrayFind a component under this container at any level by xtype or class Find a component under this container at any level by xtype or class Parameters:xtype : String/ClassThe xtype string for a component, or the class of the component directly shallow : Boolean(optional) False to check whether this Component is descended from the xtype (this is
+the default), or true to check whether this Component is directly of the specified xtype.
Returns:ArrayArray of Ext.Components
| Container | | | findParentBy( Function fn )
:
Ext.ContainerFind a container above this component at any level by a custom function. If the passed function returns
true, the con... | Component | | | getColumnModel()
:
- Ext.grid.ColumnModelReturns the grid's ColumnModel. Returns the grid's ColumnModel. Parameters:Returns:Ext.grid.ColumnModelThe column model
| GridPanel | | | getDragDropText()
+ Ext.grid.ColumnModelReturns the grid's ColumnModel. Returns the grid's ColumnModel. Parameters:Returns:Ext.grid.ColumnModelThe column model
| GridPanel | | | getComponent( String/Number comp )
+ :
+ Ext.ComponentExamines this container's items property
+and gets a direct child component of this container. Examines this container's items property
+and gets a direct child component of this container. Parameters:comp : String/NumberThis parameter may be any of the following:
+
+- a
String : representing the itemId
+or id 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 | | | getDragDropText()
:
StringCalled to get grid's drag proxy text, by default returns this.ddText. Called to get grid's drag proxy text, by default returns this.ddText. | GridPanel | | | getEl()
:
@@ -1139,7 +1447,11 @@ For the frame width see Returns the itemId of this component. If an
itemId was not assigned through configuration the
- id is returned using getId. | Component | | | getLayoutTarget()
+id is returned using getId. | Component | | | getLayout()
+ :
+ ContainerLayoutReturns the layout currently in use by the container. If the container does not currently have a layout
+set, a defau... Returns the layout currently in use by the container. If the container does not currently have a layout
+set, a default Ext.layout.ContainerLayout will be created and set as the container's layout. | Container | | | getLayoutTarget()
:
Ext.ElementReturns the Element to be used to contain the child Components of this Container.
An implementation is provided which... Returns the Element to be used to contain the child Components of this Container.
@@ -1176,7 +1488,9 @@ format of the data object. Parameters:Retrieve a tool by id. | 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 | | | getView()
+ 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 | | | getView()
:
Ext.grid.GridViewReturns the grid's GridView object. Returns the grid's GridView object. Parameters:Returns:Ext.grid.GridViewThe grid view
| GridPanel | | | getWidth()
:
@@ -1203,7 +1517,22 @@ alert(t.getXTypes()); // alerts 'component/box/field/textfield'
false to cancel hiding the component. Fires the 'h...Hide this component. Listen to the ' beforehide' event and return
false to cancel hiding the component. Fires the ' hide'
event after hiding the component. Note this method is called internally if
-the component is configured to be hidden. | Component | | | isVisible()
+the component is configured to be hidden. | Component | | | insert( Number index, Ext.Component component )
+ :
+ Ext.ComponentInserts a Component into this Container at a specified index. Fires the
+beforeadd event before inserting, then fires ... Inserts a Component into this Container at a specified index. Fires the
+ beforeadd event before inserting, then fires the add event after the
+Component has been inserted. | Container | | | isVisible()
:
BooleanReturns true if this component is visible. Returns true if this component is visible. | Component | | | isXType( String xtype, [Boolean shallow] )
:
@@ -1218,7 +1547,23 @@ to participate in determination of inherited xtypes.
var isText = t.isXType('textfield'); // true
var isBoxSubclass = t.isXType('box'); // true, descended from BoxComponent
var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instanceParameters:xtype : StringThe xtype to check for this Component shallow : Boolean(optional) False to check whether this Component is descended from the xtype (this is
-the default), or true to check whether this Component is directly of the specified xtype.
Returns: | Component | | | mon( Observable|Element item, Object|String ename, Function fn, Object scope, Object opt )
+the default), or true to check whether this Component is directly of the specified xtype.Returns: | Component | | | load( Object/String/Function config )
+ :
+ Ext.PanelLoads this content panel immediately with content returned from an XHR call. Loads this content panel immediately with content returned from an XHR call. Parameters:config : Object/String/FunctionA config object containing any of the following options:
+ panel.load({
+ url: 'your-url.php',
+ 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...',
+ timeout: 30,
+ scripts: false
+});
+The only required property is url. The optional properties nocache, text and scripts
+are shorthand for disableCaching, indicatorText and loadScripts and are used to set their
+associated property on this panel Updater instance.
Returns: | Panel | | | 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
@@ -1258,7 +1603,12 @@ new ColumnModel. Also, an existing plugins might also need reconfiguring
with the new data. Parameters:store : Ext.data.StorecolModel : Ext.grid.ColumnModel
Returns: | GridPanel | | | relayEvents( Object o, Array events )
:
- voidRelays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by this. | Observable | | | removeAll( [Boolean autoDestroy] )
+ voidRelays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by this. | Observable | | | remove( Component/String component, [Boolean autoDestroy] )
+ :
+ Ext.ComponentRemoves a component from this container. Fires the beforeremove event before removing, then fires
+the remove event a... Removes a component from this container. Fires the beforeremove event before removing, then fires
+the remove event after the component has been removed. | Container | | | removeAll( [Boolean autoDestroy] )
:
ArrayRemoves all components from this container. Removes all components from this container. | Container | | | removeClass( string cls )
@@ -1299,7 +1649,9 @@ event... | Observable | | | setAutoScroll( Boolean scroll )
:
- Ext.BoxComponentSets the overflow on the content element of the component. Sets the overflow on the content element of the component. | BoxComponent | | | setHeight( Mixed 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.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. | 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).
@@ -1392,7 +1744,9 @@ content area will be updated via Ext.Element update loadScri
Note that Panels do not directly support being activated, but some...Fires after the Panel has been visually activated.
Note that Panels do not directly support being activated, but some Panel subclasses
do (like Ext.Window). Panels which are child Components of a TabPanel fire the
-activate and deactivate events under the control of the TabPanel. Listeners will be called with the following arguments:
| Panel | | | added :
+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 | | | 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 | | | afteredit :
( Object e )
@@ -1412,13 +1766,19 @@ activate and deactivate events under the control of the TabPanel.Listeners will be called with the following arguments: | EditorGridPanel | | | afterrender :
+};Listeners will be called with the following arguments: | EditorGridPanel | | | afterlayout :
+ ( Ext.Container this, ContainerLayout layout )
+ Fires when the components in this container are arranged by the associated layout manager. Fires when the components in this container are arranged by the associated layout manager. Listeners will be called with the following arguments: | Container | | | afterrender :
( Ext.Component this )
Fires after the component rendering is finished.
The afterrender event is fired after this Component has been rendere... Fires after the component rendering is finished.
The afterrender event is fired after this Component has been rendered, been postprocesed
by any afterRender method defined for the Component, and, if stateful, after state
-has been restored. Listeners will be called with the following arguments: | Component | | | beforeclose :
+has been restored.Listeners will be called with the following arguments: | Component | | | beforeadd :
+ ( Ext.Container this, Ext.Component component, Number index )
+ Fires before any Ext.Component is added or inserted into the container.
+A handler can return false to cancel the add. Fires before any Ext.Component is added or inserted into the container.
+A handler can return false to cancel the add. Listeners will be called with the following arguments: | Container | | | beforeclose :
( Ext.Panel p )
Fires before the Panel is closed. Note that Panels do not directly support being closed, but some
Panel subclasses d... Fires before the Panel is closed. Note that Panels do not directly support being closed, but some
@@ -1451,7 +1811,11 @@ Return false from an event handler to stop the hide.
Fires before a property value changes. Handlers can return false to cancel the property change
(this will internally... Fires before a property value changes. Handlers can return false to cancel the property change
(this will internally call Ext.data.Record.reject on the property's record). Listeners will be called with the following arguments:source : ObjectThe source data object for the grid (corresponds to the same object passed in
-as the source config property). recordId : StringThe record's id in the data store value : MixedThe current edited property value oldValue : MixedThe original property value prior to editing
| PropertyGrid | | | beforerender :
+as the source config property).recordId : StringThe record's id in the data store value : MixedThe current edited property value oldValue : MixedThe original property value prior to editing | PropertyGrid | | | beforeremove :
+ ( Ext.Container this, Ext.Component component )
+ Fires before any Ext.Component is removed from the container. A handler can return
+false to cancel the remove. Fires before any Ext.Component is removed from the container. A handler can return
+false to cancel the remove. Listeners will be called with the following arguments: | Container | | | beforerender :
( Ext.Component this )
Fires before the component is rendered. Return false from an
event handler to stop the render. | PropertyGrid | | | reconfigure :
( Grid this, Ext.data.Store store, Ext.grid.ColumnModel colModel )
- Fires when the grid is reconfigured with a new store and/or column model. Fires when the grid is reconfigured with a new store and/or column model. Listeners will be called with the following arguments:this : Gridstore : Ext.data.StoreThe new store colModel : Ext.grid.ColumnModelThe new column model
| GridPanel | | | removed :
+ Fires when the grid is reconfigured with a new store and/or column model. Fires when the grid is reconfigured with a new store and/or column model. Listeners will be called with the following arguments:this : Gridstore : Ext.data.StoreThe new store colModel : Ext.grid.ColumnModelThe new column model
| GridPanel | | | remove :
+ ( Ext.Container this, Ext.Component component )
+ Listeners will be called with the following arguments: | Container | | | removed :
( Ext.Component this, Ext.Container ownerCt )
Fires when a component is removed from an Ext.Container Fires when a component is removed from an Ext.Container Listeners will be called with the following arguments: | Component | | | render :
( Ext.Component this )
|
|