| activeItem : String/NumberA string component id or the numeric index of the component that should be initially activated within the
-container'... 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
+}); 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 | | 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
@@ -58,8 +58,8 @@ based layout manager, for example:
- See Ext.layout.AnchorLayout.anchor also. | Component | | autoDestroy : BooleanIf true the container will automatically destroy any contained component that is removed from it, else
-destruction m... | Component | | 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
@@ -89,13 +89,25 @@ different DOM elements. Example usage: {
autoEl: 'li',
html: 'First list item'
}
-}
| Component | | autoShow : BooleanTrue if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
+} | Component | | 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 | | bubbleEvents : ArrayAn array of events that, when fired, should be bubbled to any parent container.
-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
-t... 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 | | clearCls : StringThe CSS class used to to apply to the special clearing div rendered
+them on render (defaults to false). | Component | | boxMaxHeight : NumberThe maximum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size mana... The maximum value in pixels which this BoxComponent will set its height to.
+ Warning: This will override any size management applied by layout managers. | BoxComponent | | boxMaxWidth : NumberThe maximum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size manag... The maximum value in pixels which this BoxComponent will set its width to.
+ Warning: This will override any size management applied by layout managers. | BoxComponent | | boxMinHeight : NumberThe minimum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size mana... The minimum value in pixels which this BoxComponent will set its height to.
+ Warning: This will override any size management applied by layout managers. | BoxComponent | | boxMinWidth : NumberThe minimum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size manag... The minimum value in pixels which this BoxComponent will set its width to.
+ Warning: This will override any size management applied by layout managers. | BoxComponent | | bubbleEvents : ArrayAn array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.... | Container | | bufferResize : Boolean/NumberWhen set to true (50 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
+th... When set to true (50 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
+the frequency it calculates and does a re-layout of components. This is useful for heavy containers or containers
+with a large quantity of sub-components for which frequent layout calls would be expensive. Defaults to 50 . | Container | | 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').
@@ -105,7 +117,21 @@ manager (e.g. fieldLabel is specified or isFormField=true is specified.
See Ext.layout.FormLayout.fieldTpl also. | Component | | 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 | | ctCls : StringAn optional extra CSS class that will be added to this component's container. This can be useful for
+useful for adding customized styles to the component or any of its children using standard CSS rules. | Component | | 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.
@@ -116,30 +142,35 @@ 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
-a child item is specified as a raw configurat... 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 th... 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
- 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.
- })
+
| 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 : 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 | | disabled : Boolean Render this component disabled (default is false). | Component | | disabledClass : String CSS class added to the component when it is disabled (defaults to 'x-item-disabled'). | Component | | fieldLabel : StringThe label text to display next to this Component (defaults to '').
Note: this config is only used when this Component... The label text to display next to this Component (defaults to '').
Note: this config is only used when this Component is rendered by a Container which
@@ -154,11 +185,11 @@ Example use: new Ext.FormPanel({
xtype: 'textfield',
fieldLabel: 'Name'
}]
-});
| Component | | forceLayout : BooleanIf true the container will force a layout initially even if hidden or collapsed. This option
-is useful for forcing f... If true the container will force a layout initially even if hidden or collapsed. This option
+}); | Component | | 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 | | 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 (de... True to hide the borders of each contained component, false to defer to the component's existing
+ hide method will be called internally. | Component | | hideBorders : BooleanTrue to hide the borders of each contained component, false to defer to the component's existing
+border settings (def... True to hide the borders of each contained component, false to defer to the component's existing
border settings (defaults to false). | Container | | hideLabel : Booleantrue to completely hide the label element
(label and separator). Defaults to false.
By default, even if you do not sp... true to completely hide the label element
@@ -180,7 +211,11 @@ Example use: new Ext.FormPanel({
(css display).
Note: the default of 'display' is generally preferred
since items are automatically laid out when they are first shown (no sizing
-is done while hidden).
| Component | | id : StringThe unique id of this component (defaults to an auto-assigned id).
+is done while hidden). | Component | | html : String/ObjectAn HTML fragment, or a DomHelper specification to use as the layout element
+content (defaults to ''). The HTML conten... An HTML fragment, or a DomHelper specification to use as the layout element
+content (defaults to ''). The HTML content is added after the component is rendered,
+so the document will not contain this HTML at the time the render event is fired.
+This content is inserted into the body before any configured contentEl is appended. | Component | | id : StringThe unique id of this component (defaults to an auto-assigned id).
You should assign an id if you need to be able to ... The unique id of this component (defaults to an auto-assigned id).
You should assign an id if you need to be able to access the component later and you do
not have an object reference available (e.g., using Ext.getCmp).
@@ -248,39 +283,39 @@ avoiding potential conflicts with getComponent( 'p1'); // not the same as Ext.getCmp()
p2 = p1. ownerCt. getComponent( 'p2'); // reference via a sibling
Also see id and ref .
- Note: to access the container of an item see ownerCt. | Component | | items : Object/Array** IMPORTANT: be sure to specify a layout if needed ! **
-A single item, or an array of child Components to be added ... ** 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:
- | 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 | | 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
@@ -325,84 +360,82 @@ Example use: new Ext.FormPanel({
fieldLabel: 'Name',
labelStyle: 'font-weight:bold;'
}]
-});
| Component | | layout : String/Object*Important: In order for child items to be correctly sized and
-positioned, typically a layout manager must be specif... *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 strin... This 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
+}); | 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.
@@ -495,9 +528,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',
@@ -516,13 +549,14 @@ For example, to put a reference to a Toolbar Button into the Panel which owns
}
}
});
- In the code above, if the ref had been 'saveButton' the reference would
-have been placed into the Toolbar. Each '/' in the ref moves up one level from the
-Component's ownerCt. | Component | | region : StringNote: this config is only used when this BoxComponent is rendered
+ In the code above, if the ref had been 'saveButton'
+the reference would have been placed into the Toolbar. Each '/' in the ref
+moves up one level from the Component's ownerCt .
+ Also see the added and removed events. | Component | | region : StringNote: this config is only used when this BoxComponent is rendered
by a Container which has been configured to use the... Note: this config is only used when this BoxComponent is rendered
by a Container which has been configured to use the BorderLayout
layout manager (e.g. specifying layout:'border').
- See Ext.layout.BorderLayout also. | BoxComponent | | resizeEvent : String The event to listen to for resizing in layouts. Defaults to 'resize'. | Container | | stateEvents : Array | BoxComponent | | resizeEvent : String The event to listen to for resizing in layouts. Defaults to 'resize' . | Container | | 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
@@ -596,7 +630,16 @@ Ext.Element.ap... A custom style specification to be appl
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 | | x : Number The local x (left) coordinate for this component if contained within a positioning container. | BoxComponent | | xtype : StringThe registered xtype to create. This config option is not used when passing
+must be called in order for the tips to render. | BoxComponent | | tpl : MixedAn Ext.Template, Ext.XTemplate
+or an array of strings to form an Ext.XTemplate.
+Used in conjunction with the data and... | Component | | tplWriteMode : StringThe Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
+(see Ext.X... The Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
+(see Ext.XTemplate.overwrite ). | Component | | x : Number The local x (left) coordinate for this component if contained within a positioning container. | BoxComponent | | xtype : StringThe registered xtype to create. This config option is not used when passing
a config object into a constructor. This ... The registered xtype to create. This config option is not used when passing
a config object into a constructor. This config option is used only when
lazy instantiation is being used, and a child item of a Container is being
@@ -627,35 +670,37 @@ config for a suggestion, or use a render listener directly: new
See also getEl
| Component | | hidden : Boolean True if this component is hidden. Read-only. | Component | | initialConfig : Object This Component's initial configuration specification. Read-only. | Component | | items : MixedCollection | Container | | ownerCt : Ext.ContainerThis Component's owner Container (defaults to undefined, and is set automatically when
this Component is added to a C... This Component's owner Container (defaults to undefined, and is set automatically when
this Component is added to a Container). Read-only.
- Note: to access items within the Container see itemId. | Component | | rendered : Boolean True if this component has been rendered. Read-only. | Component |
Public Methods|
| Viewport( Object config )
- Create a new Viewport Create a new Viewport Parameters:config : ObjectThe config object Returns: | Viewport | | add( Object/Array component , Object (Optional) , Object (Optional) )
- :
- Ext.ComponentAdds Component(s) to this Container.
-Description :
-<ul class="mdetail-params">
-Fires the beforeadd event before ad... Adds Component(s) to this Container.
- Description :
-
- Notes :
- Parameters:component : Object/ArrayEither a single component or an Array of components to add. See
+ 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|
| Viewport( Object config )
+ Create a new Viewport Create a new Viewport Parameters:config : ObjectThe config object Returns: | Viewport | | add( Object/Array component , Object (Optional) , Object (Optional) )
+ :
+ Ext.ComponentAdds Component(s) to this Container.
+Description :
+<ul class="mdetail-params">
+Fires the beforeadd event before addin... Adds Component(s) to this Container.
+ Description :
+
+ Notes :
+ Parameters:component : Object/ArrayEither a single component or an Array of components to add. See
items for additional information. (Optional) : Objectcomponent_2 (Optional) : Objectcomponent_n Returns: | Container | | addClass( string cls )
:
Ext.ComponentAdds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. | Component | | addEvents( Object|String o , string Optional. )
@@ -717,15 +762,19 @@ Or a shorthand syntax:
:
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 | | cascade( Function fn , [Object scope ], [Array args ] )
+ Ext.ContainerBubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of... Bubbles up the component/container heirarchy, calling the specified function with each component. The scope ( this) of
+function call will be the scope provided or the current component. The arguments to the function
+will be the args provided or the current component. If the function returns false at any point,
+the bubble is stopped. | Container | | canLayout()
:
- 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,
+ void 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 par... We can only lay out if there is a view area in which to layout.
+display:none on the layout target, *or any of its parent elements* will mean it has no view area. | Container | | cascade( Function fn , [Object scope ], [Array args ] )
+ :
+ 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. Parameters:overrides : ObjectA new config containing any properties to override in the cloned version.
@@ -739,12 +788,12 @@ should usually not need to be called directly. Disable 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
-t... 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
+ Ext.Container Force 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( Object events )
+ 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
@@ -753,13 +802,13 @@ this.getBubbleTarget() if present... Enables events fi
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');
+ // 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() {
+ // We know that we want Field's events to bubble directly to the FormPanel.
+ getBubbleTarget : function() {
if (!this.formPanel) {
this.formPanel = this.findParentByType('form');
}
@@ -774,21 +823,21 @@ access the required target more quickly.
}],
listeners: {
change: function() {
-// Title goes red if form has been modified.
- myForm.header.setStyle("color", "red");
+ // Title goes red if form has been modified.
+ myForm.header.setStyle('color', 'red');
}
}
-});
| Observable | | find( String prop , String value )
+}); | Observable | | 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:Array Array 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 co... Find a component under this container at any level by a custom function. If the passed function returns
+ Array Find 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:Array Array 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 | Container | | findParentBy( Function fn )
:
Ext.Container | Component | | getComponent( String/Number comp )
:
- Ext.ComponentExamines this container's items property
-and gets a direct child component of this container. Examines this container's items property
-and gets a direct child component of this container. 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
-
+ Ext.Component Examines 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 | | getEl()
:
Ext.ElementReturns the Ext.Element which encapsulates this Component.
@@ -851,21 +900,21 @@ id is returned using g... Returns the itemId was not assigned through configuration the
id is returned using getId . | Component | | getLayout()
:
- ContainerLayoutReturns the layout currently in use by the container. If the container does not currently have a layout
-set, a defa... Returns the layout currently in use by the container. If the container does not currently have a layout
+ ContainerLayout Returns 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 whic... Returns the Element to be used to contain the child Components of this Container.
- An implementation is provided which returns the Container's Element, but
-if there is a more complex structure to a Container, this may be overridden to return
+ Ext.Element Returns the Element to be used to contain the child Components of this Container.
+An implementation is provided which... Returns the Element to be used to contain the child Components of this Container.
+ An implementation is provided which returns the Container's Element, but
+if there is a more complex structure to a Container, this may be overridden to return
the element into which the layout renders child Components. | Container | | getOuterSize()
:
ObjectGets the current size of the component's underlying element, including space taken by its margins. Gets the current size of the component's underlying element, including space taken by its margins. | BoxComponent | | getPosition( [Boolean local ] )
:
ArrayGets the current XY position of the component's underlying element. Gets the current XY position of the component's underlying element. | BoxComponent | | getResizeEl()
:
- voidReturns the outermost Element of this Component which defines the Components overall size.
+ Ext.Element Returns the outermost Element of this Component which defines the Components overall size.
Usually this will return t... Returns the outermost Element of this Component which defines the Components overall size.
Usually this will return the same Element as getEl ,
but in some cases, a Component may have some more wrapping Elements around its main
@@ -873,7 +922,7 @@ active Element.
An example is a ComboBox. It is encased in a wrapping Element which
contains both the <input> Element (which is what would be returned
by its getEl method, and the trigger button Element.
-This Element is returned as the resizeEl . | BoxComponent | | getSize()
+This Element is returned as the resizeEl . | BoxComponent | | getSize()
:
ObjectGets the current size of the component's underlying element. Gets the current size of the component's underlying element. | BoxComponent | | getWidth()
:
@@ -902,19 +951,19 @@ false to cancel hiding the component. Fires the 'h...Hi
event after hiding the component. Note this method is called internally if
the component is configured to be hidden . | Component | | insert( Number index , Ext.Component component )
:
- Ext.ComponentInserts a Component into this Container at a specified index. Fires the
-beforeadd event before inserting, then fires... Inserts a Component into this Container at a specified index. Fires the
- beforeadd event before inserting, then fires the add event after the
-Component has been inserted. Parameters:Returns:Ext.Component component The Component (or config object) that was
+ Ext.Component Inserts 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 ] )
@@ -930,7 +979,26 @@ 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 | | nextSibling()
+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 )
+ :
+ voidAdds listeners to any Observable object (or Elements) which are automatically removed when this Component
+is destroye... Adds listeners to any Observable object (or Elements) which are automatically removed when this Component
+is destroyed. Usage:
+myGridPanel.mon(myGridPanel.getSelectionModel(), 'selectionchange', handleSelectionChange, null, {buffer: 50});
+
+ or:
+myGridPanel.mon(myGridPanel.getSelectionModel(), {
+ selectionchange: handleSelectionChange,
+ buffer: 50
+});
+
Parameters:item : Observable|ElementThe item to which to add a listener/listeners. ename : Object|StringThe event name, or an object containing event name properties. fn : FunctionOptional. If the ename parameter was an event name, this
+is the handler function. scope : ObjectOptional. If the ename parameter was an event name, this
+is the scope (this reference) in which the handler function is executed. opt : ObjectOptional. If the ename parameter was an event name, this
+is the addListener options. Returns: | Component | | mun( Observable|Element item , Object|String ename , Function fn , Object scope )
+ :
+ voidRemoves listeners that were added by the mon method. Removes listeners that were added by the mon method. Parameters:item : Observable|ElementThe item from which to remove a listener/listeners. ename : Object|StringThe event name, or an object containing event name properties. fn : FunctionOptional. If the ename parameter was an event name, this
+is the handler function. scope : ObjectOptional. If the ename parameter was an event name, this
+is the scope (this reference) in which the handler function is executed. Returns: | Component | | nextSibling()
:
Ext.ComponentReturns the next component in the owning container Returns the next component in the owning container | Component | | on( String eventName , Function handler , [Object scope ], [Object options ] )
:
@@ -943,12 +1011,12 @@ the default), or true to check whether this Component is directly of the specifi
:
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 ... 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. Parameters:autoDestroy : Boolean(optional) True to automatically invoke the removed Component's Ext.Component.destroy function.
+ Array Removes all components from this container. Removes all components from this container.
| Container | | removeClass( string cls )
:
Ext.ComponentRemoves a CSS class from the component's underlying element. Removes a CSS class from the component's underlying element. | Component | | removeListener( String eventName , Function handler , [Object scope ] )
@@ -983,7 +1051,9 @@ which this component will be inserted (defaults to appending to the end of the c
If events were suspended using the queueSuspended parameter, then all
event...Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
-events fired during event suspension will be sent to any listeners now. | Observable | | setDisabled( Boolean disabled )
+events fired during event suspension will be sent to any listeners now. | Observable | | setAutoScroll( Boolean scroll )
+ :
+ Ext.BoxComponentSets the overflow on the content element of the component. Sets the overflow on the content element of the component. | BoxComponent | | setDisabled( Boolean disabled )
:
Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. | Component | | setHeight( Number height )
:
@@ -1032,11 +1102,18 @@ after the Force the component's size to recalculate based on the underlying element's current height and width. Force the component's size to recalculate based on the underlying element's current height and width. | BoxComponent | | un( String eventName , Function handler , [Object scope ] )
:
- voidRemoves an event handler (shorthand for removeListener.) | Observable | | updateBox( Object box )
+ voidRemoves an event handler (shorthand for removeListener.) | Observable | | update( Mixed htmlOrData , [Boolean loadScripts ], [Function callback ] )
+ :
+ voidUpdate the content area of a component. Update the content area of a component. Parameters:htmlOrData : MixedIf this component has been configured with a template via the tpl config
+then it will use this argument as data to populate the template.
+If this component was not configured with a template, the components
+content area will be updated via Ext.Element update loadScripts : Boolean(optional) Only legitimate when using the html configuration. Defaults to false callback : Function(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading Returns: | Component | | updateBox( Object box )
:
Ext.BoxComponentSets the current box measurements of the component's underlying element. Sets the current box measurements of the component's underlying element. | BoxComponent |
Public Events|
| add :
( Ext.Container this , Ext.Component component , Number index )
- Listeners will be called with the following arguments: | Container | | afterlayout :
+ Listeners will be called with the following arguments: | Container | | added :
+ ( Ext.Component this , Ext.Container ownerCt , number index )
+ Fires when a component is added to an Ext.Container Fires when a component is added to an Ext.Container Listeners will be called with the following arguments: | Component | | afterlayout :
( Ext.Container this , ContainerLayout layout )
Fires when the components in this container are arranged by the associated layout manager. Fires when the components in this container are arranged by the associated layout manager. Listeners will be called with the following arguments: | Container | | afterrender :
( Ext.Component this )
@@ -1046,8 +1123,8 @@ The afterrender event is fired after this Component has been rendere...stateful, after state
has been restored.Listeners will be called with the following arguments: | Component | | beforeadd :
( Ext.Container this , Ext.Component component , Number index )
- Fires before any Ext.Component is added or inserted into the container.
-A handler can return false to cancel the add... Fires before any Ext.Component is added or inserted into the container.
+ 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 | | beforedestroy :
( Ext.Component this )
Fires before the component is destroyed. Return false from an event handler to stop the destroy. Fires before the component is destroyed. Return false from an event handler to stop the destroy. Listeners will be called with the following arguments: | Component | | beforehide :
@@ -1056,8 +1133,8 @@ A handler can return false to cancel the add.Fires before the component is hidden by calling the hide method.
Return false from an event handler to stop the hide. Listeners will be called with the following arguments: | Component | | beforeremove :
( Ext.Container this , Ext.Component component )
- Fires before any Ext.Component is removed from the container. A handler can return
-false to cancel the remove. Fires before any Ext.Component is removed from the container. A handler can return
+ 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 )
| BoxComponent | | remove :
( Ext.Container this , Ext.Component component )
- Listeners will be called with the following arguments: | Container | | render :
+ Listeners will be called with the following arguments: | Container | | removed :
+ ( Ext.Component this , Ext.Container ownerCt )
+ Fires when a component is removed from an Ext.Container Fires when a component is removed from an Ext.Container Listeners will be called with the following arguments: | Component | | render :
( Ext.Component this )
Fires after the component markup is rendered. Fires after the component markup is rendered. Listeners will be called with the following arguments: | Component | | resize :
( Ext.Component this , Number adjWidth , Number adjHeight , Number rawWidth , Number rawHeight )
|
|