Upgrade to ExtJS 4.0.2 - Released 06/09/2011
[extjs.git] / docs / source / Tip3.html
index d1d06dc..1cfc7bf 100644 (file)
@@ -1,52 +1,66 @@
-<!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-tip.Tip-method-constructor'><span id='Ext-tip.Tip'>/**
-</span></span> * @class Ext.tip.Tip
+<!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-tip-Tip'>/**
+</span> * @class Ext.tip.Tip
  * @extends Ext.panel.Panel
  * This is the base class for {@link Ext.tip.QuickTip} and {@link Ext.tip.ToolTip} that provides the basic layout and
  * positioning that all tip-based classes require. This class can be used directly for simple, statically-positioned
  * tips that are displayed programmatically, or it can be extended to provide custom tip implementations.
- * @constructor
- * Create a new Tip
- * @param {Object} config The configuration options
  * @xtype tip
  */
 Ext.define('Ext.tip.Tip', {
     extend: 'Ext.panel.Panel',
     requires: [ 'Ext.layout.component.Tip' ],
     alternateClassName: 'Ext.Tip',
-<span id='Ext-tip.Tip-cfg-closable'>    /**
+<span id='Ext-tip-Tip-cfg-closable'>    /**
 </span>     * @cfg {Boolean} closable True to render a close tool button into the tooltip header (defaults to false).
      */
-<span id='Ext-tip.Tip-cfg-width'>    /**
+<span id='Ext-tip-Tip-cfg-width'>    /**
 </span>     * @cfg {Number} width
      * Width in pixels of the tip (defaults to auto).  Width will be ignored if it exceeds the bounds of
      * {@link #minWidth} or {@link #maxWidth}.  The maximum supported value is 500.
      */
-<span id='Ext-tip.Tip-cfg-minWidth'>    /**
+<span id='Ext-tip-Tip-cfg-minWidth'>    /**
 </span>     * @cfg {Number} minWidth The minimum width of the tip in pixels (defaults to 40).
      */
     minWidth : 40,
-<span id='Ext-tip.Tip-cfg-maxWidth'>    /**
+<span id='Ext-tip-Tip-cfg-maxWidth'>    /**
 </span>     * @cfg {Number} maxWidth The maximum width of the tip in pixels (defaults to 300).  The maximum supported value is 500.
      */
     maxWidth : 300,
-<span id='Ext-tip.Tip-cfg-shadow'>    /**
+<span id='Ext-tip-Tip-cfg-shadow'>    /**
 </span>     * @cfg {Boolean/String} shadow True or &quot;sides&quot; for the default effect, &quot;frame&quot; for 4-way shadow, and &quot;drop&quot;
      * for bottom-right shadow (defaults to &quot;sides&quot;).
      */
     shadow : &quot;sides&quot;,
 
-<span id='Ext-tip.Tip-cfg-defaultAlign'>    /**
+<span id='Ext-tip-Tip-cfg-defaultAlign'>    /**
 </span>     * @cfg {String} defaultAlign &lt;b&gt;Experimental&lt;/b&gt;. The default {@link Ext.core.Element#alignTo} anchor position value
      * for this tip relative to its element of origin (defaults to &quot;tl-bl?&quot;).
      */
     defaultAlign : &quot;tl-bl?&quot;,
-<span id='Ext-tip.Tip-cfg-constrainPosition'>    /**
+<span id='Ext-tip-Tip-cfg-constrainPosition'>    /**
 </span>     * @cfg {Boolean} constrainPosition If true, then the tooltip will be automatically constrained to stay within
      * the browser viewport. Defaults to false.
      */
     constrainPosition : true,
 
-<span id='Ext-tip.Tip-property-frame'>    /**
+<span id='Ext-tip-Tip-property-frame'>    /**
 </span>     * @inherited
      */
     frame: false,
@@ -63,6 +77,23 @@ Ext.define('Ext.tip.Tip', {
     focusOnToFront: false,
     componentLayout: 'tip',
 
+<span id='Ext-tip-Tip-cfg-closeAction'>    /**
+</span>     * @cfg {String} closeAction
+     * &lt;p&gt;The action to take when the close header tool is clicked:
+     * &lt;div class=&quot;mdetail-params&quot;&gt;&lt;ul&gt;
+     * &lt;li&gt;&lt;b&gt;&lt;code&gt;'{@link #destroy}'&lt;/code&gt;&lt;/b&gt; : &lt;div class=&quot;sub-desc&quot;&gt;
+     * {@link #destroy remove} the window from the DOM and {@link Ext.Component#destroy destroy}
+     * it and all descendant Components. The window will &lt;b&gt;not&lt;/b&gt; be available to be
+     * redisplayed via the {@link #show} method.
+     * &lt;/div&gt;&lt;/li&gt;
+     * &lt;li&gt;&lt;b&gt;&lt;code&gt;'{@link #hide}'&lt;/code&gt;&lt;/b&gt; : &lt;b&gt;Default&lt;/b&gt;&lt;div class=&quot;sub-desc&quot;&gt;
+     * {@link #hide} the window by setting visibility to hidden and applying negative offsets.
+     * The window will be available to be redisplayed via the {@link #show} method.
+     * &lt;/div&gt;&lt;/li&gt;
+     * &lt;/ul&gt;&lt;/div&gt;
+     * &lt;p&gt;&lt;b&gt;Note:&lt;/b&gt; This behavior has changed! setting *does* affect the {@link #close} method
+     * which will invoke the approriate closeAction.
+     */
     closeAction: 'hide',
 
     ariaRole: 'tooltip',
@@ -74,7 +105,7 @@ Ext.define('Ext.tip.Tip', {
         this.constrain = this.constrain || this.constrainPosition;
     },
 
-<span id='Ext-tip.Tip-method-showAt'>    /**
+<span id='Ext-tip-Tip-method-showAt'>    /**
 </span>     * Shows this tip at the specified XY position.  Example usage:
      * &lt;pre&gt;&lt;code&gt;
 // Show the tip at x:50 and y:100
@@ -95,7 +126,7 @@ tip.showAt([50,100]);
         }
     },
 
-<span id='Ext-tip.Tip-method-showBy'>    /**
+<span id='Ext-tip-Tip-method-showBy'>    /**
 </span>     * &lt;b&gt;Experimental&lt;/b&gt;. Shows this tip at a position relative to another element using a standard {@link Ext.core.Element#alignTo}
      * anchor position value.  Example usage:
      * &lt;pre&gt;&lt;code&gt;
@@ -113,7 +144,7 @@ tip.showBy('my-el', 'tl-tr');
         this.showAt(this.el.getAlignToXY(el, pos || this.defaultAlign));
     },
 
-<span id='Ext-tip.Tip-method-initDraggable'>    /**
+<span id='Ext-tip-Tip-method-initDraggable'>    /**
 </span>     * @private
      * @override
      * Set Tip draggable using base Component's draggability
@@ -134,4 +165,6 @@ tip.showBy('my-el', 'tl-tr');
     ghost: undefined,
     unghost: undefined
 });
-</pre></pre></body></html>
\ No newline at end of file
+</pre>
+</body>
+</html>