X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..c8256059947f3aa8f5b0a9a2acf55e2142bb4742:/docs/output/Ext.Toolbar.html diff --git a/docs/output/Ext.Toolbar.html b/docs/output/Ext.Toolbar.html index 3cbeef06..ef1eff03 100644 --- a/docs/output/Ext.Toolbar.html +++ b/docs/output/Ext.Toolbar.html @@ -1,95 +1,95 @@ -
Observable Component BoxComponent Container Toolbar
Package: | Ext |
Defined In: | Toolbar.js |
Class: | Toolbar |
Subclasses: | PagingToolbar |
Extends: | Container |
xtype: | toolbar |
Basic Toolbar class. Although the defaultType for Toolbar -is button, Toolbar elements (child items for the Toolbar container) may -be virtually any type of Component. Toolbar elements can be created explicitly via their constructors, -or implicitly via their xtypes, and can be added dynamically.
-Some items have shortcut strings for creation:
--Shortcut xtype Class Description -'->' 'tbfill' Ext.Toolbar.Fill begin using the right-justified button container -'-' 'tbseparator' Ext.Toolbar.Separator add a vertical separator bar between toolbar items -' ' 'tbspacer' Ext.Toolbar.Spacer add horiztonal space between elements --Example usage of various elements: -
var tb = new Ext.Toolbar({
- renderTo: document.body,
- width: 600,
- height: 100,
- items: [
- {
- // xtype: 'button', // default for Toolbars, same as 'tbbutton'
- text: 'Button'
- },
- {
- xtype: 'splitbutton', // same as 'tbsplitbutton'
- text: 'Split Button'
- },
- // begin using the right-justified button container
- '->', // same as {xtype: 'tbfill'}, // Ext.Toolbar.Fill
- {
- xtype: 'textfield',
- name: 'field1',
- emptyText: 'enter search term'
- },
- // add a vertical separator bar between toolbar items
- '-', // same as {xtype: 'tbseparator'} to create Ext.Toolbar.Separator
- 'text 1', // same as {xtype: 'tbtext', text: 'text1'} to create Ext.Toolbar.TextItem
- {xtype: 'tbspacer'},// same as ' ' to create Ext.Toolbar.Spacer
- 'text 2',
- {xtype: 'tbspacer', width: 50}, // add a 50px space
- 'text 3'
- ]
-});
-Example adding a ComboBox within a menu of a button:
-// ComboBox creation
-var combo = new Ext.form.ComboBox({
- store: new Ext.data.ArrayStore({
- autoDestroy: true,
- fields: ['initials', 'fullname'],
- data : [
- ['FF', 'Fred Flintstone'],
- ['BR', 'Barney Rubble']
- ]
- }),
- displayField: 'fullname',
- typeAhead: true,
- mode: 'local',
- forceSelection: true,
- triggerAction: 'all',
- emptyText: 'Select a name...',
- selectOnFocus: true,
- width: 135,
- getListParent: function() {
- return this.el.up('.x-menu');
- },
- iconCls: 'no-icon' //use iconCls if placing within menu to shift to right side of menu
-});
-
-// put ComboBox in a Menu
-var menu = new Ext.menu.Menu({
- id: 'mainMenu',
- items: [
- combo // A Field in a Menu
- ]
-});
-
-// add a Button with the menu
-tb.add({
- text:'Button w/ Menu',
- menu: menu // assign menu by instance
- });
+Observable
Component
BoxComponent
Container
Toolbar
Class Ext.Toolbar
Package: Ext Defined In: Toolbar.js Class: Toolbar Subclasses: PagingToolbar Extends: Container
Basic Toolbar class. Although the defaultType for Toolbar
+is button, Toolbar elements (child items for the Toolbar container) may
+be virtually any type of Component. Toolbar elements can be created explicitly via their constructors,
+or implicitly via their xtypes, and can be added dynamically.
+Some items have shortcut strings for creation:
+
+Shortcut xtype Class Description
+'->' 'tbfill' Ext.Toolbar.Fill begin using the right-justified button container
+'-' 'tbseparator' Ext.Toolbar.Separator add a vertical separator bar between toolbar items
+' ' 'tbspacer' Ext.Toolbar.Spacer add horiztonal space between elements
+
+Example usage of various elements:
+var tb = new Ext.Toolbar({
+ renderTo: document.body,
+ width: 600,
+ height: 100,
+ items: [
+ {
+ // xtype: 'button', // default for Toolbars, same as 'tbbutton'
+ text: 'Button'
+ },
+ {
+ xtype: 'splitbutton', // same as 'tbsplitbutton'
+ text: 'Split Button'
+ },
+ // begin using the right-justified button container
+ '->', // same as {xtype: 'tbfill'}, // Ext.Toolbar.Fill
+ {
+ xtype: 'textfield',
+ name: 'field1',
+ emptyText: 'enter search term'
+ },
+ // add a vertical separator bar between toolbar items
+ '-', // same as {xtype: 'tbseparator'} to create Ext.Toolbar.Separator
+ 'text 1', // same as {xtype: 'tbtext', text: 'text1'} to create Ext.Toolbar.TextItem
+ {xtype: 'tbspacer'},// same as ' ' to create Ext.Toolbar.Spacer
+ 'text 2',
+ {xtype: 'tbspacer', width: 50}, // add a 50px space
+ 'text 3'
+ ]
+});
+Example adding a ComboBox within a menu of a button:
+// ComboBox creation
+var combo = new Ext.form.ComboBox({
+ store: new Ext.data.ArrayStore({
+ autoDestroy: true,
+ fields: ['initials', 'fullname'],
+ data : [
+ ['FF', 'Fred Flintstone'],
+ ['BR', 'Barney Rubble']
+ ]
+ }),
+ displayField: 'fullname',
+ typeAhead: true,
+ mode: 'local',
+ forceSelection: true,
+ triggerAction: 'all',
+ emptyText: 'Select a name...',
+ selectOnFocus: true,
+ width: 135,
+ getListParent: function() {
+ return this.el.up('.x-menu');
+ },
+ iconCls: 'no-icon' //use iconCls if placing within menu to shift to right side of menu
+});
+
+// put ComboBox in a Menu
+var menu = new Ext.menu.Menu({
+ id: 'mainMenu',
+ items: [
+ combo // A Field in a Menu
+ ]
+});
+
+// add a Button with the menu
+tb.add({
+ text:'Button w/ Menu',
+ menu: menu // assign menu by instance
+ });
tb.doLayout();
Config Options
Config Options Defined By activeItem : String/NumberA string component id or the numeric index of the component that should be initially activated within the
container's...A string component id or the numeric index of the component that should be initially activated within the
container's layout on render. For example, activeItem: 'item-1' or activeItem: 0 (index 0 = the first
item in the container's collection). activeItem only applies to layout styles that can display
items one at a time (like Ext.layout.AccordionLayout, Ext.layout.CardLayout and
-Ext.layout.FitLayout). Related to Ext.layout.ContainerLayout.activeItem. Container allowDomMove : BooleanWhether the component can move the Dom node when rendering (defaults to true). Component anchor : StringNote: this config is only used when this Component is rendered
+Ext.layout.FitLayout). Related to Ext.layout.ContainerLayout.activeItem. Container allowDomMove : BooleanWhether the component can move the Dom node when rendering (defaults to true). Component anchor : StringNote: this config is only used when this Component is rendered
by a Container which has been configured to use an Anc...Note: this config is only used when this Component is rendered
-by a Container which has been configured to use an AnchorLayout
+by a Container which has been configured to use an AnchorLayout (or subclass thereof).
based layout manager, for example:
- Ext.form.FormPanel
- specifying
layout: 'anchor' // or 'form', or 'absolute'
-See Ext.layout.AnchorLayout.anchor also.
Component applyTo : MixedSpecify the id of the element, a DOM element or an existing Element corresponding to a DIV
+See Ext.layout.AnchorLayout.anchor also.
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.
@@ -166,7 +166,9 @@ result in elements needing to be synchronized with the new height. Example:<
}
}
}
-}).show();
BoxComponent autoShow : BooleanTrue if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
+}).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
them on render...True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
them on render (defaults to false). Component autoWidth : BooleanTrue to use width:'auto', false to use fixed width (or allow it to be managed by its parent
Container's layout manage...True to use width:'auto', false to use fixed width (or allow it to be managed by its parent
@@ -198,10 +200,25 @@ child items when the browser changes its width:
var myPanel = <
}, {
title: 'Box 3'
}],
-});
BoxComponent bufferResize : Boolean/NumberWhen set to true (100 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
-t...When set to true (100 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
+}); 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 manag...The maximum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size management applied by layout managers.
BoxComponent boxMinHeight : NumberThe minimum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size mana...The minimum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size management applied by layout managers.
BoxComponent boxMinWidth : NumberThe minimum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size manag...The minimum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size management applied by layout managers.
BoxComponent bubbleEvents : ArrayAn array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble....An array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.
+Defaults to ['add', 'remove']
.
Container bufferResize : Boolean/NumberWhen set to true (50 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
+th...When set to true (50 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
the frequency it calculates and does a re-layout of components. This is useful for heavy containers or containers
-with a large quantity of sub-components for which frequent layout calls would be expensive. Container 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 buttonAlign : StringThe default position at which to align child items. Defaults to "left"
+May be specified as "center" to cause items ad...The default position at which to align child items. Defaults to "left"
+May be specified as "center"
to cause items added before a Fill (A "->"
) item
+to be centered in the Toolbar. Items added after a Fill are still right-aligned.
+Specify as "right"
to right align all child items.
Toolbar 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').
@@ -211,7 +228,21 @@ manager (e.g. fieldLabel is specified or isFormField=true is specified.
See Ext.layout.FormLayout.fieldTpl also.
Component cls : StringAn optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
useful for ...An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
-useful for adding customized styles to the component or any of its children using standard CSS rules. Component ctCls : StringAn optional extra CSS class that will be added to this component's container. This can be useful for
+useful for adding customized styles to the component or any of its children using standard CSS rules. Component contentEl : StringOptional. Specify an existing HTML element, or the id of an existing HTML element to use as the content
+for this comp...Optional. Specify an existing HTML element, or the id
of an existing HTML element to use as the content
+for this component.
+
+- Description :
+This config option is used to take an existing HTML element and place it in the layout element
+of a new component (it simply moves the specified DOM element after the Component is rendered to use as the content.
+- Notes :
+The specified HTML element is appended to the layout element of the component after any configured
+HTML has been inserted, and so the document will not contain this element at the time the render event is fired.
+The specified HTML element used will not participate in any
layout
+scheme that the Component may use. It is just HTML. Layouts operate on child items
.
+Add either the x-hidden
or the x-hide-display
CSS class to
+prevent a brief flicker of the content before it is rendered to the panel.
+
Component ctCls : StringAn optional extra CSS class that will be added to this component's container. This can be useful for
adding customize...An optional extra CSS class that will be added to this component's container. This can be useful for
adding customized styles to the container or any of its children using standard CSS rules. See
Ext.layout.ContainerLayout.extraCls also.
@@ -222,18 +253,23 @@ which assigns a value by default:
To configure the above Class with an extra CSS class append to the default. For example,
for BoxLayout (Hbox and Vbox):ctCls: 'x-box-layout-ct custom-class'
- Component defaultType : StringThe default xtype of child Components to create in this Container when
+ Component data : MixedThe initial set of data to apply to the tpl
to
+update the content area of the Component. Component defaultType : StringThe default xtype of child Components to create in this Container when
a child item is specified as a raw configurati...The default xtype of child Components to create in this Container when
a child item is specified as a raw configuration object, rather than as an instantiated Component.
-Defaults to 'panel', except Ext.menu.Menu which defaults to 'menuitem',
-and Ext.Toolbar and Ext.ButtonGroup which default to 'button'.
Container defaults : ObjectA config object that will be applied to all components added to this container either via the items
-config or via the...A config object that will be applied to all components added to this container either via the items
-config or via the add or insert methods. The defaults config can contain any
-number of name/value property pairs to be added to each item, and should be valid for the types of items
-being added to the container. For example, to automatically apply padding to the body of each of a set of
-contained Ext.Panel items, you could pass: defaults: {bodyStyle:'padding:15px'}.
-Note: defaults will not be applied to config objects if the option is already specified.
-For example:
defaults: { // defaults are applied to items, not the container
+Defaults to 'panel'
, except Ext.menu.Menu which defaults to 'menuitem'
,
+and Ext.Toolbar and Ext.ButtonGroup which default to 'button'
.
Container defaults : Object|FunctionThis option is a means of applying default settings to all added items whether added through the items
+config or via ...This option is a means of applying default settings to all added items whether added through the items
+config or via the add or insert methods.
+If an added item is a config object, and not an instantiated Component, then the default properties are
+unconditionally applied. If the added item is an instantiated Component, then the default properties are
+applied conditionally so as not to override existing properties in the item.
+If the defaults option is specified as a function, then the function will be called using this Container as the
+scope (this
reference) and passing the added item as the first parameter. Any resulting object
+from that call is then applied to the item as default properties.
+For example, to automatically apply padding to the body of each of a set of
+contained Ext.Panel items, you could pass: defaults: {bodyStyle:'padding:15px'}
.
+Usage:
defaults: { // defaults are applied to items, not the container
autoScroll:true
},
items: [
@@ -246,7 +282,9 @@ items: [
id: 'panel2', // options in components, so the defaults
autoScroll: false // will be applied here, panel2 will be autoScroll:true.
})
-]
Container disabled : BooleanRender this component disabled (default is false). Component disabledClass : StringCSS class added to the component when it is disabled (defaults to 'x-item-disabled'). Component fieldLabel : StringThe label text to display next to this Component (defaults to '').
+] Container disabled : BooleanRender this component disabled (default is false). Component disabledClass : StringCSS class added to the component when it is disabled (defaults to 'x-item-disabled'). Component enableOverflow : BooleanDefaults to false. Configure true to make the toolbar provide a button
+which activates a dropdown Menu to show items ...Defaults to false. Configure true to make the toolbar provide a button
+which activates a dropdown Menu to show items which overflow the Toolbar's width.
Toolbar 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.
@@ -260,7 +298,13 @@ Example use:
new Ext.FormPanel({
xtype: 'textfield',
fieldLabel: 'Name'
}]
-});
Component forceLayout : BooleanIf true the container will force a layout initially even if hidden or collapsed. This option
+}); 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 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).
Note to express this dimension as a percentage or offset s...The height of this component in pixels (defaults to auto).
@@ -291,7 +335,11 @@ since items are automatically laid out when they are first shown (no sizing
is done while hidden). Component hideParent : BooleanTrue to hide and show the component's container when hide/show is called on the component, false to hide
and show the...True to hide and show the component's container when hide/show is called on the component, false to hide
and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide
-button on a window by setting hide:true on the button when adding it to its parent container. Component id : StringThe unique id of this component (defaults to an auto-assigned id).
+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).
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).
@@ -301,8 +349,11 @@ rules to style the specific instance of this component uniquely, and also to sel
sub-elements using this component's id as the parent.
Note: to avoid complications imposed by a unique id also see
itemId
and ref
.
-Note: to access the container of an item see ownerCt
.
Component itemCls : StringAn additional CSS class to apply to the div wrapping the form item
-element of this field. If supplied, itemCls at th...An additional CSS class to apply to the div wrapping the form item
+
Note: to access the container of an item see ownerCt
.
Component itemCls : StringNote: this config is only used when this Component is rendered by a Container which
+has been configured to use the Fo...Note: this config is only used when this Component is rendered by a Container which
+has been configured to use the FormLayout layout manager (e.g.
+Ext.form.FormPanel or specifying layout:'form').
+An additional CSS class to apply to the div wrapping the form item
element of this field. If supplied, itemCls at the field level will override
the default itemCls supplied at the container level. The value specified for
itemCls will be added to the default class ('x-form-item').
@@ -311,22 +362,22 @@ the default itemCls supplied at the container level. The value s
you to write standard CSS rules that can apply to the field, the label (if specified), or
any other element within the markup for the field.
Note: see the note for fieldLabel.
-Example use:// Apply a style to the field's label:
+Example use:// Apply a style to the field's label:
<style>
.required .x-form-item-label {font-weight:bold;color:red;}
</style>
new Ext.FormPanel({
- height: 100,
- renderTo: Ext.getBody(),
- items: [{
- xtype: 'textfield',
- fieldLabel: 'Name',
- itemCls: 'required' //this label will be styled
- },{
- xtype: 'textfield',
- fieldLabel: 'Favorite Color'
- }]
+ height: 100,
+ renderTo: Ext.getBody(),
+ items: [{
+ xtype: 'textfield',
+ fieldLabel: 'Name',
+ itemCls: 'required' //this label will be styled
+ },{
+ xtype: 'textfield',
+ fieldLabel: 'Favorite Color'
+ }]
});
Component itemId : StringAn itemId can be used as an alternative way to get a reference to a component
when no object reference is available. ...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
@@ -433,11 +484,11 @@ Example use:
new Ext.FormPanel({
fieldLabel: 'Name',
labelStyle: 'font-weight:bold;'
}]
-});
Component layout : String/ObjectThis class assigns a default layout (layout:'toolbar').
-Developers may override this configuration option if another...This class assigns a default layout (layout:'toolbar'
).
-Developers may override this configuration option if another layout
-is required (the constructor must be passed a configuration object in this
-case instead of an array).
+}); Component layout : String/ObjectThis class assigns a default layout (layout:'toolbar').
+Developers may override this configuration option if another ...This class assigns a default layout (layout:'toolbar'
).
+Developers may override this configuration option if another layout
+is required (the constructor must be passed a configuration object in this
+case instead of an array).
See Ext.Container.layout for additional information. Toolbar layoutConfig : Object Container listeners : ObjectA config object containing one or more event handlers to be added to this
@@ -536,9 +587,9 @@ object. The ptype will be looked up at render time up to determine
type of Plugin to create.
If you create your own Plugins, you may register them using
Ext.ComponentMgr.registerPlugin in order to be able to
-take advantage of lazy instantiation and rendering. Component ref : StringA path specification, relative to the Component's ownerCt specifying into which
-ancestor Container to place a named r...A path specification, relative to the Component's ownerCt specifying into which
-ancestor Container to place a named reference to this Component.
+take advantage of lazy instantiation and rendering. Component ref : StringA path specification, relative to the Component's ownerCt
+specifying into which ancestor Container to place a named r...A path specification, relative to the Component's ownerCt
+specifying into which ancestor Container to place a named reference to this Component.
The ancestor axis can be traversed by using '/' characters in the path.
For example, to put a reference to a Toolbar Button into the Panel which owns the Toolbar:
var myGrid = new Ext.grid.EditorGridPanel({
title: 'My EditorGridPanel',
@@ -557,9 +608,10 @@ For example, to put a reference to a Toolbar Button into the Panel which owns
}
}
});
-In the code above, if the ref had been 'saveButton'
the reference would
-have been placed into the Toolbar. Each '/' in the ref moves up one level from the
-Component's ownerCt.
Component region : String Component region : StringNote: this config is only used when this BoxComponent is rendered
by a Container which has been configured to use the...Note: this config is only used when this BoxComponent is rendered
by a Container which has been configured to use the BorderLayout
layout manager (e.g. specifying layout:'border').
@@ -575,7 +627,7 @@ to render and manage its child items.
When using this config, a call to render() is not required.
-See render also.
Component stateEvents : ArrayAn array of events that, when fired, should trigger this component to
+See render also.
Component resizeEvent : StringThe event to listen to for resizing in layouts. Defaults to 'resize'
. Container stateEvents : ArrayAn array of events that, when fired, should trigger this component to
save its state (defaults to none). stateEvents ...An array of events that, when fired, should trigger this component to
save its state (defaults to none). stateEvents
may be any type
of event supported by this component, including browser or custom events
@@ -645,7 +697,20 @@ Ext.Element.ap...
A custom style specification to be appl
}
})
]
-}); Component width : NumberThe width of this component in pixels (defaults to auto).
+}); Component tabTip : StringNote: this config is only used when this BoxComponent is a child item of a TabPanel.
+A string to be used as innerHTML...Note: this config is only used when this BoxComponent is a child item of a TabPanel.
+A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over
+the associated tab selector element. Ext.QuickTips.init()
+must be called in order for the tips to render. BoxComponent tpl : MixedAn Ext.Template, Ext.XTemplate
+or an array of strings to form an Ext.XTemplate.
+Used in conjunction with the data and...An Ext.Template , Ext.XTemplate
+or an array of strings to form an Ext.XTemplate.
+Used in conjunction with the data
and
+tplWriteMode
configurations. Component tplWriteMode : StringThe Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
+(see Ext.X...The Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
+(see Ext.XTemplate.overwrite
). Component width : NumberThe width of this component in pixels (defaults to auto).
Note to express this dimension as a percentage or offset se...The width of this component in pixels (defaults to auto).
Note to express this dimension as a percentage or offset see Ext.Component.anchor. BoxComponent x : NumberThe local x (left) coordinate for this component if contained within a positioning container. BoxComponent xtype : StringThe registered xtype to create. This config option is not used when passing
a config object into a constructor. This ...The registered xtype to create. This config option is not used when passing
@@ -675,55 +740,59 @@ config for a suggestion, or use a render listener directly:new
single: true // Remove the listener after first invocation
}
});
-See also getEl
Component hidden : BooleanTrue if this component is hidden. Read-only. Component initialConfig : ObjectThis Component's initial configuration specification. Read-only. Component items : MixedCollectionThe collection of components in this container as a Ext.util.MixedCollection Container ownerCt : Ext.ContainerThe component's owner Ext.Container (defaults to undefined, and is set automatically when
-the component is added to a...The component's owner Ext.Container (defaults to undefined, and is set automatically when
-the component is added to a container). Read-only.
-Note: to access items within the container see itemId.
Component rendered : BooleanTrue if this component has been rendered. Read-only. Component
Public Methods
Method Defined By Toolbar( Object/Array config
)
- Creates a new ToolbarCreates a new ToolbarParameters:config
: Object/ArrayA config object or an array of buttons to add
Returns:- void
xtype: toolbar
Toolbar add( Mixed arg1
, Mixed arg2
, Mixed etc.
)
- :
- voidAdds element(s) to the toolbar -- this function takes a variable number of
-arguments of mixed type and adds them to ...Adds element(s) to the toolbar -- this function takes a variable number of
-arguments of mixed type and adds them to the toolbar.
-
Note: See the notes within Ext.Container.add.
Parameters:arg1
: MixedThe following types of arguments are all valid:
-
-- Ext.Button config: A valid button config object (equivalent to addButton)
-- HtmlElement: Any standard HTML element (equivalent to addElement)
-- Field: Any form field (equivalent to addField)
-- Item: Any subclass of Ext.Toolbar.Item (equivalent to addItem)
-- String: Any generic string (gets wrapped in a Ext.Toolbar.TextItem, equivalent to addText).
-Note that there are a few special strings that are treated differently as explained next.
-- '-': Creates a separator element (equivalent to addSeparator)
-- ' ': Creates a spacer element (equivalent to addSpacer)
-- '->': Creates a fill element (equivalent to addFill)
+See also getEl
Component hidden : BooleanTrue if this component is hidden. Read-only. Component initialConfig : ObjectThis Component's initial configuration specification. Read-only. Component items : MixedCollectionThe collection of components in this container as a Ext.util.MixedCollection Container ownerCt : Ext.ContainerThis Component's owner Container (defaults to undefined, and is set automatically when
+this Component is added to a C... Component refOwner : Ext.ContainerThe ancestor Container into which the ref reference was inserted if this Component
+is a child of a Container, and has...The ancestor Container into which the ref reference was inserted if this Component
+is a child of a Container, and has been configured with a ref
. Component rendered : BooleanTrue if this component has been rendered. Read-only. Component
Public Methods
Method Defined By Toolbar( Object/Array config
)
+ Creates a new ToolbarCreates a new ToolbarParameters:config
: Object/ArrayA config object or an array of buttons to add
Returns:- void
Toolbar add( Mixed arg1
, Mixed arg2
, Mixed etc.
)
+ :
+ voidAdds element(s) to the toolbar -- this function takes a variable number of
+arguments of mixed type and adds them to t...Adds element(s) to the toolbar -- this function takes a variable number of
+arguments of mixed type and adds them to the toolbar.
+
Note: See the notes within Ext.Container.add.
Parameters:arg1
: MixedThe following types of arguments are all valid:
+
+- Ext.Button config: A valid button config object (equivalent to addButton)
+- HtmlElement: Any standard HTML element (equivalent to addElement)
+- Field: Any form field (equivalent to addField)
+- Item: Any subclass of Ext.Toolbar.Item (equivalent to addItem)
+- String: Any generic string (gets wrapped in a Ext.Toolbar.TextItem, equivalent to addText).
+Note that there are a few special strings that are treated differently as explained next.
+- '-': Creates a separator element (equivalent to addSeparator)
+- ' ': Creates a spacer element (equivalent to addSpacer)
+- '->': Creates a fill element (equivalent to addFill)
arg2
: Mixedetc.
: Mixed
Returns:- void
Toolbar addButton( Object/Array config
)
:
- Ext.Button/ArrayAdds a button (or buttons). See Ext.Button for more info on the config.
-Note: See the notes within Ext.Container.add...Adds a button (or buttons). See Ext.Button for more info on the config.
+ Ext.Button/ArrayAdds a button (or buttons). See Ext.Button for more info on the config.
+Note: See the notes within Ext.Container.add.Adds a button (or buttons). See Ext.Button for more info on the config.
Note: See the notes within Ext.Container.add.
Parameters:config
: Object/ArrayA button config or array of configs
Returns:Ext.Button/Array
Toolbar addClass( string cls
)
:
Ext.ComponentAdds a CSS class to the component's underlying element.Adds a CSS class to the component's underlying element.Parameters:cls
: stringThe CSS class name to add
Returns:Ext.Component
this
Component addDom( Object config
)
:
- Ext.Toolbar.ItemAdds a new element to the toolbar from the passed Ext.DomHelper config
-Note: See the notes within Ext.Container.add.Adds a new element to the toolbar from the passed Ext.DomHelper config
+ Ext.Toolbar.ItemAdds a new element to the toolbar from the passed Ext.DomHelper config
+Note: See the notes within Ext.Container.add.Adds a new element to the toolbar from the passed Ext.DomHelper config
Note: See the notes within Ext.Container.add.
Parameters:config
: Object
Returns:Ext.Toolbar.Item
The element's item
Toolbar addElement( Mixed el
)
:
- Ext.Toolbar.ItemAdds any standard HTML element to the toolbar
-Note: See the notes within Ext.Container.add.Adds any standard HTML element to the toolbar
-
Note: See the notes within Ext.Container.add.
Parameters:el
: MixedThe element or id of the element to add
Returns:Ext.Toolbar.Item
The element's item
Toolbar addEvents( Object object
)
+ Ext.Toolbar.ItemAdds any standard HTML element to the toolbar
+Note: See the notes within Ext.Container.add.Adds any standard HTML element to the toolbar
+
Note: See the notes within Ext.Container.add.
Parameters:el
: MixedThe element or id of the element to add
Returns:Ext.Toolbar.Item
The element's item
Toolbar addEvents( Object|String o
, string Optional.
)
:
- voidUsed to define events on this ObservableUsed to define events on this ObservableParameters:object
: ObjectThe object with the events defined
Returns:- void
Observable addField( Ext.form.Field field
)
+ voidAdds the specified events to the list of events which this Observable may fire.Adds the specified events to the list of events which this Observable may fire.Parameters:o
: Object|StringEither an object with event names as properties with a value of true
+or the first event name string if multiple event names are being passed as separate parameters.Optional.
: stringEvent name if multiple event names are being passed as separate parameters.
+Usage:this.addEvents('storeloaded', 'storecleared');
Returns:- void
Observable addField( Ext.form.Field field
)
:
- Ext.Toolbar.ItemAdds a dynamically rendered Ext.form field (TextField, ComboBox, etc). Note: the field should not have
-been rendered...Adds a dynamically rendered Ext.form field (TextField, ComboBox, etc). Note: the field should not have
-been rendered yet. For a field that has already been rendered, use addElement.
+ Ext.Toolbar.ItemAdds a dynamically rendered Ext.form field (TextField, ComboBox, etc). Note: the field should not have
+been rendered ...Adds a dynamically rendered Ext.form field (TextField, ComboBox, etc). Note: the field should not have
+been rendered yet. For a field that has already been rendered, use addElement.
Note: See the notes within Ext.Container.add.
Parameters:field
: Ext.form.Field
Returns:Ext.Toolbar.Item
Toolbar addFill()
:
- voidForces subsequent additions into the float:right toolbar
-Note: See the notes within Ext.Container.add.Forces subsequent additions into the float:right toolbar
+ voidForces subsequent additions into the float:right toolbar
+Note: See the notes within Ext.Container.add.Forces subsequent additions into the float:right toolbar
Note: See the notes within Ext.Container.add.
Parameters:- None.
Returns:- void
Toolbar addItem( Ext.Toolbar.Item item
)
:
- Ext.Toolbar.ItemAdds any Toolbar.Item or subclass
-Note: See the notes within Ext.Container.add.Adds any Toolbar.Item or subclass
+ Ext.Toolbar.ItemAdds any Toolbar.Item or subclass
+Note: See the notes within Ext.Container.add.Adds any Toolbar.Item or subclass
Note: See the notes within Ext.Container.add.
Parameters:item
: Ext.Toolbar.Item
Returns:Ext.Toolbar.Item
The item
Toolbar 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.
@@ -745,8 +814,8 @@ Using the options argument, it is possible to combine different types of listene
A delayed, one-time listener.
myDataView.on('click', this.onClick, this, {
- single: true,
- delay: 100
+single: true,
+delay: 100
});
Attaching multiple handlers in 1 call
@@ -754,39 +823,39 @@ The method also allows for a single argument to be passed which is a config obje
which specify multiple handlers.
myGridPanel.on({
- 'click' : {
- fn: this.onClick,
- scope: this,
- delay: 100
- },
- 'mouseover' : {
- fn: this.onMouseOver,
- scope: this
- },
- 'mouseout' : {
- fn: this.onMouseOut,
- scope: this
- }
+'click' : {
+ fn: this.onClick,
+ scope: this,
+ delay: 100
+},
+'mouseover' : {
+ fn: this.onMouseOver,
+ scope: this
+},
+'mouseout' : {
+ fn: this.onMouseOut,
+ scope: this
+}
});
Or a shorthand syntax:
myGridPanel.on({
- 'click' : this.onClick,
- 'mouseover' : this.onMouseOver,
- 'mouseout' : this.onMouseOut,
- scope: this
+'click' : this.onClick,
+'mouseover' : this.onMouseOver,
+'mouseout' : this.onMouseOut,
+ scope: this
});
Returns:- void
Observable addSeparator()
:
- Ext.Toolbar.ItemAdds a separator
-Note: See the notes within Ext.Container.add.Adds a separator
+ Ext.Toolbar.ItemAdds a separator
+Note: See the notes within Ext.Container.add.Adds a separator
Note: See the notes within Ext.Container.add.
Parameters:- None.
Returns:Ext.Toolbar.Item
The separator {@link Ext.Toolbar.Item item}
Toolbar addSpacer()
:
- Ext.Toolbar.SpacerAdds a spacer element
-Note: See the notes within Ext.Container.add.Adds a spacer element
+ Ext.Toolbar.SpacerAdds a spacer element
+Note: See the notes within Ext.Container.add.Adds a spacer element
Note: See the notes within Ext.Container.add.
Parameters:- None.
Returns:Ext.Toolbar.Spacer
The spacer item
Toolbar addText( String text
)
:
- Ext.Toolbar.ItemAdds text to the toolbar
-Note: See the notes within Ext.Container.add.Adds text to the toolbar
+ Ext.Toolbar.ItemAdds text to the toolbar
+Note: See the notes within Ext.Container.add.Adds text to the toolbar
Note: See the notes within Ext.Container.add.
Parameters:text
: StringThe text to add
Returns:Ext.Toolbar.Item
The element's item
Toolbar applyToMarkup( String/HTMLElement el
)
:
voidApply this component to existing markup that is valid. With this function, no call to render() is required.Apply this component to existing markup that is valid. With this function, no call to render() is required.Parameters:el
: String/HTMLElement
Returns:- void
Component bubble( Function fn
, [Object scope
], [Array args
] )
@@ -818,9 +887,41 @@ to...Force this container's layout to be recalculated. A
to an already rendered container, or possibly after changing sizing/position properties of child components.Parameters:shallow
: Boolean(optional) True to only calc the layout of this component, and let child components auto
calc layouts as required (defaults to false, which calls doLayout recursively for each subcontainer)force
: Boolean(optional) True to force a layout to occur, even if the item is hidden.
Returns:Ext.Container
this
Container enable()
:
- Ext.ComponentEnable this component and fire the 'enable' event.Enable this component and fire the 'enable' event.Parameters:- None.
Returns:Ext.Component
this
Component enableBubble( Object events
)
- :
- voidUsed to enable bubbling of eventsUsed to enable bubbling of eventsParameters:events
: Object
Returns:- void
Observable find( String prop
, String value
)
+ Ext.ComponentEnable this component and fire the 'enable' event.Enable this component and fire the 'enable' event.Parameters:- None.
Returns:Ext.Component
this
Component enableBubble( String/Array events
)
+ :
+ voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget() if present....Enables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget()
if present. There is no implementation in the Observable base class.
+This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default
+implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
+access the required target more quickly.
+Example:
Ext.override(Ext.form.Field, {
+ // Add functionality to Field's initComponent to enable the change event to bubble
+ initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
+ this.enableBubble('change');
+ }),
+
+ // We know that we want Field's events to bubble directly to the FormPanel.
+ getBubbleTarget : function() {
+ if (!this.formPanel) {
+ this.formPanel = this.findParentByType('form');
+ }
+ return this.formPanel;
+ }
+});
+
+var myForm = new Ext.formPanel({
+ title: 'User Details',
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: function() {
+ // Title goes red if form has been modified.
+ myForm.header.setStyle('color', 'red');
+ }
+ }
+});
Parameters:events
: String/ArrayThe event name to bubble, or an Array of event names.
Returns:- void
Observable find( String prop
, String value
)
:
ArrayFind a component under this container at any level by propertyFind a component under this container at any level by propertyParameters:prop
: Stringvalue
: String
Returns:Array
Array of Ext.Components
Container findBy( Function fn
, [Object scope
] )
:
@@ -856,9 +957,9 @@ by calling Examines this container's items
property
and gets a direct child component of this container.Parameters:comp
: String/NumberThis parameter may be any of the following:
For additional information see Ext.util.MixedCollection.get.
Returns:Ext.Component
The component (if found).
Container getEl()
@@ -907,7 +1008,7 @@ the element into which the Gets the current XY position of the component's underlying element.Gets the current XY position of the component's underlying element.Parameters:local
: Boolean(optional) If true the element's left and top are returned instead of page XY (defaults to false)
Returns:Array
The XY position of the element (e.g., [100, 200])
BoxComponent getResizeEl()
:
- voidReturns the outermost Element of this Component which defines the Components overall size.
+ Ext.ElementReturns the outermost Element of this Component which defines the Components overall size.
Usually this will return t...Returns the outermost Element of this Component which defines the Components overall size.
Usually this will return the same Element as getEl
,
but in some cases, a Component may have some more wrapping Elements around its main
@@ -915,7 +1016,7 @@ active Element.
An example is a ComboBox. It is encased in a wrapping Element which
contains both the <input>
Element (which is what would be returned
by its getEl
method, and the trigger button Element.
-This Element is returned as the resizeEl
.
Parameters:- None.
Returns:- void
BoxComponent getSize()
+This Element is returned as the resizeEl
.Parameters:- None.
Returns:Ext.Element
The Element which is to be resized by size managing layouts.
BoxComponent getSize()
:
ObjectGets the current size of the component's underlying element.Gets the current size of the component's underlying element.Parameters:- None.
Returns:Object
An object containing the element's size {width: (element width), height: (element height)}
BoxComponent getWidth()
:
@@ -959,9 +1060,9 @@ property to the registered type of the Component wanted.
For a list of all available xtypes, see Ext.Component.Returns:Ext.Component
component The Component (or config object) that was
inserted with the Container's default config values applied.
Container insertButton( Number index
, Object/Ext.Toolbar.Item/Ext.Button/Array item
)
:
- Ext.Button/ItemInserts any Ext.Toolbar.Item/Ext.Button at the specified index.
-Note: See the notes within Ext.Container.add.Inserts any Ext.Toolbar.Item/Ext.Button at the specified index.
-
Note: See the notes within Ext.Container.add.
Parameters:index
: NumberThe index where the item is to be inserteditem
: Object/Ext.Toolbar.Item/Ext.Button/ArrayThe button, or button config object to be
+ Ext.Button/ItemInserts any Ext.Toolbar.Item/Ext.Button at the specified index.
+Note: See the notes within Ext.Container.add.Inserts any Ext.Toolbar.Item/Ext.Button at the specified index.
+
Note: See the notes within Ext.Container.add.
Parameters:index
: NumberThe index where the item is to be inserteditem
: Object/Ext.Toolbar.Item/Ext.Button/ArrayThe button, or button config object to be
inserted, or an array of buttons/configs.
Returns:Ext.Button/Item
Toolbar isVisible()
:
BooleanReturns true if this component is visible.Returns true if this component is visible.Parameters:- None.
Returns:Boolean
True if this component is visible, false otherwise.
Component isXType( String xtype
, [Boolean shallow
] )
@@ -977,7 +1078,26 @@ to participate in determination of inherited xtypes.
var isText = t.isXType('textfield'); // true
var isBoxSubclass = t.isXType('box'); // true, descended from BoxComponent
var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instanceParameters:xtype
: StringThe xtype to check for this Componentshallow
: 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:Boolean
True if this component descends from the specified xtype, false otherwise.
Component nextSibling()
+the default), or true to check whether this Component is directly of the specified xtype.Returns:Boolean
True if this component descends from the specified xtype, false otherwise.
Component mon( Observable|Element item
, Object|String ename
, Function fn
, Object scope
, Object opt
)
+ :
+ voidAdds listeners to any Observable object (or Elements) which are automatically removed when this Component
+is destroye...Adds listeners to any Observable object (or Elements) which are automatically removed when this Component
+is destroyed. Usage:
+myGridPanel.mon(myGridPanel.getSelectionModel(), 'selectionchange', handleSelectionChange, null, {buffer: 50});
+
+or:
+myGridPanel.mon(myGridPanel.getSelectionModel(), {
+ selectionchange: handleSelectionChange,
+ buffer: 50
+});
+
Parameters:item
: Observable|ElementThe item to which to add a listener/listeners.ename
: Object|StringThe event name, or an object containing event name properties.fn
: FunctionOptional. If the ename
parameter was an event name, this
+is the handler function.scope
: ObjectOptional. If the ename
parameter was an event name, this
+is the scope (this
reference) in which the handler function is executed.opt
: ObjectOptional. If the ename
parameter was an event name, this
+is the addListener options.
Returns:- void
Component mun( Observable|Element item
, Object|String ename
, Function fn
, Object scope
)
+ :
+ voidRemoves listeners that were added by the mon method.Removes listeners that were added by the mon method.Parameters:item
: Observable|ElementThe item from which to remove a listener/listeners.ename
: Object|StringThe event name, or an object containing event name properties.fn
: FunctionOptional. If the ename
parameter was an event name, this
+is the handler function.scope
: ObjectOptional. If the ename
parameter was an event name, this
+is the scope (this
reference) in which the handler function is executed.
Returns:- void
Component nextSibling()
:
Ext.ComponentReturns the next component in the owning containerReturns the next component in the owning containerParameters:- None.
Returns:Ext.Component
Component on( String eventName
, Function handler
, [Object scope
], [Object options
] )
:
@@ -1030,12 +1150,14 @@ which this component will be inserted (defaults to appending to the end of the c
If events were suspended using the queueSuspended parameter, then all
event...Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
-events fired during event suspension will be sent to any listeners now.Parameters:- None.
Returns:- void
Observable setDisabled( Boolean disabled
)
+events fired during event suspension will be sent to any listeners now.Parameters:- None.
Returns:- void
Observable setAutoScroll( Boolean scroll
)
:
- Ext.ComponentConvenience function for setting disabled/enabled by boolean.Convenience function for setting disabled/enabled by boolean.Parameters:disabled
: Boolean
Returns:Ext.Component
this
Component setHeight( Number height
)
+ Ext.BoxComponentSets the overflow on the content element of the component.Sets the overflow on the content element of the component.Parameters:scroll
: BooleanTrue to allow the Component to auto scroll.
Returns:Ext.BoxComponent
this
BoxComponent setDisabled( Boolean disabled
)
:
- Ext.BoxComponentSets the height of the component. This method fires the resize event.Sets the height of the component. This method fires the resize event.Parameters:height
: NumberThe new height to set. This may be one of:
-- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
+ Ext.ComponentConvenience function for setting disabled/enabled by boolean.Convenience function for setting disabled/enabled by boolean.Parameters:disabled
: Boolean
Returns:Ext.Component
this
Component setHeight( Mixed height
)
+ :
+ Ext.BoxComponentSets the height of the component. This method fires the resize event.Sets the height of the component. This method fires the resize event.Parameters:height
: MixedThe new height to set. This may be one of:
+- A Number specifying the new height in the Element's defaultUnits (by default, pixels).
- A String used to set the CSS height style.
- undefined to leave the height unchanged.
Returns:Ext.BoxComponent
this
BoxComponent setPagePosition( Number x
, Number y
)
@@ -1062,10 +1184,10 @@ This may be one of:
undefined
to leave the height unchanged.
Returns:Ext.BoxComponent
this
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.Parameters:visible
: BooleanTrue to show, false to hide
Returns:Ext.Component
this
Component setWidth( Number width
)
+ Ext.ComponentConvenience function to hide or show this component by boolean.Convenience function to hide or show this component by boolean.Parameters:visible
: BooleanTrue to show, false to hide
Returns:Ext.Component
this
Component setWidth( Mixed width
)
:
- Ext.BoxComponentSets the width of the component. This method fires the resize event.Sets the width of the component. This method fires the resize event.Parameters:width
: NumberThe new width to setThis may be one of:
-- A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels).
+ Ext.BoxComponentSets the width of the component. This method fires the resize event.Sets the width of the component. This method fires the resize event.Parameters:width
: MixedThe new width to set. This may be one of:
+- A Number specifying the new width in the Element's defaultUnits (by default, pixels).
- A String used to set the CSS width style.
Returns:Ext.BoxComponent
this
BoxComponent show()
:
@@ -1079,11 +1201,18 @@ after the Force the component's size to recalculate based on the underlying element's current height and width.Force the component's size to recalculate based on the underlying element's current height and width.Parameters:- None.
Returns:Ext.BoxComponent
this
BoxComponent un( String eventName
, Function handler
, [Object scope
] )
:
- voidRemoves an event handler (shorthand for removeListener.)Removes an event handler (shorthand for removeListener.)Parameters:eventName
: StringThe type of event the handler was associated with.handler
: FunctionThe handler to remove. This must be a reference to the function passed into the addListener call.scope
: Object(optional) The scope originally specified for the handler.
Returns:- void
Observable updateBox( Object box
)
+ voidRemoves an event handler (shorthand for removeListener.)Removes an event handler (shorthand for removeListener.)Parameters:eventName
: StringThe type of event the handler was associated with.handler
: FunctionThe handler to remove. This must be a reference to the function passed into the addListener call.scope
: Object(optional) The scope originally specified for the handler.
Returns:- void
Observable update( Mixed htmlOrData
, [Boolean loadScripts
], [Function callback
] )
+ :
+ voidUpdate the content area of a component.Update the content area of a component.Parameters:htmlOrData
: MixedIf this component has been configured with a template via the tpl config
+then it will use this argument as data to populate the template.
+If this component was not configured with a template, the components
+content area will be updated via Ext.Element updateloadScripts
: Boolean(optional) Only legitimate when using the html configuration. Defaults to falsecallback
: Function(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading
Returns:- void
Component updateBox( Object box
)
:
Ext.BoxComponentSets the current box measurements of the component's underlying element.Sets the current box measurements of the component's underlying element.Parameters:box
: ObjectAn object in the format {x, y, width, height}
Returns:Ext.BoxComponent
this
BoxComponent
Public Events
Event Defined By add :
( Ext.Container this
, Ext.Component component
, Number index
)
- Listeners will be called with the following arguments:this
: Ext.Containercomponent
: Ext.ComponentThe component that was addedindex
: NumberThe index at which the component was added to the container's items collection
Container afterlayout :
+ Listeners will be called with the following arguments:this
: Ext.Containercomponent
: Ext.ComponentThe component that was addedindex
: NumberThe index at which the component was added to the container's items collection
Container added :
+ ( Ext.Component this
, Ext.Container ownerCt
, number index
)
+ Fires when a component is added to an Ext.ContainerFires when a component is added to an Ext.ContainerListeners will be called with the following arguments:this
: Ext.ComponentownerCt
: Ext.ContainerContainer which holds the componentindex
: numberPosition at which the component was added
Component afterlayout :
( Ext.Container this
, ContainerLayout layout
)
Fires when the components in this container are arranged by the associated layout manager.Fires when the components in this container are arranged by the associated layout manager.Listeners will be called with the following arguments:this
: Ext.Containerlayout
: ContainerLayoutThe ContainerLayout implementation for this container
Container afterrender :
( Ext.Component this
)
@@ -1139,7 +1268,9 @@ Fires after the component is hidden when calling the Fires after the overflow state has changed.Fires after the overflow state has changed.Listeners will be called with the following arguments:c
: ObjectThe ContainerlastOverflow
: Booleanoverflow state
Toolbar remove :
( Ext.Container this
, Ext.Component component
)
- Listeners will be called with the following arguments:this
: Ext.Containercomponent
: Ext.ComponentThe component that was removed
Container render :
+ Listeners will be called with the following arguments:this
: Ext.Containercomponent
: Ext.ComponentThe component that was removed
Container removed :
+ ( Ext.Component this
, Ext.Container ownerCt
)
+ Fires when a component is removed from an Ext.ContainerFires when a component is removed from an Ext.ContainerListeners will be called with the following arguments:this
: Ext.ComponentownerCt
: Ext.ContainerContainer which holds the component
Component render :
( Ext.Component this
)
Fires after the component markup is rendered.Fires after the component markup is rendered.Listeners will be called with the following arguments:this
: Ext.Component
Component resize :
( Ext.Component this
, Number adjWidth
, Number adjHeight
, Number rawWidth
, Number rawHeight
)