Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / docs / source / ToolTip.html
diff --git a/docs/source/ToolTip.html b/docs/source/ToolTip.html
new file mode 100644 (file)
index 0000000..b0cf4ce
--- /dev/null
@@ -0,0 +1,495 @@
+<html>\r
+<head>\r
+  <title>The source code</title>\r
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
+</head>\r
+<body  onload="prettyPrint();">\r
+    <pre class="prettyprint lang-js"><div id="cls-Ext.ToolTip"></div>/**\r
+ * @class Ext.ToolTip\r
+ * @extends Ext.Tip\r
+ * A standard tooltip implementation for providing additional information when hovering over a target element.\r
+ * @constructor\r
+ * Create a new Tooltip\r
+ * @param {Object} config The configuration options\r
+ */\r
+Ext.ToolTip = Ext.extend(Ext.Tip, {\r
+    <div id="prop-Ext.ToolTip-triggerElement"></div>/**\r
+     * When a Tooltip is configured with the {@link #delegate} option to cause selected child elements of the {@link #target}\r
+     * Element to each trigger a seperate show event, this property is set to the DOM element which triggered the show.\r
+     * @type DOMElement\r
+     * @property triggerElement\r
+     */\r
+    <div id="cfg-Ext.ToolTip-target"></div>/**\r
+     * @cfg {Mixed} target The target HTMLElement, Ext.Element or id to monitor for mouseover events to trigger\r
+     * showing this ToolTip.\r
+     */\r
+    <div id="cfg-Ext.ToolTip-autoHide"></div>/**\r
+     * @cfg {Boolean} autoHide True to automatically hide the tooltip after the mouse exits the target element\r
+     * or after the {@link #dismissDelay} has expired if set (defaults to true).  If {@link closable} = true a close\r
+     * tool button will be rendered into the tooltip header.\r
+     */\r
+    <div id="cfg-Ext.ToolTip-showDelay"></div>/**\r
+     * @cfg {Number} showDelay Delay in milliseconds before the tooltip displays after the mouse enters the\r
+     * target element (defaults to 500)\r
+     */\r
+    showDelay: 500,\r
+    <div id="cfg-Ext.ToolTip-hideDelay"></div>/**\r
+     * @cfg {Number} hideDelay Delay in milliseconds after the mouse exits the target element but before the\r
+     * tooltip actually hides (defaults to 200).  Set to 0 for the tooltip to hide immediately.\r
+     */\r
+    hideDelay: 200,\r
+    <div id="cfg-Ext.ToolTip-dismissDelay"></div>/**\r
+     * @cfg {Number} dismissDelay Delay in milliseconds before the tooltip automatically hides (defaults to 5000).\r
+     * To disable automatic hiding, set dismissDelay = 0.\r
+     */\r
+    dismissDelay: 5000,\r
+    <div id="cfg-Ext.ToolTip-mouseOffset"></div>/**\r
+     * @cfg {Array} mouseOffset An XY offset from the mouse position where the tooltip should be shown (defaults to [15,18]).\r
+     */\r
+    <div id="cfg-Ext.ToolTip-trackMouse"></div>/**\r
+     * @cfg {Boolean} trackMouse True to have the tooltip follow the mouse as it moves over the target element (defaults to false).\r
+     */\r
+    trackMouse : false,\r
+    <div id="cfg-Ext.ToolTip-anchorToTarget"></div>/**\r
+     * @cfg {Boolean} anchorToTarget True to anchor the tooltip to the target element, false to\r
+     * anchor it relative to the mouse coordinates (defaults to true).  When anchorToTarget is\r
+     * true, use {@link #defaultAlign} to control tooltip alignment to the target element.  When\r
+     * anchorToTarget is false, use {@link #anchorPosition} instead to control alignment.\r
+     */\r
+    anchorToTarget: true,\r
+    <div id="cfg-Ext.ToolTip-anchorOffset"></div>/**\r
+     * @cfg {Number} anchorOffset A numeric pixel value used to offset the default position of the\r
+     * anchor arrow (defaults to 0).  When the anchor position is on the top or bottom of the tooltip,\r
+     * anchorOffset will be used as a horizontal offset.  Likewise, when the anchor position is on the\r
+     * left or right side, anchorOffset will be used as a vertical offset.\r
+     */\r
+    anchorOffset: 0,\r
+    <div id="cfg-Ext.ToolTip-delegate"></div>/**\r
+     * @cfg {String} delegate <p>Optional. A {@link Ext.DomQuery DomQuery} selector which allows selection of individual elements\r
+     * within the {@link #target} element to trigger showing and hiding the ToolTip as the mouse moves within the target.</p>\r
+     * <p>When specified, the child element of the target which caused a show event is placed into the {@link #triggerElement} property\r
+     * before the ToolTip is shown.</p>\r
+     * <p>This may be useful when a Component has regular, repeating elements in it, each of which need a Tooltip which contains\r
+     * information specific to that element. For example:</p><pre><code>\r
+var myGrid = new Ext.grid.gridPanel(gridConfig);\r
+myGrid.on('render', function(grid) {\r
+    var store = grid.getStore();  // Capture the Store.\r
+    var view = grid.getView();    // Capture the GridView.\r
+    myGrid.tip = new Ext.ToolTip({\r
+        target: view.mainBody,    // The overall target element.\r
+        delegate: '.x-grid3-row', // Each grid row causes its own seperate show and hide.\r
+        trackMouse: true,         // Moving within the row should not hide the tip.\r
+        renderTo: document.body,  // Render immediately so that tip.body can be referenced prior to the first show.\r
+        listeners: {              // Change content dynamically depending on which element triggered the show.\r
+            beforeshow: function updateTipBody(tip) {\r
+                var rowIndex = view.findRowIndex(tip.triggerElement);\r
+                tip.body.dom.innerHTML = "Over Record ID " + store.getAt(rowIndex).id;\r
+            }\r
+        }\r
+    });\r
+});</code></pre>\r
+     */\r
+\r
+    // private\r
+    targetCounter: 0,\r
+\r
+    constrainPosition: false,\r
+\r
+    // private\r
+    initComponent: function(){\r
+        Ext.ToolTip.superclass.initComponent.call(this);\r
+        this.lastActive = new Date();\r
+        this.initTarget(this.target);\r
+        this.origAnchor = this.anchor;\r
+    },\r
+\r
+    // private\r
+    onRender : function(ct, position){\r
+        Ext.ToolTip.superclass.onRender.call(this, ct, position);\r
+        this.anchorCls = 'x-tip-anchor-' + this.getAnchorPosition();\r
+        this.anchorEl = this.el.createChild({\r
+            cls: 'x-tip-anchor ' + this.anchorCls\r
+        });\r
+    },\r
+\r
+    // private\r
+    afterRender : function(){\r
+        Ext.ToolTip.superclass.afterRender.call(this);\r
+        this.anchorEl.setStyle('z-index', this.el.getZIndex() + 1);\r
+    },\r
+\r
+    <div id="method-Ext.ToolTip-initTarget"></div>/**\r
+     * Binds this ToolTip to the specified element. The tooltip will be displayed when the mouse moves over the element.\r
+     * @param {Mixed} t The Element, HtmlElement, or ID of an element to bind to\r
+     */\r
+    initTarget : function(target){\r
+        var t;\r
+        if((t = Ext.get(target))){\r
+            if(this.target){\r
+                this.target = Ext.get(this.target);\r
+                this.target.un('mouseover', this.onTargetOver, this);\r
+                this.target.un('mouseout', this.onTargetOut, this);\r
+                this.target.un('mousemove', this.onMouseMove, this);\r
+            }\r
+            this.mon(t, {\r
+                mouseover: this.onTargetOver,\r
+                mouseout: this.onTargetOut,\r
+                mousemove: this.onMouseMove,\r
+                scope: this\r
+            });\r
+            this.target = t;\r
+        }\r
+        if(this.anchor){\r
+            this.anchorTarget = this.target;\r
+        }\r
+    },\r
+\r
+    // private\r
+    onMouseMove : function(e){\r
+        var t = this.delegate ? e.getTarget(this.delegate) : this.triggerElement = true;\r
+        if (t) {\r
+            this.targetXY = e.getXY();\r
+            if (t === this.triggerElement) {\r
+                if(!this.hidden && this.trackMouse){\r
+                    this.setPagePosition(this.getTargetXY());\r
+                }\r
+            } else {\r
+                this.hide();\r
+                this.lastActive = new Date(0);\r
+                this.onTargetOver(e);\r
+            }\r
+        } else if (!this.closable && this.isVisible()) {\r
+            this.hide();\r
+        }\r
+    },\r
+\r
+    // private\r
+    getTargetXY : function(){\r
+        if(this.anchor){\r
+            this.targetCounter++;\r
+            var offsets = this.getOffsets();\r
+            var xy = (this.anchorToTarget && !this.trackMouse) ?\r
+                this.el.getAlignToXY(this.anchorTarget, this.getAnchorAlign()) :\r
+                this.targetXY;\r
+\r
+            var dw = Ext.lib.Dom.getViewWidth()-5;\r
+            var dh = Ext.lib.Dom.getViewHeight()-5;\r
+            var scrollX = (document.documentElement.scrollLeft || document.body.scrollLeft || 0)+5;\r
+            var scrollY = (document.documentElement.scrollTop || document.body.scrollTop || 0)+5;\r
+\r
+            var axy = [xy[0] + offsets[0], xy[1] + offsets[1]];\r
+            var sz = this.getSize();\r
+            this.anchorEl.removeClass(this.anchorCls);\r
+\r
+            if(this.targetCounter < 2){\r
+                if(axy[0] < scrollX){\r
+                    if(this.anchorToTarget){\r
+                        this.defaultAlign = 'l-r';\r
+                        if(this.mouseOffset){this.mouseOffset[0] *= -1;}\r
+                    }\r
+                    this.anchor = 'left';\r
+                    return this.getTargetXY();\r
+                }\r
+                if(axy[0]+sz.width > dw){\r
+                    if(this.anchorToTarget){\r
+                        this.defaultAlign = 'r-l';\r
+                        if(this.mouseOffset){this.mouseOffset[0] *= -1;}\r
+                    }\r
+                    this.anchor = 'right';\r
+                    return this.getTargetXY();\r
+                }\r
+                if(axy[1] < scrollY){\r
+                    if(this.anchorToTarget){\r
+                        this.defaultAlign = 't-b';\r
+                        if(this.mouseOffset){this.mouseOffset[1] *= -1;}\r
+                    }\r
+                    this.anchor = 'top';\r
+                    return this.getTargetXY();\r
+                }\r
+                if(axy[1]+sz.height > dh){\r
+                    if(this.anchorToTarget){\r
+                        this.defaultAlign = 'b-t';\r
+                        if(this.mouseOffset){this.mouseOffset[1] *= -1;}\r
+                    }\r
+                    this.anchor = 'bottom';\r
+                    return this.getTargetXY();\r
+                }\r
+            }\r
+\r
+            this.anchorCls = 'x-tip-anchor-'+this.getAnchorPosition();\r
+            this.anchorEl.addClass(this.anchorCls);\r
+            this.targetCounter = 0;\r
+            return axy;\r
+        }else{\r
+            var mouseOffset = this.getMouseOffset();\r
+            return [this.targetXY[0]+mouseOffset[0], this.targetXY[1]+mouseOffset[1]];\r
+        }\r
+    },\r
+\r
+    getMouseOffset : function(){\r
+        var offset = this.anchor ? [0,0] : [15,18];\r
+        if(this.mouseOffset){\r
+            offset[0] += this.mouseOffset[0];\r
+            offset[1] += this.mouseOffset[1];\r
+        }\r
+        return offset;\r
+    },\r
+\r
+    // private\r
+    getAnchorPosition : function(){\r
+        if(this.anchor){\r
+            this.tipAnchor = this.anchor.charAt(0);\r
+        }else{\r
+            var m = this.defaultAlign.match(/^([a-z]+)-([a-z]+)(\?)?$/);\r
+            if(!m){\r
+               throw "AnchorTip.defaultAlign is invalid";\r
+            }\r
+            this.tipAnchor = m[1].charAt(0);\r
+        }\r
+\r
+        switch(this.tipAnchor){\r
+            case 't': return 'top';\r
+            case 'b': return 'bottom';\r
+            case 'r': return 'right';\r
+        }\r
+        return 'left';\r
+    },\r
+\r
+    // private\r
+    getAnchorAlign : function(){\r
+        switch(this.anchor){\r
+            case 'top'  : return 'tl-bl';\r
+            case 'left' : return 'tl-tr';\r
+            case 'right': return 'tr-tl';\r
+            default     : return 'bl-tl';\r
+        }\r
+    },\r
+\r
+    // private\r
+    getOffsets: function(){\r
+        var offsets, ap = this.getAnchorPosition().charAt(0);\r
+        if(this.anchorToTarget && !this.trackMouse){\r
+            switch(ap){\r
+                case 't':\r
+                    offsets = [0, 9];\r
+                    break;\r
+                case 'b':\r
+                    offsets = [0, -13];\r
+                    break;\r
+                case 'r':\r
+                    offsets = [-13, 0];\r
+                    break;\r
+                default:\r
+                    offsets = [9, 0];\r
+                    break;\r
+            }\r
+        }else{\r
+            switch(ap){\r
+                case 't':\r
+                    offsets = [-15-this.anchorOffset, 30];\r
+                    break;\r
+                case 'b':\r
+                    offsets = [-19-this.anchorOffset, -13-this.el.dom.offsetHeight];\r
+                    break;\r
+                case 'r':\r
+                    offsets = [-15-this.el.dom.offsetWidth, -13-this.anchorOffset];\r
+                    break;\r
+                default:\r
+                    offsets = [25, -13-this.anchorOffset];\r
+                    break;\r
+            }\r
+        }\r
+        var mouseOffset = this.getMouseOffset();\r
+        offsets[0] += mouseOffset[0];\r
+        offsets[1] += mouseOffset[1];\r
+\r
+        return offsets;\r
+    },\r
+\r
+    // private\r
+    onTargetOver : function(e){\r
+        if(this.disabled || e.within(this.target.dom, true)){\r
+            return;\r
+        }\r
+        var t = e.getTarget(this.delegate);\r
+        if (t) {\r
+            this.triggerElement = t;\r
+            this.clearTimer('hide');\r
+            this.targetXY = e.getXY();\r
+            this.delayShow();\r
+        }\r
+    },\r
+\r
+    // private\r
+    delayShow : function(){\r
+        if(this.hidden && !this.showTimer){\r
+            if(this.lastActive.getElapsed() < this.quickShowInterval){\r
+                this.show();\r
+            }else{\r
+                this.showTimer = this.show.defer(this.showDelay, this);\r
+            }\r
+        }else if(!this.hidden && this.autoHide !== false){\r
+            this.show();\r
+        }\r
+    },\r
+\r
+    // private\r
+    onTargetOut : function(e){\r
+        if(this.disabled || e.within(this.target.dom, true)){\r
+            return;\r
+        }\r
+        this.clearTimer('show');\r
+        if(this.autoHide !== false){\r
+            this.delayHide();\r
+        }\r
+    },\r
+\r
+    // private\r
+    delayHide : function(){\r
+        if(!this.hidden && !this.hideTimer){\r
+            this.hideTimer = this.hide.defer(this.hideDelay, this);\r
+        }\r
+    },\r
+\r
+    <div id="method-Ext.ToolTip-hide"></div>/**\r
+     * Hides this tooltip if visible.\r
+     */\r
+    hide: function(){\r
+        this.clearTimer('dismiss');\r
+        this.lastActive = new Date();\r
+        if(this.anchorEl){\r
+            this.anchorEl.hide();\r
+        }\r
+        Ext.ToolTip.superclass.hide.call(this);\r
+        delete this.triggerElement;\r
+    },\r
+\r
+    <div id="method-Ext.ToolTip-show"></div>/**\r
+     * Shows this tooltip at the current event target XY position.\r
+     */\r
+    show : function(){\r
+        if(this.anchor){\r
+            // pre-show it off screen so that the el will have dimensions\r
+            // for positioning calcs when getting xy next\r
+            this.showAt([-1000,-1000]);\r
+            this.origConstrainPosition = this.constrainPosition;\r
+            this.constrainPosition = false;\r
+            this.anchor = this.origAnchor;\r
+        }\r
+        this.showAt(this.getTargetXY());\r
+\r
+        if(this.anchor){\r
+            this.syncAnchor();\r
+            this.anchorEl.show();\r
+            this.constrainPosition = this.origConstrainPosition;\r
+        }else{\r
+            this.anchorEl.hide();\r
+        }\r
+    },\r
+\r
+    // inherit docs\r
+    showAt : function(xy){\r
+        this.lastActive = new Date();\r
+        this.clearTimers();\r
+        Ext.ToolTip.superclass.showAt.call(this, xy);\r
+        if(this.dismissDelay && this.autoHide !== false){\r
+            this.dismissTimer = this.hide.defer(this.dismissDelay, this);\r
+        }\r
+    },\r
+\r
+    // private\r
+    syncAnchor : function(){\r
+        var anchorPos, targetPos, offset;\r
+        switch(this.tipAnchor.charAt(0)){\r
+            case 't':\r
+                anchorPos = 'b';\r
+                targetPos = 'tl';\r
+                offset = [20+this.anchorOffset, 2];\r
+                break;\r
+            case 'r':\r
+                anchorPos = 'l';\r
+                targetPos = 'tr';\r
+                offset = [-2, 11+this.anchorOffset];\r
+                break;\r
+            case 'b':\r
+                anchorPos = 't';\r
+                targetPos = 'bl';\r
+                offset = [20+this.anchorOffset, -2];\r
+                break;\r
+            default:\r
+                anchorPos = 'r';\r
+                targetPos = 'tl';\r
+                offset = [2, 11+this.anchorOffset];\r
+                break;\r
+        }\r
+        this.anchorEl.alignTo(this.el, anchorPos+'-'+targetPos, offset);\r
+    },\r
+\r
+    // private\r
+    setPagePosition : function(x, y){\r
+        Ext.ToolTip.superclass.setPagePosition.call(this, x, y);\r
+        if(this.anchor){\r
+            this.syncAnchor();\r
+        }\r
+    },\r
+\r
+    // private\r
+    clearTimer : function(name){\r
+        name = name + 'Timer';\r
+        clearTimeout(this[name]);\r
+        delete this[name];\r
+    },\r
+\r
+    // private\r
+    clearTimers : function(){\r
+        this.clearTimer('show');\r
+        this.clearTimer('dismiss');\r
+        this.clearTimer('hide');\r
+    },\r
+\r
+    // private\r
+    onShow : function(){\r
+        Ext.ToolTip.superclass.onShow.call(this);\r
+        Ext.getDoc().on('mousedown', this.onDocMouseDown, this);\r
+    },\r
+\r
+    // private\r
+    onHide : function(){\r
+        Ext.ToolTip.superclass.onHide.call(this);\r
+        Ext.getDoc().un('mousedown', this.onDocMouseDown, this);\r
+    },\r
+\r
+    // private\r
+    onDocMouseDown : function(e){\r
+        if(this.autoHide !== true && !this.closable && !e.within(this.el.dom)){\r
+            this.disable();\r
+            this.enable.defer(100, this);\r
+        }\r
+    },\r
+\r
+    // private\r
+    onDisable : function(){\r
+        this.clearTimers();\r
+        this.hide();\r
+    },\r
+\r
+    // private\r
+    adjustPosition : function(x, y){\r
+        if(this.contstrainPosition){\r
+            var ay = this.targetXY[1], h = this.getSize().height;\r
+            if(y <= ay && (y+h) >= ay){\r
+                y = ay-h-5;\r
+            }\r
+        }\r
+        return {x : x, y: y};\r
+    },\r
+\r
+    // private\r
+    onDestroy : function(){\r
+        Ext.getDoc().un('mousedown', this.onDocMouseDown, this);\r
+        Ext.ToolTip.superclass.onDestroy.call(this);\r
+    }\r
+});</pre>    \r
+</body>\r
+</html>
\ No newline at end of file