/**
+ * @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',
- /**
- * @cfg {Boolean} closable True to render a close tool button into the tooltip header (defaults to false).
+ /**
+ * @cfg {Boolean} [closable=false]
+ * True to render a close tool button into the tooltip header.
*/
- /**
+ /**
* @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.
*/
- /**
- * @cfg {Number} minWidth The minimum width of the tip in pixels (defaults to 40).
+ /**
+ * @cfg {Number} minWidth The minimum width of the tip in pixels.
*/
minWidth : 40,
- /**
- * @cfg {Number} maxWidth The maximum width of the tip in pixels (defaults to 300). The maximum supported value is 500.
+ /**
+ * @cfg {Number} maxWidth The maximum width of the tip in pixels. The maximum supported value is 500.
*/
maxWidth : 300,
- /**
+ /**
* @cfg {Boolean/String} shadow True or "sides" for the default effect, "frame" for 4-way shadow, and "drop"
- * for bottom-right shadow (defaults to "sides").
+ * for bottom-right shadow.
*/
shadow : "sides",
- /**
- * @cfg {String} defaultAlign <b>Experimental</b>. The default {@link Ext.core.Element#alignTo} anchor position value
- * for this tip relative to its element of origin (defaults to "tl-bl?").
+ /**
+ * @cfg {String} defaultAlign
+ * <b>Experimental</b>. The default {@link Ext.Element#alignTo} anchor position value for this tip relative
+ * to its element of origin.
*/
defaultAlign : "tl-bl?",
- /**
- * @cfg {Boolean} constrainPosition If true, then the tooltip will be automatically constrained to stay within
- * the browser viewport. Defaults to false.
+ /**
+ * @cfg {Boolean} constrainPosition
+ * If true, then the tooltip will be automatically constrained to stay within the browser viewport.
*/
constrainPosition : true,
- /**
- * @inherited
- */
+ // @inherited
frame: false,
// private panel overrides
@@ -63,28 +77,48 @@ Ext.define('Ext.tip.Tip', {
focusOnToFront: false,
componentLayout: 'tip',
+ /**
+ * @cfg {String} closeAction
+ * <p>The action to take when the close header tool is clicked:
+ * <div class="mdetail-params"><ul>
+ * <li><b><code>'{@link #destroy}'</code></b> : <div class="sub-desc">
+ * {@link #destroy remove} the window from the DOM and {@link Ext.Component#destroy destroy}
+ * it and all descendant Components. The window will <b>not</b> be available to be
+ * redisplayed via the {@link #show} method.
+ * </div></li>
+ * <li><b><code>'{@link #hide}'</code></b> : <b>Default</b><div class="sub-desc">
+ * {@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.
+ * </div></li>
+ * </ul></div>
+ * <p><b>Note:</b> This behavior has changed! setting *does* affect the {@link #close} method
+ * which will invoke the approriate closeAction.
+ */
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.
- this.constrain = this.constrain || this.constrainPosition;
+ me.constrain = me.constrain || me.constrainPosition;
},
- /**
+ /**
* Shows this tip at the specified XY position. Example usage:
* <pre><code>
// Show the tip at x:50 and y:100
tip.showAt([50,100]);
</code></pre>
- * @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;
- this.callParent();
+ this.callParent(arguments);
// Show may have been vetoed.
if (me.isVisible()) {
me.setPagePosition(xy[0], xy[1]);
@@ -95,8 +129,8 @@ tip.showAt([50,100]);
}
},
- /**
- * <b>Experimental</b>. Shows this tip at a position relative to another element using a standard {@link Ext.core.Element#alignTo}
+ /**
+ * <b>Experimental</b>. Shows this tip at a position relative to another element using a standard {@link Ext.Element#alignTo}
* anchor position value. Example usage:
* <pre><code>
// 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');
</code></pre>
- * @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));
},
- /**
+ /**
* @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,
- 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);
@@ -134,4 +168,6 @@ tip.showBy('my-el', 'tl-tr');
ghost: undefined,
unghost: undefined
});
-