Upgrade to ExtJS 4.0.2 - Released 06/09/2011
[extjs.git] / docs / source / AbstractCard.html
index 8250bba..a4c7aff 100644 (file)
@@ -1,30 +1,45 @@
-<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-layout.container.AbstractCard'>/**
-</span> * @class Ext.layout.container.AbstractCard
- * @extends Ext.layout.container.Fit
- * &lt;p&gt;This layout manages multiple child Components, each is fit to the Container, where only a single child Component
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>The source code</title>
+  <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../prettify/prettify.js"></script>
+  <style type="text/css">
+    .highlight { display: block; background-color: #ddd; }
+  </style>
+  <script type="text/javascript">
+    function highlight() {
+      document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+    }
+  </script>
+</head>
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js"><span id='Ext-layout-container-AbstractCard'>/**
+</span> * This layout manages multiple child Components, each is fit to the Container, where only a single child Component
  * can be visible at any given time.  This layout style is most commonly used for wizards, tab implementations, etc.
  * This class is intended to be extended or created via the layout:'card' {@link Ext.container.Container#layout} config,
- * and should generally not need to be created directly via the new keyword.&lt;/p&gt;
- * &lt;p&gt;The CardLayout's focal method is {@link #setActiveItem}.  Since only one panel is displayed at a time,
+ * and should generally not need to be created directly via the new keyword.
+ *
+ * The CardLayout's focal method is {@link #setActiveItem}.  Since only one panel is displayed at a time,
  * the only way to move from one Component to the next is by calling setActiveItem, passing the id or index of
  * the next panel to display.  The layout itself does not provide a user interface for handling this navigation,
- * so that functionality must be provided by the developer.&lt;/p&gt;
- * &lt;p&gt;Containers that are configured with a card layout will have a method setActiveItem dynamically added to it.
- * &lt;pre&gt;&lt;code&gt;
-      var p = new Ext.panel.Panel({
-          fullscreen: true,
         layout: 'card',
-          items: [{
-              html: 'Card 1'
-          },{
-              html: 'Card 2'
-          }]
-      });
     p.setActiveItem(1);
  &lt;/code&gt;&lt;/pre&gt;
- * &lt;/p&gt;
+ * so that functionality must be provided by the developer.
+ *
+ * Containers that are configured with a card layout will have a method setActiveItem dynamically added to it.
+ *
+ *     var p = new Ext.panel.Panel({
*         fullscreen: true,
+ *         layout: 'card',
+ *         items: [{
+ *             html: 'Card 1'
+ *         },{
+ *             html: 'Card 2'
+ *         }]
*     });
*     p.setActiveItem(1);
+ *
  */
-
 Ext.define('Ext.layout.container.AbstractCard', {
 
     /* Begin Definitions */
@@ -39,7 +54,7 @@ Ext.define('Ext.layout.container.AbstractCard', {
 
     hideInactive: true,
 
-<span id='Ext-layout.container.AbstractCard-cfg-deferredRender'>    /**
+<span id='Ext-layout-container-AbstractCard-cfg-deferredRender'>    /**
 </span>     * @cfg {Boolean} deferredRender
      * True to render each contained item at the time it becomes active, false to render all contained items
      * as soon as the layout is rendered (defaults to false).  If there is a significant amount of content or
@@ -88,7 +103,7 @@ Ext.define('Ext.layout.container.AbstractCard', {
         return (itemEl &amp;&amp; itemEl.parentNode === (target.dom || target)) || false;
     },
 
-<span id='Ext-layout.container.AbstractCard-method-getActiveItem'>    /**
+<span id='Ext-layout-container-AbstractCard-method-getActiveItem'>    /**
 </span>     * Return the active (visible) component in the layout.
      * @returns {Ext.Component}
      */
@@ -147,50 +162,54 @@ Ext.define('Ext.layout.container.AbstractCard', {
         return newAnim || owner.cardSwitchAnimation;
     },
 
-<span id='Ext-layout.container.AbstractCard-method-getNext'>    /**
+<span id='Ext-layout-container-AbstractCard-method-getNext'>    /**
 </span>     * Return the active (visible) component in the layout to the next card
-     * @returns {Ext.Component}
+     * @returns {Ext.Component} The next component or false.
      */
-    getNext: function(wrap) {
+    getNext: function() {
         //NOTE: Removed the JSDoc for this function's arguments because it is not actually supported in 4.0. This 
         //should come back in 4.1
-        
+        var wrap = arguments[0];
         var items = this.getLayoutItems(),
             index = Ext.Array.indexOf(items, this.activeItem);
         return items[index + 1] || (wrap ? items[0] : false);
     },
 
-<span id='Ext-layout.container.AbstractCard-method-next'>    /**
+<span id='Ext-layout-container-AbstractCard-method-next'>    /**
 </span>     * Sets the active (visible) component in the layout to the next card
+     * @return {Ext.Component} the activated component or false when nothing activated.
      */
-    next: function(anim, wrap) {
+    next: function() {
         //NOTE: Removed the JSDoc for this function's arguments because it is not actually supported in 4.0. This 
         //should come back in 4.1
-        
+        var anim = arguments[0], wrap = arguments[1];
         return this.setActiveItem(this.getNext(wrap), anim);
     },
 
-<span id='Ext-layout.container.AbstractCard-method-getPrev'>    /**
+<span id='Ext-layout-container-AbstractCard-method-getPrev'>    /**
 </span>     * Return the active (visible) component in the layout to the previous card
-     * @returns {Ext.Component}
+     * @returns {Ext.Component} The previous component or false.
      */
-    getPrev: function(wrap) {
+    getPrev: function() {
         //NOTE: Removed the JSDoc for this function's arguments because it is not actually supported in 4.0. This 
         //should come back in 4.1
-        
+        var wrap = arguments[0];
         var items = this.getLayoutItems(),
             index = Ext.Array.indexOf(items, this.activeItem);
         return items[index - 1] || (wrap ? items[items.length - 1] : false);
     },
 
-<span id='Ext-layout.container.AbstractCard-method-prev'>    /**
+<span id='Ext-layout-container-AbstractCard-method-prev'>    /**
 </span>     * Sets the active (visible) component in the layout to the previous card
+     * @return {Ext.Component} the activated component or false when nothing activated.
      */
-    prev: function(anim, wrap) {
+    prev: function() {
         //NOTE: Removed the JSDoc for this function's arguments because it is not actually supported in 4.0. This 
         //should come back in 4.1
-        
+        var anim = arguments[0], wrap = arguments[1];
         return this.setActiveItem(this.getPrev(wrap), anim);
     }
 });
-</pre></pre></body></html>
\ No newline at end of file
+</pre>
+</body>
+</html>