git.ithinksw.org / extjs.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / Tip3.html
diff --git a/docs/source/Tip3.html b/docs/source/Tip3.html
index d1d06dc..40df377 100644 (file)
--- a/docs/source/Tip3.html
+++ b/docs/source/Tip3.html
@@ -1,54 +1,68 @@
-<!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="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../resources/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.
  * @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',
  * @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>     * @cfg {Boolean} closable True to render a close tool button into the tooltip header (defaults to false).
+<span id='Ext-tip-Tip-cfg-closable'>    /**
+</span>     * @cfg {Boolean} [closable=false]
+     * True to render a close tool button into the tooltip header.
      */
      */
-<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>     * @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>     * @cfg {Number} minWidth The minimum width of the tip in pixels (defaults to 40).
+<span id='Ext-tip-Tip-cfg-minWidth'>    /**
+</span>     * @cfg {Number} minWidth The minimum width of the tip in pixels.
      */
     minWidth : 40,
      */
     minWidth : 40,
-<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.
+<span id='Ext-tip-Tip-cfg-maxWidth'>    /**
+</span>     * @cfg {Number} maxWidth The maximum width of the tip in pixels.  The maximum supported value is 500.
      */
     maxWidth : 300,
      */
     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;
 </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;).
+     * for bottom-right shadow.
      */
     shadow : &quot;sides&quot;,
 
      */
     shadow : &quot;sides&quot;,
 
-<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;).
+<span id='Ext-tip-Tip-cfg-defaultAlign'>    /**
+</span>     * @cfg {String} defaultAlign
+     * &lt;b&gt;Experimental&lt;/b&gt;. The default {@link Ext.Element#alignTo} anchor position value for this tip relative
+     * to its element of origin.
      */
     defaultAlign : &quot;tl-bl?&quot;,
      */
     defaultAlign : &quot;tl-bl?&quot;,
-<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.
+<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.
      */
     constrainPosition : true,
 
      */
     constrainPosition : true,
 
-<span id='Ext-tip.Tip-property-frame'>    /**
-</span>     * @inherited
-     */
+    // @inherited
     frame: false,
 
     // private panel overrides
     frame: false,
 
     // private panel overrides
@@ -63,28 +77,48 @@ Ext.define('Ext.tip.Tip', {
     focusOnToFront: false,
     componentLayout: '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',
 
     initComponent: function() {
     closeAction: 'hide',
 
     ariaRole: 'tooltip',
 
     initComponent: function() {
-        this.callParent(arguments);
+        var me = this;
+
+        me.floating = Ext.apply({}, {shadow: me.shadow}, me.self.prototype.floating);
+        me.callParent(arguments);
 
         // Or in the deprecated config. Floating.doConstrain only constrains if the constrain property is truthy.
 
         // Or in the deprecated config. Floating.doConstrain only constrains if the constrain property is truthy.
-        this.constrain = this.constrain || this.constrainPosition;
+        me.constrain = me.constrain || me.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
 tip.showAt([50,100]);
 &lt;/code&gt;&lt;/pre&gt;
 </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
 tip.showAt([50,100]);
 &lt;/code&gt;&lt;/pre&gt;
-     * @param {Array} xy An array containing the x and y coordinates
+     * @param {Number[]} xy An array containing the x and y coordinates
      */
     showAt : function(xy){
         var me = this;
      */
     showAt : function(xy){
         var me = this;
-        this.callParent();
+        this.callParent(arguments);
         // Show may have been vetoed.
         if (me.isVisible()) {
             me.setPagePosition(xy[0], xy[1]);
         // Show may have been vetoed.
         if (me.isVisible()) {
             me.setPagePosition(xy[0], xy[1]);
@@ -95,8 +129,8 @@ tip.showAt([50,100]);
         }
     },
 
         }
     },
 
-<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}
+<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.Element#alignTo}
      * anchor position value.  Example usage:
      * &lt;pre&gt;&lt;code&gt;
 // Show the tip at the default position ('tl-br?')
      * anchor position value.  Example usage:
      * &lt;pre&gt;&lt;code&gt;
 // Show the tip at the default position ('tl-br?')
@@ -105,15 +139,15 @@ tip.showBy('my-el');
 // Show the tip's top-left corner anchored to the element's top-right corner
 tip.showBy('my-el', 'tl-tr');
 &lt;/code&gt;&lt;/pre&gt;
 // Show the tip's top-left corner anchored to the element's top-right corner
 tip.showBy('my-el', 'tl-tr');
 &lt;/code&gt;&lt;/pre&gt;
-     * @param {Mixed} el An HTMLElement, Ext.core.Element or string id of the target element to align to
-     * @param {String} position (optional) A valid {@link Ext.core.Element#alignTo} anchor position (defaults to 'tl-br?' or
+     * @param {String/HTMLElement/Ext.Element} el An HTMLElement, Ext.Element or string id of the target element to align to
+     * @param {String} [position] A valid {@link Ext.Element#alignTo} anchor position (defaults to 'tl-br?' or
      * {@link #defaultAlign} if specified).
      */
     showBy : function(el, pos) {
         this.showAt(this.el.getAlignToXY(el, pos || this.defaultAlign));
     },
 
      * {@link #defaultAlign} if specified).
      */
     showBy : function(el, pos) {
         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
 </span>     * @private
      * @override
      * Set Tip draggable using base Component's draggability
@@ -124,7 +158,7 @@ tip.showBy('my-el', 'tl-tr');
             el: me.getDragEl(),
             delegate: me.header.el,
             constrain: me,
             el: me.getDragEl(),
             delegate: me.header.el,
             constrain: me,
-            constrainTo: me.el.dom.parentNode
+            constrainTo: me.el.getScopeParent()
         };
         // Important: Bypass Panel's initDraggable. Call direct to Component's implementation.
         Ext.Component.prototype.initDraggable.call(me);
         };
         // Important: Bypass Panel's initDraggable. Call direct to Component's implementation.
         Ext.Component.prototype.initDraggable.call(me);
@@ -134,4 +168,6 @@ tip.showBy('my-el', 'tl-tr');
     ghost: undefined,
     unghost: undefined
 });
     ghost: undefined,
     unghost: undefined
 });
-</pre></pre></body></html>
\ No newline at end of file
+</pre>
+</body>
+</html>
Mirror of ExtJS by Sencha Inc. <http://www.sencha.com/>.