Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / source / Tip3.html
1 <!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'>/**
2 </span></span> * @class Ext.tip.Tip
3  * @extends Ext.panel.Panel
4  * This is the base class for {@link Ext.tip.QuickTip} and {@link Ext.tip.ToolTip} that provides the basic layout and
5  * positioning that all tip-based classes require. This class can be used directly for simple, statically-positioned
6  * tips that are displayed programmatically, or it can be extended to provide custom tip implementations.
7  * @constructor
8  * Create a new Tip
9  * @param {Object} config The configuration options
10  * @xtype tip
11  */
12 Ext.define('Ext.tip.Tip', {
13     extend: 'Ext.panel.Panel',
14     requires: [ 'Ext.layout.component.Tip' ],
15     alternateClassName: 'Ext.Tip',
16 <span id='Ext-tip.Tip-cfg-closable'>    /**
17 </span>     * @cfg {Boolean} closable True to render a close tool button into the tooltip header (defaults to false).
18      */
19 <span id='Ext-tip.Tip-cfg-width'>    /**
20 </span>     * @cfg {Number} width
21      * Width in pixels of the tip (defaults to auto).  Width will be ignored if it exceeds the bounds of
22      * {@link #minWidth} or {@link #maxWidth}.  The maximum supported value is 500.
23      */
24 <span id='Ext-tip.Tip-cfg-minWidth'>    /**
25 </span>     * @cfg {Number} minWidth The minimum width of the tip in pixels (defaults to 40).
26      */
27     minWidth : 40,
28 <span id='Ext-tip.Tip-cfg-maxWidth'>    /**
29 </span>     * @cfg {Number} maxWidth The maximum width of the tip in pixels (defaults to 300).  The maximum supported value is 500.
30      */
31     maxWidth : 300,
32 <span id='Ext-tip.Tip-cfg-shadow'>    /**
33 </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;
34      * for bottom-right shadow (defaults to &quot;sides&quot;).
35      */
36     shadow : &quot;sides&quot;,
37
38 <span id='Ext-tip.Tip-cfg-defaultAlign'>    /**
39 </span>     * @cfg {String} defaultAlign &lt;b&gt;Experimental&lt;/b&gt;. The default {@link Ext.core.Element#alignTo} anchor position value
40      * for this tip relative to its element of origin (defaults to &quot;tl-bl?&quot;).
41      */
42     defaultAlign : &quot;tl-bl?&quot;,
43 <span id='Ext-tip.Tip-cfg-constrainPosition'>    /**
44 </span>     * @cfg {Boolean} constrainPosition If true, then the tooltip will be automatically constrained to stay within
45      * the browser viewport. Defaults to false.
46      */
47     constrainPosition : true,
48
49 <span id='Ext-tip.Tip-property-frame'>    /**
50 </span>     * @inherited
51      */
52     frame: false,
53
54     // private panel overrides
55     autoRender: true,
56     hidden: true,
57     baseCls: Ext.baseCSSPrefix + 'tip',
58     floating: {
59         shadow: true,
60         shim: true,
61         constrain: true
62     },
63     focusOnToFront: false,
64     componentLayout: 'tip',
65
66     closeAction: 'hide',
67
68     ariaRole: 'tooltip',
69
70     initComponent: function() {
71         this.callParent(arguments);
72
73         // Or in the deprecated config. Floating.doConstrain only constrains if the constrain property is truthy.
74         this.constrain = this.constrain || this.constrainPosition;
75     },
76
77 <span id='Ext-tip.Tip-method-showAt'>    /**
78 </span>     * Shows this tip at the specified XY position.  Example usage:
79      * &lt;pre&gt;&lt;code&gt;
80 // Show the tip at x:50 and y:100
81 tip.showAt([50,100]);
82 &lt;/code&gt;&lt;/pre&gt;
83      * @param {Array} xy An array containing the x and y coordinates
84      */
85     showAt : function(xy){
86         var me = this;
87         this.callParent();
88         // Show may have been vetoed.
89         if (me.isVisible()) {
90             me.setPagePosition(xy[0], xy[1]);
91             if (me.constrainPosition || me.constrain) {
92                 me.doConstrain();
93             }
94             me.toFront(true);
95         }
96     },
97
98 <span id='Ext-tip.Tip-method-showBy'>    /**
99 </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}
100      * anchor position value.  Example usage:
101      * &lt;pre&gt;&lt;code&gt;
102 // Show the tip at the default position ('tl-br?')
103 tip.showBy('my-el');
104
105 // Show the tip's top-left corner anchored to the element's top-right corner
106 tip.showBy('my-el', 'tl-tr');
107 &lt;/code&gt;&lt;/pre&gt;
108      * @param {Mixed} el An HTMLElement, Ext.core.Element or string id of the target element to align to
109      * @param {String} position (optional) A valid {@link Ext.core.Element#alignTo} anchor position (defaults to 'tl-br?' or
110      * {@link #defaultAlign} if specified).
111      */
112     showBy : function(el, pos) {
113         this.showAt(this.el.getAlignToXY(el, pos || this.defaultAlign));
114     },
115
116 <span id='Ext-tip.Tip-method-initDraggable'>    /**
117 </span>     * @private
118      * @override
119      * Set Tip draggable using base Component's draggability
120      */
121     initDraggable : function(){
122         var me = this;
123         me.draggable = {
124             el: me.getDragEl(),
125             delegate: me.header.el,
126             constrain: me,
127             constrainTo: me.el.dom.parentNode
128         };
129         // Important: Bypass Panel's initDraggable. Call direct to Component's implementation.
130         Ext.Component.prototype.initDraggable.call(me);
131     },
132
133     // Tip does not ghost. Drag is &quot;live&quot;
134     ghost: undefined,
135     unghost: undefined
136 });
137 </pre></pre></body></html>