ToolTip.js
上传用户:dawnssy
上传日期:2022-08-06
资源大小:9345k
文件大小:18k
源码类别:

JavaScript

开发平台:

JavaScript

  1. /*!  * Ext JS Library 3.1.0  * Copyright(c) 2006-2009 Ext JS, LLC  * licensing@extjs.com  * http://www.extjs.com/license  */ /**
  2.  * @class Ext.ToolTip
  3.  * @extends Ext.Tip
  4.  * A standard tooltip implementation for providing additional information when hovering over a target element.
  5.  * @xtype tooltip
  6.  * @constructor
  7.  * Create a new Tooltip
  8.  * @param {Object} config The configuration options
  9.  */
  10. Ext.ToolTip = Ext.extend(Ext.Tip, {
  11.     /**
  12.      * When a Tooltip is configured with the <code>{@link #delegate}</code>
  13.      * option to cause selected child elements of the <code>{@link #target}</code>
  14.      * Element to each trigger a seperate show event, this property is set to
  15.      * the DOM element which triggered the show.
  16.      * @type DOMElement
  17.      * @property triggerElement
  18.      */
  19.     /**
  20.      * @cfg {Mixed} target The target HTMLElement, Ext.Element or id to monitor
  21.      * for mouseover events to trigger showing this ToolTip.
  22.      */
  23.     /**
  24.      * @cfg {Boolean} autoHide True to automatically hide the tooltip after the
  25.      * mouse exits the target element or after the <code>{@link #dismissDelay}</code>
  26.      * has expired if set (defaults to true).  If <code>{@link closable} = true</code>
  27.      * a close tool button will be rendered into the tooltip header.
  28.      */
  29.     /**
  30.      * @cfg {Number} showDelay Delay in milliseconds before the tooltip displays
  31.      * after the mouse enters the target element (defaults to 500)
  32.      */
  33.     showDelay : 500,
  34.     /**
  35.      * @cfg {Number} hideDelay Delay in milliseconds after the mouse exits the
  36.      * target element but before the tooltip actually hides (defaults to 200).
  37.      * Set to 0 for the tooltip to hide immediately.
  38.      */
  39.     hideDelay : 200,
  40.     /**
  41.      * @cfg {Number} dismissDelay Delay in milliseconds before the tooltip
  42.      * automatically hides (defaults to 5000). To disable automatic hiding, set
  43.      * dismissDelay = 0.
  44.      */
  45.     dismissDelay : 5000,
  46.     /**
  47.      * @cfg {Array} mouseOffset An XY offset from the mouse position where the
  48.      * tooltip should be shown (defaults to [15,18]).
  49.      */
  50.     /**
  51.      * @cfg {Boolean} trackMouse True to have the tooltip follow the mouse as it
  52.      * moves over the target element (defaults to false).
  53.      */
  54.     trackMouse : false,
  55.     /**
  56.      * @cfg {Boolean} anchorToTarget True to anchor the tooltip to the target
  57.      * element, false to anchor it relative to the mouse coordinates (defaults
  58.      * to true).  When <code>anchorToTarget</code> is true, use
  59.      * <code>{@link #defaultAlign}</code> to control tooltip alignment to the
  60.      * target element.  When <code>anchorToTarget</code> is false, use
  61.      * <code>{@link #anchorPosition}</code> instead to control alignment.
  62.      */
  63.     anchorToTarget : true,
  64.     /**
  65.      * @cfg {Number} anchorOffset A numeric pixel value used to offset the
  66.      * default position of the anchor arrow (defaults to 0).  When the anchor
  67.      * position is on the top or bottom of the tooltip, <code>anchorOffset</code>
  68.      * will be used as a horizontal offset.  Likewise, when the anchor position
  69.      * is on the left or right side, <code>anchorOffset</code> will be used as
  70.      * a vertical offset.
  71.      */
  72.     anchorOffset : 0,
  73.     /**
  74.      * @cfg {String} delegate <p>Optional. A {@link Ext.DomQuery DomQuery}
  75.      * selector which allows selection of individual elements within the
  76.      * <code>{@link #target}</code> element to trigger showing and hiding the
  77.      * ToolTip as the mouse moves within the target.</p>
  78.      * <p>When specified, the child element of the target which caused a show
  79.      * event is placed into the <code>{@link #triggerElement}</code> property
  80.      * before the ToolTip is shown.</p>
  81.      * <p>This may be useful when a Component has regular, repeating elements
  82.      * in it, each of which need a Tooltip which contains information specific
  83.      * to that element. For example:</p><pre><code>
  84. var myGrid = new Ext.grid.gridPanel(gridConfig);
  85. myGrid.on('render', function(grid) {
  86.     var store = grid.getStore();  // Capture the Store.
  87.     var view = grid.getView();    // Capture the GridView.
  88.     myGrid.tip = new Ext.ToolTip({
  89.         target: view.mainBody,    // The overall target element.
  90.         delegate: '.x-grid3-row', // Each grid row causes its own seperate show and hide.
  91.         trackMouse: true,         // Moving within the row should not hide the tip.
  92.         renderTo: document.body,  // Render immediately so that tip.body can be
  93.                                   //  referenced prior to the first show.
  94.         listeners: {              // Change content dynamically depending on which element
  95.                                   //  triggered the show.
  96.             beforeshow: function updateTipBody(tip) {
  97.                 var rowIndex = view.findRowIndex(tip.triggerElement);
  98.                 tip.body.dom.innerHTML = 'Over Record ID ' + store.getAt(rowIndex).id;
  99.             }
  100.         }
  101.     });
  102. });
  103.      *</code></pre>
  104.      */
  105.     // private
  106.     targetCounter : 0,
  107.     constrainPosition : false,
  108.     // private
  109.     initComponent : function(){
  110.         Ext.ToolTip.superclass.initComponent.call(this);
  111.         this.lastActive = new Date();
  112.         this.initTarget(this.target);
  113.         this.origAnchor = this.anchor;
  114.     },
  115.     // private
  116.     onRender : function(ct, position){
  117.         Ext.ToolTip.superclass.onRender.call(this, ct, position);
  118.         this.anchorCls = 'x-tip-anchor-' + this.getAnchorPosition();
  119.         this.anchorEl = this.el.createChild({
  120.             cls: 'x-tip-anchor ' + this.anchorCls
  121.         });
  122.     },
  123.     // private
  124.     afterRender : function(){
  125.         Ext.ToolTip.superclass.afterRender.call(this);
  126.         this.anchorEl.setStyle('z-index', this.el.getZIndex() + 1);
  127.     },
  128.     /**
  129.      * Binds this ToolTip to the specified element. The tooltip will be displayed when the mouse moves over the element.
  130.      * @param {Mixed} t The Element, HtmlElement, or ID of an element to bind to
  131.      */
  132.     initTarget : function(target){
  133.         var t;
  134.         if((t = Ext.get(target))){
  135.             if(this.target){
  136.                 var tg = Ext.get(this.target);
  137.                 this.mun(tg, 'mouseover', this.onTargetOver, this);
  138.                 this.mun(tg, 'mouseout', this.onTargetOut, this);
  139.                 this.mun(tg, 'mousemove', this.onMouseMove, this);
  140.             }
  141.             this.mon(t, {
  142.                 mouseover: this.onTargetOver,
  143.                 mouseout: this.onTargetOut,
  144.                 mousemove: this.onMouseMove,
  145.                 scope: this
  146.             });
  147.             this.target = t;
  148.         }
  149.         if(this.anchor){
  150.             this.anchorTarget = this.target;
  151.         }
  152.     },
  153.     // private
  154.     onMouseMove : function(e){
  155.         var t = this.delegate ? e.getTarget(this.delegate) : this.triggerElement = true;
  156.         if (t) {
  157.             this.targetXY = e.getXY();
  158.             if (t === this.triggerElement) {
  159.                 if(!this.hidden && this.trackMouse){
  160.                     this.setPagePosition(this.getTargetXY());
  161.                 }
  162.             } else {
  163.                 this.hide();
  164.                 this.lastActive = new Date(0);
  165.                 this.onTargetOver(e);
  166.             }
  167.         } else if (!this.closable && this.isVisible()) {
  168.             this.hide();
  169.         }
  170.     },
  171.     // private
  172.     getTargetXY : function(){
  173.         if(this.delegate){
  174.             this.anchorTarget = this.triggerElement;
  175.         }
  176.         if(this.anchor){
  177.             this.targetCounter++;
  178.             var offsets = this.getOffsets(),
  179.                 xy = (this.anchorToTarget && !this.trackMouse) ? this.el.getAlignToXY(this.anchorTarget, this.getAnchorAlign()) : this.targetXY,
  180.                 dw = Ext.lib.Dom.getViewWidth() - 5,
  181.                 dh = Ext.lib.Dom.getViewHeight() - 5,
  182.                 de = document.documentElement,
  183.                 bd = document.body,
  184.                 scrollX = (de.scrollLeft || bd.scrollLeft || 0) + 5,
  185.                 scrollY = (de.scrollTop || bd.scrollTop || 0) + 5,
  186.                 axy = [xy[0] + offsets[0], xy[1] + offsets[1]]
  187.                 sz = this.getSize();
  188.                 
  189.             this.anchorEl.removeClass(this.anchorCls);
  190.             if(this.targetCounter < 2){
  191.                 if(axy[0] < scrollX){
  192.                     if(this.anchorToTarget){
  193.                         this.defaultAlign = 'l-r';
  194.                         if(this.mouseOffset){this.mouseOffset[0] *= -1;}
  195.                     }
  196.                     this.anchor = 'left';
  197.                     return this.getTargetXY();
  198.                 }
  199.                 if(axy[0]+sz.width > dw){
  200.                     if(this.anchorToTarget){
  201.                         this.defaultAlign = 'r-l';
  202.                         if(this.mouseOffset){this.mouseOffset[0] *= -1;}
  203.                     }
  204.                     this.anchor = 'right';
  205.                     return this.getTargetXY();
  206.                 }
  207.                 if(axy[1] < scrollY){
  208.                     if(this.anchorToTarget){
  209.                         this.defaultAlign = 't-b';
  210.                         if(this.mouseOffset){this.mouseOffset[1] *= -1;}
  211.                     }
  212.                     this.anchor = 'top';
  213.                     return this.getTargetXY();
  214.                 }
  215.                 if(axy[1]+sz.height > dh){
  216.                     if(this.anchorToTarget){
  217.                         this.defaultAlign = 'b-t';
  218.                         if(this.mouseOffset){this.mouseOffset[1] *= -1;}
  219.                     }
  220.                     this.anchor = 'bottom';
  221.                     return this.getTargetXY();
  222.                 }
  223.             }
  224.             this.anchorCls = 'x-tip-anchor-'+this.getAnchorPosition();
  225.             this.anchorEl.addClass(this.anchorCls);
  226.             this.targetCounter = 0;
  227.             return axy;
  228.         }else{
  229.             var mouseOffset = this.getMouseOffset();
  230.             return [this.targetXY[0]+mouseOffset[0], this.targetXY[1]+mouseOffset[1]];
  231.         }
  232.     },
  233.     getMouseOffset : function(){
  234.         var offset = this.anchor ? [0,0] : [15,18];
  235.         if(this.mouseOffset){
  236.             offset[0] += this.mouseOffset[0];
  237.             offset[1] += this.mouseOffset[1];
  238.         }
  239.         return offset;
  240.     },
  241.     // private
  242.     getAnchorPosition : function(){
  243.         if(this.anchor){
  244.             this.tipAnchor = this.anchor.charAt(0);
  245.         }else{
  246.             var m = this.defaultAlign.match(/^([a-z]+)-([a-z]+)(?)?$/);
  247.             if(!m){
  248.                throw 'AnchorTip.defaultAlign is invalid';
  249.             }
  250.             this.tipAnchor = m[1].charAt(0);
  251.         }
  252.         switch(this.tipAnchor){
  253.             case 't': return 'top';
  254.             case 'b': return 'bottom';
  255.             case 'r': return 'right';
  256.         }
  257.         return 'left';
  258.     },
  259.     // private
  260.     getAnchorAlign : function(){
  261.         switch(this.anchor){
  262.             case 'top'  : return 'tl-bl';
  263.             case 'left' : return 'tl-tr';
  264.             case 'right': return 'tr-tl';
  265.             default     : return 'bl-tl';
  266.         }
  267.     },
  268.     // private
  269.     getOffsets : function(){
  270.         var offsets, 
  271.             ap = this.getAnchorPosition().charAt(0);
  272.         if(this.anchorToTarget && !this.trackMouse){
  273.             switch(ap){
  274.                 case 't':
  275.                     offsets = [0, 9];
  276.                     break;
  277.                 case 'b':
  278.                     offsets = [0, -13];
  279.                     break;
  280.                 case 'r':
  281.                     offsets = [-13, 0];
  282.                     break;
  283.                 default:
  284.                     offsets = [9, 0];
  285.                     break;
  286.             }
  287.         }else{
  288.             switch(ap){
  289.                 case 't':
  290.                     offsets = [-15-this.anchorOffset, 30];
  291.                     break;
  292.                 case 'b':
  293.                     offsets = [-19-this.anchorOffset, -13-this.el.dom.offsetHeight];
  294.                     break;
  295.                 case 'r':
  296.                     offsets = [-15-this.el.dom.offsetWidth, -13-this.anchorOffset];
  297.                     break;
  298.                 default:
  299.                     offsets = [25, -13-this.anchorOffset];
  300.                     break;
  301.             }
  302.         }
  303.         var mouseOffset = this.getMouseOffset();
  304.         offsets[0] += mouseOffset[0];
  305.         offsets[1] += mouseOffset[1];
  306.         return offsets;
  307.     },
  308.     // private
  309.     onTargetOver : function(e){
  310.         if(this.disabled || e.within(this.target.dom, true)){
  311.             return;
  312.         }
  313.         var t = e.getTarget(this.delegate);
  314.         if (t) {
  315.             this.triggerElement = t;
  316.             this.clearTimer('hide');
  317.             this.targetXY = e.getXY();
  318.             this.delayShow();
  319.         }
  320.     },
  321.     // private
  322.     delayShow : function(){
  323.         if(this.hidden && !this.showTimer){
  324.             if(this.lastActive.getElapsed() < this.quickShowInterval){
  325.                 this.show();
  326.             }else{
  327.                 this.showTimer = this.show.defer(this.showDelay, this);
  328.             }
  329.         }else if(!this.hidden && this.autoHide !== false){
  330.             this.show();
  331.         }
  332.     },
  333.     // private
  334.     onTargetOut : function(e){
  335.         if(this.disabled || e.within(this.target.dom, true)){
  336.             return;
  337.         }
  338.         this.clearTimer('show');
  339.         if(this.autoHide !== false){
  340.             this.delayHide();
  341.         }
  342.     },
  343.     // private
  344.     delayHide : function(){
  345.         if(!this.hidden && !this.hideTimer){
  346.             this.hideTimer = this.hide.defer(this.hideDelay, this);
  347.         }
  348.     },
  349.     /**
  350.      * Hides this tooltip if visible.
  351.      */
  352.     hide: function(){
  353.         this.clearTimer('dismiss');
  354.         this.lastActive = new Date();
  355.         if(this.anchorEl){
  356.             this.anchorEl.hide();
  357.         }
  358.         Ext.ToolTip.superclass.hide.call(this);
  359.         delete this.triggerElement;
  360.     },
  361.     /**
  362.      * Shows this tooltip at the current event target XY position.
  363.      */
  364.     show : function(){
  365.         if(this.anchor){
  366.             // pre-show it off screen so that the el will have dimensions
  367.             // for positioning calcs when getting xy next
  368.             this.showAt([-1000,-1000]);
  369.             this.origConstrainPosition = this.constrainPosition;
  370.             this.constrainPosition = false;
  371.             this.anchor = this.origAnchor;
  372.         }
  373.         this.showAt(this.getTargetXY());
  374.         if(this.anchor){
  375.             this.syncAnchor();
  376.             this.anchorEl.show();
  377.             this.constrainPosition = this.origConstrainPosition;
  378.         }else{
  379.             this.anchorEl.hide();
  380.         }
  381.     },
  382.     // inherit docs
  383.     showAt : function(xy){
  384.         this.lastActive = new Date();
  385.         this.clearTimers();
  386.         Ext.ToolTip.superclass.showAt.call(this, xy);
  387.         if(this.dismissDelay && this.autoHide !== false){
  388.             this.dismissTimer = this.hide.defer(this.dismissDelay, this);
  389.         }
  390.         if(this.anchor && !this.anchorEl.isVisible()){
  391.             this.syncAnchor();
  392.             this.anchorEl.show();
  393.         }
  394.     },
  395.     // private
  396.     syncAnchor : function(){
  397.         var anchorPos, targetPos, offset;
  398.         switch(this.tipAnchor.charAt(0)){
  399.             case 't':
  400.                 anchorPos = 'b';
  401.                 targetPos = 'tl';
  402.                 offset = [20+this.anchorOffset, 2];
  403.                 break;
  404.             case 'r':
  405.                 anchorPos = 'l';
  406.                 targetPos = 'tr';
  407.                 offset = [-2, 11+this.anchorOffset];
  408.                 break;
  409.             case 'b':
  410.                 anchorPos = 't';
  411.                 targetPos = 'bl';
  412.                 offset = [20+this.anchorOffset, -2];
  413.                 break;
  414.             default:
  415.                 anchorPos = 'r';
  416.                 targetPos = 'tl';
  417.                 offset = [2, 11+this.anchorOffset];
  418.                 break;
  419.         }
  420.         this.anchorEl.alignTo(this.el, anchorPos+'-'+targetPos, offset);
  421.     },
  422.     // private
  423.     setPagePosition : function(x, y){
  424.         Ext.ToolTip.superclass.setPagePosition.call(this, x, y);
  425.         if(this.anchor){
  426.             this.syncAnchor();
  427.         }
  428.     },
  429.     // private
  430.     clearTimer : function(name){
  431.         name = name + 'Timer';
  432.         clearTimeout(this[name]);
  433.         delete this[name];
  434.     },
  435.     // private
  436.     clearTimers : function(){
  437.         this.clearTimer('show');
  438.         this.clearTimer('dismiss');
  439.         this.clearTimer('hide');
  440.     },
  441.     // private
  442.     onShow : function(){
  443.         Ext.ToolTip.superclass.onShow.call(this);
  444.         Ext.getDoc().on('mousedown', this.onDocMouseDown, this);
  445.     },
  446.     // private
  447.     onHide : function(){
  448.         Ext.ToolTip.superclass.onHide.call(this);
  449.         Ext.getDoc().un('mousedown', this.onDocMouseDown, this);
  450.     },
  451.     // private
  452.     onDocMouseDown : function(e){
  453.         if(this.autoHide !== true && !this.closable && !e.within(this.el.dom)){
  454.             this.disable();
  455.             this.enable.defer(100, this);
  456.         }
  457.     },
  458.     // private
  459.     onDisable : function(){
  460.         this.clearTimers();
  461.         this.hide();
  462.     },
  463.     // private
  464.     adjustPosition : function(x, y){
  465.         if(this.contstrainPosition){
  466.             var ay = this.targetXY[1], h = this.getSize().height;
  467.             if(y <= ay && (y+h) >= ay){
  468.                 y = ay-h-5;
  469.             }
  470.         }
  471.         return {x : x, y: y};
  472.     },
  473.     
  474.     beforeDestroy : function(){
  475.         this.clearTimers();
  476.         Ext.destroy(this.anchorEl);
  477.         delete this.anchorEl;
  478.         delete this.target;
  479.         delete this.anchorTarget;
  480.         delete this.triggerElement;
  481.         Ext.ToolTip.superclass.beforeDestroy.call(this);    
  482.     },
  483.     // private
  484.     onDestroy : function(){
  485.         Ext.getDoc().un('mousedown', this.onDocMouseDown, this);
  486.         Ext.ToolTip.superclass.onDestroy.call(this);
  487.     }
  488. });
  489. Ext.reg('tooltip', Ext.ToolTip);