| | activeItem : String/NumberA string component id or the numeric index of the component that should be initially activated within the
+ floating:false, a Menu may be used as child of a Container. 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 | | | allowOtherMenus : Boolean True to allow multiple menus to be displayed at the same time (defaults to false) | Menu | | | anchor : String | Container | | | allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component | | | allowOtherMenus : Boolean True to allow multiple menus to be displayed at the same time (defaults to false) | Menu | | | anchor : StringNote: this config is only used when this Component is rendered
by a Container which has been configured to use an Anc... Note: this config is only used when this Component is rendered
-by a Container which has been configured to use an AnchorLayout
+by a Container which has been configured to use an AnchorLayout (or subclass thereof).
based layout manager, for example:
- See Ext.layout.AnchorLayout.anchor also. | Component | | | applyTo : Mixed | BoxComponent | | | applyTo : MixedSpecify the id of the element, a DOM element or an existing Element corresponding to a DIV
that is already present in... Specify the id of the element, a DOM element or an existing Element corresponding to a DIV
that is already present in the document that specifies some structural markup for this
component.
@@ -32,10 +32,10 @@ to create its subcomponents from that markup if applicable. 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 component's container.
- | Component | | | autoDestroy : BooleanIf true the container will automatically destroy any contained component that is removed from it, else
+ | 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.
+destruction must be handled manually (defaults to true). | Container | | | autoEl : MixedA tag name or DomHelper spec used to create the Element which will
+encapsulate this Component.
You do not normally ne... A tag name or DomHelper spec used to create the Element which will
encapsulate this Component.
You do not normally need to specify this. For the base classes Ext.Component, Ext.BoxComponent,
@@ -63,7 +63,7 @@ different DOM elements. Example usage: {
autoEl: 'li',
html: 'First list item'
}
-}
| Component | | | autoHeight : BooleanTrue to use height:'auto', false to use fixed height (or allow it to be managed by its parent
+} | Component | | | autoHeight : BooleanTrue to use height:'auto', false to use fixed height (or allow it to be managed by its parent
Container's layout mana... True to use height:'auto', false to use fixed height (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
@@ -95,11 +95,11 @@ result in elements needing to be synchronized with the new height. Example: <
}
}
}
-}).show(); | BoxComponent | | | autoScroll : Booleantrue to use overflow:'auto' on the components layout element and show scroll bars automatically when
+}).show(); | BoxComponent | | | 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
+necessary, false to clip any overflowing content (defaults to false). | BoxComponent | | | autoShow : BooleanTrue if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
them on render... True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
-them on render (defaults to false). | Component | | | autoWidth : BooleanTrue to use width:'auto', false to use fixed width (or allow it to be managed by its parent
+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
@@ -129,21 +129,21 @@ child items when the browser changes its width: var myPanel = <
}, {
title: 'Box 3'
}],
-});
| BoxComponent | | | boxMaxHeight : NumberThe maximum value in pixels which this BoxComponent will set its height to.
+}); | BoxComponent | | | 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 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 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 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.
+ 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
+Defaults to ['add', 'remove']. | Container | | | bufferResize : Boolean/NumberWhen set to true (50 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
th... When set to true (50 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
the frequency it calculates and does a re-layout of components. This is useful for heavy containers or containers
-with a large quantity of sub-components for which frequent layout calls would be expensive. Defaults to 50. | Container | | | clearCls : StringThe CSS class used to to apply to the special clearing div rendered
+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').
@@ -151,9 +151,9 @@ directly after each form field wrapper to provide field clearing (defaults to
which has been configured to use the FormLayout layout
manager (e.g. Ext.form.FormPanel or specifying layout:'form') and either a
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
+ 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 | | | contentEl : StringOptional. Specify an existing HTML element, or the id of an existing HTML element to use as the content
+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.
@@ -167,7 +167,7 @@ of a new component (it simply moves the specified DOM element after the Compo
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
+ | 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.
@@ -179,20 +179,20 @@ 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 | | | data : MixedThe initial set of data to apply to the tpl to
-update the content area of the Component. | Component | | | defaultAlign : StringThe default Ext.Element.alignTo anchor position value for this menu
+update the content area of the Component. | Component | | | defaultAlign : StringThe default Ext.Element.alignTo anchor position value for this menu
relative to its element of origin (defaults to 't... The default Ext.Element.alignTo anchor position value for this menu
-relative to its element of origin (defaults to 'tl-bl?') | Menu | | | defaultOffsets : ArrayAn array specifying the [x, y] offset in pixels by which to
+relative to its element of origin (defaults to 'tl-bl?') | Menu | | | defaultOffsets : ArrayAn array specifying the [x, y] offset in pixels by which to
change the default Menu popup position after aligning acc... An array specifying the [x, y] offset in pixels by which to
change the default Menu popup position after aligning according to the defaultAlign
-configuration. Defaults to [0, 0]. | Menu | | | defaultType : StringThe default xtype of child Components to create in this Container when
+configuration. Defaults to [0, 0]. | Menu | | | defaultType : StringThe default xtype of child Components to create in this Container when
a child item is specified as a raw configurati... The default xtype of child Components to create in this Container when
a child item is specified as a raw configuration object, rather than as an instantiated Component.
Defaults to 'panel', except Ext.menu.Menu which defaults to 'menuitem',
-and Ext.Toolbar and Ext.ButtonGroup which default to 'button'. | Container | | | defaults : ObjectA config object that will be applied to all items added to this container either via the items
+and Ext.Toolbar and Ext.ButtonGroup which default to 'button'. | Container | | | defaults : ObjectA config object that will be applied to all items added to this container either via the items
config or via the add ... A config object that will be applied to all items added to this container either via the items
config or via the add method. 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 menu. | Menu | | | 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 | | | enableScrolling : Boolean True to allow the menu container to have scroller controls if the menu is too long (defaults to true). | Menu | | | fieldLabel : StringThe label text to display next to this Component (defaults to '').
+being added to the menu. | Menu | | | 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 | | | enableScrolling : Boolean True to allow the menu container to have scroller controls if the menu is too long (defaults to true). | Menu | | | 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
has been configured to use the FormLayout layout manager (e.g.
@@ -206,22 +206,28 @@ Example use: new Ext.FormPanel({
xtype: 'textfield',
fieldLabel: 'Name'
}]
-});
| Component | | | floating : BooleanBy default, a Menu configured as floating:true
-will be rendered as an Ext.Layer (an absolutely positioned,
+}); | Component | | | flex : NumberNote: this config is only used when this Component is rendered
+by a Container which has been configured to use a BoxL... Note: this config is only used when this Component is rendered
+by a Container which has been configured to use a BoxLayout.
+Each child Component with a flex property will be flexed either vertically (by a VBoxLayout)
+or horizontally (by an HBoxLayout) according to the item's relative flex value
+compared to the sum of all Components with flex value specified. Any child items that have
+either a flex = 0 or flex = undefined will not be 'flexed' (the initial size will not be changed). | BoxComponent | | | floating : BooleanBy default, a Menu configured as floating:true
+will be rendered as an Ext.Layer (an absolutely positioned,
floating C... By default, a Menu configured as floating:true
will be rendered as an Ext.Layer (an absolutely positioned,
floating Component with zindex=15000).
If configured as floating:false, the Menu may be
used as child item of another Container instead of a free-floating
-Layer. | Menu | | | forceLayout : BooleanIf true the container will force a layout initially even if hidden or collapsed. This option
+ Layer. | Menu | | | 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 | | | height : NumberThe height of this component in pixels (defaults to auto).
+is useful for forcing forms to render in collapsed or hidden containers. (defaults to false). | Container | | | height : NumberThe height of this component in pixels (defaults to auto).
Note to express this dimension as a percentage or offset s... The height of this component in pixels (defaults to auto).
Note to express this dimension as a percentage or offset see Ext.Component.anchor. | BoxComponent | | | hidden : BooleanRender this component hidden (default is false). If true, the
- hide method will be called internally. | Component | | | hideBorders : BooleanTrue to hide the borders of each contained component, false to defer to the component's existing
+ 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.
+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
(label and separator). Defaults to false.
By default, even if you do not specify a fieldLabel the space will still be
@@ -235,20 +241,20 @@ Example use: new Ext.FormPanel({
xtype: 'textfield'
hideLabel: true
}]
-});
| Component | | | hideMode : StringHow this component should be hidden. Supported values are 'visibility'
+}); | Component | | | hideMode : StringHow this component should be hidden. Supported values are 'visibility'
(css visibility), 'offsets' (negative offset p... How this component should be hidden. Supported values are 'visibility'
(css visibility), 'offsets' (negative offset position) and 'display'
(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 | | | hideParent : BooleanTrue to hide and show the component's container when hide/show is called on the component, false to hide
+is done while hidden). | Component | | | hideParent : BooleanTrue to hide and show the component's container when hide/show is called on the component, false to hide
and show the... True to hide and show the component's container when hide/show is called on the component, false to hide
and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide
-button on a window by setting hide:true on the button when adding it to its parent container. | Component | | | html : String/ObjectAn HTML fragment, or a DomHelper specification to use as the layout element
+button on a window by setting hide:true on the button when adding it to its parent container. | Component | | | html : String/ObjectAn HTML fragment, or a DomHelper specification to use as the layout element
content (defaults to ''). The HTML conten... An HTML fragment, or a DomHelper specification to use as the layout element
content (defaults to ''). The HTML content is added after the component is rendered,
so the document will not contain this HTML at the time the render event is fired.
-This content is inserted into the body before any configured contentEl is appended. | Component | | | id : StringThe unique id of this component (defaults to an auto-assigned id).
+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).
@@ -258,9 +264,9 @@ rules to style the specific instance of this component uniquely, and also to sel
sub-elements using this component's id as the parent.
Note: to avoid complications imposed by a unique id also see
itemId and ref.
- Note: to access the container of an item see ownerCt. | Component | | | ignoreParentClicks : BooleanTrue to ignore clicks on any item in this menu that is a parent item (displays
+ Note: to access the container of an item see ownerCt. | Component | | | ignoreParentClicks : BooleanTrue to ignore clicks on any item in this menu that is a parent item (displays
a submenu) so that the submenu is not ... True to ignore clicks on any item in this menu that is a parent item (displays
-a submenu) so that the submenu is not dismissed when clicking the parent item (defaults to false). | Menu | | | itemCls : StringNote: this config is only used when this Component is rendered by a Container which
+a submenu) so that the submenu is not dismissed when clicking the parent item (defaults to false). | Menu | | | itemCls : StringNote: this config is only used when this Component is rendered by a Container which
has been configured to use the Fo... Note: this config is only used when this Component is rendered by a Container which
has been configured to use the FormLayout layout manager (e.g.
Ext.form.FormPanel or specifying layout:'form').
@@ -289,7 +295,7 @@ Example use: // Apply a style to the field's label:
xtype: 'textfield',
fieldLabel: 'Favorite Color'
}]
-});
| Component | | | itemId : StringAn itemId can be used as an alternative way to get a reference to a component
+}); | Component | | | itemId : StringAn itemId can be used as an alternative way to get a reference to a component
when no object reference is available. ... An itemId can be used as an alternative way to get a reference to a component
when no object reference is available. Instead of using an id with
Ext.getCmp, use itemId with
@@ -319,8 +325,8 @@ p1 = c.ownerCt.getComponent('p2'); // reference via a sibling
Also see id and ref.
Note: to access the container of an item see ownerCt. | Component | | | items : MixedAn array of items to be added to this menu. Menus may contain either menu items,
-or general Components. | Menu | | | labelSeparator : StringThe separator to display after the text of each
-fieldLabel. This property may be configured at various levels.
+or general Components. | Menu | | | labelSeparator : StringThe separator to display after the text of each
+fieldLabel. This property may be configured at various levels.
The o... The separator to display after the text of each
fieldLabel. This property may be configured at various levels.
The order of precedence is:
@@ -348,7 +354,7 @@ Example use: new Ext.FormPanel({
xtype: 'textfield',
fieldLabel: 'Field 2' // labelSeparator will be '='
}]
-});
| Component | | | labelStyle : StringA CSS style specification string to apply directly to this field's
+}); | Component | | | labelStyle : StringA CSS style specification string to apply directly to this field's
label. Defaults to the container's labelStyle val... A CSS style specification string to apply directly to this field's
label. Defaults to the container's labelStyle value if set (e.g.,
Ext.layout.FormLayout.labelStyle , or '').
@@ -363,12 +369,12 @@ Example use: new Ext.FormPanel({
fieldLabel: 'Name',
labelStyle: 'font-weight:bold;'
}]
-});
| Component | | | layout : String/ObjectThis class assigns a default layout (layout:'menu').
+}); | Component | | | layout : String/ObjectThis class assigns a default layout (layout:'menu').
Developers may override this configuration option if another lay... This class assigns a default layout ( layout:'menu').
Developers may override this configuration option if another layout is required.
See Ext.Container.layout for additional information. | Menu | | | 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
+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.
@@ -423,7 +429,7 @@ Ext.DomObserver = Ext.extend(Object, {
typeAhead: true,
mode: 'local',
triggerAction: 'all'
-}); | Observable | | | margins : ObjectNote: this config is only used when this BoxComponent is rendered
+}); | Observable | | | margins : ObjectNote: 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
or one of the two BoxLayout subclasses.
@@ -444,18 +450,18 @@ right and left are set to the second.
to the second, and the bottom is set to the third.
If there are four values, they apply to the top, right, bottom, and left, respectively.
- Defaults to: {top:0, right:0, bottom:0, left:0}
| BoxComponent | | | maxHeight : Number The maximum height of the menu. Only applies when enableScrolling is set to True (defaults to null). | Menu | | | minWidth : Number The minimum width of the menu in pixels (defaults to 120) | Menu | | | monitorResize : BooleanTrue to automatically monitor window resize events to handle anything that is sensitive to the current size
+ Defaults to: {top:0, right:0, bottom:0, left:0}
| BoxComponent | | | maxHeight : Number The maximum height of the menu. Only applies when enableScrolling is set to True (defaults to null). | Menu | | | minWidth : Number The minimum width of the menu in pixels (defaults to 120) | Menu | | | 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
+to be set manually. | Container | | | overCls : StringAn optional extra CSS class that will be added to this component's Element when the mouse moves
over the Element, and... An optional extra CSS class that will be added to this component's Element when the mouse moves
over the Element, and removed when the mouse moves out. (defaults to ''). This can be
-useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules. | Component | | | pageX : Number The page level x coordinate for this component if contained within a positioning container. | BoxComponent | | | pageY : Number The page level y coordinate for this component if contained within a positioning container. | BoxComponent | | | plain : Boolean True to remove the incised line down the left side of the menu. Defaults to false. | Menu | | | plugins : Object/ArrayAn object or array of objects that will provide custom functionality for this component. The only
+useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules. | Component | | | pageX : Number The page level x coordinate for this component if contained within a positioning container. | BoxComponent | | | pageY : Number The page level y coordinate for this component if contained within a positioning container. | BoxComponent | | | plain : Boolean True to remove the incised line down the left side of the menu. Defaults to false. | Menu | | | plugins : Object/ArrayAn object or array of objects that will provide custom functionality for this component. The only
requirement for a ... An object or array of objects that will provide custom functionality for this component. The only
requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component.
When a component is created, if any plugins are available, the component will call the init method on each
plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the
-component as needed to provide its functionality. | Component | | | ptype : StringThe registered ptype to create. This config option is not used when passing
+component as needed to provide its functionality. | Component | | | 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
a config object into a constructor. This config option is used only when
lazy instantiation is being used, and a Plugin is being
@@ -464,7 +470,7 @@ 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
+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.
@@ -488,12 +494,12 @@ 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.
- Also see the added and removed events. | Component | | | region : StringNote: this config is only used when this BoxComponent is rendered
+ 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 | | | renderTo : MixedSpecify the id of the element, a DOM element or an existing Element that this component
-will be rendered into.
+ See Ext.layout.BorderLayout also. | BoxComponent | | | renderTo : MixedSpecify the id of the element, a DOM element or an existing Element that this component
+will be rendered into.
Notes ... Specify the id of the element, a DOM element or an existing Element that this component
will be rendered into.
- Notes :
@@ -504,20 +510,20 @@ to render and manage its child items. When using this config, a call to render() is not required.
- See render also. | Component | | | resizeEvent : String The event to listen to for resizing in layouts. Defaults to 'resize'. | Container | | | scrollIncrement : Number The amount to scroll the menu. Only applies when enableScrolling is set to True (defaults to 24). | Menu | | | shadow : Boolean/StringTrue or 'sides' for the default effect, 'frame' for 4-way shadow, and 'drop'
+ See render also. | Component | | | resizeEvent : String The event to listen to for resizing in layouts. Defaults to 'resize'. | Container | | | scrollIncrement : Number The amount to scroll the menu. Only applies when enableScrolling is set to True (defaults to 24). | Menu | | | shadow : Boolean/StringTrue or 'sides' for the default effect, 'frame' for 4-way shadow, and 'drop'
for bottom-right shadow (defaults to 'si... True or 'sides' for the default effect, 'frame' for 4-way shadow, and 'drop'
-for bottom-right shadow (defaults to 'sides') | Menu | | | showSeparator : Boolean True to show the icon separator. (defaults to true). | Menu | | | stateEvents : ArrayAn array of events that, when fired, should trigger this component to
+for bottom-right shadow (defaults to 'sides') | Menu | | | showSeparator : Boolean True to show the icon separator. (defaults to true). | Menu | | | 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
(e.g., ['click', 'customerchange']).
See stateful for an explanation of saving and
-restoring Component state. | Component | | | stateId : StringThe unique id for this component to use for state management purposes
+restoring Component state. | Component | | | stateId : StringThe unique id for this component to use for state management purposes
(defaults to the component id if one was set, o... The unique id for this component to use for state management purposes
(defaults to the component id if one was set, otherwise null if the
component is using a generated id).
See stateful for an explanation of saving and
-restoring Component state. | Component | | | stateful : BooleanA flag which causes the Component to attempt to restore the state of
+restoring Component state. | Component | | | stateful : BooleanA flag which causes the Component to attempt to restore the state of
internal properties from a saved state on startu... A flag which causes the Component to attempt to restore the state of
internal properties from a saved state on startup. The component must have
either a stateId or id assigned
@@ -553,7 +559,7 @@ properties into the object, but a developer may override this to support
more behaviour.
You can perform extra processing on state save and restore by attaching
handlers to the beforestaterestore, staterestore,
-beforestatesave and statesave events. | Component | | | style : StringA custom style specification to be applied to this component's Element. Should be a valid argument to
+ beforestatesave and statesave events. | Component | | | style : StringA custom style specification to be applied to this component's Element. Should be a valid argument to
Ext.Element.ap... A custom style specification to be applied to this component's Element. Should be a valid argument to
Ext.Element.applyStyles.
new Ext.Panel({
@@ -577,22 +583,22 @@ Ext.Element.ap...
A custom style specification to be appl
})
]
}); | Component | | | subMenuAlign : StringThe Ext.Element.alignTo anchor position value to use for submenus of
-this menu (defaults to 'tl-tr?') | Menu | | | tabTip : StringNote: this config is only used when this BoxComponent is a child item of a TabPanel.
+this menu (defaults to 'tl-tr?') | Menu | | | tabTip : StringNote: this config is only used when this BoxComponent is a child item of a TabPanel.
A string to be used as innerHTML... Note: this config is only used when this BoxComponent is a child item of a TabPanel.
A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over
the associated tab selector element. Ext.QuickTips.init()
-must be called in order for the tips to render. | BoxComponent | | | tpl : MixedAn Ext.Template, Ext.XTemplate
-or an array of strings to form an Ext.XTemplate.
+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'
+Used in conjunction with the data and
+ tplWriteMode configurations. | Component | | | tplWriteMode : StringThe Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
(see Ext.X... The Ext.(X)Template method to use when
updating the content area of the Component. Defaults to 'overwrite'
-(see Ext.XTemplate.overwrite). | Component | | | width : Number | Component | | | width : NumberThe width of this component in pixels (defaults to auto).
Note to express this dimension as a percentage or offset se... The width of this component in pixels (defaults to auto).
- Note to express this dimension as a percentage or offset see Ext.Component.anchor. | BoxComponent | | | x : Number The local x (left) coordinate for this component if contained within a positioning container. | BoxComponent | | | xtype : StringThe registered xtype to create. This config option is not used when passing
+ Note to express this dimension as a percentage or offset see Ext.Component.anchor. | BoxComponent | | | x : Number The local x (left) coordinate for this component if contained within a positioning container. | BoxComponent | | | xtype : StringThe registered xtype to create. This config option is not used when passing
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
@@ -603,7 +609,7 @@ The predefined xtypes are listed Ext.ComponentMgr.registerType in order to be able to
-take advantage of lazy instantiation and rendering. | Component | | | y : Number The local y (top) coordinate for this component if contained within a positioning container. | BoxComponent |
Public Properties|
| | disabled : Boolean True if this component is disabled. Read-only. | Component | | | el : Ext.ElementThe Ext.Element which encapsulates this Component. Read-only.
+take advantage of lazy instantiation and rendering. | Component | | | y : Number The local y (top) coordinate for this component if contained within a positioning container. | BoxComponent | | | zIndex : Number zIndex to use when the menu is floating. | Menu |
Public Properties|
| | 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.
@@ -620,16 +626,18 @@ config for a suggestion, or use a render listener directly: new
single: true // Remove the listener after first invocation
}
});
- See also getEl | Component | | | hidden : Boolean True if this component is hidden. Read-only. | Component | | | initialConfig : Object This Component's initial configuration specification. Read-only. | Component | | | items : MixedCollection | Container | | | ownerCt : Ext.ContainerThis Component's owner Container (defaults to undefined, and is set automatically when
+ 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 | | | 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 | | | private : ObjectWe can only lay out if there is a view area in which to layout.
+display:none on the layout target, *or any of its par... We can only lay out if there is a view area in which to layout.
+display:none on the layout target, *or any of its parent elements* will mean it has no view area. | Container | | | refOwner : Ext.ContainerThe ancestor Container into which the ref reference was inserted if this Component
is a child of a Container, and has... The ancestor Container into which the ref reference was inserted if this Component
-is a child of a Container, and has been configured with a ref. | Component | | | rendered : Boolean True if this component has been rendered. Read-only. | Component |
Public Methods|
| | add( Object/Array component, Object (Optional), Object (Optional) )
- :
- Ext.ComponentAdds Component(s) to this Container.
-Description :
-<ul class="mdetail-params">
+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|
| | 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 :
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 | | | addElement( Mixed el )
- :
- Ext.menu.ItemAdds an Ext.Element object to the menu | Menu | | | addEvents( Object|String o, string Optional. )
- :
+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 | | | addElement( Mixed el )
+ :
+ Ext.menu.ItemAdds an Ext.Element object to the menu | Menu | | | addEvents( Object|String o, string Optional. )
+ :
voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. | Observable | | | addItem( Ext.menu.Item item )
- :
- Ext.menu.ItemAdds an existing object based on Ext.menu.BaseItem to the menu Adds an existing object based on Ext.menu.BaseItem to the menu Parameters:item : Ext.menu.ItemThe menu item to add
Returns: | Menu | | | addListener( String eventName, Function handler, [Object scope], [Object options] )
- :
+Usage:this.addEvents('storeloaded', 'storecleared');
Returns: | Observable | | | addItem( Ext.menu.Item item )
+ :
+ Ext.menu.ItemAdds an existing object based on Ext.menu.BaseItem to the menu Adds an existing object based on Ext.menu.BaseItem to the menu Parameters:item : Ext.menu.ItemThe menu item to add
Returns: | Menu | | | addListener( String eventName, Function handler, [Object scope], [Object options] )
+ :
voidAppends an event handler to this object. Appends an event handler to this object. Parameters:eventName : StringThe name of the event to listen for. handler : FunctionThe method the event invokes. scope : Object(optional) The scope (this reference) in which the handler function is executed.
If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration.
properties. This may contain any of the following properties:
@@ -714,50 +722,46 @@ Or a shorthand syntax:
'mouseover' : this.onMouseOver,
'mouseout' : this.onMouseOut,
scope: this
-});
Returns: | Observable | | | addMenuItem( Object config )
- :
- Ext.menu.ItemCreates a new Ext.menu.Item based an the supplied config object and adds it to the menu Creates a new Ext.menu.Item based an the supplied config object and adds it to the menu Parameters:config : ObjectA MenuItem config object
Returns: | Menu | | | addSeparator()
- :
- Ext.menu.ItemAdds a separator bar to the menu Adds a separator bar to the menu | Menu | | | addText( String text )
- :
- Ext.menu.ItemCreates a new Ext.menu.TextItem with the supplied text and adds it to the menu | Menu | | | 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] )
- :
+});Returns: | Observable | | | addMenuItem( Object config )
+ :
+ Ext.menu.ItemCreates a new Ext.menu.Item based an the supplied config object and adds it to the menu Creates a new Ext.menu.Item based an the supplied config object and adds it to the menu Parameters:config : ObjectA MenuItem config object
Returns: | Menu | | | addSeparator()
+ :
+ Ext.menu.ItemAdds a separator bar to the menu Adds a separator bar to the menu | Menu | | | addText( String text )
+ :
+ Ext.menu.ItemCreates a new Ext.menu.TextItem with the supplied text and adds it to the menu | Menu | | | 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 | | | canLayout()
- :
- voidWe 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] )
- :
+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 )
- :
+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 | | | destroy()
- :
- voidDestroys this component by purging any event listeners, removing the component's element from the DOM,
+An id property can be passed on this object, otherwise one will be generated to avoid duplicates. Returns: | Component | | | destroy()
+ :
+ voidDestroys this component by purging any event listeners, removing the component's element from the DOM,
removing the c... 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 | | | 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
+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
+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
this.getBubbleTarget() if present. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default
@@ -789,39 +793,39 @@ access the required target more quickly.
myForm.header.setStyle( 'color', 'red');
}
}
-}); | 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: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
+}); | 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: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] )
- :
+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
+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... Find a container above this component at any level by a custom function. If the passed function returns
-true, the container will be returned. | Component | | | findParentByType( String/Class xtype )
- :
- Ext.ContainerFind a container above this component at any level by xtype or class Find a container above this component at any level by xtype or class | Component | | | fireEvent( String eventName, Object... args )
- :
- BooleanFires the specified event with the passed parameters (minus the event name).
+true, the container will be returned. | Component | | | findParentByType( String/Class xtype )
+ :
+ Ext.ContainerFind a container above this component at any level by xtype or class Find a container above this component at any level by xtype or class | Component | | | fireEvent( String eventName, Object... args )
+ :
+ BooleanFires the specified event with the passed parameters (minus the event name).
An event may be set to bubble up an Obse... | Observable | | | focus( [Boolean selectText], [Boolean/Number delay] )
- :
- Ext.ComponentTry to focus this component. Try to focus this component. Parameters:selectText : Boolean(optional) If applicable, true to also select the text in this component delay : Boolean/Number(optional) Delay the focus this number of milliseconds (true for 10 milliseconds)
Returns: | Component | | | get( String/Number key )
- :
- Ext.ComponentGet a component contained by this container (alias for items.get(key)) Get a component contained by this container (alias for items.get(key)) Parameters:Returns:Ext.ComponentExt.Component
| Container | | | getBox( [Boolean local] )
- :
- ObjectGets the current box measurements of the component's underlying element. Gets the current box measurements of the component's underlying element. | BoxComponent | | | getBubbleTarget()
- :
- Ext.ContainerProvides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. | Component | | | getComponent( String/Number comp )
- :
- Ext.ComponentExamines this container's items property
+by calling enableBubble. | Observable | | | focus( [Boolean selectText], [Boolean/Number delay] )
+ :
+ Ext.ComponentTry to focus this component. Try to focus this component. Parameters:selectText : Boolean(optional) If applicable, true to also select the text in this component delay : Boolean/Number(optional) Delay the focus this number of milliseconds (true for 10 milliseconds)
Returns: | Component | | | get( String/Number key )
+ :
+ Ext.ComponentGet a component contained by this container (alias for items.get(key)) Get a component contained by this container (alias for items.get(key)) Parameters:Returns:Ext.ComponentExt.Component
| Container | | | getBox( [Boolean local] )
+ :
+ ObjectGets the current box measurements of the component's underlying element. Gets the current box measurements of the component's underlying element. | BoxComponent | | | getBubbleTarget()
+ :
+ Ext.ContainerProvides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. | 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. | Container | | | getEl()
- :
- Ext.Element | Container | | | getEl()
+ :
+ Ext.ElementReturns the Ext.Element which encapsulates this Component.
This will usually be a <DIV> element created by the cla... Returns the Ext.Element which encapsulates this Component.
This will usually be a <DIV> element created by the class's onRender method, but
that may be overridden using the autoEl config.
@@ -848,35 +852,35 @@ or use a render listener directly: new Ext.Panel({
},
single: true // Remove the listener after first invocation
}
-});
| Component | | | getHeight()
- :
- NumberGets the current height of the component's underlying element. Gets the current height of the component's underlying element. | BoxComponent | | | getId()
- :
- StringReturns the id of this component or automatically generates and
+}); | Component | | | getHeight()
+ :
+ NumberGets the current height of the component's underlying element. Gets the current height of the component's underlying element. | BoxComponent | | | getId()
+ :
+ StringReturns the id of this component or automatically generates and
returns an id if an id is not defined yet:'ext-comp-'... Returns the id of this component or automatically generates and
-returns an id if an id is not defined yet: 'ext-comp-' + (++Ext.Component.AUTO_ID)
| Component | | | getItemId()
- :
- StringReturns the itemId of this component. If an
-itemId was not assigned through configuration the
+returns an id if an id is not defined yet: 'ext-comp-' + (++Ext.Component.AUTO_ID)
| Component | | | getItemId()
+ :
+ StringReturns the itemId of this component. If an
+itemId was not assigned through configuration the
id is returned using g... Returns the itemId of this component. If an
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
+ 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.
+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.
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()
- :
- Ext.ElementReturns the outermost Element of this Component which defines the Components overall size.
+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()
+ :
+ Ext.ElementReturns the outermost Element of this Component which defines the Components overall size.
Usually this will return t... Returns the outermost Element of this Component which defines the Components overall size.
Usually this will return the same Element as getEl,
but in some cases, a Component may have some more wrapping Elements around its main
@@ -884,32 +888,32 @@ 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()
- :
- ObjectGets the current size of the component's underlying element. Gets the current size of the component's underlying element. | BoxComponent | | | getWidth()
- :
- NumberGets the current width of the component's underlying element. Gets the current width of the component's underlying element. | BoxComponent | | | getXType()
- :
- StringGets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
+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()
+ :
+ NumberGets the current width of the component's underlying element. Gets the current width of the component's underlying element. | BoxComponent | | | getXType()
+ :
+ StringGets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
available xtypes, see the Ex... Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
available xtypes, see the Ext.Component header. Example usage:
var t = new Ext.form.TextField();
-alert(t.getXType()); // alerts 'textfield'
| Component | | | getXTypes()
- :
- StringReturns this Component's xtype hierarchy as a slash-delimited string. For a list of all
+alert(t.getXType()); // alerts 'textfield' | Component | | | getXTypes()
+ :
+ StringReturns this Component's xtype hierarchy as a slash-delimited string. For a list of all
available xtypes, see the Ext... Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
available xtypes, see the Ext.Component header.
If using your own subclasses, be aware that a Component must register its own xtype
to participate in determination of inherited xtypes.
Example usage:
var t = new Ext.form.TextField();
-alert(t.getXTypes()); // alerts 'component/box/field/textfield'
| Component | | | hasListener( String eventName )
- :
- BooleanChecks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event | Observable | | | hide( [Boolean deep] )
- :
- voidHides this menu and optionally all parent menus Hides this menu and optionally all parent menus | Menu | | | insert( Number index, Ext.Component component )
- :
- Ext.ComponentInserts a Component into this Container at a specified index. Fires the
+alert(t.getXTypes()); // alerts 'component/box/field/textfield' | Component | | | hasListener( String eventName )
+ :
+ BooleanChecks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event | Observable | | | hide( [Boolean deep] )
+ :
+ voidHides this menu and optionally all parent menus Hides this menu and optionally all parent menus | Menu | | | 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:index : NumberThe index at which the Component will be inserted
@@ -921,12 +925,12 @@ constructing a real Component object if lazy rendering might mean that the
inserted Component will not be rendered immediately. To take advantage of
this 'lazy instantiation', set the Ext.Component.xtype config
property to the registered type of the Component wanted.
-For a list of all available xtypes, see Ext.Component.
Returns: | Container | | | isVisible()
- :
- BooleanReturns true if this component is visible. Returns true if this component is visible. | Component | | | isXType( String xtype, [Boolean shallow] )
- :
- BooleanTests whether or not this Component is of a specific xtype. This can test whether this Component is descended
+For a list of all available xtypes, see Ext.Component. | Container | | | isVisible()
+ :
+ BooleanReturns true if this component is visible. Returns true if this component is visible. | Component | | | isXType( String xtype, [Boolean shallow] )
+ :
+ BooleanTests whether or not this Component is of a specific xtype. This can test whether this Component is descended
from th... Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
from the xtype (default) or whether it is directly of the xtype specified (shallow = true).
If using your own subclasses, be aware that a Component must register its own xtype
@@ -937,9 +941,9 @@ 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 )
- :
- voidAdds listeners to any Observable object (or Elements) which are automatically removed when this Component
+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});
@@ -952,36 +956,36 @@ myGridPanel.mon(myGridPanel.getSelectionModel(), {
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 )
- :
+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] )
- :
+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] )
+ :
voidAppends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:eventName : StringThe type of event to listen for handler : FunctionThe method the event invokes scope : Object(optional) The scope (this reference) in which the handler function is executed.
-If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration.
Returns: | Observable | | | previousSibling()
- :
- Ext.ComponentReturns the previous component in the owning container Returns the previous component in the owning container | Component | | | purgeListeners()
- :
- voidRemoves all listeners for this object Removes all listeners for this object | Observable | | | 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 | | | remove( Component/String component, [Boolean autoDestroy] )
- :
- Ext.ComponentRemoves a component from this container. Fires the beforeremove event before removing, then fires
+If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration. Returns: | Observable | | | previousSibling()
+ :
+ Ext.ComponentReturns the previous component in the owning container Returns the previous component in the owning container | Component | | | purgeListeners()
+ :
+ voidRemoves all listeners for this object Removes all listeners for this object | Observable | | | 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 | | | 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] )
- :
+Defaults to the value of this Container's autoDestroy config.Returns: | Container | | | removeAll( [Boolean autoDestroy] )
+ :
ArrayRemoves 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] )
- :
- voidRemoves an event handler. Removes an event handler. | Observable | | | render( [Element/HTMLElement/String container], [String/Number position] )
- :
- voidRender this Component into the passed HTML element.
+Defaults to the value of this Container's autoDestroy config. | 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] )
+ :
+ voidRemoves an event handler. Removes an event handler. | Observable | | | render( [Element/HTMLElement/String container], [String/Number position] )
+ :
+ voidRender this Component into the passed HTML element.
If you are using a Container object to house this Component, then... Render this Component into the passed HTML element.
If you are using a Container object to house this Component, then
do not use the render method.
@@ -1003,33 +1007,33 @@ have in mind.
layout manager is used which does nothing but render child components sequentially into the
Container. No sizing or positioning will be performed in this situation. Parameters:container : Element/HTMLElement/String(optional) The element this Component should be
rendered into. If it is being created from existing markup, this should be omitted. position : String/Number(optional) The element ID or DOM node index within the container before
-which this component will be inserted (defaults to appending to the end of the container)
Returns: | Component | | | resumeEvents()
- :
- voidResume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
+which this component will be inserted (defaults to appending to the end of the container) Returns: | Component | | | resumeEvents()
+ :
+ voidResume firing events. (see suspendEvents)
+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 | | | 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 )
- :
+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 )
+ :
Ext.BoxComponentSets the height of the component. This method fires the resize event. Sets the height of the component. This method fires the resize event. Parameters:height : NumberThe new height to set. This may be one of:
- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
- A String used to set the CSS height style.
- undefined to leave the height unchanged.
-
Returns: | BoxComponent | | | setPagePosition( Number x, Number y )
- :
- Ext.BoxComponentSets the page XY position of the component. To set the left and top instead, use setPosition.
+ | BoxComponent | | | setPagePosition( Number x, Number y )
+ :
+ Ext.BoxComponentSets the page XY position of the component. To set the left and top instead, use setPosition.
This method fires the ... Sets the page XY position of the component. To set the left and top instead, use setPosition.
-This method fires the move event. Parameters:x : NumberThe new x position y : NumberThe new y position
Returns: | BoxComponent | | | setPosition( Number left, Number top )
- :
- Ext.BoxComponentSets the left and top of the component. To set the page XY position instead, use setPagePosition.
+This method fires the move event. Parameters:x : NumberThe new x position y : NumberThe new y position
Returns: | BoxComponent | | | setPosition( Number left, Number top )
+ :
+ Ext.BoxComponentSets the left and top of the component. To set the page XY position instead, use setPagePosition.
This method fires ... Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
-This method fires the move event. Parameters:left : NumberThe new left top : NumberThe new top
Returns: | BoxComponent | | | setSize( Mixed width, Mixed height )
- :
- Ext.BoxComponentSets the width and height of this BoxComponent. This method fires the resize event. This method can accept
+This method fires the move event. Parameters:left : NumberThe new left top : NumberThe new top
Returns: | BoxComponent | | | setSize( Mixed width, Mixed height )
+ :
+ Ext.BoxComponentSets the width and height of this BoxComponent. This method fires the resize event. This method can accept
either wid... Sets the width and height of this BoxComponent. This method fires the resize event. This method can accept
either width and height as separate arguments, or you can pass a size object like {width:10, height:20}. Parameters:width : MixedThe new width to set. This may be one of:
- A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels).
@@ -1041,116 +1045,116 @@ This may be one of:
- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
- A String used to set the CSS height style. Animation may not be used.
undefined to leave the height unchanged.
| BoxComponent | | | setVisible( Boolean visible )
- :
- Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. | Component | | | setWidth( Number width )
- :
+Returns: | BoxComponent | | | setVisible( Boolean visible )
+ :
+ Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. | Component | | | setWidth( Number width )
+ :
Ext.BoxComponentSets the width of the component. This method fires the resize event. Sets the width of the component. This method fires the resize event. Parameters:width : NumberThe new width to setThis may be one of:
Returns: | BoxComponent | | | show( Mixed element, [String position], [Ext.menu.Menu parentMenu] )
- :
- voidIf floating=true, shows this menu relative to
+ | BoxComponent | | | show( Mixed element, [String position], [Ext.menu.Menu parentMenu] )
+ :
+ voidIf floating=true, shows this menu relative to
another element using showat, otherwise uses Ext.Component.show. | Menu | | | showAt( Array xyPosition, [Ext.menu.Menu parentMenu] )
- :
- voidDisplays this menu at a specific xy position and fires the 'show' event if a
+the element (defaults to this.defaultAlign) parentMenu : Ext.menu.Menu(optional) This menu's parent menu, if applicable (defaults to undefined) Returns: | Menu | | | showAt( Array xyPosition, [Ext.menu.Menu parentMenu] )
+ :
+ voidDisplays this menu at a specific xy position and fires the 'show' event if a
handler for the 'beforeshow' event does ... Displays this menu at a specific xy position and fires the 'show' event if a
-handler for the 'beforeshow' event does not return false cancelling the operation. Parameters:xyPosition : ArrayContains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based) parentMenu : Ext.menu.Menu(optional) This menu's parent menu, if applicable (defaults to undefined)
Returns: | Menu | | | suspendEvents( Boolean queueSuspended )
- :
+handler for the 'beforeshow' event does not return false cancelling the operation.Parameters:xyPosition : ArrayContains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based) parentMenu : Ext.menu.Menu(optional) This menu's parent menu, if applicable (defaults to undefined)
Returns: | Menu | | | suspendEvents( Boolean queueSuspended )
+ :
voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:queueSuspended : BooleanPass as true to queue up suspended events to be fired
-after the resumeEvents call instead of discarding all suspended events;
Returns: | Observable | | | syncSize()
- :
- Ext.BoxComponentForce 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 | | | update( Mixed htmlOrData, [Boolean loadScripts], [Function callback] )
- :
+after the resumeEvents call instead of discarding all suspended events;Returns: | Observable | | | syncSize()
+ :
+ Ext.BoxComponentForce 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 | | | 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 | | | 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 )
- Fires after the component rendering is finished.
+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 | | | 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 )
+ 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 | | | beforeadd :
- ( Ext.Container this, Ext.Component component, Number index )
- Fires before any Ext.Component is added or inserted into the container.
+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 | | | 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 :
- ( Ext.Component this )
- Fires before the component is hidden by calling the hide method.
+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 :
+ ( Ext.Component this )
+ Fires before the component is hidden by calling the hide method.
Return false from an event handler to stop the hide. 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
+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
-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
+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. Fires before the component is rendered. Return false from an
-event handler to stop the render. Listeners will be called with the following arguments: | Component | | | beforeshow :
- ( Ext.Component this )
- Fires before the component is shown by calling the show method.
+event handler to stop the render. Listeners will be called with the following arguments: | Component | | | beforeshow :
+ ( Ext.Component this )
+ Fires before the component is shown by calling the show method.
Return false from an event handler to stop the show. Fires before the component is shown by calling the show method.
-Return false from an event handler to stop the show. Listeners will be called with the following arguments: | Component | | | beforestaterestore :
- ( Ext.Component this, Object state )
+Return false from an event handler to stop the show.Listeners will be called with the following arguments: | Component | | | beforestaterestore :
+ ( Ext.Component this, Object state )
Fires before the state of the component is restored. Return false from an event handler to stop the restore. Fires before the state of the component is restored. Return false from an event handler to stop the restore. Listeners will be called with the following arguments:this : Ext.Componentstate : ObjectThe hash of state values returned from the StateProvider. If this
event is not vetoed, then the state object is passed to applyState. By default,
that simply copies property values into this Component. The method maybe overriden to
-provide custom state restoration.
| Component | | | beforestatesave :
- ( Ext.Component this, Object state )
+provide custom state restoration. | Component | | | beforestatesave :
+ ( Ext.Component this, Object state )
Fires before the state of the component is saved to the configured state provider. Return false to stop the save. Fires before the state of the component is saved to the configured state provider. Return false to stop the save. Listeners will be called with the following arguments:this : Ext.Componentstate : ObjectThe hash of state values. This is determined by calling
getState() on the Component. This method must be provided by the
developer to return whetever representation of state is required, by default, Ext.Component
-has a null implementation.
| Component | | | click :
- ( Ext.menu.Menu this, Ext.menu.Item menuItem, Ext.EventObject e )
- Fires when this menu is clicked (or when the enter key is pressed while it is active) Fires when this menu is clicked (or when the enter key is pressed while it is active) Listeners will be called with the following arguments: | Menu | | | destroy :
- ( Ext.Component this )
- Fires after the component is destroyed. Fires after the component is destroyed. Listeners will be called with the following arguments: | Component | | | disable :
- ( Ext.Component this )
- Fires after the component is disabled. Fires after the component is disabled. Listeners will be called with the following arguments: | Component | | | enable :
- ( Ext.Component this )
- Fires after the component is enabled. Fires after the component is enabled. Listeners will be called with the following arguments: | Component | | | hide :
- ( Ext.Component this )
- Fires after the component is hidden.
+has a null implementation. | Component | | | click :
+ ( Ext.menu.Menu this, Ext.menu.Item menuItem, Ext.EventObject e )
+ Fires when this menu is clicked (or when the enter key is pressed while it is active) Fires when this menu is clicked (or when the enter key is pressed while it is active) Listeners will be called with the following arguments: | Menu | | | destroy :
+ ( Ext.Component this )
+ Fires after the component is destroyed. Fires after the component is destroyed. Listeners will be called with the following arguments: | Component | | | disable :
+ ( Ext.Component this )
+ Fires after the component is disabled. Fires after the component is disabled. Listeners will be called with the following arguments: | Component | | | enable :
+ ( Ext.Component this )
+ Fires after the component is enabled. Fires after the component is enabled. Listeners will be called with the following arguments: | Component | | | hide :
+ ( Ext.Component this )
+ Fires after the component is hidden.
Fires after the component is hidden when calling the hide method. Fires after the component is hidden.
-Fires after the component is hidden when calling the hide method. Listeners will be called with the following arguments: | Component | | | itemclick :
- ( Ext.menu.BaseItem baseItem, Ext.EventObject e )
- Fires when a menu item contained in this menu is clicked Fires when a menu item contained in this menu is clicked Listeners will be called with the following arguments: | Menu | | | mouseout :
- ( Ext.menu.Menu this, Ext.EventObject e, Ext.menu.Item menuItem )
- Fires when the mouse exits this menu Fires when the mouse exits this menu Listeners will be called with the following arguments: | Menu | | | mouseover :
- ( Ext.menu.Menu this, Ext.EventObject e, Ext.menu.Item menuItem )
- Fires when the mouse is hovering over this menu Fires when the mouse is hovering over this menu Listeners will be called with the following arguments: | Menu | | | move :
- ( Ext.Component this, Number x, Number y )
- Fires after the component is moved. Fires after the component is moved. Listeners will be called with the following arguments:this : Ext.Componentx : NumberThe new x position y : NumberThe new y position
| BoxComponent | | | remove :
- ( Ext.Container this, Ext.Component component )
- Listeners will be called with the following arguments: | Container | | | 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 )
- Fires after the component is resized. Fires after the component is resized. Listeners will be called with the following arguments:this : Ext.ComponentadjWidth : NumberThe box-adjusted width that was set adjHeight : NumberThe box-adjusted height that was set rawWidth : NumberThe width that was originally specified rawHeight : NumberThe height that was originally specified
| BoxComponent | | | show :
- ( Ext.Component this )
- Fires after the component is shown when calling the show method. Fires after the component is shown when calling the show method. Listeners will be called with the following arguments: | Component | | | staterestore :
- ( Ext.Component this, Object state )
+Fires after the component is hidden when calling the hide method.Listeners will be called with the following arguments: | Component | | | itemclick :
+ ( Ext.menu.BaseItem baseItem, Ext.EventObject e )
+ Fires when a menu item contained in this menu is clicked Fires when a menu item contained in this menu is clicked Listeners will be called with the following arguments: | Menu | | | mouseout :
+ ( Ext.menu.Menu this, Ext.EventObject e, Ext.menu.Item menuItem )
+ Fires when the mouse exits this menu Fires when the mouse exits this menu Listeners will be called with the following arguments: | Menu | | | mouseover :
+ ( Ext.menu.Menu this, Ext.EventObject e, Ext.menu.Item menuItem )
+ Fires when the mouse is hovering over this menu Fires when the mouse is hovering over this menu Listeners will be called with the following arguments: | Menu | | | move :
+ ( Ext.Component this, Number x, Number y )
+ Fires after the component is moved. Fires after the component is moved. Listeners will be called with the following arguments:this : Ext.Componentx : NumberThe new x position y : NumberThe new y position
| BoxComponent | | | remove :
+ ( Ext.Container this, Ext.Component component )
+ Listeners will be called with the following arguments: | Container | | | 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 )
+ Fires after the component is resized. Fires after the component is resized. Listeners will be called with the following arguments:this : Ext.ComponentadjWidth : NumberThe box-adjusted width that was set adjHeight : NumberThe box-adjusted height that was set rawWidth : NumberThe width that was originally specified rawHeight : NumberThe height that was originally specified
| BoxComponent | | | show :
+ ( Ext.Component this )
+ Fires after the component is shown when calling the show method. Fires after the component is shown when calling the show method. Listeners will be called with the following arguments: | Component | | | staterestore :
+ ( Ext.Component this, Object state )
Fires after the state of the component is restored. Fires after the state of the component is restored. Listeners will be called with the following arguments: | Component | | | statesave :
- ( Ext.Component this, Object state )
+Component. The method maybe overriden to provide custom state restoration. | Component | | | statesave :
+ ( Ext.Component this, Object state )
Fires after the state of the component is saved to the configured state provider. Fires after the state of the component is saved to the configured state provider. Listeners will be called with the following arguments:this : Ext.Componentstate : ObjectThe hash of state values. This is determined by calling
getState() on the Component. This method must be provided by the
developer to return whetever representation of state is required, by default, Ext.Component
|
|