X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..e9397f91ede62d446aed37d23256e8938fc4c335:/docs/output/Ext.TabPanel.html diff --git a/docs/output/Ext.TabPanel.html b/docs/output/Ext.TabPanel.html index 45cc9411..f3151c8a 100644 --- a/docs/output/Ext.TabPanel.html +++ b/docs/output/Ext.TabPanel.html @@ -1,4 +1,9 @@ -
Properties Methods Events Config Options Direct Link 
Observable
  Component
    BoxComponent
      Container
        Panel
          TabPanel

Class Ext.TabPanel

Package:Ext
Defined In:TabPanel.js
Class:TabPanel
Extends:Panel
xtype:tabpanel

A basic tab container. TabPanels can be used exactly like a standard Ext.Panel +

Properties Methods Events Config Options Direct Link 
Observable
+  Component
+    BoxComponent
+      Container
+        Panel
+          TabPanel

Class Ext.TabPanel

Package:Ext
Defined In:TabPanel.js
Class:TabPanel
Extends:Panel

A basic tab container. TabPanels can be used exactly like a standard Ext.Panel for layout purposes, but also have special support for containing child Components (items) that are managed using a CardLayout layout manager, and displayed as separate tabs.

@@ -22,6 +27,9 @@ These events are:

the active tab.
  • deactivate : Fires when the Component that was the active tab becomes deactivated.
    • +
  • beforeclose : Fires when the user clicks on the close tool of a closeable tab. +May be vetoed by returning false from a handler.
    • +
  • close : Fires a closeable tab has been closed by the user.

    • Creating TabPanels from Code

    TabPanels can be created and rendered completely in code, as in this example:

    @@ -72,20 +80,20 @@ container's layout on render. For example, activeItem: 'item-1' or activeItem: 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 activeTab : String/Number
    A string id or the numeric index of the tab that should be initially -activated on render (defaults to none).
    TabPanel 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 +activated on render (defaults to undefined).
    TabPanel 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 +by a Container which has been configured to use an AnchorLayout (or subclass thereof). based layout manager, for example:

    -

    See Ext.layout.AnchorLayout.anchor also.

    Component 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 animScroll : Boolean
    True to animate tab scrolling so that hidden tabs slide smoothly into view (defaults +

    See Ext.layout.AnchorLayout.anchor also.

    BoxComponent 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 animScroll : Boolean
    True to animate tab scrolling so that hidden tabs slide smoothly into view (defaults to true). Only applies when ena...
    True to animate tab scrolling so that hidden tabs slide smoothly into view (defaults to true). Only applies when enableTabScroll = true.
    TabPanel 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 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.

    @@ -101,20 +109,49 @@ markup will be autogenerated if necessary.

    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 th...
    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 +destruction must be handled manually (defaults to true).
    Container autoEl : Mixed
    A tag name or DomHelper spec used to create the Element which will +encapsulate this Component. +You do not normally ne...

    A tag name or DomHelper spec used to create the Element which will +encapsulate this Component.

    +

    You do not normally need to specify this. For the base classes Ext.Component, Ext.BoxComponent, +and Ext.Container, this defaults to 'div'. The more complex Ext classes use a more complex +DOM structure created by their own onRender methods.

    +

    This is intended to allow the developer to create application-specific utility Components encapsulated by +different DOM elements. Example usage:

    {
+    xtype: 'box',
+    autoEl: {
+        tag: 'img',
+        src: 'http://www.example.com/example.jpg'
+    }
+}, {
+    xtype: 'box',
+    autoEl: {
+        tag: 'blockquote',
+        html: 'autoEl is cool!'
+    }
+}, {
+    xtype: 'container',
+    autoEl: 'ul',
+    cls: 'ux-unordered-list',
+    items: {
+        xtype: 'box',
+        autoEl: 'li',
+        html: 'First list item'
+    }
+}
    Component autoHeight : 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 +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 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 panel's body element and show scroll bars automatically when -necessary, false to c...
    true to use overflow:'auto' on the panel's body element and show scroll bars automatically when -necessary, false to clip any overflowing content (defaults to false).
    Panel autoShow : Boolean
    True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove +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 autoTabSelector : String
    The CSS selector used to search for tabs in existing markup when autoTabs = true (defaults to 'div.x-tab'). This can...
    The CSS selector used to search for tabs in existing markup when @@ -182,12 +219,12 @@ child items when the browser changes its width:
    var myPanel = <
 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 +

    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
    A DomHelper element specification object specifying the element structure of this Panel's bbar Element. See bodyCfg ...

    A DomHelper element specification object specifying the element structure -of this Panel's bbar Element. See bodyCfg also.

    Panel bodyBorder : Boolean
    True to display an interior border on the body element of the panel, false to hide it (defaults to true). +of this Panel's bbar Element. See bodyCfg also.

    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 @@ -195,8 +232,8 @@ Panel Element. By default, the Default element in t...

    A DomHelper element specification object may be specified for any Panel Element.

    By default, the Default element in the table below will be used for the html markup to -create a child element with the commensurate Default class name (baseCls will be -replaced by baseCls):

    +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
@@ -224,32 +261,43 @@ element:
    
     },
     footerCfg: {
         tag: 'h2',
-        cls: 'x-panel-footer'        // same as the Default class
+        cls: 'x-panel-footer',        // same as the Default class
         html: 'footer html'
     },
     footerCssClass: 'custom-footer', // additional css class, see addClass
     footerStyle:    'background-color:red' // see bodyStyle
 });
    -

    The example above also explicitly creates a footer with custom markup and +

    The example above also explicitly creates a footer with custom markup and styling applied.

    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 bufferResize : Boolean/Number
    When set to true (100 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer -t...
    When set to true (100 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer +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 ['add', 'remove'].

    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.
    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 +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, +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
    A DomHelper element specification object specifying the element structure of this Panel's bwrap Element. See bodyCfg...

    A DomHelper element specification object specifying the element structure -of this Panel's bwrap Element. See bodyCfg also.

    Panel clearCls : String
    The CSS class used to to apply to the special clearing div rendered +of this Panel's bwrap Element. See bodyCfg also.

    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').

    @@ -259,34 +307,27 @@ manager (e.g. fieldLabel is specified or isFormField=true is specified.


    See Ext.layout.FormLayout.fieldTpl also.

    Component closable : Boolean
    Panels themselves do not directly support being closed, but some Panel subclasses do (like Ext.Window) or a Panel Cla...
    Panels themselves do not directly support being closed, but some Panel subclasses do (like -Ext.Window) or a Panel Class within an Ext.TabPanel. Specify true -to enable closing in such situations. Defaults to false.
    Panel cls : String
    An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be +Ext.Window) or a Panel Class within an Ext.TabPanel. Specify true +to enable closing in such situations. Defaults to false.
    Panel 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 collapsedCls : String
    A CSS class to add to the panel's element after it has been collapsed (defaults to -'x-panel-collapsed').
    Panel contentEl : String
    Specify the id of an existing HTML node to use as the panel's body content -(defaults to ''). -Description : -<div clas...

    Specify the id of an existing HTML node to use as the panel's body content -(defaults to '').

      -
    • Description :
        -
        This config option is used to take an existing HTML element and place it in the body -of a new panel (it simply moves the specified DOM element into the body element of the Panel -when the Panel is rendered to use as the content (it is not going to be the -actual panel itself).
        -
      • -
    • Notes :
        -
        The specified HTML Element is appended to the Panel's body Element by the -Panel's afterRender method after any configured HTML has -been inserted, and so the document will not contain this HTML at the time the -render event is fired.
        -
        The specified HTML element used will not participate in any layout scheme that the -Panel may use. It's just HTML. Layouts operate on child items.
        -
        Add either the x-hidden or the x-hide-display CSS class to -prevent a brief flicker of the content before it is rendered to the panel.
        -
      • -
    Panel ctCls : String
    An optional extra CSS class that will be added to this component's container. This can be useful for +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 collapsedCls : String
    A CSS class to add to the panel's element after it has been collapsed (defaults to +'x-panel-collapsed').
    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 id of an existing HTML element to use as the content +for this component.

    +
      +
    • Description : +
      This config option is used to take an existing HTML element and place it in the layout element +of a new component (it simply moves the specified DOM element after the Component is rendered to use as the content.
      • +
    • Notes : +
      The specified HTML element is appended to the layout element of the component after any configured +HTML has been inserted, and so the document will not contain this element at the time the render event is fired.
      +
      The specified HTML element used will not participate in any layout +scheme that the Component may use. It is just HTML. Layouts operate on child items.
      +
      Add either the x-hidden or the x-hide-display CSS class to +prevent a brief flicker of the content before it is rendered to the panel.
      • +
    Component ctCls : 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.

    @@ -297,18 +338,23 @@ which assigns a value by default:
    To configure the above Class with an extra CSS class append to the default. For example, for BoxLayout (Hbox and Vbox):
    ctCls: 'x-box-layout-ct custom-class'
    -

    Component defaultType : String
    The default xtype of child Components to create in this Container when +

    Component data : Mixed
    The initial set of data to apply to the tpl to +update the content area of the Component.
    Component 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 'panel', except Ext.menu.Menu which defaults to 'menuitem', -and Ext.Toolbar and Ext.ButtonGroup which default to 'button'.

    Container defaults : Object
    A config object that will be applied to all components added to this container either via the items -config or via the...

    A config object that will be applied to all components added to this container either via the items -config or via the add or insert methods. The defaults config can contain any -number of name/value property pairs to be added to each item, and should be valid for the types of items -being added to the container. For example, to automatically apply padding to the body of each of a set of -contained Ext.Panel items, you could pass: defaults: {bodyStyle:'padding:15px'}.


    -

    Note: defaults will not be applied to config objects if the option is already specified. -For example:

    defaults: {               // defaults are applied to items, not the container
+
    Defaults to 'panel', except Ext.menu.Menu which defaults to 'menuitem',
+and Ext.Toolbar and Ext.ButtonGroup which default to 'button'.
    Container defaults : Object|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 (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: [
@@ -337,7 +383,7 @@ is within a getValues or
 setValues.
    TabPanel 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 ...
    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 @@ -353,9 +399,9 @@ the disabled state: } } });
    Panel disabledClass : String
    CSS class added to the component when it is disabled (defaults to 'x-item-disabled').
    Component draggable : Boolean/Object
    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 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.: @@ -399,20 +445,20 @@ 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
      • +
    • header
      • +
    • tbar (top bar)
      • +
    • body
      • +
    • bbar (bottom bar)
      • +
    • footer
    -Defaults to 'body'.
    Panel enableTabScroll : Boolean
    True to enable scrolling to tabs that may be invisible due to overflowing the +Defaults to 'body'.
    Panel enableTabScroll : Boolean
    True to enable scrolling to tabs that may be invisible due to overflowing the overall TabPanel width. Only available ...
    True to enable scrolling to tabs that may be invisible due to overflowing the overall TabPanel width. Only available with tabPosition:'top' (defaults to false).
    TabPanel 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 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.

    +The Panel's buttonAlign configuration affects the layout of these items, for example: 
    var w = new Ext.Window({
     height: 250,
     width: 500,
@@ -423,7 +469,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'
@@ -431,7 +477,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.

    Panel fieldLabel : String
    The label text to display next to this Component (defaults to ''). @@ -448,31 +494,37 @@ Example use:
    new Ext.FormPanel({
         xtype: 'textfield',
         fieldLabel: 'Name'
     }]
-});
    Component floating : Mixed
    This property is used to configure the underlying Ext.Layer. Acceptable values for this +});
    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 flex property will be flexed either vertically (by a VBoxLayout) +or horizontally (by an HBoxLayout) according to the item's relative flex value +compared to the sum of all Components with flex value specified. Any child items that have +either a flex = 0 or flex = undefined will not be 'flexed' (the initial size will not be changed).

    BoxComponent floating : 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:

      -
    • false : Default.
      Display the panel inline where it is +
    • false : Default.
      Display the panel inline where it is rendered.
      • -
    • true :
      Float the panel (absolute position it with automatic +
    • true :
      Float the panel (absolute position it with automatic shimming and shadow).
        Setting floating to true will create an Ext.Layer for this panel and display the panel at negative offsets so that it is hidden.
        Since the panel will be absolute positioned, the position must be set explicitly -after render (e.g., myPanel.setPosition(100,100);).
        +after render (e.g., myPanel.setPosition(100,100);).
      Note: when floating a panel you should always assign a fixed width, otherwise it will be auto width and will expand to fill to the right edge of the viewport.
    -
  • object :
    The specified object will be used +
  • object :
    The specified object will be used as the configuration object for the Ext.Layer that will be created.
    • Panel footer : Boolean
    true to create the footer element explicitly, false to skip creating it. The footer -will be created automatically if ...
    true to create the footer element explicitly, false to skip creating it. The footer -will be created automatically if buttons or a fbar have -been configured. See bodyCfg for an example.
    Panel footerCfg : Object
    A DomHelper element specification object specifying the element structure +will be created automatically if ...
    true to create the footer element explicitly, false to skip creating it. The footer +will be created automatically if buttons or a fbar have +been configured. See bodyCfg for an example.
    Panel footerCfg : Object
    A DomHelper element specification object specifying the element structure of this Panel's footer Element. See bodyCf...

    A DomHelper element specification object specifying the element structure -of this Panel's footer Element. See bodyCfg also.

    Panel forceLayout : Boolean
    If true the container will force a layout initially even if hidden or collapsed. This option +of this Panel's footer Element. See bodyCfg also.

    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 rounde...
    false by default to render with plain 1px square borders. true to render with 9 elements, complete with custom rounded corners (also see Ext.Element.boxWrap).

    The template generated for each condition is depicted below:

    // frame = false
 <div id="developer-specified-id-goes-here" class="x-panel">
@@ -499,7 +551,7 @@ is useful for forcing forms to render in collapsed or hidden containers. (defaul
         </div></div></div>
 </div>
    Panel headerCfg : Object
    A DomHelper element specification object specifying the element structure of this Panel's header Element. See bodyCf...

    A DomHelper element specification object specifying the element structure -of this Panel's header Element. See bodyCfg also.

    Panel height : Number
    The height of this component in pixels (defaults to auto). +of this Panel's header Element. See bodyCfg also.

    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 @@ -528,11 +580,11 @@ 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 panel's body -content (defaults to ''). The HTML content ...
    An HTML fragment, or a DomHelper specification to use as the panel's body -content (defaults to ''). The HTML content is added by the Panel's afterRender method, -and so the document will not contain this HTML at the time the render event is fired. -This content is inserted into the body before any configured contentEl is appended.
    Panel iconCls : String
    The CSS class selector that specifies a background image to be used as the header icon (defaults to ''). +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: 

    // specify the property in the config for the class:
@@ -550,8 +602,11 @@ rules to style the specific instance of this component uniquely, and also to sel
 sub-elements using this component's id as the parent.
    
 
    Note: to avoid complications imposed by a unique id also see
 itemId and ref.
    
-
    Note: to access the container of an item see ownerCt.
    Component itemCls : String
    An additional CSS class to apply to the div wrapping the form item -element of this field. If supplied, itemCls at th...

    An additional CSS class to apply to the div wrapping the form item +

    Note: to access the container of an item see ownerCt.

    Component itemCls : 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').

    @@ -560,22 +615,22 @@ the default itemCls supplied at the container level. The value s you to write standard CSS rules that can apply to the field, the label (if specified), or any other element within the markup for the field.


    Note: see the note for fieldLabel.


    -Example use:
    // Apply a style to the field's label:
+Example use:
    // Apply a style to the field's label:
 <style>
     .required .x-form-item-label {font-weight:bold;color:red;}
 </style>
 
 new Ext.FormPanel({
-	height: 100,
-	renderTo: Ext.getBody(),
-	items: [{
-		xtype: 'textfield',
-		fieldLabel: 'Name',
-		itemCls: 'required' //this label will be styled
-	},{
-		xtype: 'textfield',
-		fieldLabel: 'Favorite Color'
-	}]
+    height: 100,
+    renderTo: Ext.getBody(),
+    items: [{
+        xtype: 'textfield',
+        fieldLabel: 'Name',
+        itemCls: 'required' //this label will be styled
+    },{
+        xtype: 'textfield',
+        fieldLabel: 'Favorite Color'
+    }]
 });
    Component itemId : 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 id with @@ -630,9 +685,9 @@ Below is an example of how to create customized tab selector items:

    new Ext.XTemplate(
     '<li class="{cls}" id="{id}" style="overflow:hidden">',
          '<tpl if="closable">',
-            '<a class="x-tab-strip-close" onclick="return false;"></a>',
+            '<a class="x-tab-strip-close"></a>',
          '</tpl>',
-         '<a class="x-tab-right" href="#" onclick="return false;" style="padding-left:6px">',
+         '<a class="x-tab-right" href="#" style="padding-left:6px">',
             '<em class="x-tab-left">',
                 '<span class="x-tab-strip-inner">',
                     '<img src="{src}" style="float:left;margin:3px 3px 0 0">',
@@ -699,7 +754,7 @@ shown (no sizing is done while hidden), or in response to a html with items.
    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 +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. @@ -826,14 +881,19 @@ to the second, and the bottom is set to the third.

  • If there are four values, they apply to the top, right, bottom, and left, respectively.

    • Defaults to:

    {top:0, right:0, bottom:0, left:0}
    BoxComponent maskDisabled : 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 +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 minButtonWidth : Number
    Minimum width in pixels of all buttons in this panel (defaults to 75)
    Panel minTabWidth : Number
    The minimum width in pixels for each tab when resizeTabs = true (defaults to 30).
    TabPanel monitorResize : Boolean
    True to automatically monitor window resize events and rerender the layout on -browser resize (defaults to true).
    TabPanel overCls : String
    An optional extra CSS class that will be added to this component's Element when the mouse moves +disabled.
    Panel minButtonWidth : Number
    Minimum width in pixels of all buttons in this panel (defaults to 75)
    Panel minTabWidth : Number
    The minimum width in pixels for each tab when resizeTabs = true (defaults to 30).
    TabPanel 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 overCls : String
    An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and...
    An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and removed when the mouse moves out. (defaults to ''). This can be -useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.
    Component pageX : Number
    The page level x coordinate for this component if contained within a positioning container.
    BoxComponent pageY : Number
    The page level y coordinate for this component if contained within a positioning container.
    BoxComponent plain : Boolean
    true to render the tab strip without a background container image +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 plain : Boolean
    true to render the tab strip without a background container image (defaults to false).
    TabPanel 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. @@ -848,9 +908,9 @@ object. The ptype will be looked up at render time up to determine type of Plugin to create.

    If you create your own Plugins, you may register them using Ext.ComponentMgr.registerPlugin in order to be able to -take advantage of lazy instantiation and rendering.
    Component ref : 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 ownerCt specifying into which -ancestor Container to place a named reference to this Component.

    +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 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',
@@ -869,9 +929,10 @@ For example, to put a reference to a Toolbar Button into the Panel which owns
         }
     }
 });
    -

    In the code above, if the ref had been 'saveButton' the reference would -have been placed into the Toolbar. Each '/' in the ref moves up one level from the -Component's ownerCt.

    Component region : String
    Note: this config is only used when this BoxComponent is rendered +

    In the code above, if the ref had been 'saveButton' +the reference would have been placed into the Toolbar. Each '/' in the ref +moves up one level from the Component's ownerCt.

    +

    Also see the added and removed events.

    Component region : 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').


    @@ -887,7 +948,7 @@ to render and manage its child items.
    When using this config, a call to render() is not required.
    -

    See render also.

    Component resizeTabs : Boolean
    True to automatically resize each tab so that the tabs will completely fill the +

    See render also.

    Component resizeEvent : String
    The event to listen to for resizing in layouts. Defaults to 'bodyresize'.
    Panel resizeTabs : Boolean
    True to automatically resize each tab so that the tabs will completely fill the tab strip (defaults to false). Setti...
    True to automatically resize each tab so that the tabs will completely fill the tab strip (defaults to false). Setting this to true may cause specific widths that might be set per tab to be overridden in order to fit them all into view (although minTabWidth will always be honored).
    TabPanel scrollDuration : Float
    The number of milliseconds that each scroll animation should last (defaults @@ -897,13 +958,13 @@ to .35). Only applies when resizeTabs = true, the calculated tab width). Only applies when enableTabScroll = true.
    TabPanel scrollRepeatInterval : Number
    Number of milliseconds between each scroll while a tab scroll button is continuously pressed (defaults to 400).
    TabPanel shadow : Boolean/String
    true (or a valid Ext.Shadow Ext.Shadow.mode value) to display a shadow behind the -panel, false to display no shadow (...
    true (or a valid Ext.Shadow Ext.Shadow.mode value) to display a shadow behind the -panel, false to display no shadow (defaults to 'sides'). Note that this option -only applies when floating = true.
    Panel shadowOffset : Number
    The number of pixels to offset the shadow if displayed (defaults to 4). Note that this -option only applies when float...
    The number of pixels to offset the shadow if displayed (defaults to 4). Note that this -option only applies when floating = true.
    Panel shim : Boolean
    false to disable the iframe shim in browsers which need one (defaults to true). -Note that this option only applies wh...
    false to disable the iframe shim in browsers which need one (defaults to true). -Note that this option only applies when floating = true.
    Panel stateEvents : Array
    An array of events that, when fired, should trigger this component to +panel, false to display no shadow (...
    true (or a valid Ext.Shadow Ext.Shadow.mode value) to display a shadow behind the +panel, false to display no shadow (defaults to 'sides'). Note that this option +only applies when floating = true.
    Panel shadowOffset : Number
    The number of pixels to offset the shadow if displayed (defaults to 4). Note that this +option only applies when float...
    The number of pixels to offset the shadow if displayed (defaults to 4). Note that this +option only applies when floating = true.
    Panel shim : Boolean
    false to disable the iframe shim in browsers which need one (defaults to true). +Note that this option only applies wh...
    false to disable the iframe shim in browsers which need one (defaults to true). +Note that this option only applies when floating = true.
    Panel 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). stateEvents may be any type of event supported by this component, including browser or custom events @@ -982,10 +1043,11 @@ tabs. If you change the margin in CSS, you will need to update this value so cal with either resizeTabs or scrolling tabs. (defaults to 2)

    TabPanel tabPosition : String
    The position where the tab strip should be rendered (defaults to 'top'). The only other supported value is 'bottom'. ...
    The position where the tab strip should be rendered (defaults to 'top'). The only other supported value is 'bottom'. Note: tab scrolling is only supported for -tabPosition: 'top'.
    TabPanel tabTip : String
    A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over -the tab of a Ext.Pan...
    A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over -the tab of a Ext.Panel which is an item of a Ext.TabPanel. Ext.QuickTips.init() -must be called in order for the tips to render.
    Panel tabWidth : Number
    The initial width in pixels of each new tab (defaults to 120).
    TabPanel tbar : Object/Array
    The top toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of +tabPosition: 'top'.
    TabPanel 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 tabWidth : Number
    The initial width in pixels of each new tab (defaults to 120).
    TabPanel 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.

    @@ -994,15 +1056,24 @@ 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.

    Panel tbarCfg : Object
    A DomHelper element specification object specifying the element structure of this Panel's tbar Element. See bodyCfg ...

    A DomHelper element specification object specifying the element structure -of this Panel's tbar Element. See bodyCfg also.

    Panel title : String
    The title text to be used as innerHTML (html tags are accepted) to display in the panel +of this Panel's tbar Element. See bodyCfg also.

    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 unstyled : Boolean
    Overrides the baseCls setting to baseCls = 'x-plain' which renders -the panel unstyled except for required attributes ...
    Overrides the baseCls setting to baseCls = 'x-plain' which renders +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 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 Ext.Template, Ext.XTemplate +or an array of strings to form an Ext.XTemplate. +Used in conjunction with the data and +tplWriteMode configurations.
    Component tplWriteMode : 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 unstyled : Boolean
    Overrides the baseCls setting to baseCls = 'x-plain' which renders +the panel unstyled except for required attributes ...
    Overrides the baseCls setting to baseCls = 'x-plain' which renders the panel unstyled except for required attributes for Ext layouts to function (e.g. overflow:hidden).
    Panel wheelIncrement : Number
    For scrolling tabs, the number of pixels to increment on mouse wheel scrolling (defaults to 20).
    TabPanel width : Number
    The width of this component in pixels (defaults to auto). Note to express this dimension as a percentage or offset se...
    The width of this component in pixels (defaults to auto). @@ -1026,7 +1097,7 @@ 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 el also.

    Panel buttons : Array
    This Panel's Array of buttons as created from the buttons +

    Note: see the Note for el also.

    Panel buttons : Array
    This Panel's Array of buttons as created from the buttons config property. Read only.
    Panel bwrap : Ext.Element
    The Panel's bwrap Element used to contain other Panel elements (tbar, body, bbar, footer). See bodyCfg. Read-only.
    Panel collapsed : Boolean
    True if this panel is collapsed. Read-only.
    Panel dd : Ext.dd.DragSource.
    If this Panel is configured draggable, this property will contain an instance of Ext.dd.DragSource which handles drag...

    If this Panel is configured draggable, this property will contain @@ -1052,18 +1123,20 @@ config for a suggestion, or use a render listener directly:

    new
 
    See also getEl
    Component footer : Ext.Element
    The Panel's footer Element. Read-only. This Element is used to house the Panel's buttons or fbar. Note: see the Note ...
    The Panel's footer Element. Read-only. -

    This Element is used to house the Panel's buttons or fbar.

    -

    Note: see the Note for el also.

    Panel 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
    The component's owner Ext.Container (defaults to undefined, and is set automatically when -the component is added to a...
    The component's owner Ext.Container (defaults to undefined, and is set automatically when -the component is added to a container). Read-only. -

    Note: to access items within the container see itemId.

    Component rendered : Boolean
    True if this component has been rendered. Read-only.
    Component

    Public Methods

    MethodDefined By
     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
     rendered : Boolean
    True if this component has been rendered. Read-only.
    		Component

    Public Methods

    MethodDefined By

    Public Events

    EventDefined By