True to enable dragging of this Panel (defaults to false). For custom drag/drop implementations, an Ext.Panel.DD conf...
-
True to enable dragging of this Panel (defaults to false).
For custom drag/drop implementations, an Ext.Panel.DD config could also be passed in this config instead of true. Ext.Panel.DD is an internal, undocumented class which moves a proxy Element around in place of the Panel's element, but provides no other behaviour during dragging or on drop. It is a subclass of Ext.dd.DragSource, so behaviour may be added by implementing the interface methods of Ext.dd.DragDrop eg:
new Ext.Panel({
+Config Options
|
| activeItem : String/NumberA string component id or the numeric index of the component that should be initially activated within the
+container's... | Container |
| allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component |
| anchor : StringNote: this config is only used when this Component is rendered
+by a Container which has been configured to use an Anc... Note: this config is only used when this Component is rendered
+by a Container which has been configured to use an AnchorLayout (or subclass thereof).
+based layout manager, for example:
+ See Ext.layout.AnchorLayout.anchor also. | BoxComponent |
| anchorOffset : NumberA numeric pixel value used to offset the
+default position of the anchor arrow (defaults to 0). When the anchor
+posit... A numeric pixel value used to offset the
+default position of the anchor arrow (defaults to 0). When the anchor
+position is on the top or bottom of the tooltip, anchorOffset
+will be used as a horizontal offset. Likewise, when the anchor position
+is on the left or right side, anchorOffset will be used as
+a vertical offset. | ToolTip |
| anchorToTarget : BooleanTrue to anchor the tooltip to the target
+element, false to anchor it relative to the mouse coordinates (defaults
+to t... True to anchor the tooltip to the target
+element, false to anchor it relative to the mouse coordinates (defaults
+to true). When anchorToTarget is true, use
+ defaultAlign to control tooltip alignment to the
+target element. When anchorToTarget is false, use
+ anchorPosition instead to control alignment. | ToolTip |
| animCollapse : Booleantrue to animate the transition when the panel is collapsed, false to skip the
+animation (defaults to true if the Ext.... true to animate the transition when the panel is collapsed, false to skip the
+animation (defaults to true if the Ext.Fx class is available, otherwise false ). | Panel |
| applyTo : MixedThe id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in
+the document ... The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in
+the document that specifies some panel-specific structural markup. When applyTo is used,
+constituent parts of the panel can be specified by CSS class name within the main element, and the panel
+will automatically create those components from that markup. Any required components not specified in the
+markup will be autogenerated if necessary.
+ The following class names are supported (baseCls will be replaced by baseCls):
+ - baseCls + '-header'
+- baseCls + '-header-text'
+- baseCls + '-bwrap'
+- baseCls + '-tbar'
+- baseCls + '-body'
+- baseCls + '-bbar'
+- baseCls + '-footer'
+ Using this config, a call to render() is not required. If applyTo is specified, any value passed for
+renderTo will be ignored and the target element's parent node will automatically be used as the
+panel's container. | Panel |
| autoDestroy : BooleanIf true the container will automatically destroy any contained component that is removed from it, else
+destruction mu... If true the container will automatically destroy any contained component that is removed from it, else
+destruction must be handled manually (defaults to true). | Container |
| autoEl : MixedA tag name or DomHelper spec used to create the Element which will
+encapsulate this Component.
+You do not normally ne... A tag name or DomHelper spec used to create the Element which will
+encapsulate this Component.
+ You do not normally need to specify this. For the base classes Ext.Component, Ext.BoxComponent,
+and Ext.Container, this defaults to 'div'. The more complex Ext classes use a more complex
+DOM structure created by their own onRender methods.
+ This is intended to allow the developer to create application-specific utility Components encapsulated by
+different DOM elements. Example usage: {
+ xtype: 'box',
+ autoEl: {
+ tag: 'img',
+ src: 'http://www.example.com/example.jpg'
+ }
+}, {
+ xtype: 'box',
+ autoEl: {
+ tag: 'blockquote',
+ html: 'autoEl is cool!'
+ }
+}, {
+ xtype: 'container',
+ autoEl: 'ul',
+ cls: 'ux-unordered-list',
+ items: {
+ xtype: 'box',
+ autoEl: 'li',
+ html: 'First list item'
+ }
+}
| Component |
| autoHeight : Booleantrue to use height:'auto', false to use fixed height (defaults to false).
+Note: Setting autoHeight: true means that t... true to use height:'auto', false to use fixed height (defaults to false ).
+Note: Setting autoHeight: true means that the browser will manage the panel's height
+based on its contents, and that Ext will not manage it at all. If the panel is within a layout that
+manages dimensions (fit , border , etc.) then setting autoHeight: true
+can cause issues with scrolling and will not generally work as expected since the panel will take
+on the height of its contents rather than the height required by the Ext layout.
| Panel |
| autoHide : BooleanTrue to automatically hide the tooltip after the
+mouse exits the target element or after the dismissDelay
+has expired... True to automatically hide the tooltip after the
+mouse exits the target element or after the dismissDelay
+has expired if set (defaults to true). If closable = true
+a close tool button will be rendered into the tooltip header. | ToolTip |
| autoLoad : Object/String/FunctionA valid url spec according to the Updater Ext.Updater.update method.
+If autoLoad is not null, the panel will attempt ... A valid url spec according to the Updater Ext.Updater.update method.
+If autoLoad is not null, the panel will attempt to load its contents
+immediately upon render.
+The URL will become the default URL for this panel's body element,
+so it may be refreshed at any time. | Panel |
| autoScroll : Booleantrue to use overflow:'auto' on the components layout element and show scroll bars automatically when
+necessary, false... true to use overflow:'auto' on the components layout element and show scroll bars automatically when
+necessary, false to clip any overflowing content (defaults to false ).
| BoxComponent |
| autoShow : BooleanTrue if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
+them on render... True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
+them on render (defaults to false). | Component |
| autoWidth : BooleanTrue to use width:'auto', false to use fixed width (or allow it to be managed by its parent
+Container's layout manage... True to use width:'auto', false to use fixed width (or allow it to be managed by its parent
+Container's layout manager. Defaults to false.
+ Note: Although many components inherit this config option, not all will
+function as expected with a width of 'auto'. Setting autoWidth:true means that the
+browser will manage width based on the element's contents, and that Ext will not manage it at all.
+ If the browser is managing the width, be aware that resizes performed by the browser in response
+to changes within the structure of the Component cannot be detected. Therefore changes to the width might
+result in elements needing to be synchronized with the new width. For example, where the target element is: <div id='grid-container' style='margin-left:25%;width:50%'></div>
+A Panel rendered into that target element must listen for browser window resize in order to relay its
+child items when the browser changes its width: var myPanel = new Ext.Panel({
+ renderTo: 'grid-container',
+ monitorResize: true, // relay on browser resize
+ title: 'Panel',
+ height: 400,
+ autoWidth: true,
+ layout: 'hbox',
+ layoutConfig: {
+ align: 'stretch'
+ },
+ defaults: {
+ flex: 1
+ },
+ items: [{
+ title: 'Box 1',
+ }, {
+ title: 'Box 2'
+ }, {
+ title: 'Box 3'
+ }],
+});
| BoxComponent |
| baseCls : StringThe base CSS class to apply to this panel's element (defaults to 'x-panel').
+Another option available by default is t... The base CSS class to apply to this panel's element (defaults to 'x-panel' ).
+ Another option available by default is to specify 'x-plain' which strips all styling
+except for required attributes for Ext layouts to function (e.g. overflow:hidden).
+See unstyled also. | Panel |
| bbar : Object/ArrayThe bottom toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of
+buttons/button co... The bottom toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of
+buttons/button configs to be added to the toolbar. Note that this is not available as a property after render.
+To access the bottom toolbar after render, use getBottomToolbar.
+ Note: Although a Toolbar may contain Field components, these will not be updated by a load
+of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and
+so are not scanned to collect form items. However, the values will be submitted because form
+submission parameters are collected from the DOM tree. | Panel |
| bbarCfg : ObjectA DomHelper element specification object specifying the element structure
+of this Panel's bbar Element. See bodyCfg ... A DomHelper element specification object specifying the element structure
+of this Panel's bbar Element. See bodyCfg also. | Panel |
| bodyBorder : BooleanTrue to display an interior border on the body element of the panel, false to hide it (defaults to true).
+This only a... True to display an interior border on the body element of the panel, false to hide it (defaults to true).
+This only applies when border == true. If border == true and bodyBorder == false, the border will display
+as a 1px wide inset border, giving the entire body element an inset appearance. | Panel |
| bodyCfg : ObjectA DomHelper element specification object may be specified for any
+Panel Element.
+By default, the Default element in t... A DomHelper element specification object may be specified for any
+Panel Element.
+ By default, the Default element in the table below will be used for the html markup to
+create a child element with the commensurate Default class name (baseCls will be
+replaced by baseCls ):
+
+Panel Default Default Custom Additional Additional
+Element element class element class style
+======== ========================== ========= ============== ===========
+header div baseCls+'-header' headerCfg headerCssClass headerStyle
+bwrap div baseCls+'-bwrap' bwrapCfg bwrapCssClass bwrapStyle
++ tbar div baseCls+'-tbar' tbarCfg tbarCssClass tbarStyle
++ body div baseCls+'-body' bodyCfg bodyCssClass bodyStyle
++ bbar div baseCls+'-bbar' bbarCfg bbarCssClass bbarStyle
++ footer div baseCls+'-footer' footerCfg footerCssClass footerStyle
+
+ Configuring a Custom element may be used, for example, to force the body Element
+to use a different form of markup than is created by default. An example of this might be
+to create a child Panel containing a custom content, such as
+a header, or forcing centering of all Panel content by having the body be a <center>
+element:
+ new Ext.Panel({
+ title: 'Message Title',
+ renderTo: Ext.getBody(),
+ width: 200, height: 130,
+ bodyCfg: {
+ tag: 'center',
+ cls: 'x-panel-body', // Default class not applied if Custom element specified
+ html: 'Message'
+ },
+ footerCfg: {
+ tag: 'h2',
+ cls: 'x-panel-footer', // same as the Default class
+ html: 'footer html'
+ },
+ footerCssClass: 'custom-footer', // additional css class, see addClass
+ footerStyle: 'background-color:red' // see bodyStyle
+});
+ The example above also explicitly creates a footer with custom markup and
+styling applied. | Panel |
| bodyCssClass : String/Object/FunctionAdditional css class selector to be applied to the body element in the format expected by
+Ext.Element.addClass (defau... | Panel |
| bodyStyle : String/Object/FunctionCustom CSS styles to be applied to the body element in the format expected by
+Ext.Element.applyStyles (defaults to nu... | Panel |
| border : BooleanTrue to display the borders of the panel's body element, false to hide them (defaults to true). By default,
+the bord... True to display the borders of the panel's body element, false to hide them (defaults to true). By default,
+the border is a 2px wide inset border, but this can be further altered by setting bodyBorder to false. | Panel |
| boxMaxHeight : NumberThe maximum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size mana... The maximum value in pixels which this BoxComponent will set its height to.
+ Warning: This will override any size management applied by layout managers. | BoxComponent |
| boxMaxWidth : NumberThe maximum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size manag... The maximum value in pixels which this BoxComponent will set its width to.
+ Warning: This will override any size management applied by layout managers. | BoxComponent |
| boxMinHeight : NumberThe minimum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size mana... The minimum value in pixels which this BoxComponent will set its height to.
+ Warning: This will override any size management applied by layout managers. | BoxComponent |
| boxMinWidth : NumberThe minimum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size manag... The minimum value in pixels which this BoxComponent will set its width to.
+ Warning: This will override any size management applied by layout managers. | BoxComponent |
| bubbleEvents : ArrayAn array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.... | Container |
| bufferResize : Boolean/NumberWhen set to true (50 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
+th... When set to true (50 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
+the frequency it calculates and does a re-layout of components. This is useful for heavy containers or containers
+with a large quantity of sub-components for which frequent layout calls would be expensive. Defaults to 50 . | Container |
| buttonAlign : StringThe alignment of any buttons added to this panel. Valid values are 'right',
+'left' and 'center' (defaults to 'right'... The alignment of any buttons added to this panel. Valid values are 'right' ,
+ 'left' and 'center' (defaults to 'right' ). | Panel |
| buttons : Arraybuttons will be used as items for the toolbar in
+the footer (fbar). Typically the value of this configuration propert... buttons will be used as items for the toolbar in
+the footer ( fbar ). Typically the value of this configuration property will be
+an array of Ext.Buttons or Ext.Button configuration objects.
+If an item is configured with minWidth or the Panel is configured with minButtonWidth ,
+that width will be applied to the item. | Panel |
| bwrapCfg : ObjectA DomHelper element specification object specifying the element structure
+of this Panel's bwrap Element. See bodyCfg... A DomHelper element specification object specifying the element structure
+of this Panel's bwrap Element. See bodyCfg also. | Panel |
| clearCls : StringThe CSS class used to to apply to the special clearing div rendered
+directly after each form field wrapper to provide... The CSS class used to to apply to the special clearing div rendered
+directly after each form field wrapper to provide field clearing (defaults to
+'x-form-clear-left').
+ 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') and either a
+fieldLabel is specified or isFormField=true is specified.
+ See Ext.layout.FormLayout.fieldTpl also. | Component |
| closable : Boolean True to render a close tool button into the tooltip header (defaults to false). | Tip |
| cls : StringAn optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
+useful for ... An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
+useful for adding customized styles to the component or any of its children using standard CSS rules. | Component |
| collapseFirst : Booleantrue to make sure the collapse/expand toggle button always renders first (to the left of)
+any other tools in the pane... true to make sure the collapse/expand toggle button always renders first (to the left of)
+any other tools in the panel's title bar, false to render it last (defaults to true ).
| Panel |
| collapsed : Boolean true to render the panel collapsed, false to render it expanded (defaults to
+false ).
| Panel |
| collapsedCls : String A CSS class to add to the panel's element after it has been collapsed (defaults to
+'x-panel-collapsed' ). | Panel |
| collapsible : BooleanTrue to make the panel collapsible and have the expand/collapse toggle button automatically rendered into
+the header ... True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into
+the header tool button area, false to keep the panel statically sized with no button (defaults to false). | Panel |
| 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.
+ Note: ctCls defaults to '' except for the following class
+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 : StringExperimental. The default Ext.Element.alignTo anchor position value
+for this tip relative to its element of origin (d... Experimental. The default Ext.Element.alignTo anchor position value
+for this tip relative to its element of origin (defaults to "tl-bl?"). | Tip |
| defaultType : StringThe default xtype of child Components to create in this Container when
+a child item is specified as a raw configurati... The default xtype of child Components to create in this Container when
+a child item is specified as a raw configuration object, rather than as an instantiated Component.
+ Defaults to 'panel' , except Ext.menu.Menu which defaults to 'menuitem' ,
+and Ext.Toolbar and Ext.ButtonGroup which default to 'button' . | Container |
| defaults : Object|FunctionThis option is a means of applying default settings to all added items whether added through the items
+config or via ... This option is a means of applying default settings to all added items whether added through the items
+config or via the add or insert methods.
+ If an added item is a config object, and not an instantiated Component, then the default properties are
+unconditionally applied. If the added item is an instantiated Component, then the default properties are
+applied conditionally so as not to override existing properties in the item.
+ If the defaults option is specified as a function, then the function will be called using this Container as the
+scope (this reference) and passing the added item as the first parameter. Any resulting object
+from that call is then applied to the item as default properties.
+ For example, to automatically apply padding to the body of each of a set of
+contained Ext.Panel items, you could pass: defaults: {bodyStyle:'padding:15px'} .
+ Usage: defaults: { // defaults are applied to items, not the container
+ autoScroll:true
+},
+items: [
+ {
+ xtype: 'panel', // defaults do not have precedence over
+ id: 'panel1', // options in config objects, so the defaults
+ autoScroll: false // will not be applied here, panel1 will be autoScroll:false
+ },
+ new Ext.Panel({ // defaults do have precedence over options
+ id: 'panel2', // options in components, so the defaults
+ autoScroll: false // will be applied here, panel2 will be autoScroll:true.
+ })
+]
| Container |
| delegate : StringOptional. A DomQuery
+selector which allows selection of individual elements within the
+target element to trigger show... Optional. A DomQuery
+selector which allows selection of individual elements within the
+target element to trigger showing and hiding the
+ToolTip as the mouse moves within the target.
+ When specified, the child element of the target which caused a show
+event is placed into the triggerElement property
+before the ToolTip is shown.
+ This may be useful when a Component has regular, repeating elements
+in it, each of which need a Tooltip which contains information specific
+to that element. For example: var myGrid = new Ext.grid.gridPanel(gridConfig);
+myGrid.on('render', function(grid) {
+ var store = grid.getStore(); // Capture the Store.
+ var view = grid.getView(); // Capture the GridView.
+ myGrid.tip = new Ext.ToolTip({
+ target: view.mainBody, // The overall target element.
+ delegate: '.x-grid3-row', // Each grid row causes its own seperate show and hide.
+ trackMouse: true, // Moving within the row should not hide the tip.
+ renderTo: document.body, // Render immediately so that tip.body can be
+ // referenced prior to the first show.
+ listeners: { // Change content dynamically depending on which element
+ // triggered the show.
+ beforeshow: function updateTipBody(tip) {
+ var rowIndex = view.findRowIndex(tip.triggerElement);
+ tip.body.dom.innerHTML = 'Over Record ID ' + store.getAt(rowIndex).id;
+ }
+ }
+ });
+});
| ToolTip |
| disabled : BooleanRender this panel disabled (default is false). An important note when using the disabled
+config on panels is that IE ... Render this panel disabled (default is false ). An important note when using the disabled
+config on panels is that IE will often fail to initialize the disabled mask element correectly if
+the panel's layout has not yet completed by the time the Panel is disabled during the render process.
+If you experience this issue, you may need to instead use the afterlayout event to initialize
+the disabled state:
+ new Ext.Panel({
+ ...
+ listeners: {
+ 'afterlayout': {
+ fn: function(p){
+ p.disable();
+ },
+ single: true // important, as many layouts can occur
+ }
+ }
+});
| Panel |
| disabledClass : String CSS class added to the component when it is disabled (defaults to 'x-item-disabled'). | Component |
| dismissDelay : NumberDelay in milliseconds before the tooltip
+automatically hides (defaults to 5000). To disable automatic hiding, set
+dis... Delay in milliseconds before the tooltip
+automatically hides (defaults to 5000). To disable automatic hiding, set
+dismissDelay = 0. | ToolTip |
| draggable : Boolean/Objecttrue to enable dragging of this Panel (defaults to false).
+For custom drag/drop implementations, an Ext.Panel.DD conf... true to enable dragging of this Panel (defaults to false ).
+ For custom drag/drop implementations, an Ext.Panel.DD config could also be passed
+in this config instead of true . Ext.Panel.DD is an internal, undocumented class which
+moves a proxy Element around in place of the Panel's element, but provides no other behaviour
+during dragging or on drop. It is a subclass of Ext.dd.DragSource, so behaviour may be
+added by implementing the interface methods of Ext.dd.DragDrop e.g.:
+ new Ext.Panel({
title: 'Drag me',
x: 100,
y: 100,
@@ -487,268 +348,215 @@ A specialized tooltip class for tooltips that can be specified in markup and aut
height: 200,
draggable: {
// Config option of Ext.Panel.DD class.
-// It's a floating Panel, so do not show a placeholder proxy in the original position.
+// It's a floating Panel, so do not show a placeholder proxy in the original position.
insertProxy: false,
// Called for each mousemove event while dragging the DD object.
onDrag : function(e){
// Record the x,y position of the drag proxy so that we can
// position the Panel at end of drag.
- var pel = this.proxy.getEl();
- this.x = pel.getLeft(true);
- this.y = pel.getTop(true);
+ var pel = this.proxy.getEl();
+ this.x = pel.getLeft(true);
+ this.y = pel.getTop(true);
// Keep the Shadow aligned if there is one.
- var s = this.panel.getEl().shadow;
+ var s = this.panel.getEl().shadow;
if (s) {
- s.realign(this.x, this.y, pel.getWidth(), pel.getHeight());
+ s.realign(this.x, this.y, pel.getWidth(), pel.getHeight());
}
},
// Called on the mouseup event.
endDrag : function(e){
- this.panel.setPosition(this.x, this.y);
+ this.panel.setPosition(this.x, this.y);
}
}
-}).show();
-
- |
- Panel |
-
-
- |
-
-
- elements : String
- A comma-delimited list of panel elements to initialize when the panel is rendered. Normally, this list will be genera...
-
- A comma-delimited list of panel elements to initialize when the panel is rendered. Normally, this list will be generated automatically based on the items added to the panel at config time, but sometimes it might be useful to make sure a structural element is rendered even if not specified at config time (for example, you may want to add a button or toolbar dynamically after the panel has been rendered). Adding those elements to this list will allocate the required placeholders in the panel when it is rendered. Valid values are - header
- tbar (top bar)
- body (required)
- bbar (bottom bar)
- footer
-
Defaults to 'body'.
-
- |
- Panel |
-
-
- |
-
-
- fieldLabel : String
- The label text to display next to this Component (defaults to '') This config is only used when this Component is ren...
-
- The label text to display next to this Component (defaults to '') This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: new Ext.FormPanel({
+}).show();
| Panel |
| elements : StringA comma-delimited list of panel elements to initialize when the panel is rendered. Normally, this list will be
+gener... A comma-delimited list of panel elements to initialize when the panel is rendered. Normally, this list will be
+generated automatically based on the items added to the panel at config time, but sometimes it might be useful to
+make sure a structural element is rendered even if not specified at config time (for example, you may want
+to add a button or toolbar dynamically after the panel has been rendered). Adding those elements to this
+list will allocate the required placeholders in the panel when it is rendered. Valid values are
+header
+tbar (top bar)
+body
+bbar (bottom bar)
+footer
+
+Defaults to ' body '. | Panel |
| fbar : Object/ArrayA Toolbar object, a Toolbar config, or an array of
+Buttons/Button configs, describing a Toolbar to be rendered into t... A Toolbar object, a Toolbar config, or an array of
+Buttons/Button configs, describing a Toolbar to be rendered into this Panel's footer element.
+ After render, the fbar property will be an Toolbar instance.
+ If buttons are specified, they will supersede the fbar configuration property.
+The Panel's buttonAlign configuration affects the layout of these items, for example:
+ var w = new Ext.Window({
+ height: 250,
+ width: 500,
+ bbar: new Ext.Toolbar({
+ items: [{
+ text: 'bbar Left'
+ },'->',{
+ text: 'bbar Right'
+ }]
+ }),
+ buttonAlign: 'left', // anything but 'center' or 'right' and you can use '-', and '->'
+ // to control the alignment of fbar items
+ fbar: [{
+ text: 'fbar Left'
+ },'->',{
+ text: 'fbar Right'
+ }]
+}).show();
+ Note: Although a Toolbar may contain Field components, these will not be updated by a load
+of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and
+so are not scanned to collect form items. However, the values will be submitted because form
+submission parameters are collected from the DOM tree. | Panel |
| fieldLabel : StringThe label text to display next to this Component (defaults to '').
+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.
+Ext.form.FormPanel or specifying layout:'form').
+ Also see hideLabel and
+Ext.layout.FormLayout.fieldTpl.
+Example use: new Ext.FormPanel({
height: 100,
renderTo: Ext.getBody(),
items: [{
xtype: 'textfield',
fieldLabel: 'Name'
}]
-});
-
- |
- Component |
-
-
- |
-
-
- floating : Boolean
- True to float the panel (absolute position it with automatic shimming and shadow), false to display it inline where i...
-
- True to float the panel (absolute position it with automatic shimming and shadow), false to display it inline where it is rendered (defaults to false). Note that by default, setting floating to true will cause the panel to display at negative offsets so that it is hidden -- because the panel is absolute positioned, the position must be set explicitly after render (e.g., myPanel.setPosition(100,100);). Also, when floating a panel you should always assign a fixed width, otherwise it will be auto width and will expand to fill to the right edge of the viewport.
-
- |
- Panel |
-
-
- |
-
-
- footer : Boolean
- True to create the footer element explicitly, false to skip creating it. By default, when footer is not specified, if...
-
- True to create the footer element explicitly, false to skip creating it. By default, when footer is not specified, if one or more buttons have been added to the panel the footer will be created automatically, otherwise it will not.
-
- |
- Panel |
-
-
- |
-
-
- frame : Boolean
- True to render the panel with custom rounded borders, false to render with plain 1px square borders (defaults to false).
- |
- Panel |
-
-
- |
-
-
- header : Boolean
- True to create the header element explicitly, false to skip creating it. By default, when header is not specified, if...
-
- True to create the header element explicitly, false to skip creating it. By default, when header is not specified, if a title is set the header will be created automatically, otherwise it will not. If a title is set but header is explicitly set to false, the header will not be rendered.
-
- |
- Panel |
-
-
- |
-
-
- headerAsText : Boolean
- True to display the panel title in the header, false to hide it (defaults to true).
- |
- Panel |
-
-
- |
-
-
- height : Number
- The height of this component in pixels (defaults to auto).
- |
- BoxComponent |
-
-
- |
-
-
- hidden : Boolean
- Render this component hidden (default is false).
- |
- Component |
-
-
- |
-
-
- hideBorders : Boolean
- True to hide the borders of each contained component, false to defer to the component's existing border settings (def...
-
- True to hide the borders of each contained component, false to defer to the component's existing border settings (defaults to false).
-
- |
- Container |
-
-
- |
-
-
- hideCollapseTool : Boolean
- True to hide the expand/collapse toggle button when collapsible = true, false to display it (defaults to false).
- |
- Panel |
-
-
- |
-
-
- hideDelay : Number
- Delay in milliseconds after the mouse exits the target element but before the tooltip actually hides (defaults to 200...
-
- Delay in milliseconds after the mouse exits the target element but before the tooltip actually hides (defaults to 200). Set to 0 for the tooltip to hide immediately.
-
- |
- ToolTip |
-
-
- |
-
-
- hideLabel : Boolean
- True to completely hide the label element (defaults to false). By default, even if you do not specify a fieldLabel th...
-
- True to completely hide the label element (defaults to false). By default, even if you do not specify a fieldLabel the space will still be reserved so that the field will line up with other fields that do have labels. Setting this to true will cause the field to not reserve that space. This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: new Ext.FormPanel({
+});
| Component |
| flex : NumberNote: this config is only used when this Component is rendered
+by a Container which has been configured to use a BoxL... Note: this config is only used when this Component is rendered
+by a Container which has been configured to use a BoxLayout.
+Each child Component with a flex property will be flexed either vertically (by a VBoxLayout)
+or horizontally (by an HBoxLayout) according to the item's relative flex value
+compared to the sum of all Components with flex value specified. Any child items that have
+either a flex = 0 or flex = undefined will not be 'flexed' (the initial size will not be changed). | BoxComponent |
| floating : MixedThis property is used to configure the underlying Ext.Layer. Acceptable values for this
+configuration property are:<d... This property is used to configure the underlying Ext.Layer. Acceptable values for this
+configuration property are: | Panel |
| footer : Booleantrue to create the footer element explicitly, false to skip creating it. The footer
+will be created automatically if ... true to create the footer element explicitly, false to skip creating it. The footer
+will be created automatically if buttons or a fbar have
+been configured. See bodyCfg for an example. | Panel |
| footerCfg : ObjectA DomHelper element specification object specifying the element structure
+of this Panel's footer Element. See bodyCf... A DomHelper element specification object specifying the element structure
+of this Panel's footer Element. See bodyCfg also. | Panel |
| forceLayout : BooleanIf true the container will force a layout initially even if hidden or collapsed. This option
+is useful for forcing fo... If true the container will force a layout initially even if hidden or collapsed. This option
+is useful for forcing forms to render in collapsed or hidden containers. (defaults to false). | Container |
| frame : Booleanfalse by default to render with plain 1px square borders. true to render with
+9 elements, complete with custom rounde... false by default to render with plain 1px square borders. true to render with
+9 elements, complete with custom rounded corners (also see Ext.Element.boxWrap).
+ The template generated for each condition is depicted below: // frame = false
+<div id="developer-specified-id-goes-here" class="x-panel">
+
+ <div class="x-panel-header"><span class="x-panel-header-text">Title: (frame:false)</span></div>
+
+ <div class="x-panel-bwrap">
+ <div class="x-panel-body"><p>html value goes here</p></div>
+ </div>
+</div>
+
+// frame = true (create 9 elements)
+<div id="developer-specified-id-goes-here" class="x-panel">
+ <div class="x-panel-tl"><div class="x-panel-tr"><div class="x-panel-tc">
+ <div class="x-panel-header"><span class="x-panel-header-text">Title: (frame:true)</span></div>
+ </div></div></div>
+
+ <div class="x-panel-bwrap">
+ <div class="x-panel-ml"><div class="x-panel-mr"><div class="x-panel-mc">
+ <div class="x-panel-body"><p>html value goes here</p></div>
+ </div></div></div>
+
+ <div class="x-panel-bl"><div class="x-panel-br"><div class="x-panel-bc"/>
+ </div></div></div>
+</div>
| Panel |
| header : Booleantrue to create the Panel's header element explicitly, false to skip creating
+it. If a title is set the header will b... true to create the Panel's header element explicitly, false to skip creating
+it. If a title is set the header will be created automatically, otherwise it will not.
+If a title is set but header is explicitly set to false , the header
+will not be rendered. | Panel |
| headerAsText : Booleantrue to display the panel title in the header ,
+ false to hide it (defaults to true ). | Panel |
| headerCfg : ObjectA DomHelper element specification object specifying the element structure
+of this Panel's header Element. See bodyCf... A DomHelper element specification object specifying the element structure
+of this Panel's header Element. See bodyCfg also. | Panel |
| height : NumberThe height of this component in pixels (defaults to auto).
+Note to express this dimension as a percentage or offset s... The height of this component in pixels (defaults to auto).
+ Note to express this dimension as a percentage or offset see Ext.Component.anchor. | BoxComponent |
| hidden : BooleanRender this component hidden (default is false). If true, the
+ hide method will be called internally. | Component |
| hideBorders : BooleanTrue to hide the borders of each contained component, false to defer to the component's existing
+border settings (def... True to hide the borders of each contained component, false to defer to the component's existing
+border settings (defaults to false). | Container |
| hideCollapseTool : Booleantrue to hide the expand/collapse toggle button when collapsible == true ,
+ false to display it (defaults to false ). | Panel |
| hideDelay : NumberDelay in milliseconds after the mouse exits the
+target element but before the tooltip actually hides (defaults to 200... Delay in milliseconds after the mouse exits the
+target element but before the tooltip actually hides (defaults to 200).
+Set to 0 for the tooltip to hide immediately. | ToolTip |
| 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
+reserved so that the field will line up with other fields that do have labels.
+Setting this to true will cause the field to not reserve that space.
+ Note: see the note for clearCls.
+Example use: new Ext.FormPanel({
height: 100,
renderTo: Ext.getBody(),
items: [{
xtype: 'textfield'
hideLabel: true
}]
-});
-
- |
- Component |
-
-
- |
-
-
- hideMode : String
- How 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) - defaults to "display". For Containers which may be hidden and shown as part of a card layout Container such as a TabPanel, it is recommended that hideMode is configured as "offsets". This ensures that hidden Components still have height and width so that layout managers can perform measurements when calculating layouts.
-
- |
- Component |
-
-
- |
-
-
- hideParent : Boolean
- True 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/Object
- An HTML fragment, or a DomHelper specification to use as the panel's body content (defaults to ''). The HTML content ...
-
- An HTML fragment, or a DomHelper specification to use as the panel's body content (defaults to ''). The HTML content is added by the Panel's afterRender method, and so the document will not contain this HTML at the time the render event is fired. This content is inserted into the body before any configured contentEl is appended.
-
- |
- Panel |
-
-
- |
-
-
- iconCls : String
- A CSS class that will provide a background image to be used as the header icon (defaults to ''). An example custom ic...
-
- A CSS class that will provide a background image to be used as the header icon (defaults to ''). An example custom icon class would be something like: .my-icon { background: url(../images/my-icon.gif) 0 6px no-repeat !important;}
-
- |
- Panel |
-
-
- |
-
-
- id : String
- The 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.ComponentMgr.getCmp). Note that this id will also be used as the element id for the containing HTML element that is rendered to the page for this component. This allows you to write id-based CSS rules to style the specific instance of this component uniquely, and also to select sub-elements using this component's id as the parent.
-
- |
- Component |
-
-
- |
-
-
- interceptTitles : Boolean
- True to automatically use the element's DOM title value if available (defaults to false).
- |
- QuickTip |
-
-
- |
-
-
- itemCls : String
- An additional CSS class to apply to the wrapper's form item element of this field (defaults to the container's itemCl...
-
- An additional CSS class to apply to the wrapper's form item element of this field (defaults to the container's itemCls value if set, or ''). Since it is applied to the item wrapper, it allows 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. This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: // Apply a style to the field's label:
+});
| 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
+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
+content (defaults to ''). The HTML conten... An HTML fragment, or a DomHelper specification to use as the layout element
+content (defaults to ''). The HTML content is added after the component is rendered,
+so the document will not contain this HTML at the time the render event is fired.
+This content is inserted into the body before any configured contentEl is appended. | Component |
| iconCls : StringThe CSS class selector that specifies a background image to be used as the header icon (defaults to '').
+An example o... The CSS class selector that specifies a background image to be used as the header icon (defaults to '').
+ An example of specifying a custom icon class would be something like:
+ // specify the property in the config for the class:
+ ...
+ iconCls: 'my-icon'
+
+// css class that specifies background image to be used as the icon image:
+.my-icon { background-image: url(../images/my-icon.gif) 0 6px no-repeat !important; }
| Panel |
| 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).
+ Note that this id will also be used as the element id for the containing HTML element
+that is rendered to the page for this component. This allows you to write id-based CSS
+rules to style the specific instance of this component uniquely, and also to select
+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 |
| interceptTitles : Boolean True to automatically use the element's DOM title value if available (defaults to false). | QuickTip |
| 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').
+ Since it is applied to the item wrapper (see
+Ext.layout.FormLayout.fieldTpl), it allows
+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:
<style>
- .required .x-form-item-label {font-weight:bold;color:red;}
+ .required .x-form-item-label {font-weight:bold;color:red;}
</style>
new Ext.FormPanel({
@@ -757,68 +565,112 @@ A specialized tooltip class for tooltips that can be specified in markup and aut
items: [{
xtype: 'textfield',
fieldLabel: 'Name',
- itemCls: 'required' //this label will be styled
+ itemCls: 'required' //this label will be styled
},{
xtype: 'textfield',
fieldLabel: 'Favorite Color'
}]
-});
-
- |
- Component |
-
-
- |
-
-
- items : Mixed
- A single item, or an array of child Components to be added to this container. Each item can be any type of object bas...
-
- A single item, or an array of child Components to be added to this container. Each item can be any type of object based on Ext.Component. Component config objects may also be specified in order to avoid the overhead of constructing a real Component object if lazy rendering might mean that the added 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. If a single item is being passed, it should be passed directly as an object reference (e.g., items: {...}). Multiple items should be passed as an array of objects (e.g., items: [{...}, {...}]).
-
- |
- Container |
-
-
- |
-
-
- keys : Object/Array
- A KeyMap config object (in the format expected by Ext.KeyMap.addBinding used to assign custom key handling to this pa...
-
- A KeyMap config object (in the format expected by Ext.KeyMap.addBinding used to assign custom key handling to this panel (defaults to null).
-
- |
- Panel |
-
-
- |
-
-
- labelSeparator : String
- The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.l...
-
- The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.labelSeparator, which is a colon ':' by default). To display no separator for this field's label specify empty string ''. This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: new Ext.FormPanel({
+});
| 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
+Ext.Container.getComponent which will retrieve
+itemId 's or id's. Since itemId 's are an index to the
+container's internal MixedCollection, the itemId is scoped locally to the container --
+avoiding potential conflicts with Ext.ComponentMgr which requires a unique
+id .
+ var c = new Ext.Panel({ //
+ height: 300,
+ renderTo: document.body,
+ layout: 'auto',
+ items: [
+ {
+ itemId: 'p1',
+ title: 'Panel 1',
+ height: 150
+ },
+ {
+ itemId: 'p2',
+ title: 'Panel 2',
+ height: 150
+ }
+ ]
+})
+p1 = c.getComponent('p1'); // not the same as Ext.getCmp()
+p2 = p1.ownerCt.getComponent('p2'); // reference via a sibling
+ Also see id and ref .
+ Note: to access the container of an item see ownerCt. | Component |
| items : Object/Array** IMPORTANT: be sure to specify a layout if needed ! **
+A single item, or an array of child Components to be added t... ** IMPORTANT: be sure to specify a layout if needed ! **
+ A single item, or an array of child Components to be added to this container,
+for example:
+ // specifying a single item
+items: {...},
+layout: 'fit', // specify a layout!
+
+// specifying multiple items
+items: [{...}, {...}],
+layout: 'anchor', // specify a layout!
+ Each item may be:
+
+- any type of object based on Ext.Component
+- a fully instanciated object or
+- an object literal that:
+
+- has a specified
xtype
+- the Ext.Component.xtype specified is associated with the Component
+desired and should be chosen from one of the available xtypes as listed
+in Ext.Component.
+- If an
xtype is not explicitly
+specified, the defaultType for that Container is used.
+- will be "lazily instanciated", avoiding the overhead of constructing a fully
+instanciated Component object
+
+ Notes:
+
+- Ext uses lazy rendering. Child Components will only be rendered
+should it become necessary. Items are automatically laid out when they are first
+shown (no sizing is done while hidden), or in response to a doLayout call.
+- Do not specify
contentEl /
+html with items .
+ | Container |
| keys : Object/ArrayA Ext.KeyMap config object (in the format expected by Ext.KeyMap.addBinding
+used to assign custom key handling to thi... | Panel |
| labelSeparator : StringThe separator to display after the text of each
+fieldLabel. This property may be configured at various levels.
+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:
+
+- field / component level
+- container level
+- layout level (defaults to colon ':')
+
+To display no separator for this field's label specify empty string ''.
+ Note: see the note for clearCls.
+ Also see hideLabel and
+Ext.layout.FormLayout.fieldTpl.
+Example use: new Ext.FormPanel({
height: 100,
renderTo: Ext.getBody(),
+ layoutConfig: {
+ labelSeparator: '~' // layout config has lowest priority (defaults to ':')
+ },
+ labelSeparator: '>>', // config at container level
items: [{
xtype: 'textfield',
- fieldLabel: 'Name',
- labelSeparator: '...'
+ fieldLabel: 'Field 1',
+ labelSeparator: '...' // field/component level config supersedes others
+ },{
+ xtype: 'textfield',
+ fieldLabel: 'Field 2' // labelSeparator will be '='
}]
-});
-
- |
- Component |
-
-
- |
-
-
- labelStyle : String
- A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if se...
-
- A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if set, or '').
. This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: new Ext.FormPanel({
+});
| 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 '').
+ Note: see the note for clearCls .
+ Also see hideLabel and
+Ext.layout.FormLayout.fieldTpl.
+Example use: new Ext.FormPanel({
height: 100,
renderTo: Ext.getBody(),
items: [{
@@ -826,1720 +678,892 @@ A specialized tooltip class for tooltips that can be specified in markup and aut
fieldLabel: 'Name',
labelStyle: 'font-weight:bold;'
}]
-});
-
- |
- Component |
-
-
- |
-
-
- layout : String
- The layout type to be used in this container. If not specified, a default Ext.layout.ContainerLayout will be created ...
-
- The layout type to be used in this container. If not specified, a default Ext.layout.ContainerLayout will be created and used. Specific config values for the chosen layout type can be specified using layoutConfig. Valid values are: - absolute
- accordion
- anchor
- border
- card
- column
- fit
- form
- table
-
- |
- Container |
-
-
- |
-
-
- layoutConfig : Object
- This is a config object containing properties specific to the chosen layout (to be used in conjunction with the layou...
-
- This is a config object containing properties specific to the chosen layout (to be used in conjunction with the layout config value). For complete details regarding the valid config options for each layout type, see the layout class corresponding to the type specified:
-
- |
- Container |
-
-
- |
-
-
- listeners : Object
- (optional) A config object containing one or more event handlers to be added to this object during initialization. Th...
-
- (optional) 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.
-
- |
- Observable |
-
-
- |
-
-
- maskDisabled : Boolean
- True to mask the panel when it is disabled, false to not mask it (defaults to true). Either way, the panel will alway...
-
- True to mask the panel when it is disabled, false to not mask it (defaults to true). Either way, the panel will always tell its contained elements to disable themselves when it is disabled, but masking the panel can provide an additional visual cue that the panel is disabled.
-
- |
- Panel |
-
-
- |
-
-
- maxWidth : Number
- The maximum width of the tip in pixels (defaults to 300). The maximum supported value is 500.
- |
- Tip |
-
-
- |
-
-
- minButtonWidth : Number
- Minimum width in pixels of all buttons in this panel (defaults to 75)
- |
- Panel |
-
-
- |
-
-
- minWidth : Number
- The minimum width of the tip in pixels (defaults to 40).
- |
- Tip |
-
-
- |
-
-
- monitorResize : Boolean
- True 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 |
-
-
- |
-
-
- mouseOffset : Array
- An XY offset from the mouse position where the tooltip should be shown (defaults to [15,18]).
- |
- ToolTip |
-
-
- |
-
-
- overCls : String
- An 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 |
-
-
- |
-
-
- plugins : Object/Array
- An object or array of objects that will provide custom functionality for this component. The only requirement for a v...
-
- 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 |
-
-
- |
-
-
- renderTo : Mixed
- The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using...
-
- The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required.
-
- |
- Component |
-
-
- |
-
-
- shadow : Boolean/String
- True (or a valid Ext.Shadow Ext.Shadow.mode value) to display a shadow behind the panel, false to display no shadow (...
-
- True (or a valid Ext.Shadow Ext.Shadow.mode value) to display a shadow behind the panel, false to display no shadow (defaults to 'sides'). Note that this option only applies when floating = true.
-
- |
- Panel |
-
-
- |
-
-
- shadowOffset : Number
- The number of pixels to offset the shadow if displayed (defaults to 4). Note that this option only applies when float...
-
- The number of pixels to offset the shadow if displayed (defaults to 4). Note that this option only applies when floating = true.
-
- |
- Panel |
-
-
- |
-
-
- shim : Boolean
- False to disable the iframe shim in browsers which need one (defaults to true). Note that this option only applies wh...
-
- False to disable the iframe shim in browsers which need one (defaults to true). Note that this option only applies when floating = true.
-
- |
- Panel |
-
-
- |
-
-
- showDelay : Number
- Delay in milliseconds before the tooltip displays after the mouse enters the target element (defaults to 500)
- |
- ToolTip |
-
-
- |
-
-
- stateEvents : Array
- An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be...
-
- An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be any types of events 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 : String
- The 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 : Boolean
- A 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 for state to be managed. Auto-generated ids are not guaranteed to be stable across page loads and cannot be relied upon to save and restore the same state for a component. For state saving to work, the state manager's provider must have been set to an implementation of Ext.state.Provider which overrides the set and get methods to save and recall name/value pairs. A built-in implementation, Ext.state.CookieProvider is available. To set the state provider for the current page: Ext.state.Manager.setProvider(new Ext.state.CookieProvider()); Components attempt to save state when one of the events listed in the stateEvents configuration fires. You can perform extra processing on state save and restore by attaching handlers to the beforestaterestore, staterestore, beforestatesave and statesave events
-
- |
- Component |
-
-
- |
-
-
- style : String
- A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.app...
-
- A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.applyStyles.
-
- |
- Component |
-
-
- |
-
-
- tabTip : String
- Adds a tooltip when mousing over the tab of a Ext.Panel which is an item of a Ext.TabPanel. Ext.QuickTips.init() must...
-
- Adds a tooltip when mousing over the tab of a Ext.Panel which is an item of a Ext.TabPanel. Ext.QuickTips.init() must be called in order for the tips to render.
-
- |
- Panel |
-
-
- |
-
-
- target : Mixed
- The target HTMLElement, Ext.Element or id to associate with this quicktip (defaults to the document).
- |
- QuickTip |
-
-
- |
-
-
- tbar : Object/Array
- The top toolbar of the panel. This can be either an Ext.Toolbar object or an array of buttons/button configs to be ad...
-
- The top toolbar of the panel. This can be either an Ext.Toolbar object or an array of buttons/button configs to be added to the toolbar. Note that this is not available as a property after render. To access the top toolbar after render, use getTopToolbar.
-
- |
- Panel |
-
-
- |
-
-
- title : String
- The title text to display in the panel header (defaults to ''). When a title is specified the header element will aut...
-
- The title text to display in the panel header (defaults to ''). When a title is specified the header element will automatically be created and displayed unless header is explicitly set to false. If you don't want to specify a title at config time, but you may want one later, you must either specify a non-empty title (a blank space ' ' will do) or header:true so that the container element will get created.
-
- |
- Panel |
-
-
- |
-
-
- titleCollapse : Boolean
- True to allow expanding and collapsing the panel (when collapsible = true) by clicking anywhere in the header bar, fa...
-
- True to allow expanding and collapsing the panel (when collapsible = true) by clicking anywhere in the header bar, false to allow it only by clicking to tool button (defaults to false).
-
- |
- Panel |
-
-
- |
-
-
- tools : Array
- An array of tool button configs to be added to the header tool area. When rendered, each tool is stored as an Element...
-
- An array of tool button configs to be added to the header tool area. When rendered, each tool is stored as an Element referenced by a public property called tools.<tool-type> Each tool config may contain the following properties: Example usage: tools:[{
+});
| Component |
| layout : String/Object*Important: In order for child items to be correctly sized and
+positioned, typically a layout manager must be specifi... *Important: In order for child items to be correctly sized and
+positioned, typically a layout manager must be specified through
+the layout configuration option.
+ The sizing and positioning of child items is the responsibility of
+the Container's layout manager which creates and manages the type of layout
+you have in mind. For example: new Ext.Window({
+ width:300, height: 300,
+ layout: 'fit', // explicitly set layout manager: override the default (layout:'auto')
+ items: [{
+ title: 'Panel inside a Window'
+ }]
+}).show();
+ If the layout configuration is not explicitly specified for
+a general purpose container (e.g. Container or Panel) the
+default layout manager will be used
+which does nothing but render child components sequentially into the
+Container (no sizing or positioning will be performed in this situation).
+Some container classes implicitly specify a default layout
+(e.g. FormPanel specifies layout:'form' ). Other specific
+purpose classes internally specify/manage their internal layout (e.g.
+GridPanel, TabPanel, TreePanel, Toolbar, Menu, etc.).
+ layout may be specified as either as an Object or
+as a String:
+- Specify as an Object
+layout: {
+ type: 'vbox',
+ padding: '5',
+ align: 'left'
+}
+ type
+ The layout type to be used for this container. If not specified,
+a default Ext.layout.ContainerLayout will be created and used.
+ Valid layout type values are:
+
+ - Layout specific configuration properties
+ Additional layout specific configuration properties may also be
+specified. For complete details regarding the valid config options for
+each layout type, see the layout class corresponding to the type
+specified.
+
+- Specify as a String
+layout: 'vbox',
+layoutConfig: {
+ padding: '5',
+ align: 'left'
+}
+ layout
+ The layout type to be used for this container (see list
+of valid layout type values above).
+ layoutConfig
+ Additional layout specific configuration properties. For complete
+details regarding the valid config options for each layout type, see the
+layout class corresponding to the layout specified.
+ | Container |
| layoutConfig : ObjectThis is a config object containing properties specific to the chosen
+ layout if layout
+has been specified as a string. | Container |
| listeners : ObjectA config object containing one or more event handlers to be added to this
+object during initialization. This should ... A config object containing one or more event handlers to be added to this
+object during initialization. This should be a valid listeners config object as specified in the
+addListener example for attaching multiple handlers at once.
+ DOM events from ExtJs Components
+ While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
+is usually only done when extra value can be added. For example the DataView's
+click event passing the node clicked on. To access DOM
+events directly from a Component's HTMLElement, listeners must be added to the Element after the Component
+has been rendered. A plugin can simplify this step: // Plugin is configured with a listeners config object.
+// The Component is appended to the argument list of all handler functions.
+Ext.DomObserver = Ext.extend(Object, {
+ constructor: function(config) {
+ this.listeners = config.listeners ? config.listeners : config;
+ },
+
+ // Component passes itself into plugin's init method
+ init: function(c) {
+ var p, l = this.listeners;
+ for (p in l) {
+ if (Ext.isFunction(l[p])) {
+ l[p] = this.createHandler(l[p], c);
+ } else {
+ l[p].fn = this.createHandler(l[p].fn, c);
+ }
+ }
+
+ // Add the listeners to the Element immediately following the render call
+ c.render = c.render.createSequence(function() {
+ var e = c.getEl();
+ if (e) {
+ e.on(l);
+ }
+ });
+ },
+
+ createHandler: function(fn, c) {
+ return function(e) {
+ fn.call(this, e, c);
+ };
+ }
+});
+
+var combo = new Ext.form.ComboBox({
+
+ // Collapse combo when its element is clicked on
+ plugins: [ new Ext.DomObserver({
+ click: function(evt, comp) {
+ comp.collapse();
+ }
+ })],
+ store: myStore,
+ typeAhead: true,
+ mode: 'local',
+ triggerAction: 'all'
+});
| 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.
+ An object containing margins to apply to this BoxComponent in the
+format: {
+ top: (top margin),
+ right: (right margin),
+ bottom: (bottom margin),
+ left: (left margin)
+}
+ May also be a string containing space-separated, numeric margin values. The order of the
+sides associated with each value matches the way CSS processes margin values:
+
+- If there is only one value, it applies to all sides.
+- If there are two values, the top and bottom borders are set to the first value and the
+right and left are set to the second.
+- If there are three values, the top is set to the first value, the left and right are set
+to the second, and the bottom is set to the third.
+- If there are four values, they apply to the top, right, bottom, and left, respectively.
+
+ Defaults to: {top:0, right:0, bottom:0, left:0}
| BoxComponent |
| maskDisabled : Booleantrue to mask the panel when it is disabled, false to not mask it (defaults
+to true). Either way, the panel will alwa... true to mask the panel when it is disabled, false to not mask it (defaults
+to true ). Either way, the panel will always tell its contained elements to disable themselves
+when it is disabled, but masking the panel can provide an additional visual cue that the panel is
+disabled. | Panel |
| maxWidth : Number The maximum width of the tip in pixels (defaults to 300). The maximum supported value is 500. | Tip |
| minButtonWidth : NumberMinimum width in pixels of all buttons in this panel (defaults to 75 ) | Panel |
| minWidth : Number The minimum width of the tip in pixels (defaults to 40). | Tip |
| 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 |
| mouseOffset : Array An XY offset from the mouse position where the
+tooltip should be shown (defaults to [15,18]). | ToolTip |
| overCls : StringAn optional extra CSS class that will be added to this component's Element when the mouse moves
+over the Element, and... An optional extra CSS class that will be added to this component's Element when the mouse moves
+over the Element, and removed when the mouse moves out. (defaults to ''). This can be
+useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules. | Component |
| padding : Number/StringA shortcut for setting a padding style on the body element. The value can either be
+a number to be applied to all sid... A shortcut for setting a padding style on the body element. The value can either be
+a number to be applied to all sides, or a normal css string describing padding.
+Defaults to undefined. | Panel |
| pageX : 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 |
| plugins : Object/ArrayAn object or array of objects that will provide custom functionality for this component. The only
+requirement for a ... An object or array of objects that will provide custom functionality for this component. The only
+requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component.
+When a component is created, if any plugins are available, the component will call the init method on each
+plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the
+component as needed to provide its functionality. | Component |
| preventBodyReset : BooleanDefaults to false. When set to true, an extra css class 'x-panel-normal'
+will be added to the panel's element, effec... Defaults to false . When set to true , an extra css class 'x-panel-normal'
+will be added to the panel's element, effectively applying css styles suggested by the W3C
+(see http://www.w3.org/TR/CSS21/sample.html) to the Panel's body element (not the header,
+footer, etc.). | Panel |
| ptype : StringThe registered ptype to create. This config option is not used when passing
+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
+specified not as a fully instantiated Component, but as a Component config
+object. The ptype will be looked up at render time up to determine what
+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.
+ 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',
+ store: myStore,
+ colModel: myColModel,
+ tbar: [{
+ text: 'Save',
+ handler: saveChanges,
+ disabled: true,
+ ref: '../saveButton'
+ }],
+ listeners: {
+ afteredit: function() {
+// The button reference is in the GridPanel
+ myGrid.saveButton.enable();
+ }
+ }
+});
+ In the code above, if the ref had been 'saveButton'
+the reference would have been placed into the Toolbar. Each '/' in the ref
+moves up one level from the Component's ownerCt .
+ Also see the added and removed events. | Component |
| region : StringNote: this config is only used when this BoxComponent is rendered
+by a Container which has been configured to use the... Note: this config is only used when this BoxComponent is rendered
+by a Container which has been configured to use the BorderLayout
+layout manager (e.g. specifying layout:'border').
+ See Ext.layout.BorderLayout also. | BoxComponent |
| 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 :
+Do not use this option if the Component is to be a child item of
+a Container. It is the responsibility of the
+ Container's layout manager
+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 'bodyresize'. | Panel |
| 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"). | Tip |
| shadowOffset : NumberThe number of pixels to offset the shadow if displayed (defaults to 4). Note that this
+option only applies when float... The number of pixels to offset the shadow if displayed (defaults to 4 ). Note that this
+option only applies when floating = true . | Panel |
| shim : Booleanfalse to disable the iframe shim in browsers which need one (defaults to true).
+Note that this option only applies wh... false to disable the iframe shim in browsers which need one (defaults to true ).
+Note that this option only applies when floating = true . | Panel |
| showDelay : Number Delay in milliseconds before the tooltip displays
+after the mouse enters the target element (defaults to 500) | ToolTip |
| 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
+(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
+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
+for state to be managed. Auto-generated ids are not guaranteed to be stable
+across page loads and cannot be relied upon to save and restore the same
+state for a component.
+ For state saving to work, the state manager's provider must have been
+set to an implementation of Ext.state.Provider which overrides the
+set and get
+methods to save and recall name/value pairs. A built-in implementation,
+Ext.state.CookieProvider is available.
+ To set the state provider for the current page:
+ Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
+ expires: new Date(new Date().getTime()+(1000*60*60*24*7)), //7 days from now
+}));
+ A stateful Component attempts to save state when one of the events
+listed in the stateEvents configuration fires.
+ To save state, a stateful Component first serializes its state by
+calling getState . By default, this function does
+nothing. The developer must provide an implementation which returns an
+object hash which represents the Component's restorable state.
+ The value yielded by getState is passed to Ext.state.Manager.set
+which uses the configured Ext.state.Provider to save the object
+keyed by the Component's stateId , or, if that is not
+specified, its id .
+ During construction, a stateful Component attempts to restore
+its state by calling Ext.state.Manager.get passing the
+stateId , or, if that is not specified, the
+id .
+ The resulting object is passed to applyState .
+The default implementation of applyState simply copies
+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
+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({
+ title: 'Some Title',
+ renderTo: Ext.getBody(),
+ width: 400, height: 300,
+ layout: 'form',
+ items: [{
+ xtype: 'textarea',
+ style: {
+ width: '95%',
+ marginBottom: '10px'
+ }
+ },
+ new Ext.Button({
+ text: 'Send',
+ minWidth: '100',
+ style: {
+ marginBottom: '10px'
+ }
+ })
+ ]
+});
| 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 |
| target : Mixed The target HTMLElement, Ext.Element or id to associate with this quicktip (defaults to the document). | QuickTip |
| tbar : Object/ArrayThe top toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of
+buttons/button confi... The top toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of
+buttons/button configs to be added to the toolbar. Note that this is not available as a property after render.
+To access the top toolbar after render, use getTopToolbar.
+ Note: Although a Toolbar may contain Field components, these will not be updated by a load
+of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and
+so are not scanned to collect form items. However, the values will be submitted because form
+submission parameters are collected from the DOM tree. | Panel |
| tbarCfg : ObjectA DomHelper element specification object specifying the element structure
+of this Panel's tbar Element. See bodyCfg ... A DomHelper element specification object specifying the element structure
+of this Panel's tbar Element. See bodyCfg also. | Panel |
| title : StringThe title text to be used as innerHTML (html tags are accepted) to display in the panel
+header (defaults to ''). When... The title text to be used as innerHTML (html tags are accepted) to display in the panel
+ header (defaults to ''). When a title is specified the
+ header element will automatically be created and displayed unless
+ header is explicitly set to false . If you do not want to specify a
+ title at config time, but you may want one later, you must either specify a non-empty
+ title (a blank space ' ' will do) or header:true so that the container
+element will get created. | Panel |
| titleCollapse : Booleantrue to allow expanding and collapsing the panel (when collapsible = true)
+by clicking anywhere in the header bar, fa... true to allow expanding and collapsing the panel (when collapsible = true )
+by clicking anywhere in the header bar, false ) to allow it only by clicking to tool button
+(defaults to false )). If this panel is a child item of a border layout also see the
+ BorderLayout.Region
+ floatable config option. | Panel |
| toolTemplate : Ext.Template/Ext.XTemplateA Template used to create tools in the header Element. Defaults to:new Ext.Template('<div class="x-tool x-tool-{id... A Template used to create tools in the header Element. Defaults to: new Ext.Template('<div class="x-tool x-tool-{id}"> </div>')
+ This may may be overridden to provide a custom DOM structure for tools based upon a more
+complex XTemplate. The template's data is a single tool configuration object (Not the entire Array)
+as specified in tools. In the following example an <a> tag is used to provide a
+visual indication when hovering over the tool: var win = new Ext.Window({
+ tools: [{
+ id: 'download',
+ href: '/MyPdfDoc.pdf'
+ }],
+ toolTemplate: new Ext.XTemplate(
+ '<tpl if="id==\'download\'">',
+ '<a class="x-tool x-tool-pdf" href="{href}"></a>',
+ '</tpl>',
+ '<tpl if="id!=\'download\'">',
+ '<div class="x-tool x-tool-{id}"> </div>',
+ '</tpl>'
+ ),
+ width:500,
+ height:300,
+ closeAction:'hide'
+});
+ Note that the CSS class 'x-tool-pdf' should have an associated style rule which provides an
+appropriate background image, something like:
+ a.x-tool-pdf {background-image: url(../shared/extjs/images/pdf.gif)!important;}
| Panel |
| tools : ArrayAn array of tool button configs to be added to the header tool area. When rendered, each tool is
+stored as an Element... An array of tool button configs to be added to the header tool area. When rendered, each tool is
+stored as an Element referenced by a public property called tools.<tool-type>
+ Each tool config may contain the following properties:
+
+- id : String
Required. The type
+of tool to create. By default, this assigns a CSS class of the form x-tool-<tool-type> to the
+resulting tool Element. Ext provides CSS rules, and an icon sprite containing images for the tool types listed below.
+The developer may implement custom tools by supplying alternate CSS rules and background images:
+
+
+ close
+ minimize
+ maximize
+ restore
+ gear
+ pin
+ unpin
+ right
+ left
+ up
+ down
+ refresh
+ minus
+ plus
+ help
+ search
+ save
+ print
+
+- handler : Function
Required. The function to
+call when clicked. Arguments passed are:
+- stopEvent : Boolean
Defaults to true. Specify as false to allow click event to propagate.
+- scope : Object
The scope in which to call the handler.
+- qtip : String/Object
+- hidden : Boolean
True to initially render hidden.
+- on : Object
A listener config object specifiying
+event listeners in the format of an argument to addListener
+
+ Note that, apart from the toggle tool which is provided when a panel is collapsible, these
+tools only provide the visual button. Any required functionality must be provided by adding
+handlers that implement the necessary behavior.
+ Example usage:
+ tools:[{
id:'refresh',
qtip: 'Refresh form Data',
// hidden:true,
handler: function(event, toolEl, panel){
// refresh logic
}
-}]
Note that apart from the toggle tool which is provided when a panel is collapsible, these tools only provide the visual button. Any required functionality must be provided by adding handlers that implement the necessary behavior.
-
- |
- Panel |
-
-
- |
-
-
- trackMouse : Boolean
- True to have the tooltip follow the mouse as it moves over the target element (defaults to false).
- |
- ToolTip |
-
-
- |
-
-
- width : Number
- The width of this component in pixels (defaults to auto).
- |
- BoxComponent |
-
-
- |
-
-
- x : Number
- The local x (left) coordinate for this component if contained within a positioning container.
- |
- BoxComponent |
-
-
- |
-
-
- xtype : String
- The 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 specified not as a fully instantiated Component, but as a Component config object. The xtype will be looked up at render time up to determine what type of child Component to create. The predefined xtypes are listed here. If you subclass Components to create your own Components, you may register them using 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
-
-
-
-
-
-
- |
-
-
- body : Ext.Element
-
-The Panel's body Element which may be used to contain HTML content.
-The content may be specified in the html config,...
-
-
-The Panel's body Element which may be used to contain HTML content.
-The content may be specified in the html config, or it may be loaded using the
- autoLoad config, or through the Panel's Updater. Read-only.
+},
+{
+ id: 'help',
+ qtip: 'Get Help',
+ handler: function(event, toolEl, panel){
+ // whatever
+ }
+}]
+ For the custom id of 'help' define two relevant css classes with a link to
+a 15x15 image:
+ .x-tool-help {background-image: url(images/help.png);}
+.x-tool-help-over {background-image: url(images/help_over.png);}
+// if using an image sprite:
+.x-tool-help {background-image: url(images/help.png) no-repeat 0 0;}
+.x-tool-help-over {background-position:-15px 0;}
| Panel |
| tpl : MixedAn Ext.Template, Ext.XTemplate
+or an array of strings to form an Ext.XTemplate.
+Used in conjunction with the data and... | Component |
| tplWriteMode : StringThe Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
+(see Ext.X... The Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
+(see Ext.XTemplate.overwrite ). | Component |
| trackMouse : Boolean True to have the tooltip follow the mouse as it
+moves over the target element (defaults to false). | ToolTip |
| unstyled : BooleanOverrides the baseCls setting to baseCls = 'x-plain' which renders
+the panel unstyled except for required attributes ... Overrides the baseCls setting to baseCls = 'x-plain' which renders
+the panel unstyled except for required attributes for Ext layouts to function (e.g. overflow:hidden). | Panel |
| width : NumberWidth in pixels of the tip (defaults to auto). Width will be ignored if it exceeds the bounds of
+minWidth or maxWidt... Width in pixels of the tip (defaults to auto). Width will be ignored if it exceeds the bounds of
+ minWidth or maxWidth. The maximum supported value is 500. | Tip |
| 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
+specified not as a fully instantiated Component, but as a Component config
+object. The xtype will be looked up at render time up to determine what
+type of child Component to create.
+The predefined xtypes are listed here.
+
+If you subclass Components to create your own Components, you may register
+them using 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
|
| body : Ext.ElementThe Panel's body Element which may be used to contain HTML content.
+The content may be specified in the html config, ... The Panel's body Element which may be used to contain HTML content.
+The content may be specified in the html config, or it may be loaded using the
+ autoLoad config, or through the Panel's Updater. Read-only.
If this is used to load visible HTML elements in either way, then
the Panel may not be used as a Layout for hosting nested Panels.
- If this Panel is intended to be used as the host of a Layout (See layout
+ If this Panel is intended to be used as the host of a Layout (See layout
then the body Element must not be loaded or changed - it is under the control
-of the Panel's Layout.
-
- |
- Panel |
-
-
- |
-
-
- buttons : Array
- This Panel's Array of buttons as created from the buttons
-config property. Read only.
- |
- Panel |
-
-
- |
-
-
- dd : Ext.dd.DragSource.
- If this Panel is configured draggable, this property will contain
-an instance of Ext.dd.DragSource which handles drag...
-
- If this Panel is configured draggable, this property will contain
-an instance of Ext.dd.DragSource which handles dragging the Panel.
-The developer must provide implementations of the abstract methods of Ext.dd.DragSource
-in order to supply behaviour for each stage of the drag/drop process. See draggable.
-
- |
- Panel |
-
-
- |
-
-
- disabled : Boolean
- True if this component is disabled. Read-only.
- |
- Component |
-
-
- |
-
-
- footer : Ext.Element
-
-The Panel's footer Element. Read-only.
- This Element is used to house the Panel's buttons.
- |
- Panel |
-
-
- |
-
-
- header : Ext.Element
- The Panel's header Element. Read-only.
- This Element is used to house the title and tools
- |
- Panel |
-
-
- |
-
-
- hidden : Boolean
-
-True if this component is hidden. Read-only.
- |
- Component |
-
-
- |
-
-
- initialConfig : Object
- This Component's initial configuration specification. Read-only.
- |
- Component |
-
-
- |
-
-
- items : MixedCollection
- |
- Container |
-
-
- |
-
-
- ownerCt : Ext.Container
- The 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.
-
- |
- Component |
-
-
- |
-
-
- rendered : Boolean
- True if this component has been rendered. Read-only.
- |
- Component |
-
-
-
-
Public Methods
-
-
-
-
-
-
- |
-
-
- QuickTip( Object config )
- Create a new Tip
-
- Create a new Tip
- Parameters:
-
- Returns:
-
-
-
-
- |
- QuickTip |
-
-
- |
-
-
- add( Ext.Component/Object component ) : Ext.Component
- Adds a Component to this Container. Fires the beforeadd event before
-adding, then fires the add event after the compo...
-
- Adds a Component to this Container. Fires the beforeadd event before
-adding, then fires the add event after the component has been added.
- You will never call the render method of a child Component when using a Container.
-Child Components are rendered by this Container's layout manager when
-this Container is first rendered.
- Certain layout managers allow dynamic addition of child components. Those that do
-include Ext.layout.CardLayout, Ext.layout.AnchorLayout,
-Ext.layout.FormLayout, Ext.layout.TableLayout.
- If the Container is already rendered when add is called, you may need to call
-doLayout to refresh the view which causes any unrendered child Components
-to be rendered. This is required so that you can add multiple child components if needed
-while only refreshing the layout once.
- When creating complex UIs, it is important to remember that sizing and positioning
-of child items is the responsibility of the Container's layout manager. If
-you expect child items to be sized in response to user interactions, you must
-specify a layout manager which creates and manages the type of layout you have in mind.
- Omitting the layout config means that a basic layout manager is
-used which does nothnig but render child components sequentially into the Container.
-No sizing or positioning will be performed in this situation.
- Parameters:
- component : Ext.Component/ObjectThe Component to add.
-Ext uses lazy rendering, and will only render the added Component should
-it become necessary, that is: when the Container is layed out either on first render
-or in response to a doLayout call.
-A Component config object may be passed instead of an instantiated Component object.
-The type of Component created from a config object is determined by the xtype
-config property. If no xtype is configured, the Container's defaultType
-is used.
-For a list of all available xtypes, see Ext.Component.
- Returns:
-
- Ext.Component component The Component (or config object) that was added with the Container's default config values applied. example: var myNewGrid = new Ext.grid.GridPanel({ store: myStore, colModel: myColModel }); myTabPanel.add(myNewGrid); myTabPanel.setActiveTab(myNewGrid);
-
-
-
-
- |
- Container |
-
-
- |
-
-
- addButton( String/Object config , Function handler , Object scope ) : Ext.Button
- Adds a button to this panel. Note that this method must be called prior to rendering. The preferred
-approach is to ...
-
- Adds a button to this panel. Note that this method must be called prior to rendering. The preferred
-approach is to add buttons via the buttons config.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- addClass( string cls ) : void
- Adds a CSS class to the component's underlying element.
-
- Adds a CSS class to the component's underlying element.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Component |
-
-
- |
-
-
- addEvents( Object object ) : void
- Used to define events on this Observable
-
- Used to define events on this Observable
- Parameters:
-
- Returns:
-
-
-
-
- |
- Observable |
-
-
- |
-
-
- addListener( String eventName , Function handler , [Object scope ], [Object options ] ) : void
- Appends an event handler to this component
-
- Appends an event handler to this component
- Parameters:
- eventName : StringThe type of event to listen for handler : FunctionThe method the event invokes scope : Object(optional) The scope in which to execute the handler
-function. The handler function's "this" context. options : Object(optional) An object containing handler configuration
+of the Panel's Layout.
+ Note: see the Note for el also.
| Panel |
| buttons : ArrayThis Panel's Array of buttons as created from the buttons
+config property. Read only. | Panel |
| bwrap : Ext.ElementThe Panel's bwrap Element used to contain other Panel elements
+(tbar, body, bbar, footer). See bodyCfg. Read-only. | Panel |
| collapsed : Boolean True if this panel is collapsed. Read-only. | Panel |
| dd : Ext.dd.DragSource.If this Panel is configured draggable, this property will contain
+an instance of Ext.dd.DragSource which handles drag... If this Panel is configured draggable, this property will contain
+an instance of Ext.dd.DragSource which handles dragging the Panel.
+The developer must provide implementations of the abstract methods of Ext.dd.DragSource
+in order to supply behaviour for each stage of the drag/drop process. See draggable. | Panel |
| 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.
+ Note: this element will not be available until this Component has been rendered.
+ To add listeners for DOM events to this Component (as opposed to listeners
+for this Component's own Observable events), see the listeners
+config for a suggestion, or use a render listener directly: new Ext.Panel({
+ title: 'The Clickable Panel',
+ listeners: {
+ render: function(p) {
+ // Append the Panel to the click handler's argument list.
+ p.getEl().on('click', handlePanelClick.createDelegate(null, [p], true));
+ },
+ single: true // Remove the listener after first invocation
+ }
+});
+ See also getEl | Component |
| footer : Ext.ElementThe Panel's footer Element. Read-only.
+This Element is used to house the Panel's buttons or fbar.
+Note: see the Note ... The Panel's footer Element. Read-only.
+ This Element is used to house the Panel's buttons or fbar .
+ Note: see the Note for el also. | Panel |
| header : Ext.ElementThe Panel's header Element. Read-only.
+This Element is used to house the title and tools
+Note: see the Note for el al... The Panel's header Element. Read-only.
+ This Element is used to house the title and tools
+ Note: see the Note for el also. | Panel |
| hidden : Boolean True if this component is hidden. Read-only. | Component |
| initialConfig : Object This Component's initial configuration specification. Read-only. | Component |
| items : MixedCollection | Container |
| ownerCt : Ext.ContainerThis Component's owner Container (defaults to undefined, and is set automatically when
+this Component is added to a C... This Component's owner Container (defaults to undefined, and is set automatically when
+this Component is added to a Container). Read-only.
+ Note: to access items within the Container see itemId. | Component |
| 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 |
| triggerElement : DOMElementWhen a Tooltip is configured with the delegate
+option to cause selected child elements of the target
+Element to each ... When a Tooltip is configured with the delegate
+option to cause selected child elements of the target
+Element to each trigger a seperate show event, this property is set to
+the DOM element which triggered the show. | ToolTip |
Public Methods
|
| QuickTip( Object config )
+ | QuickTip |
| add( ...Object/Array component )
+ :
+ Ext.Component/ArrayAdds Component(s) to this Container.
+Description :
+<ul class="mdetail-params">
+Fires the beforeadd event before addin... Adds Component(s) to this Container.
+ Description :
+
+ Notes :
+ Parameters:component : ...Object/ArrayEither one or more Components to add or an Array of Components to add. See
+items for additional information. Returns: | Container |
| addButton( String/Object config , Function handler , Object scope )
+ :
+ Ext.ButtonAdds a button to this panel. Note that this method must be called prior to rendering. The preferred
+approach is to ... Adds a button to this panel. Note that this method must be called prior to rendering. The preferred
+approach is to add buttons via the buttons config. | Panel |
| addClass( string cls )
+ :
+ Ext.ComponentAdds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. | Component |
| 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 |
| 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:
-- scope : Object
The scope in which to execute the handler function. The handler function's "this" context.
-- delay : Number
The number of milliseconds to delay the invocation of the handler after the event fires.
-- single : Boolean
True to add a handler to handle just the next firing of the event, and then remove itself.
-- buffer : Number
Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed
+ - scope : Object
The scope (this reference) in which the handler function is executed.
+If omitted, defaults to the object which fired the event.
+- delay : Number
The number of milliseconds to delay the invocation of the handler after the event fires.
+- single : Boolean
True to add a handler to handle just the next firing of the event, and then remove itself.
+- buffer : Number
Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed
by the specified number of milliseconds. If the event fires again within that time, the original
-handler is not invoked, but the new handler is scheduled in its place.
+handler is not invoked, but the new handler is scheduled in its place.
+- target : Observable
Only call the handler if the event was fired on the target Observable, not
+if the event was bubbled up from a child Observable.
Combining Options
Using the options argument, it is possible to combine different types of listeners:
-A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
- el.on('click', this.onClick, this, {
- single: true,
- delay: 100,
- forumId: 4
+A delayed, one-time listener.
+myDataView.on('click', this.onClick, this, {
+single: true,
+delay: 100
});
Attaching multiple handlers in 1 call
The method also allows for a single argument to be passed which is a config object containing properties
which specify multiple handlers.
- foo.on({
- 'click' : {
- fn: this.onClick,
- scope: this,
- delay: 100
- },
- 'mouseover' : {
- fn: this.onMouseOver,
- scope: this
- },
- 'mouseout' : {
- fn: this.onMouseOut,
- scope: this
- }
+myGridPanel.on({
+'click' : {
+ fn: this.onClick,
+ scope: this,
+ delay: 100
+},
+'mouseover' : {
+ fn: this.onMouseOver,
+ scope: this
+},
+'mouseout' : {
+ fn: this.onMouseOut,
+ scope: this
+}
});
Or a shorthand syntax:
- foo.on({
- 'click' : this.onClick,
- 'mouseover' : this.onMouseOver,
- 'mouseout' : this.onMouseOut,
- scope: this
-});
- Returns:
-
-
-
-
- |
- Observable |
-
-
- |
-
-
- applyToMarkup( String/HTMLElement el ) : void
- Apply 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:
-
- Returns:
-
-
-
-
- |
- Component |
-
-
- |
-
-
- bubble( Function fn , [Object scope ], [Array args ] ) : void
- Bubbles 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
+ myGridPanel.on({
+'click' : this.onClick,
+'mouseover' : this.onMouseOver,
+'mouseout' : this.onMouseOut,
+ scope: this
+});
Returns: | Observable |
| applyToMarkup( String/HTMLElement el )
+ :
+ voidApply this component to existing markup that is valid. With this function, no call to render() is required. Apply this component to existing markup that is valid. With this function, no call to render() is required. | Component |
| bubble( Function fn , [Object scope ], [Array args ] )
+ :
+ Ext.ContainerBubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of... Bubbles up the component/container heirarchy, calling the specified function with each component. The scope ( this) of
function call will be the scope provided or the current component. The arguments to the function
will be the args provided or the current component. If the function returns false at any point,
-the bubble is stopped.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Container |
-
-
- |
-
-
- cascade( Function fn , [Object scope ], [Array args ] ) : void
- Cascades 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
+the bubble is stopped. | Container |
| cancelShow( String/HTMLElement/Element el )
+ :
+ voidHides a visible tip or cancels an impending show for a particular element. Hides a visible tip or cancels an impending show for a particular element. | QuickTip |
| 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.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Container |
-
-
- |
-
-
- cloneConfig( Object overrides ) : Ext.Component
- Clone the current component using the original config values passed into this instance by default.
-
- Clone the current component using the original config values passed into this instance by default.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Component |
-
-
- |
-
-
- collapse( Boolean animate ) : Ext.Panel
- Collapses the panel body so that it becomes hidden. Fires the beforecollapse event which will
-cancel the collapse ac...
-
- Collapses the panel body so that it becomes hidden. Fires the beforecollapse event which will
-cancel the collapse action if it returns false.
- Parameters:
- animate : BooleanTrue to animate the transition, else false (defaults to the value of the
- animCollapse panel config)
- Returns:
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- destroy() : void
- Destroys 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.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Component |
-
-
- |
-
-
- disable() : Ext.Component
- Disable this component.
-
- Disable this component.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Component |
-
-
- |
-
-
- doLayout( [Boolean shallow ] ) : void
- Force this container's layout to be recalculated. A call to this function is required after adding a new component
-to...
-
- Force this container's layout to be recalculated. A call to this function is required after adding a new component
-to an already rendered container, or possibly after changing sizing/position properties of child components.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Container |
-
-
- |
-
-
- enable() : Ext.Component
- Enable this component.
-
- Enable this component.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Component |
-
-
- |
-
-
- expand( Boolean animate ) : Ext.Panel
- Expands the panel body so that it becomes visible. Fires the beforeexpand event which will
-cancel the expand action ...
-
- Expands the panel body so that it becomes visible. Fires the beforeexpand event which will
-cancel the expand action if it returns false.
- Parameters:
- animate : BooleanTrue to animate the transition, else false (defaults to the value of the
- animCollapse panel config)
- Returns:
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- find( String prop , String value ) : Array
- Find a component under this container at any level by property
-
- Find a component under this container at any level by property
- Parameters:
- prop : Stringvalue : String
- Returns:
-
- Array Array of Ext.Components
-
-
-
-
- |
- Container |
-
-
- |
-
-
- findBy( Function fcn , [Object scope ] ) : Array
- Find a component under this container at any level by a custom function. If the passed function returns
-true, the com...
-
- Find a component under this container at any level by a custom function. If the passed function returns
-true, the component will be included in the results. The passed function is called with the arguments (component, this container).
- Parameters:
- fcn : Functionscope : Object(optional)
- Returns:
-
- Array Array of Ext.Components
-
-
-
-
- |
- Container |
-
-
- |
-
-
- findById( String id ) : Ext.Component
- Find a component under this container at any level by id
-
- Find a component under this container at any level by id
- Parameters:
-
- Returns:
-
-
-
-
- |
- Container |
-
-
- |
-
-
- findByType( String/Class xtype , [Boolean shallow ] ) : Array
- Find 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:
-
- Array Array of Ext.Components
-
-
-
-
- |
- Container |
-
-
- |
-
-
- findParentBy( Function fcn , [Object scope ] ) : Ext.Container
- Find 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. The passed function is called with the arguments (container, this component).
- Parameters:
- fcn : Functionscope : Object(optional)
- Returns:
-
-
-
-
- |
- Component |
-
-
- |
-
-
- findParentByType( String/Class xtype ) : Ext.Container
- Find 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
- Parameters:
-
- Returns:
-
-
-
-
- |
- Component |
-
-
- |
-
-
- fireEvent( String eventName , Object... args ) : Boolean
- Fires the specified event with the passed parameters (minus the event name).
-
- Fires the specified event with the passed parameters (minus the event name).
- Parameters:
-
- Returns:
-
-
-
-
- |
- Observable |
-
-
- |
-
-
- focus( [Boolean selectText ], [Boolean/Number delay ] ) : Ext.Component
- Try 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 |
-
-
- |
-
-
- getBottomToolbar() : Ext.Toolbar
- Returns the toolbar from the bottom (bbar) section of the panel.
-
- Returns the toolbar from the bottom (bbar) section of the panel.
- Parameters:
-
- Returns:
-
- Ext.Toolbar The toolbar
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- getBox( [Boolean local ] ) : Object
- Gets the current box measurements of the component's underlying element.
-
- Gets the current box measurements of the component's underlying element.
- Parameters:
-
- Returns:
-
-
-
-
- |
- BoxComponent |
-
-
- |
-
-
- getComponent( String/Number id ) : Ext.Component
- Gets a direct child Component by id, or by index.
-
- Gets a direct child Component by id, or by index.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Container |
-
-
- |
-
-
- getEl() : Ext.Element
-
-
- Returns the underlying Ext.Element.
- Parameters:
-
- Returns:
-
- Ext.Element The element
-
-
-
-
- |
- Component |
-
-
- |
-
-
- getFrameHeight() : Number
- Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and
-header and ...
-
- Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and
-header and footer elements, but not including the body height). To retrieve the body height see getInnerHeight.
- Parameters:
-
- Returns:
-
- Number The frame height
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- getFrameWidth() : Number
- Returns the width in pixels of the framing elements of this panel (not including the body width). To
-retrieve the bo...
-
- Returns the width in pixels of the framing elements of this panel (not including the body width). To
-retrieve the body width see getInnerWidth.
- Parameters:
-
- Returns:
-
- Number The frame width
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- getId() : String
- Returns the id of this component.
-
- Returns the id of this component.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Component |
-
-
- |
-
-
- getInnerHeight() : Number
- Returns the height in pixels of the body element (not including the height of any framing elements).
-For the frame he...
-
- Returns the height in pixels of the body element (not including the height of any framing elements).
-For the frame height see getFrameHeight.
- Parameters:
-
- Returns:
-
- Number The body height
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- getInnerWidth() : Number
- Returns the width in pixels of the body element (not including the width of any framing elements).
-For the frame widt...
-
- Returns the width in pixels of the body element (not including the width of any framing elements).
-For the frame width see getFrameWidth.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- getItemId() : String
- Returns the item id of this component.
-
- Returns the item id of this component.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Component |
-
-
- |
-
-
- getLayout() : ContainerLayout
- Returns the layout currently in use by the container. If the container does not currently have a layout
-set, a defau...
-
- Returns the layout currently in use by the container. If the container does not currently have a layout
-set, a default Ext.layout.ContainerLayout will be created and set as the container's layout.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Container |
-
-
- |
-
-
- getLayoutTarget() : Ext.Element
- Returns the Element to be used to contain the child Components of this Container.
-An implementation is provided which...
-
- Returns the Element to be used to contain the child Components of this Container.
- An implementation is provided which returns the Container's Element, but
+the cascade is stopped on that branch. | Container |
| cloneConfig( Object overrides )
+ :
+ Ext.ComponentClone the current component using the original config values passed into this instance by default. Clone the current component using the original config values passed into this instance by default. | Component |
| collapse( Boolean animate )
+ :
+ Ext.PanelCollapses the panel body so that it becomes hidden. Fires the beforecollapse event which will
+cancel the collapse ac... Collapses the panel body so that it becomes hidden. Fires the beforecollapse event which will
+cancel the collapse action if it returns false. Parameters:animate : BooleanTrue to animate the transition, else false (defaults to the value of the
+ animCollapse panel config) Returns: | Panel |
| 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
+to... Force this container's layout to be recalculated. A call to this function is required after adding a new component
+to an already rendered container, or possibly after changing sizing/position properties of child components. Parameters:shallow : Boolean(optional) True to only calc the layout of this component, and let child components auto
+calc layouts as required (defaults to false, which calls doLayout recursively for each subcontainer) force : Boolean(optional) True to force a layout to occur, even if the item is hidden. Returns: | Container |
| enable()
+ :
+ Ext.ComponentEnable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. | Component |
| enableBubble( String/Array events )
+ :
+ voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget() if present.... Enables events fired by this Observable to bubble up an owner hierarchy by calling
+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');
+ }
+ }
+});
| Observable |
| expand( Boolean animate )
+ :
+ Ext.PanelExpands the panel body so that it becomes visible. Fires the beforeexpand event which will
+cancel the expand action ... Expands the panel body so that it becomes visible. Fires the beforeexpand event which will
+cancel the expand action if it returns false. Parameters:animate : BooleanTrue to animate the transition, else false (defaults to the value of the
+ animCollapse panel config) Returns: | Panel |
| find( String prop , String value )
+ :
+ ArrayFind a component under this container at any level by property Find a component under this container at any level by property Parameters:prop : Stringvalue : String Returns:Array Array of Ext.Components
| Container |
| findBy( Function fn , [Object scope ] )
+ :
+ ArrayFind a component under this container at any level by a custom function. If the passed function returns
+true, the com... Find a component under this container at any level by a custom function. If the passed function returns
+true, the component will be included in the results. The passed function is called with the arguments (component, this container). Parameters:fn : FunctionThe function to call scope : Object(optional) Returns:Array Array of Ext.Components
| Container |
| findById( String id )
+ :
+ Ext.ComponentFind a component under this container at any level by id Find a component under this container at any level by id | Container |
| findByType( String/Class xtype , [Boolean shallow ] )
+ :
+ ArrayFind a component under this container at any level by xtype or class Find a component under this container at any level by xtype or class 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:Array Array 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).
+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.Component Ext.Component
| Container |
| getBottomToolbar()
+ :
+ Ext.ToolbarReturns the toolbar from the bottom (bbar) section of the panel. Returns the toolbar from the bottom ( bbar ) section of the panel. | Panel |
| getBox( [Boolean local ] )
+ :
+ ObjectGets the current box measurements of the component's underlying element. Gets the current box measurements of the component's underlying element. | 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. Parameters:comp : String/NumberThis parameter may be any of the following:
+
+- a
String : representing the itemId
+or id of the child component
+- a
Number : representing the position of the child component
+within the items property
+
+ For additional information see Ext.util.MixedCollection.get. Returns: | Container |
| getEl()
+ :
+ Ext.ElementReturns the Ext.Element which encapsulates this Component.
+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.
+ Note: this element will not be available until this Component has been rendered.
+ To add listeners for DOM events to this Component (as opposed to listeners
+for this Component's own Observable events), see the listeners config for a suggestion,
+or use a render listener directly: new Ext.Panel({
+ title: 'The Clickable Panel',
+ listeners: {
+ render: function(p) {
+ // Append the Panel to the click handler's argument list.
+ p.getEl().on('click', handlePanelClick.createDelegate(null, [p], true));
+ },
+ single: true // Remove the listener after first invocation
+ }
+});
| Component |
| getFooterToolbar()
+ :
+ Ext.ToolbarReturns the toolbar from the footer (fbar) section of the panel. Returns the toolbar from the footer ( fbar ) section of the panel. | Panel |
| getFrameHeight()
+ :
+ NumberReturns the height in pixels of the framing elements of this panel (including any top and bottom bars and
+header and ... Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and
+header and footer elements, but not including the body height). To retrieve the body height see getInnerHeight. | Panel |
| getFrameWidth()
+ :
+ NumberReturns the width in pixels of the framing elements of this panel (not including the body width). To
+retrieve the bo... Returns the width in pixels of the framing elements of this panel (not including the body width). To
+retrieve the body width see getInnerWidth. | Panel |
| 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 |
| getInnerHeight()
+ :
+ NumberReturns the height in pixels of the body element (not including the height of any framing elements).
+For the frame he... Returns the height in pixels of the body element (not including the height of any framing elements).
+For the frame height see getFrameHeight. | Panel |
| getInnerWidth()
+ :
+ NumberReturns the width in pixels of the body element (not including the width of any framing elements).
+For the frame widt... Returns the width in pixels of the body element (not including the width of any framing elements).
+For the frame width see getFrameWidth. | Panel |
| 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
+set, a defau... Returns the layout currently in use by the container. If the container does not currently have a layout
+set, a default Ext.layout.ContainerLayout will be created and set as the container's layout. | Container |
| getLayoutTarget()
+ :
+ Ext.ElementReturns the Element to be used to contain the child Components of this Container.
+An implementation is provided which... Returns the Element to be used to contain the child Components of this Container.
+ 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.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Container |
-
-
- |
-
-
- getPosition( [Boolean local ] ) : Array
- Gets the current XY position of the component's underlying element.
-
- Gets the current XY position of the component's underlying element.
- Parameters:
-
- Returns:
-
-
-
-
- |
- BoxComponent |
-
-
- |
-
-
- getSize() : Object
- Gets the current size of the component's underlying element.
-
- Gets the current size of the component's underlying element.
- Parameters:
-
- Returns:
-
-
-
-
- |
- BoxComponent |
-
-
- |
-
-
- getTool( String id ) : Object
- Retrieve a tool by id.
-
- Retrieve a tool by id.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- getTopToolbar() : Ext.Toolbar
- Returns the toolbar from the top (tbar) section of the panel.
-
- Returns the toolbar from the top (tbar) section of the panel.
- Parameters:
-
- Returns:
-
- Ext.Toolbar The toolbar
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- getUpdater() : Ext.Updater
- Get the Ext.Updater for this panel. Enables you to perform Ajax updates of this panel's body.
-
- Get the Ext.Updater for this panel. Enables you to perform Ajax updates of this panel's body.
- Parameters:
-
- Returns:
-
- Ext.Updater The Updater
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- getXType() : String
- Gets 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'
- Parameters:
-
- Returns:
-
-
-
-
- |
- Component |
-
-
- |
-
-
- getXTypes() : String
- Returns 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.
+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
+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 |
| getTool( String id )
+ :
+ Object | Panel |
| getTopToolbar()
+ :
+ Ext.ToolbarReturns the toolbar from the top (tbar) section of the panel. Returns the toolbar from the top ( tbar ) section of the panel. | Panel |
| getUpdater()
+ :
+ Ext.UpdaterGet the Ext.Updater for this panel. Enables you to perform Ajax updates of this panel's body. Get the Ext.Updater for this panel. Enables you to perform Ajax updates of this panel's body. | Panel |
| 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
+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'
- Parameters:
-
- Returns:
-
-
-
-
- |
- Component |
-
-
- |
-
-
- hasListener( String eventName ) : Boolean
- Checks 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
- Parameters:
-
- Returns:
-
-
-
-
- |
- Observable |
-
-
- |
-
-
- hide() : Ext.Component
- Hide this component.
-
- Hide this component.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Component |
-
-
- |
-
-
- insert( Number index , Ext.Component component ) : Ext.Component
- Inserts a Component into this Container at a specified index. Fires the
-beforeadd event before inserting, then fires ...
-
- Inserts a Component into this Container at a specified index. Fires the
- beforeadd event before inserting, then fires the add event after the
-Component has been inserted.
- Parameters:
- index : NumberThe index at which the Component will be inserted
+ 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()
+ :
+ voidHides this tooltip if visible. Hides this tooltip if visible. | ToolTip |
| initTarget( Mixed t )
+ :
+ voidBinds this ToolTip to the specified element. The tooltip will be displayed when the mouse moves over the element. Binds this ToolTip to the specified element. The tooltip will be displayed when the mouse moves over the element. | ToolTip |
| insert( Number index , Ext.Component component )
+ :
+ Ext.ComponentInserts a Component into this Container at a specified index. Fires the
+beforeadd event before inserting, then fires ... Inserts a Component into this Container at a specified index. Fires the
+ beforeadd event before inserting, then fires the add event after the
+Component has been inserted. Parameters:
- Returns:
-
-
-
-
- |
- Container |
-
-
- |
-
-
- isVisible() : void
- Returns true if this component is visible.
-
- Returns true if this component is visible.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Component |
-
-
- |
-
-
- isXType( String xtype , [Boolean shallow ] ) : void
- Tests 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
+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
+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
to participate in determination of inherited xtypes.
- For a list of all available xtypes, see the Ext.Component header.
+ For a list of all available xtypes, see the Ext.Component header.
Example usage:
- var t = new Ext.form.TextField();
+var t = new Ext.form.TextField();
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 instance
- Parameters:
- 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 |
-
-
- |
-
-
- load( Object/String/Function config ) : Ext.Panel
- Loads this content panel immediately with content returned from an XHR call.
-
- Loads this content panel immediately with content returned from an XHR call.
- Parameters:
- config : Object/String/FunctionA config object containing any of the following options:
+ 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 |
| load( Object/String/Function config )
+ :
+ Ext.PanelLoads this content panel immediately with content returned from an XHR call. Loads this content panel immediately with content returned from an XHR call. Parameters:config : Object/String/FunctionA config object containing any of the following options:
panel.load({
- url: "your-url.php",
- params: {param1: "foo", param2: "bar"}, // or a URL encoded string
+ url: 'your-url.php',
+ params: {param1: 'foo', param2: 'bar'}, // or a URL encoded string
callback: yourFunction,
scope: yourObject, // optional scope for the callback
discardUrl: false,
nocache: false,
- text: "Loading...",
+ text: 'Loading...',
timeout: 30,
scripts: false
});
The only required property is url. The optional properties nocache, text and scripts
are shorthand for disableCaching, indicatorText and loadScripts and are used to set their
-associated property on this panel Updater instance.
- Returns:
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- on( String eventName , Function handler , [Object scope ], [Object options ] ) : void
- Appends an event handler to this element (shorthand for addListener)
-
- Appends an event handler to this element (shorthand for addListener)
- Parameters:
- eventName : StringThe type of event to listen for handler : FunctionThe method the event invokes scope : Object(optional) The scope in which to execute the handler
-function. The handler function's "this" context. options : Object(optional)
- Returns:
-
-
-
-
- |
- Observable |
-
-
- |
-
-
- purgeListeners() : void
- Removes all listeners for this object
-
- Removes all listeners for this object
- Parameters:
-
- Returns:
-
-
-
-
- |
- Observable |
-
-
- |
-
-
- register( Object config ) : void
- Configures a new quick tip instance and assigns it to a target element. The following config values are
-supported (f...
-
- Configures a new quick tip instance and assigns it to a target element. The following config values are
-supported (for example usage, see the Ext.QuickTips class header):
+associated property on this panel Updater instance. Returns: | Panel |
| mon( Observable|Element item , Object|String ename , Function fn , Object scope , Object opt )
+ :
+ voidAdds listeners to any Observable object (or Elements) which are automatically removed when this Component
+is destroye... Adds listeners to any Observable object (or Elements) which are automatically removed when this Component
+is destroyed. Usage:
+myGridPanel.mon(myGridPanel.getSelectionModel(), 'selectionchange', handleSelectionChange, null, {buffer: 50});
+
+ or:
+myGridPanel.mon(myGridPanel.getSelectionModel(), {
+ selectionchange: handleSelectionChange,
+ buffer: 50
+});
+
Parameters:item : Observable|ElementThe item to which to add a listener/listeners. ename : Object|StringThe event name, or an object containing event name properties. fn : FunctionOptional. If the ename parameter was an event name, this
+is the handler function. scope : ObjectOptional. If the ename parameter was an event name, this
+is the scope (this reference) in which the handler function is executed. opt : ObjectOptional. If the ename parameter was an event name, this
+is the addListener options. Returns: | Component |
| mun( Observable|Element item , Object|String ename , Function fn , Object scope )
+ :
+ voidRemoves listeners that were added by the mon method. Removes listeners that were added by the mon method. Parameters:item : Observable|ElementThe item from which to remove a listener/listeners. ename : Object|StringThe event name, or an object containing event name properties. fn : FunctionOptional. If the ename parameter was an event name, this
+is the handler function. scope : ObjectOptional. If the ename parameter was an event name, this
+is the scope (this reference) in which the handler function is executed. Returns: | Component |
| nextSibling()
+ :
+ Ext.ComponentReturns the next component in the owning container Returns the next component in the owning container | Component |
| on( String eventName , Function handler , [Object scope ], [Object options ] )
+ :
+ 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 |
| register( Object config )
+ :
+ voidConfigures a new quick tip instance and assigns it to a target element. The following config values are
+supported (f... Configures a new quick tip instance and assigns it to a target element. The following config values are
+supported (for example usage, see the Ext.QuickTips class header):
-
-
- |
- QuickTip |
-
-
- |
-
-
- relayEvents( Object o , Array events ) : void
- Relays 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.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Observable |
-
-
- |
-
-
- remove( Component/String component , [Boolean autoDestroy ] ) : Ext.Component
- Removes 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.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Container |
-
-
- |
-
-
- removeAll( [Boolean autoDestroy ] ) : Array
- Removes all components from this container.
-
- Removes all components from this container.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Container |
-
-
- |
-
-
- removeClass( string cls ) : void
- Removes a CSS class from the component's underlying element.
-
- Removes a CSS class from the component's underlying element.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Component |
-
-
- |
-
-
- removeListener( String eventName , Function handler , [Object scope ] ) : void
- Removes a listener
-
- Removes a listener
- Parameters:
-
- Returns:
-
-
-
-
- |
- Observable |
-
-
- |
-
-
- render( [Element/HTMLElement/String container ], [String/Number position ] ) : void
- Render 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
+width Parameters:config : ObjectThe config object Returns: | QuickTip |
| 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 ] )
+ :
+ 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.
+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.
A Container's child Components are rendered by that Container's
-layout manager when the Container is first rendered.
+ layout manager when the Container is first rendered.
Certain layout managers allow dynamic addition of child components. Those that do
-include Ext.layout.CardLayout, Ext.layout.AnchorLayout,
-Ext.layout.FormLayout, Ext.layout.TableLayout.
+include Ext.layout.CardLayout, Ext.layout.AnchorLayout,
+ Ext.layout.FormLayout, Ext.layout.TableLayout.
If the Container is already rendered when a new child Component is added, you may need to call
-the Container's doLayout to refresh the view which causes any
+the Container's doLayout to refresh the view which causes any
unrendered child Components to be rendered. This is required so that you can add multiple
child components if needed while only refreshing the layout once.
When creating complex UIs, it is important to remember that sizing and positioning
-of child items is the responsibility of the Container's layout manager.
+of child items is the responsibility of the Container's layout manager.
If you expect child items to be sized in response to user interactions, you must
configure the Container with a layout manager which creates and manages the type of layout you
have in mind.
- Omitting the Container's layout config means that a basic
+ Omitting the Container's layout config means that a basic
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
+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() : void
-
-
- Resume firing events. (see suspendEvents)
- Parameters:
-
- Returns:
-
-
-
-
- |
- Observable |
-
-
- |
-
-
- setDisabled( Boolean disabled ) : void
- Convenience function for setting disabled/enabled by boolean.
-
- Convenience function for setting disabled/enabled by boolean.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Component |
-
-
- |
-
-
- setHeight( Number height ) : Ext.BoxComponent
- Sets 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
- Returns:
-
-
-
-
- |
- BoxComponent |
-
-
- |
-
-
- setIconClass( String cls ) : void
- Sets the CSS class that provides the icon image for this panel. This method will replace any existing
-icon class if ...
-
- Sets the CSS class that provides the icon image for this panel. This method will replace any existing
-icon class if one has already been set.
- Parameters:
- cls : StringThe new CSS class name
- Returns:
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- setPagePosition( Number x , Number y ) : Ext.BoxComponent
- Sets 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.BoxComponent
- Sets 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( Number/Object width , Number height ) : Ext.BoxComponent
- Sets the width and height of the component. This method fires the resize event. This method can accept
-either width...
-
- Sets the width and height of the component. This method fires the resize event. This method can accept
-either width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.
- Parameters:
- width : Number/ObjectThe new width to set, or a size object in the format {width, height} height : NumberThe new height to set (not required if a size object is passed as the first arg)
- Returns:
-
-
-
-
- |
- BoxComponent |
-
-
- |
-
-
- setTitle( String title , [String iconCls ] ) : void
- Sets the title text for the panel and optionally the icon class.
-In order to be able to set the title, a header eleme...
-
- Sets the title text for the panel and optionally the icon class.
+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( 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: | BoxComponent |
| setIconClass( String cls )
+ :
+ voidSets the CSS class that provides the icon image for this panel. This method will replace any existing
+icon class if ... Sets the CSS class that provides the icon image for this panel. This method will replace any existing
+icon class if one has already been set and fire the iconchange event after completion. Parameters:cls : StringThe new CSS class name Returns: | Panel |
| 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 ... 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
+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).
+- A String used to set the CSS width style.
+- A size object in the format
{width: widthValue, height: heightValue} .
+undefined to leave the width unchanged.
+ height : MixedThe new height to set (not required if a size object is passed as the first arg).
+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.
+ Returns: | BoxComponent |
| setTitle( String title , [String iconCls ] )
+ :
+ voidSets the title text for the panel and optionally the icon class.
+In order to be able to set the title, a header eleme... Sets the title text for the panel and optionally the icon class.
In order to be able to set the title, a header element must have been created
-for the Panel. This is triggered either by configuring the Panel with a non-blank title,
-or configuring it with header: true.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- setVisible( Boolean visible ) : Ext.Component
- Convenience function to hide or show this component by boolean.
-
- Convenience function to hide or show this component by boolean.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Component |
-
-
- |
-
-
- setWidth( Number width ) : Ext.BoxComponent
- Sets 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 set
- Returns:
-
-
-
-
- |
- BoxComponent |
-
-
- |
-
-
- show() : Ext.Component
- Show this component.
-
- Show this component.
- Parameters:
-
- Returns:
-
-
-
-
- |
- Component |
-
-
- |
-
-
- showAt( Array xy ) : void
- Shows this tip at the specified XY position. Example usage:
- // Show the tip at x:50 and y:100
-tip.showAt([50,100]);
-
- Shows this tip at the specified XY position. Example usage:
+for the Panel. This is triggered either by configuring the Panel with a non-blank title ,
+or configuring it with header: true . Parameters:title : StringThe title text to set iconCls : String(optional) iconCls A user-defined CSS class that provides the icon image for this panel Returns: | Panel |
| setVisible( Boolean visible )
+ :
+ Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. | 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 : 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: | BoxComponent |
| show()
+ :
+ voidShows this tooltip at the current event target XY position. Shows this tooltip at the current event target XY position. | ToolTip |
| showAt( Array xy )
+ :
+ voidShows this tip at the specified XY position. Example usage:
+// Show the tip at x:50 and y:100
+tip.showAt([50,100]); Shows this tip at the specified XY position. Example usage:
// Show the tip at x:50 and y:100
-tip.showAt([50,100]);
- Parameters:
-
- Returns:
-
-
-
-
- |
- Tip |
-
-
- |
-
-
- showBy( Mixed el , [String position ] ) : void
- Experimental. Shows this tip at a position relative to another element using a standard Ext.Element.alignTo
-anchor po...
-
- Experimental. Shows this tip at a position relative to another element using a standard Ext.Element.alignTo
+tip.showAt([50,100]); | Tip |
| showBy( Mixed el , [String position ] )
+ :
+ voidExperimental. Shows this tip at a position relative to another element using a standard Ext.Element.alignTo
+anchor po... Experimental. Shows this tip at a position relative to another element using a standard Ext.Element.alignTo
anchor position value. Example usage:
// Show the tip at the default position ('tl-br?')
tip.showBy('my-el');
// Show the tip's top-left corner anchored to the element's top-right corner
-tip.showBy('my-el', 'tl-tr');
- Parameters:
-
- Returns:
-
-
-
-
- |
- Tip |
-
-
- |
-
-
- suspendEvents() : void
-
-
- Suspend the firing of all events. (see resumeEvents)
- Parameters:
-
- Returns:
-
-
-
-
- |
- Observable |
-
-
- |
-
-
- syncSize() : Ext.BoxComponent
- 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:
-
- Returns:
-
-
-
-
- |
- BoxComponent |
-
-
- |
-
-
- toggleCollapse( Boolean animate ) : Ext.Panel
- Shortcut for performing an expand or collapse based on the current state of the panel.
-
- Shortcut for performing an expand or collapse based on the current state of the panel.
- Parameters:
- animate : BooleanTrue to animate the transition, else false (defaults to the value of the
- animCollapse panel config)
- Returns:
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- un( String eventName , Function handler , [Object scope ] ) : void
- Removes a listener (shorthand for removeListener)
-
- Removes a listener (shorthand for removeListener)
- Parameters:
-
- Returns:
-
-
-
-
- |
- Observable |
-
-
- |
-
-
- unregister( String/HTMLElement/Element el ) : void
- Removes this quick tip from its element and destroys it.
-
- Removes this quick tip from its element and destroys it.
- Parameters:
-
- Returns:
-
-
-
-
- |
- QuickTip |
-
-
- |
-
-
- updateBox( Object box ) : Ext.BoxComponent
- Sets the current box measurements of the component's underlying element.
-
- Sets the current box measurements of the component's underlying element.
- Parameters:
-
- Returns:
-
-
-
-
- |
- BoxComponent |
-
-
-
-
Public Events
-
-
-
-
-
-
- |
-
-
- activate : ( Ext.Panel p )
- Fires after the Panel has been visually activated.
-Note that Panels do not directly support being activated, but some...
-
- Fires after the Panel has been visually activated.
+tip.showBy( 'my-el', 'tl-tr'); | Tip |
| 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 |
| toggleCollapse( Boolean animate )
+ :
+ Ext.PanelShortcut for performing an expand or collapse based on the current state of the panel. Shortcut for performing an expand or collapse based on the current state of the panel. Parameters:animate : BooleanTrue to animate the transition, else false (defaults to the value of the
+ animCollapse panel config) Returns: | Panel |
| un( String eventName , Function handler , [Object scope ] )
+ :
+ voidRemoves an event handler (shorthand for removeListener.) | Observable |
| unregister( String/HTMLElement/Element el )
+ :
+ voidRemoves this quick tip from its element and destroys it. Removes this quick tip from its element and destroys it. | QuickTip |
| 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
|
| activate :
+ ( Ext.Panel p )
+ Fires after the Panel has been visually activated.
+Note that Panels do not directly support being activated, but some... Fires after the Panel has been visually activated.
Note that Panels do not directly support being activated, but some Panel subclasses
-do (like Ext.Window). Panels which are child Components of a TabPanel fire the
-activate and deactivate events under the control of the TabPanel.
- Listeners will be called with the following arguments:
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- add : ( Ext.Container this , Ext.Component component , Number index )
- Fires after any Ext.Component is added or inserted into the container.
-
- Fires after any Ext.Component is added or inserted into the container.
- Listeners will be called with the following arguments:
-
-
-
-
- |
- Container |
-
-
- |
-
-
- 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 |
-
-
- |
-
-
- beforeadd : ( Ext.Container this , Ext.Component component , Number index )
- Fires before any Ext.Component is added or inserted into the container.
-A handler can return false to cancel the add.
-
- Fires before any Ext.Component is added or inserted into the container.
-A handler can return false to cancel the add.
- Listeners will be called with the following arguments:
-
-
-
-
- |
- Container |
-
-
- |
-
-
- beforeclose : ( Ext.Panel p )
- Fires before the Panel is closed. Note that Panels do not directly support being closed, but some
-Panel subclasses d...
-
- Fires before the Panel is closed. Note that Panels do not directly support being closed, but some
-Panel subclasses do (like Ext.Window). This event only applies to such subclasses.
-A handler can return false to cancel the close.
- Listeners will be called with the following arguments:
- p : Ext.PanelThe Panel being closed.
-
-
-
- |
- Panel |
-
-
- |
-
-
- beforecollapse : ( Ext.Panel p , Boolean animate )
- Fires before the Panel is collapsed. A handler can return false to cancel the collapse.
-
- Fires before the Panel is collapsed. A handler can return false to cancel the collapse.
- Listeners will be called with the following arguments:
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- beforedestroy : ( Ext.Component this )
- Fires before the component is destroyed. Return false to stop the destroy.
-
- Fires before the component is destroyed. Return false to stop the destroy.
- Listeners will be called with the following arguments:
-
-
-
-
- |
- Component |
-
-
- |
-
-
- beforeexpand : ( Ext.Panel p , Boolean animate )
- Fires before the Panel is expanded. A handler can return false to cancel the expand.
-
- Fires before the Panel is expanded. A handler can return false to cancel the expand.
- Listeners will be called with the following arguments:
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- beforehide : ( Ext.Component this )
- Fires before the component is hidden. Return false to stop the hide.
-
- Fires before the component is hidden. Return false 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 to stop the render.
-
- Fires before the component is rendered. Return false to stop the render.
- Listeners will be called with the following arguments:
-
-
-
-
- |
- Component |
-
-
- |
-
-
- beforeshow : ( Ext.Component this )
- Fires before the component is shown. Return false to stop the show.
-
- Fires before the component is shown. Return false 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 to stop the restore.
-
- Fires before the state of the component is restored. Return false to stop the restore.
- Listeners will be called with the following arguments:
- this : Ext.Componentstate : ObjectThe hash of state values
-
-
-
- |
- 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
-
-
-
- |
- Component |
-
-
- |
-
-
- bodyresize : ( Ext.Panel p , Number width , Number height )
- Fires after the Panel has been resized.
-
- Fires after the Panel has been resized.
- Listeners will be called with the following arguments:
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- close : ( Ext.Panel p )
- Fires after the Panel is closed. Note that Panels do not directly support being closed, but some
-Panel subclasses do...
-
- Fires after the Panel is closed. Note that Panels do not directly support being closed, but some
-Panel subclasses do (like Ext.Window).
- Listeners will be called with the following arguments:
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- collapse : ( Ext.Panel p )
- Fires after the Panel has been collapsed.
-
- Fires after the Panel has been collapsed.
- Listeners will be called with the following arguments:
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- deactivate : ( Ext.Panel p )
- Fires after the Panel has been visually deactivated.
-Note that Panels do not directly support being deactivated, but ...
-
- Fires after the Panel has been visually deactivated.
+do (like Ext.Window). Panels which are child Components of a TabPanel fire the
+activate and deactivate events under the control of the TabPanel. Listeners will be called with the following arguments: | Panel |
| 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.
+A handler can return false to cancel the add. Fires before any Ext.Component is added or inserted into the container.
+A handler can return false to cancel the add. Listeners will be called with the following arguments: | Container |
| beforeclose :
+ ( Ext.Panel p )
+ Fires before the Panel is closed. Note that Panels do not directly support being closed, but some
+Panel subclasses d... Fires before the Panel is closed. Note that Panels do not directly support being closed, but some
+Panel subclasses do (like Ext.Window) or a Panel within a Ext.TabPanel. This event only
+applies to such subclasses.
+A handler can return false to cancel the close. Listeners will be called with the following arguments:p : Ext.PanelThe Panel being closed.
| Panel |
| beforecollapse :
+ ( Ext.Panel p , Boolean animate )
+ Fires before the Panel is collapsed. A handler can return false to cancel the collapse. Fires before the Panel is collapsed. A handler can return false to cancel the collapse. Listeners will be called with the following arguments: | Panel |
| 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 |
| beforeexpand :
+ ( Ext.Panel p , Boolean animate )
+ Fires before the Panel is expanded. A handler can return false to cancel the expand. Fires before the Panel is expanded. A handler can return false to cancel the expand. Listeners will be called with the following arguments: | Panel |
| 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
+false to cancel the remove. Fires before any Ext.Component is removed from the container. A handler can return
+false to cancel the remove. Listeners will be called with the following arguments: | Container |
| beforerender :
+ ( Ext.Component this )
+ Fires before the component is rendered. Return false from an
+event handler to stop the render. 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.
+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 )
+ 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 )
+ 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 |
| bodyresize :
+ ( Ext.Panel p , Number width , Number height )
+ Fires after the Panel has been resized. Fires after the Panel has been resized. Listeners will be called with the following arguments:p : Ext.Panelthe Panel which has been resized. width : NumberThe Panel body's new width. height : NumberThe Panel body's new height.
| Panel |
| close :
+ ( Ext.Panel p )
+ Fires after the Panel is closed. Note that Panels do not directly support being closed, but some
+Panel subclasses do... Fires after the Panel is closed. Note that Panels do not directly support being closed, but some
+Panel subclasses do (like Ext.Window) or a Panel within a Ext.TabPanel. Listeners will be called with the following arguments: | Panel |
| collapse :
+ ( Ext.Panel p )
+ Fires after the Panel has been collapsed. Fires after the Panel has been collapsed. Listeners will be called with the following arguments: | Panel |
| deactivate :
+ ( Ext.Panel p )
+ Fires after the Panel has been visually deactivated.
+Note that Panels do not directly support being deactivated, but ... Fires after the Panel has been visually deactivated.
Note that Panels do not directly support being deactivated, but some Panel subclasses
-do (like Ext.Window). Panels which are child Components of a TabPanel fire the
-activate and deactivate events under the control of the TabPanel.
- Listeners will be called with the following arguments:
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- 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 |
-
-
- |
-
-
- expand : ( Ext.Panel p )
- Fires after the Panel has been expanded.
-
- Fires after the Panel has been expanded.
- Listeners will be called with the following arguments:
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- hide : ( Ext.Component this )
- Fires after the component is hidden.
-
- Fires after the component is hidden.
- Listeners will be called with the following arguments:
-
-
-
-
- |
- Component |
-
-
- |
-
-
- iconchange : ( Ext.Panel p , String The , String The )
- Fires after the Panel icon class has been set or changed.
-
- Fires after the Panel icon class has been set or changed.
- Listeners will be called with the following arguments:
-
-
-
-
- |
- Panel |
-
-
- |
-
-
- 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 )
-
-
- Fires after any Ext.Component is removed from the container.
- Listeners will be called with the following arguments:
-
-
-
-
- |
- Container |
-
-
- |
-
-
- render : ( Ext.Component this )
- Fires after the component is rendered.
-
- Fires after the component 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.
-
- Fires after the component is shown.
- 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:
- this : Ext.Componentstate : ObjectThe hash of state values
-
-
-
- |
- 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
-
-
-
- |
- Component |
-
-
- |
-
-
- titlechange : ( Ext.Panel p , String The )
- Fires after the Panel title has been set or changed.
-
- Fires after the Panel title has been set or changed.
- Listeners will be called with the following arguments:
-
-
-
-
- |
- Panel |
-
-
-
-
\ No newline at end of file
+do (like Ext.Window). Panels which are child Components of a TabPanel fire the
+activate and deactivate events under the control of the TabPanel.Listeners will be called with the following arguments: