X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..c8256059947f3aa8f5b0a9a2acf55e2142bb4742:/docs/output/Ext.Panel.html?ds=sidebyside diff --git a/docs/output/Ext.Panel.html b/docs/output/Ext.Panel.html index 1dedddd4..648ee4dd 100644 --- a/docs/output/Ext.Panel.html +++ b/docs/output/Ext.Panel.html @@ -1,10 +1,10 @@ -
Package: | Ext |
Defined In: | Panel.js |
Class: | Panel |
Subclasses: | ButtonGroup, TabPanel, Tip, Window, FieldSet, FormPanel, GridPanel, TreePanel |
Extends: | Container |
xtype: | panel |
Panel is a container that has specific functionality and structural components that make +
Package: | Ext |
Defined In: | Panel.js |
Class: | Panel |
Subclasses: | ButtonGroup, TabPanel, Tip, Window, FieldSet, FormPanel, GridPanel, TreePanel |
Extends: | Container |
Panel is a container that has specific functionality and structural components that make it the perfect building block for application-oriented user interfaces.
Panels are, by virtue of their inheritance from Ext.Container, capable of being configured with a layout, and containing child Components.
When either specifying child items of a Panel, or dynamically adding Components
to a Panel, remember to consider how you wish the Panel to arrange those child elements, and whether
-those child elements need to be sized using one of Ext's built-in layout schemes. By
+those child elements need to be sized using one of Ext's built-in layout
schemes. By
default, Panels use the ContainerLayout scheme. This simply renders
child components, appending them one after the other inside the Container, and does not apply any sizing
at all.
Note: this config is only used when this Component is rendered -by a Container which has been configured to use an AnchorLayout +by a Container which has been configured to use an AnchorLayout (or subclass thereof). based layout manager, for example:
layout: 'anchor' // or 'form', or 'absolute'
See Ext.layout.AnchorLayout.anchor also.
See Ext.layout.AnchorLayout.anchor also.
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
).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,
+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.
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
+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.The URL will become the default URL for this panel's body element, -so it may be refreshed at any time.
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
).True to use width:'auto', false to use fixed width (or allow it to be managed by its parent @@ -92,19 +92,19 @@ child items when the browser changes its width:
var myPanel = <
title: 'Box 3'
}],
});
Another option available by default is to specify 'x-plain' which strips all styling +Another option available by default is t...
'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.
unstyled
also.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 +
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.
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):
+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 @@ -147,26 +147,37 @@ element: 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 +
The example above also explicitly creates a footer
with custom markup and
styling applied.
The maximum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size management applied by layout managers.
The maximum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size management applied by layout managers.
The minimum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size management applied by layout managers.
The minimum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size management applied by layout managers.
An array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.
+Defaults to ['add', 'remove']
.
'right'
,
+'left'
and 'center'
(defaults to 'right'
).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,
+If an item is configured with minWidth
or the Panel is configured with minButtonWidth
,
that width will be applied to the item.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').
@@ -176,37 +187,30 @@ manager (e.g. fieldLabel is specified or isFormField=true is specified.See Ext.layout.FormLayout.fieldTpl also.
true
+to enable closing in such situations. Defaults to false
.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
).true
to render the panel collapsed, false
to render it expanded (defaults to
+false
).'x-panel-collapsed'
).Specify the id of an existing HTML node to use as the panel's body content -(defaults to '').
Optional. Specify an existing HTML element, or the id
of an existing HTML element to use as the content
+for this component.
layout
+scheme that the Component may use. It is just HTML. Layouts operate on child items
.x-hidden
or the x-hide-display
CSS class to
+prevent a brief flicker of the content before it is rendered to the panel.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.
@@ -217,18 +221,23 @@ which assigns a value by default:ctCls: 'x-box-layout-ct custom-class'
-tpl
to
+update the content area of the Component.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'.
A config object that will be applied to all components added to this container either via the items -config or via the add or insert methods. The defaults config can contain any -number of name/value property pairs to be added to each item, and should be valid for the types of items -being added to the container. For example, to automatically apply padding to the body of each of a set of -contained Ext.Panel items, you could pass: defaults: {bodyStyle:'padding:15px'}.
Note: defaults will not be applied to config objects if the option is already specified. -For example:
defaults: { // defaults are applied to items, not the container
+Defaults to 'panel'
, except Ext.menu.Menu which defaults to 'menuitem'
,
+and Ext.Toolbar and Ext.ButtonGroup which default to 'button'
.
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: [
@@ -242,7 +251,7 @@ items: [
autoScroll: false // will be applied here, panel2 will be autoScroll:true.
})
]
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
@@ -258,9 +267,9 @@ the disabled state:
}
}
});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
+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.:
@@ -304,18 +313,18 @@ generated automatically based on the items added to the panel at config time, bu
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
body
'.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: +If buttons
are specified, they will supersede the fbar
configuration property.
buttonAlign
configuration affects the layout of these items, for example:
var w = new Ext.Window({
height: 250,
width: 500,
@@ -326,7 +335,7 @@ The Panel's 'bbar Right'
}]
}),
- buttonAlign: 'left', // anything but 'center' or 'right' and you can use "-", and "->"
+ buttonAlign: 'left', // anything but 'center' or 'right' and you can use '-', and '->'
// to control the alignment of fbar items
fbar: [{
text: 'fbar Left'
@@ -334,7 +343,7 @@ The Panel's 'fbar Right'
}]
}).show();
-Note: Although a Toolbar may contain Field components, these will not be updated by a load +
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.
new Ext.FormPanel({
xtype: 'textfield',
fieldLabel: 'Name'
}]
-});
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).
This property is used to configure the underlying Ext.Layer. Acceptable values for this configuration property are:
false
: Default.true
: myPanel.setPosition(100,100);
).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">
@@ -401,19 +416,19 @@ is useful for forcing forms to render in collapsed or hidden containers. (defaul
<div class="x-panel-bl"><div class="x-panel-br"><div class="x-panel-bc"/>
</div></div></div>
</div>
collapsible == true
,
-false to display it (defaults to false).true
to hide the expand/collapse toggle button when collapsible == true
,
+false
to display it (defaults to false
).An example of specifying a custom icon class would be something like:
// specify the property in the config for the class:
@@ -459,8 +474,11 @@ rules to style the specific instance of this component uniquely, and also to sel
sub-elements using this component's id as the parent.
Note: to avoid complications imposed by a unique id also see
itemId
and ref
.
-Note: to access the container of an item see ownerCt
.
An additional CSS class to apply to the div wrapping the form item +
Note: to access the container of an item see ownerCt
.
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').
@@ -469,22 +487,22 @@ the default itemCls supplied at the container level. The value s you to write standard CSS rules that can apply to the field, the label (if specified), or any other element within the markup for the field.Note: see the note for fieldLabel.
// Apply a style to the field's label:
+Example use:// Apply a style to the field's label:
<style>
.required .x-form-item-label {font-weight:bold;color:red;}
</style>
new Ext.FormPanel({
- height: 100,
- renderTo: Ext.getBody(),
- items: [{
- xtype: 'textfield',
- fieldLabel: 'Name',
- itemCls: 'required' //this label will be styled
- },{
- xtype: 'textfield',
- fieldLabel: 'Favorite Color'
- }]
+ height: 100,
+ renderTo: Ext.getBody(),
+ items: [{
+ xtype: 'textfield',
+ fieldLabel: 'Name',
+ itemCls: 'required' //this label will be styled
+ },{
+ xtype: 'textfield',
+ fieldLabel: 'Favorite Color'
+ }]
});
null
).The separator to display after the text of each fieldLabel. This property may be configured at various levels. @@ -607,7 +625,7 @@ you have in mind. For example:
new Ext.Window({
}]
}).show();
If the layout configuration is not explicitly specified for -a general purpose container (e.g. Container or Panel) the +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). @@ -625,30 +643,30 @@ as a String:
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:
+Valid layout type
values are:
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
+each layout type, see the layout class corresponding to the type
specified.
The layout type to be used for this container (see list +
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.
+layout class corresponding to thelayout
specified.
Defaults to:
{top:0, right:0, bottom:0, left:0}
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.75
)layout
and should not need
to be set manually.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.).A path specification, relative to the Component's ownerCt specifying into which -ancestor Container to place a named reference to this Component.
+take advantage of lazy instantiation and rendering.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',
@@ -793,9 +814,10 @@ For example, to put a reference to a Toolbar Button into the Panel which owns
}
}
});
-In the code above, if the ref had been 'saveButton'
the reference would
-have been placed into the Toolbar. Each '/' in the ref moves up one level from the
-Component's ownerCt.
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 render also.
See render also.
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
.4
). Note that this
+option only applies when floating = true
.false
to disable the iframe shim in browsers which need one (defaults to true
).
+Note that this option only applies when floating = true
.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
@@ -888,10 +910,11 @@ Ext.Element.ap...
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.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.
@@ -900,19 +923,19 @@ of an ancestor FormPanel. A Panel's toolbars are not part of the standard Contai so are not scanned to collect form items. However, the values will be submitted because form submission parameters are collected from the DOM tree.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.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.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 @@ -933,44 +956,44 @@ visual indication when hovering over the tool:
var win = 'hide'
});
-Note that the CSS class "x-tool-pdf" should have an associated style rule which provides an +
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;}
tools.<tool-type>
Each tool config may contain the following properties:
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
For the custom id of 'help' define two relevant css classes with a link to +
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;}
data
and
+tplWriteMode
configurations.Ext.XTemplate.overwrite
).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 el also.
buttons
config property. Read only.Note: to access items within the container see itemId.
Method | Defined By | |||
---|---|---|---|---|
Panel( Object config )
- Parameters:
| Panel | |||
add( Object/Array component , Object (Optional) , Object (Optional) )
- :
- Ext.ComponentAdds Component(s) to this Container.
+ Note: see the Note for | 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 |
Method | Defined By | |
---|---|---|
Panel( Object config )
+ Parameters:
| Panel | |
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. @@ -1079,10 +1113,10 @@ accordingly (see
- Parameters:
| Container | |
addButton( String/Object config , Function handler , Object scope )
+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 )
+button config, an object will be treated as a button config object.handler : FunctionThe function to be called on button Ext.Button.click scope : ObjectThe scope ( this reference) in which the button handler function is executed. Defaults to the Button.
| 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 object )
+ 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. )
:
- voidUsed to define events on this Observable Used to define events on this Observable Parameters:
| Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] )
+ 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 ] )
@@ -1188,9 +1224,41 @@ to...Force this container's layout to be recalculated. A
to an already rendered container, or possibly after changing sizing/position properties of child components. Parameters:
| Container | |
enable()
:
- Ext.Component Enable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. Parameters:
| Component | |
enableBubble( Object events )
- :
- voidUsed to enable bubbling of events Used to enable bubbling of events Parameters:
| Observable | |
expand( Boolean animate )
+ Ext.ComponentEnable 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
@@ -1223,7 +1291,7 @@ by calling Get 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 ] )
+ 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()
:
@@ -1233,9 +1301,9 @@ by calling Examines this container's items property
and gets a direct child component of this container.Parameters:
| Container | |
getEl()
@@ -1256,7 +1324,9 @@ or use a render listener directly:
Parameters:
| Component | |
getFrameHeight()
+}); 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
@@ -1300,7 +1370,7 @@ the element into which the Gets the current XY position of the component's underlying element. Gets the current XY position of the component's underlying element. Parameters:
| BoxComponent | |
getResizeEl()
:
- void Returns the outermost Element of this Component which defines the Components overall size.
+ Ext.Element Returns the outermost Element of this Component which defines the Components overall size.
Usually this will return t... Returns the outermost Element of this Component which defines the Components overall size. Usually this will return the same Element as An example is a ComboBox. It is encased in a wrapping Element which
contains both the Parameters:
| BoxComponent | |
getSize()
+This Element is returned as the resizeEl .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.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()
:
@@ -1375,19 +1445,38 @@ the default), or true to check whether this Component is directly of the specifi
:
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:
| Panel | |
nextSibling()
+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:
+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 ] )
:
@@ -1440,12 +1529,14 @@ which this component will be inserted (defaults to appending to the end of the c
If events were suspended using the queueSuspended parameter, then all
event...Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
-events fired during event suspension will be sent to any listeners now. Parameters:
| Observable | |
setDisabled( Boolean disabled )
+events fired during event suspension will be sent to any listeners now.Parameters:
| Observable | |
setAutoScroll( Boolean scroll )
:
- Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. Parameters:
| Component | |
setHeight( Number height )
+ Ext.BoxComponentSets the overflow on the content element of the component. Sets the overflow on the content element of the component. Parameters:
| BoxComponent | |
setDisabled( Boolean disabled )
:
- Ext.BoxComponentSets the height of the component. This method fires the resize event. Sets the height of the component. This method fires the resize event. Parameters:
| 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 )
@@ -1479,13 +1570,13 @@ This may be one of:
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. 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: | Panel | |
setVisible( Boolean visible )
+for the Panel. This is triggered either by configuring the Panel with a non-blank title ,
+or configuring it with header: true .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( Number width )
+ 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()
:
@@ -1502,7 +1593,12 @@ after the 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:
| Panel | |
un( String eventName , Function handler , [Object scope ] )
:
- voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable | |
updateBox( Object box )
+ 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 )
@@ -1512,7 +1608,9 @@ Note that Panels do not directly support being activated, but some Panel subclas
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 | ||
afterlayout :
+ Listeners will be called with the following arguments:
| Container | ||
added :
+ ( Ext.Component this , Ext.Container ownerCt , number index )
+ Fires when a component is added to an Ext.Container Fires when a component is added to an Ext.Container Listeners will be called with the following arguments:
| Component | ||
afterlayout :
( Ext.Container this , ContainerLayout layout )
Fires when the components in this container are arranged by the associated layout manager. Fires when the components in this container are arranged by the associated layout manager. Listeners will be called with the following arguments:
| Container | ||
afterrender :
( Ext.Component this )
@@ -1564,7 +1662,7 @@ provide custom state restoration. | 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 :
+ 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
@@ -1594,7 +1692,9 @@ Fires after the component is hidden when calling the 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 | ||
render :
+ Listeners will be called with the following arguments:
| Container | ||
removed :
+ ( Ext.Component this , Ext.Container ownerCt )
+ Fires when a component is removed from an Ext.Container Fires when a component is removed from an Ext.Container Listeners will be called with the following arguments:
| Component | ||
render :
( Ext.Component this )
Fires after the component markup is rendered. Fires after the component markup is rendered. Listeners will be called with the following arguments:
| Component | ||
resize :
( Ext.Component this , Number adjWidth , Number adjHeight , Number rawWidth , Number rawHeight )
|