Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / docs / source / CardLayout.html
diff --git a/docs/source/CardLayout.html b/docs/source/CardLayout.html
new file mode 100644 (file)
index 0000000..5ee808f
--- /dev/null
@@ -0,0 +1,130 @@
+<html>\r
+<head>\r
+  <title>The source code</title>\r
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
+</head>\r
+<body  onload="prettyPrint();">\r
+    <pre class="prettyprint lang-js"><div id="cls-Ext.layout.CardLayout"></div>/**\r
+ * @class Ext.layout.CardLayout\r
+ * @extends Ext.layout.FitLayout\r
+ * <p>This layout manages multiple child Components, each fitted to the Container, where only a single child Component can be\r
+ * visible at any given time.  This layout style is most commonly used for wizards, tab implementations, etc.\r
+ * This class is intended to be extended or created via the layout:'card' {@link Ext.Container#layout} config,\r
+ * and should generally not need to be created directly via the new keyword.</p>\r
+ * <p>The CardLayout's focal method is {@link #setActiveItem}.  Since only one panel is displayed at a time,\r
+ * the only way to move from one Component to the next is by calling setActiveItem, passing the id or index of\r
+ * the next panel to display.  The layout itself does not provide a user interface for handling this navigation,\r
+ * so that functionality must be provided by the developer.</p>\r
+ * <p>In the following example, a simplistic wizard setup is demonstrated.  A button bar is added\r
+ * to the footer of the containing panel to provide navigation buttons.  The buttons will be handled by a\r
+ * common navigation routine -- for this example, the implementation of that routine has been ommitted since\r
+ * it can be any type of custom logic.  Note that other uses of a CardLayout (like a tab control) would require a\r
+ * completely different implementation.  For serious implementations, a better approach would be to extend\r
+ * CardLayout to provide the custom functionality needed.  Example usage:</p>\r
+ * <pre><code>\r
+var navHandler = function(direction){\r
+    // This routine could contain business logic required to manage the navigation steps.\r
+    // It would call setActiveItem as needed, manage navigation button state, handle any\r
+    // branching logic that might be required, handle alternate actions like cancellation\r
+    // or finalization, etc.  A complete wizard implementation could get pretty\r
+    // sophisticated depending on the complexity required, and should probably be\r
+    // done as a subclass of CardLayout in a real-world implementation.\r
+};\r
+\r
+var card = new Ext.Panel({\r
+    title: 'Example Wizard',\r
+    layout:'card',\r
+    activeItem: 0, // make sure the active item is set on the container config!\r
+    bodyStyle: 'padding:15px',\r
+    defaults: {\r
+        // applied to each contained panel\r
+        border:false\r
+    },\r
+    // just an example of one possible navigation scheme, using buttons\r
+    bbar: [\r
+        {\r
+            id: 'move-prev',\r
+            text: 'Back',\r
+            handler: navHandler.createDelegate(this, [-1]),\r
+            disabled: true\r
+        },\r
+        '->', // greedy spacer so that the buttons are aligned to each side\r
+        {\r
+            id: 'move-next',\r
+            text: 'Next',\r
+            handler: navHandler.createDelegate(this, [1])\r
+        }\r
+    ],\r
+    // the panels (or "cards") within the layout\r
+    items: [{\r
+        id: 'card-0',\r
+        html: '&lt;h1&gt;Welcome to the Wizard!&lt;/h1&gt;&lt;p&gt;Step 1 of 3&lt;/p&gt;'\r
+    },{\r
+        id: 'card-1',\r
+        html: '&lt;p&gt;Step 2 of 3&lt;/p&gt;'\r
+    },{\r
+        id: 'card-2',\r
+        html: '&lt;h1&gt;Congratulations!&lt;/h1&gt;&lt;p&gt;Step 3 of 3 - Complete&lt;/p&gt;'\r
+    }]\r
+});\r
+</code></pre>\r
+ */\r
+Ext.layout.CardLayout = Ext.extend(Ext.layout.FitLayout, {\r
+    <div id="cfg-Ext.layout.CardLayout-deferredRender"></div>/**\r
+     * @cfg {Boolean} deferredRender\r
+     * True to render each contained item at the time it becomes active, false to render all contained items\r
+     * as soon as the layout is rendered (defaults to false).  If there is a significant amount of content or\r
+     * a lot of heavy controls being rendered into panels that are not displayed by default, setting this to\r
+     * true might improve performance.\r
+     */\r
+    deferredRender : false,\r
+    \r
+    <div id="cfg-Ext.layout.CardLayout-layoutOnCardChange"></div>/**\r
+     * @cfg {Boolean} layoutOnCardChange\r
+     * True to force a layout of the active item when the active card is changed. Defaults to false.\r
+     */\r
+    layoutOnCardChange : false,\r
+\r
+    <div id="cfg-Ext.layout.CardLayout-renderHidden"></div>/**\r
+     * @cfg {Boolean} renderHidden @hide\r
+     */\r
+    // private\r
+    renderHidden : true,\r
+    \r
+    constructor: function(config){\r
+        Ext.layout.CardLayout.superclass.constructor.call(this, config);\r
+        this.forceLayout = (this.deferredRender === false);\r
+    },\r
+\r
+    <div id="method-Ext.layout.CardLayout-setActiveItem"></div>/**\r
+     * Sets the active (visible) item in the layout.\r
+     * @param {String/Number} item The string component id or numeric index of the item to activate\r
+     */\r
+    setActiveItem : function(item){\r
+        item = this.container.getComponent(item);\r
+        if(this.activeItem != item){\r
+            if(this.activeItem){\r
+                this.activeItem.hide();\r
+            }\r
+            this.activeItem = item;\r
+            item.show();\r
+            this.container.doLayout();\r
+            if(this.layoutOnCardChange && item.doLayout){\r
+                item.doLayout();\r
+            }\r
+        }\r
+    },\r
+\r
+    // private\r
+    renderAll : function(ct, target){\r
+        if(this.deferredRender){\r
+            this.renderItem(this.activeItem, undefined, target);\r
+        }else{\r
+            Ext.layout.CardLayout.superclass.renderAll.call(this, ct, target);\r
+        }\r
+    }\r
+});\r
+Ext.Container.LAYOUTS['card'] = Ext.layout.CardLayout;</pre>    \r
+</body>\r
+</html>
\ No newline at end of file