Observable Component BoxComponent Container Panel Tip ToolTip
Package: | Ext |
Defined In: | ToolTip.js |
Class: | ToolTip |
Subclasses: | QuickTip |
Extends: | Tip |
Config Options | Defined By | |
---|---|---|
activeItem : String/Number A string component id or the numeric index of the component that should be initially activated within the
container's... A string component id or the numeric index of the component that should be initially activated within the
container's layout on render. For example, activeItem: 'item-1' or activeItem: 0 (index 0 = the first
item in the container's collection). activeItem only applies to layout styles that can display
items one at a time (like Ext.layout.AccordionLayout, Ext.layout.CardLayout and
Ext.layout.FitLayout). Related to Ext.layout.ContainerLayout.activeItem. | Container | |
allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component | |
anchor : String Note: 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 : Number A 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 : Boolean True 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 : Boolean true 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 : Mixed The 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 The following class names are supported (baseCls will be replaced by baseCls):
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 : Boolean If 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 | |
autoHeight : Boolean true 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 : Boolean True 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/Function A 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 : Boolean true 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 : Boolean True 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 : Boolean True 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:
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:
| BoxComponent | |
baseCls : String The 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 | Panel | |
bbar : Object/Array The 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 : Object | Panel | |
bodyBorder : Boolean True 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 : Object A 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 ( 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:
The example above also explicitly creates a | Panel | |
bodyCssClass : String/Object/Function Additional css class selector to be applied to the body element in the format expected by
Ext.Element.addClass (defau... Additional css class selector to be applied to the body element in the format expected by
Ext.Element.addClass (defaults to null). See bodyCfg. | Panel | |
bodyStyle : String/Object/Function Custom CSS styles to be applied to the body element in the format expected by
Ext.Element.applyStyles (defaults to nu... Custom CSS styles to be applied to the body element in the format expected by
Ext.Element.applyStyles (defaults to null). See bodyCfg. | Panel | |
border : Boolean True 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 : Number The 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 : Number The 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 : Number The 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 : Number The 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 : Array An array of events that, when fired, should be bubbled to any parent container.
See Ext.util.Observable.enableBubble.... An array of events that, when fired, should be bubbled to any parent container.
See Ext.util.Observable.enableBubble.
Defaults to | Container | |
bufferResize : Boolean/Number When 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 : String The 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 : Array buttons 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 : Object | Panel | |
clearCls : String The 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 : String An 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 : Boolean true 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 : Booleantrue 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 : Boolean True 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 : String Optional. 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
| Component | |
ctCls : String An 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:
| Component | |
data : Mixed The initial set of data to apply to the tpl to
update the content area of the Component. | Component | |
defaultAlign : String Experimental. 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 : String The 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 | Container | |
defaults : Object|Function This 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 ( For example, to automatically apply padding to the body of each of a set of
contained Ext.Panel items, you could pass: Usage:
| Container | |
delegate : String Optional. 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
When specified, the child element of the target which caused a show
event is placed into the 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:
| ToolTip | |
disabled : Boolean Render 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:
| Panel | |
disabledClass : String CSS class added to the component when it is disabled (defaults to 'x-item-disabled'). | Component | |
dismissDelay : Number Delay 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/Object true to enable dragging of this Panel (defaults to false).
For custom drag/drop implementations, an Ext.Panel.DD conf...
For custom drag/drop implementations, an Ext.Panel.DD config could also be passed
in this config instead of
| Panel | |
elements : String A 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
body '. | Panel | |
fbar : Object/Array A 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 If buttonAlign configuration affects the layout of these items, for example:
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 : String The 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:
| Component | |
flex : Number Note: 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 | BoxComponent | |
floating : Mixed This 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 : Boolean true to create the footer element explicitly, false to skip creating it. The footer
will be created automatically if ... | Panel | |
footerCfg : Object | Panel | |
forceLayout : Boolean If 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 : Boolean false 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:
| Panel | |
header : Boolean true to create the Panel's header element explicitly, false to skip creating
it. If a title is set the header will b... | Panel | |
headerAsText : Boolean | Panel | |
headerCfg : Object | Panel | |
height : Number The 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 : Boolean Render this component hidden (default is false). If true, the
hide method will be called internally. | 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 : Booleantrue 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
(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:
| 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). 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 : 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 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 : String The 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:
| 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.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
Note: to access the container of an item see | Component | |
itemCls : String Note: 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:
| Component | |
itemId : String An 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
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
A single item, or an array of child Components to be added to this container, for example:
Each item may be:
Notes: | Container | |
keys : Object/Array A Ext.KeyMap config object (in the format expected by Ext.KeyMap.addBinding
used to assign custom key handling to thi... A Ext.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 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:
Note: see the note for clearCls. Also see hideLabel and Ext.layout.FormLayout.fieldTpl. Example use:
| Component | |
labelStyle : String A 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 Also see
| 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 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:
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
The layout type to be used for this container. If not specified, a default Ext.layout.ContainerLayout will be created and used. Valid layout 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
The layout Additional layout specific configuration properties. For complete
details regarding the valid config options for each layout type, see the
layout class corresponding to the | Container | |
layoutConfig : Object | Container | |
listeners : Object A 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
| Observable | |
margins : Object Note: 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:
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:
Defaults to:
| BoxComponent | |
maskDisabled : Boolean true 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 : 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 | |
padding : Number/String A 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/Array An 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 : Boolean Defaults 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 : String The 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 : String A 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 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:
In the code above, if the | Component | |
region : String Note: 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 : Mixed Specify 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.
See render also. | Component | |
resizeEvent : String The event to listen to for resizing in layouts. Defaults to 'bodyresize'. | Panel | |
shadow : Boolean/String True 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 : 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). stateEvents ... An array of events that, when fired, should trigger this component to
save its state (defaults to none). See | 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 | 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
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:
A stateful Component attempts to save state when one of the events
listed in the To save state, a stateful Component first serializes its state by
calling 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 During construction, a stateful Component attempts to restore
its state by calling Ext.state.Manager.get passing the
The resulting object is passed to 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.ap... A custom style specification to be applied to this component's Element. Should be a valid argument to
Ext.Element.applyStyles.
| Component | |
tabTip : String Note: 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 monitor
for mouseover events to trigger showing this ToolTip. | ToolTip | |
tbar : Object/Array The 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 : Object | Panel | |
title : String The 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 : 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 )). If this panel is a child item of a border layout also see the
BorderLayout.Region
floatable config option. | Panel | |
toolTemplate : Ext.Template/Ext.XTemplate A 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:
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:
Note that the CSS class 'x-tool-pdf' should have an associated style rule which provides an appropriate background image, something like:
| 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:
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:
For the custom id of
| Panel | |
tpl : Mixed An Ext.Template, Ext.XTemplate
or an array of strings to form an Ext.XTemplate.
Used in conjunction with the data and... An data and
tplWriteMode configurations. | Component | |
tplWriteMode : String The 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 : Boolean | Panel | |
width : Number | Tip | |
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 |
Property | Defined By | |
---|---|---|
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.
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
then the body Element must not be loaded or changed - it is under the control
of the Panel's Layout.
Note: see the Note for | Panel | |
buttons : Array This Panel's Array of buttons as created from the buttons
config property. Read only. | Panel | |
bwrap : Ext.Element | 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.Element The 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 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:
See also getEl | Component | |
footer : Ext.Element | Panel | |
header : Ext.Element | 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 The collection of components in this container as a Ext.util.MixedCollection | Container | |
ownerCt : Ext.Container This Component's owner Container (defaults to undefined, and is set automatically when
this Component is added to a C... | Component | |
refOwner : Ext.Container The 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 : DOMElement When a Tooltip is configured with the delegate
option to cause selected child elements of the target
Element to each ... | ToolTip |
Method | Defined By | |
---|---|---|
ToolTip( Object config )
Create a new Tooltip Create a new Tooltip Parameters:
| ToolTip | |
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:
| 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. Parameters:
| 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. Parameters:
| 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. Parameters:
| 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:
| 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. Parameters:
| Component | |
bubble( Function fn , [Object scope ], [Array args ] )
:
Ext.ComponentBubbles 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:
| Component | |
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:
| Container | |
cloneConfig( Object overrides )
:
Ext.ComponentClone the current component using the original config values passed into this instance by default. Clone the current component using the original config values passed into this instance by default. Parameters:
| 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:
| 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:
| Component | |
disable()
:
Ext.Component Disable this component and fire the 'disable' event. Disable this component and fire the 'disable' event. Parameters:
| 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:
| Container | |
enable()
:
Ext.Component Enable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. Parameters:
| 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 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:
Parameters:
| 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:
| 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:
| 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:
| 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 Parameters:
| 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:
| 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. Parameters:
| Component | |
findParentByType( String/Ext.Component/Class xtype , [Boolean shallow ] )
:
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 Parameters:
| 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... Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble. Parameters:
| Observable | |
focus( [Boolean selectText ], [Boolean/Number delay ] )
:
Ext.ComponentTry to focus this component. Try to focus this component. Parameters:
| 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:
| Container | |
getBottomToolbar() : Ext.Toolbar | 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. Parameters:
| BoxComponent | |
getBubbleTarget()
:
Ext.Container Provides 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. Parameters:
| 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:
| Container | |
getEl()
:
Ext.Element Returns 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:
Parameters:
| Component | |
getFooterToolbar() : Ext.Toolbar | Panel | |
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:
| 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:
| Panel | |
getHeight()
:
Number Gets the current height of the component's underlying element. Gets the current height of the component's underlying element. Parameters:
| BoxComponent | |
getId()
:
String Returns 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:
Parameters:
| 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:
| 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:
| Panel | |
getItemId() : String | 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:
| 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 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:
| Container | |
getOuterSize()
:
Object Gets 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. Parameters:
| 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. Parameters:
| BoxComponent | |
getResizeEl()
:
Ext.Element Returns the outermost Element of this Component which defines the Components overall size.
Usually this will return t... Returns the outermost Element of this Component which defines the Components overall size. Usually this will return the same Element as An example is a ComboBox. It is encased in a wrapping Element which
contains both the Parameters:
| BoxComponent | |
getSize()
:
Object Gets the current size of the component's underlying element. Gets the current size of the component's underlying element. Parameters:
| BoxComponent | |
getTool( String id )
:
ObjectRetrieve a tool by id. Retrieve a tool by id. Parameters:
| Panel | |
getTopToolbar() : Ext.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:
| Panel | |
getWidth()
:
Number Gets the current width of the component's underlying element. Gets the current width of the component's underlying element. Parameters:
| BoxComponent | |
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:
Parameters:
| 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. If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes. Example usage:
Parameters:
| 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 Parameters:
| Observable | |
hide()
:
void Hides this tooltip if visible. Hides this tooltip if visible. Parameters:
| 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. Parameters:
| 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:
| Container | |
isVisible()
:
Boolean Returns true if this component is visible. Returns true if this component is visible. Parameters:
| Component | |
isXType( String/Ext.Component/Class 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. Example usage:
Parameters:
| 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:
| 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:
or:
Parameters:
| 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:
| Component | |
nextSibling()
:
Ext.Component Returns the next component in the owning container Returns the next component in the owning container Parameters:
| 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:
| Observable | |
previousSibling()
:
Ext.Component Returns the previous component in the owning container Returns the previous component in the owning container Parameters:
| Component | |
purgeListeners()
:
void Removes all listeners for this object Removes all listeners for this object Parameters:
| Observable | |
relayEvents( Object o , Array events )
:
voidRelays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by this. Parameters:
| 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. Parameters:
| Container | |
removeAll( [Boolean autoDestroy ] )
:
ArrayRemoves all components from this container. Removes all components from this container. Parameters:
| 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. Parameters:
| Component | |
removeListener( String eventName , Function handler , [Object scope ] )
:
voidRemoves an event handler. Removes an event handler. Parameters:
| 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. 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 a new child Component is added, you may need to call 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. 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 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:
| Component | |
resumeEvents()
:
void Resume 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. Parameters:
| 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. Parameters:
| BoxComponent | |
setDisabled( Boolean disabled )
:
Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. Parameters:
| 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:
| 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:
| 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:
| 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:
| 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:
| 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 Parameters:
| 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. Parameters:
| 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:
| BoxComponent | |
show()
:
void Shows this tooltip at the current event target XY position. Shows this tooltip at the current event target XY position. Parameters:
| 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:
Parameters:
| 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:
Parameters:
| Tip | |
suspendEvents( Boolean queueSuspended )
:
voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:
| 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:
| 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:
| Panel | |
un( String eventName , Function handler , [Object scope ] )
:
voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable | |
update( Mixed htmlOrData , [Boolean loadScripts ], [Function callback ] )
:
voidUpdate the content area of a component. Update the content area of a component. Parameters:
| Component | |
updateBox( Object box )
:
Ext.BoxComponentSets the current box measurements of the component's underlying element. Sets the current box measurements of the component's underlying element. Parameters:
| BoxComponent |
Event | Defined By | |
---|---|---|
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 )
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:
| 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 )
| 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 )
| 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:
| 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:
| 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) 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 when calling the hide method. Fires after the component is hidden.
Fires after the component is hidden when calling the hide method. Listeners will be called with the following arguments:
| Component | |
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:
| BoxComponent | |
remove :
( Ext.Container this , Ext.Component component )
Listeners will be called with the following arguments:
| Container | |
removed :
( Ext.Component this , Ext.Container ownerCt )
Fires when a component is removed from an Ext.Container Fires when a component is removed from an Ext.Container Listeners will be called with the following arguments:
| Component | |
render :
( Ext.Component this )
Fires after the component markup is rendered. Fires after the component markup is rendered. Listeners will be called with the following arguments:
| Component | |
resize :
( Ext.Component this , Number adjWidth , Number adjHeight , Number rawWidth , Number rawHeight )
Fires after the component is resized. Fires after the component is resized. Listeners will be called with the following arguments:
| BoxComponent | |
show :
( Ext.Component this )
Fires after the component is shown when calling the show method. Fires after the component is shown when calling the show method. Listeners will be called with the following arguments:
| Component | |
staterestore :
( Ext.Component this , Object state )
Fires after the state of the component is restored. Fires after the state of the component is restored. Listeners will be called with the following arguments:
| Component | |
statesave :
( Ext.Component this , Object state )
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:
| Component | |
titlechange :
( Ext.Panel p , String The )
| Panel |