/** * ツールチップは、ページで特定の要素にマウスを重ねるとツールチップを表示する一般的な場合に対応する{@link Ext.tip.Tip}実装です。ターゲット要素またはマウスに対するツールチップの整列、自動的に表示および非表示するタイミングをさらに細かく制御できます。 * * この実装には、ターゲット要素に基づいてツールチップのテキストを自動的に配置する組み込みメソッドはあり**ません**。各ツールチップインスタンスの{@link #html}固定値を設定するか、カスタム論理({@link #beforeshow}イベントリスナなど)を実装して、適切なツールチップのコンテンツをその場で生成する必要があります。各ターゲット要素の特定DOM属性に基づきツールチップを自動的に配置して設定するためのより便利な方法については、{@link Ext.tip.QuickTip}を参照してください。 * * #基本的な例 * * @example * var tip = Ext.create('Ext.tip.ToolTip', { * target: 'clearButton', * html: 'Press this button to clear the form' * }); * * #委譲 * * ツールチップを単一要素に追加するだけでなく、親が共通の多くの要素を1つのツールチップに付加するために委譲を使用します。これは多数のツールチップインスタンスを生成するよりも効率的です。これを行うには、{@link #target}コンフィグをすべての要素の共通の親を指して、{@link #delegate}コンフィグをすべての該当するサブ要素を選択するCSSセレクタに設定します。 * * 委譲を使用する場合、ツールチップのコンテンツを各委譲要素に基づいてプログラム的に変更したい可能性が高くなります。これは、{@link #beforeshow}イベントのカスタムリスナを実装することで行えます。例: * * @example * var store = Ext.create('Ext.data.ArrayStore', { * fields: ['company', 'price', 'change'], * data: [ * ['3m Co', 71.72, 0.02], * ['Alcoa Inc', 29.01, 0.42], * ['Altria Group Inc', 83.81, 0.28], * ['American Express Company', 52.55, 0.01], * ['American International Group, Inc.', 64.13, 0.31], * ['AT&T Inc.', 31.61, -0.48] * ] * }); * * var grid = Ext.create('Ext.grid.Panel', { * title: 'Array Grid', * store: store, * columns: [ * {text: 'Company', flex: 1, dataIndex: 'company'}, * {text: 'Price', width: 75, dataIndex: 'price'}, * {text: 'Change', width: 75, dataIndex: 'change'} * ], * height: 200, * width: 400, * renderTo: Ext.getBody() * }); * * var view = grid.getView(); * var tip = Ext.create('Ext.tip.ToolTip', { * // The overall target element. * target: view.el, * // Each grid row causes its own separate show and hide. * delegate: view.itemSelector, * // Moving within the row should not hide the tip. * trackMouse: true, * // Render immediately so that tip.body can be referenced prior to the first show. * renderTo: Ext.getBody(), * listeners: { * // Change content dynamically depending on which element triggered the show. * beforeshow: function updateTipBody(tip) { * tip.update('Over company "' + view.getRecord(tip.triggerElement).get('company') + '"'); * } * } * }); * * # 配置 * * 以下の設定プロパティを使用すると、ツールチップをターゲット要素、マウスポインターに合わせて揃える方法を制御できます。 * * - {@link #anchor} * - {@link #anchorToTarget} * - {@link #anchorOffset} * - {@link #trackMouse} * - {@link #mouseOffset} * * # 表示/非表示 * * 以下の設定プロパティを使用すると、ツールチップを自動的に表示および非表示にする方法を制御できます。 * * - {@link #autoHide} * - {@link #showDelay} * - {@link #hideDelay} * - {@link #dismissDelay} * * @docauthor Jason Johnston <[email protected]> */ Ext.define('Ext.tip.ToolTip', { extend: 'Ext.tip.Tip', alias: 'widget.tooltip', alternateClassName: 'Ext.ToolTip', /** * @property {HTMLElement} triggerElement * `{@link #delegate}`オプションで`{@link #target}`要素の選択された子要素が個別のshowイベントをトリガーさせるようにツールチップが設定されている場合、このプロパティはshowをトリガーするDOM要素に設定されています。 */ /** * @cfg {HTMLElement/Ext.dom.Element/String} target * このツールチップを表示するきっかけとなるmouseoverイベントを監視するターゲット要素またはidの文字列。 */ /** * @cfg {Boolean} [autoHide=true] * trueにすると、マウスがターゲット要素から出て行った後、または`{@link #dismissDelay}`が設定されていて、その時間が経った後に、ツールチップを自動的に非表示にします。`{@link #closable} = true`の場合に、閉じるツールボタンは、ツールチップヘッダーにレンダリングされます。 */ autoHide: true, /** * @cfg {Number} showDelay * マウスがターゲット要素に入ってから、ツールチップが表示されるまでのミリ秒単位の遅延時間。 */ showDelay: 500, /** * @cfg {Number} hideDelay * マウスがターゲット要素を出てから、ツールチップが実際に非表示になるまでのミリ秒単位の遅延時間。ツールチップをすぐに非表示するには0に設定します。 */ hideDelay: 200, /** * @cfg {Number} dismissDelay * ツールチップが自動的に非表示になる前の遅延時間(ミリ秒単位)。自動的に非表示になるのを無効にするには、dismissDelayを0に設定します。 */ dismissDelay: 5000, /** * @cfg {Number[]} [mouseOffset=[15,18]] * マウスの位置からツールチップを表示する位置までのXYオフセット。 */ /** * @cfg {Boolean} trackMouse * trueにすると、ツールチップが、ターゲット要素を越えるように移動するマウスを追うようにします。 */ trackMouse: false, /** * @cfg {String} anchor * 指定された場合、ツールチップが、ターゲット要素またはマウスポインタに戻るためのアローポインタと共に、ターゲット要素の特定のサイド、またはマウスポインタに固定される("top"、"right"、"bottom"、"left")ことを示します。{@link #constrainPosition} コンフィグが有効なとき、これは優先的な値として使用され、必要に応じて反転することがあります。 */ /** * @cfg {Boolean} anchorToTarget * trueにすると、ツールチップをターゲット要素にアンカーします。 falseにすると、マウスの座標に関連してアンカーします。`anchorToTarget`がtrueの場合、ターゲット要素へのツールチップの整列を管理するために`{@link #defaultAlign}`を使用します。`anchorToTarget`がfalseの場合、整列を管理する代わりに`{@link #anchor}` コンフィグを使用します。 */ anchorToTarget: true, /** * @cfg {Number} anchorOffset * アンカーアローのデフォルトの位置のオフセットとして使用されるピクセル数値。アンカーポジションがツールチップの上部または下部である場合、`anchorOffset`は、水平方向のオフセットとして使用されます。同様に、アンカーポジションがツールチップの左サイドまたは右サイドである場合、`anchorOffset`は垂直方向のオフセットとして使用されます。 */ anchorOffset: 0, /** * @cfg {String} delegate * * ターゲットにマウスを移動させる度にツールチップの表示と非表示をするために、`{@link #target}` 要素内の個々の要素から選択することを許可する{@link Ext.DomQuery DomQuery}セレクタ。シンプルセレクタについては、{@link Ext.dom.Query}を参照してください。 * * 指定された場合、showイベントの原因になるターゲットの子要素が、ツールチップが表示される前に`{@link #triggerElement}`プロパティに配置されます。 * * コンポーネントが規則的で、繰り返して要素が入っていて、各要素がその要素固有の情報を含むのツールチップを必要とする場合に役に立ちます。 * * {@link Ext.tip.ToolTip}のクラスドキュメンテーションのdelegateの例を参照してください。 */ // @private targetCounter: 0, quickShowInterval: 250, /** * @cfg {String} [hideAction="hide"] * ツールチップを隠すために使われるメソッドです。このために使えるもう一つのメソッドとして、`fadeOut`があります。 */ hideAction: 'hide', /** * @cfg {Number} [fadeOutDuration=1000] * `fadeOut`アニメーションのミリ秒数。有効なのは、`hideAction`が`fadeOut`に設定されている場合だけです。 */ fadeOutDuration: 1000, ariaRole: 'tooltip', // @private initComponent: function() { var me = this; me.callParent(arguments); me.lastActive = new Date(); me.setTarget(me.target); me.origAnchor = me.anchor; }, // @private onRender: function(ct, position) { var me = this; me.callParent(arguments); me.anchorCls = Ext.baseCSSPrefix + 'tip-anchor-' + me.getAnchorPosition(); //<debug> if (me.sticky) { // tell the spec runner to ignore this element when checking if the dom is clean me.el.dom.setAttribute('data-sticky', true); } //</debug> me.anchorEl = me.el.createChild({ role: 'presentation', cls: Ext.baseCSSPrefix + 'tip-anchor ' + me.anchorCls }); }, /** * このツールチップを指定された要素に結びつけます。ツールチップは、マウスが要素の上に重なったときに表示されます。 * @param {String/HTMLElement/Ext.dom.Element} t 結び付けるElement、HTMLElement、または要素のID。 */ setTarget: function(target) { var me = this, t = Ext.get(target), tg; if (me.target) { tg = Ext.get(me.target); if (Ext.supports.Touch) { me.mun(tg, 'tap', me.onTargetOver, me); } else { me.mun(tg, { mouseover: me.onTargetOver, mouseout: me.onTargetOut, mousemove: me.onMouseMove, scope: me }); } } me.target = t; if (t) { if (Ext.supports.Touch) { me.mon(t, { tap: me.onTargetOver, scope: me }); } else { me.mon(t, { mouseover: me.onTargetOver, mouseout: me.onTargetOut, mousemove: me.onMouseMove, scope: me }); } } if (me.anchor) { me.anchorTarget = me.target; } }, // @private onMouseMove: function(e) { var me = this, t, xy; // If the event target is no longer in this tip's target (possibly due to rapidly churning content in target), ignore it. if (!me.target || me.target.contains(e.target)) { t = me.delegate ? e.getTarget(me.delegate) : me.triggerElement = true; if (t) { me.targetXY = e.getXY(); if (t === me.triggerElement) { if (!me.hidden && me.trackMouse) { xy = me.getTargetXY(); if (me.constrainPosition) { xy = me.el.adjustForConstraints(xy, me.el.parent()); } me.setPagePosition(xy); } } else { me.hide(); me.lastActive = new Date(0); me.onTargetOver(e); } } else if ((!me.closable && me.isVisible()) && me.autoHide !== false) { me.delayHide(); } } }, // @private getTargetXY: function() { var me = this, mouseOffset, offsets, xy, dw, dh, de, bd, scrollX, scrollY, axy, sz, constrainPosition; if (me.delegate) { me.anchorTarget = me.triggerElement; } if (me.anchor) { me.targetCounter++; offsets = me.getOffsets(); xy = (me.anchorToTarget && !me.trackMouse) ? me.getAlignToXY(me.anchorTarget, me.getAnchorAlign()) : me.targetXY; dw = Ext.Element.getViewportWidth() - 5; dh = Ext.Element.getViewportHeight() - 5; de = document.documentElement; bd = document.body; scrollX = (de.scrollLeft || bd.scrollLeft || 0) + 5; scrollY = (de.scrollTop || bd.scrollTop || 0) + 5; axy = [xy[0] + offsets[0], xy[1] + offsets[1]]; sz = me.getSize(); constrainPosition = me.constrainPosition; me.anchorEl.removeCls(me.anchorCls); if (me.targetCounter < 2 && constrainPosition) { if (axy[0] < scrollX) { if (me.anchorToTarget) { me.defaultAlign = 'l-r'; if (me.mouseOffset) { me.mouseOffset[0] *= -1; } } me.anchor = 'left'; return me.getTargetXY(); } if (axy[0] + sz.width > dw) { if (me.anchorToTarget) { me.defaultAlign = 'r-l'; if (me.mouseOffset) { me.mouseOffset[0] *= -1; } } me.anchor = 'right'; return me.getTargetXY(); } if (axy[1] < scrollY) { if (me.anchorToTarget) { me.defaultAlign = 't-b'; if (me.mouseOffset) { me.mouseOffset[1] *= -1; } } me.anchor = 'top'; return me.getTargetXY(); } if (axy[1] + sz.height > dh) { if (me.anchorToTarget) { me.defaultAlign = 'b-t'; if (me.mouseOffset) { me.mouseOffset[1] *= -1; } } me.anchor = 'bottom'; return me.getTargetXY(); } } me.anchorCls = Ext.baseCSSPrefix + 'tip-anchor-' + me.getAnchorPosition(); me.anchorEl.addCls(me.anchorCls); me.targetCounter = 0; return axy; } else { mouseOffset = me.getMouseOffset(); return (me.targetXY) ? [me.targetXY[0] + mouseOffset[0], me.targetXY[1] + mouseOffset[1]] : mouseOffset; } }, getMouseOffset: function() { var me = this, offset = me.anchor ? [0, 0] : [15, 18]; if (me.mouseOffset) { offset[0] += me.mouseOffset[0]; offset[1] += me.mouseOffset[1]; } return offset; }, fadeOut: function () { var me = this; me.el.fadeOut({ duration: me.fadeOutDuration, callback: function () { me.hide(); me.el.setOpacity(''); } }); }, // @private getAnchorPosition: function() { var me = this, m; if (me.anchor) { me.tipAnchor = me.anchor.charAt(0); } else { m = me.defaultAlign.match(/^([a-z]+)-([a-z]+)(\?)?$/); //<debug> if (!m) { Ext.Error.raise('The AnchorTip.defaultAlign value "' + me.defaultAlign + '" is invalid.'); } //</debug> me.tipAnchor = m[1].charAt(0); } switch (me.tipAnchor) { case 't': return 'top'; case 'b': return 'bottom'; case 'r': return 'right'; } return 'left'; }, // @private getAnchorAlign: function() { switch (this.anchor) { case 'top': return 'tl-bl'; case 'left': return 'tl-tr'; case 'right': return 'tr-tl'; default: return 'bl-tl'; } }, // @private getOffsets: function() { var me = this, mouseOffset, offsets, ap = me.getAnchorPosition().charAt(0); if (me.anchorToTarget && !me.trackMouse) { switch (ap) { case 't': offsets = [0, 9]; break; case 'b': offsets = [0, -13]; break; case 'r': offsets = [ - 13, 0]; break; default: offsets = [9, 0]; break; } } else { switch (ap) { case 't': offsets = [ - 15 - me.anchorOffset, 30]; break; case 'b': offsets = [ - 19 - me.anchorOffset, -13 - me.el.dom.offsetHeight]; break; case 'r': offsets = [ - 15 - me.el.dom.offsetWidth, -13 - me.anchorOffset]; break; default: offsets = [25, -13 - me.anchorOffset]; break; } } mouseOffset = me.getMouseOffset(); offsets[0] += mouseOffset[0]; offsets[1] += mouseOffset[1]; return offsets; }, // @private onTargetOver: function(e) { var me = this, delegate = me.delegate, t; if (me.disabled || e.within(me.target.dom, true)) { return; } t = delegate ? e.getTarget(delegate) : true; if (t) { me.triggerElement = t; me.triggerEvent = e; me.clearTimer('hide'); me.targetXY = e.getXY(); me.delayShow(); } }, // @private delayShow: function (trackMouse) { // When delaying, cache the XY coords of the mouse when this method was invoked, NOT when the deferred // show is called because the mouse could then be in a completely different location. Only cache the // coords when trackMouse is false. // // Note that the delayShow call could be coming from a caller which would internally be setting trackMouse // (e.g., Ext.chart.Tip:showTip()). Because of this, the caller will pass along the original value for // trackMouse (i.e., the value passed to the component constructor) to the delayShow method. // See EXTJSIV-11292. var me = this, xy = me.el && (trackMouse === false || !me.trackMouse) && me.getTargetXY(); if (me.hidden && !me.showTimer) { if (Ext.Date.getElapsed(me.lastActive) < me.quickShowInterval) { me.show(); } else { me.showTimer = Ext.defer(me.showFromDelay, me.showDelay, me, [xy]); } } else if (!me.hidden && me.autoHide !== false) { me.show(xy); } }, showFromDelay: function (xy) { this.fromDelayShow = true; this.show(xy); delete this.fromDelayShow; }, onShowVeto: function(){ this.callParent(); delete this.triggerElement; this.clearTimer('show'); }, // @private onTargetOut: function(e) { var me = this, triggerEl = me.triggerElement, // If we don't have a delegate, then the target is set // to true, so set it to the main target. target = triggerEl === true ? me.target : triggerEl; // If disabled, moving within the current target, ignore the mouseout // e.within is the only correct way to determine this. if (me.disabled || !triggerEl || e.within(target, true)) { return; } if (me.showTimer) { me.clearTimer('show'); me.triggerElement = null; } if (me.autoHide !== false) { me.delayHide(); } }, // @private delayHide: function() { var me = this; if (!me.hidden && !me.hideTimer) { me.hideTimer = Ext.defer(me[me.hideAction], me.hideDelay, me); } }, /** * 表示されている場合、このツールチップを非表示にします。 */ hide: function() { var me = this; me.clearTimer('dismiss'); me.lastActive = new Date(); if (me.anchorEl) { me.anchorEl.hide(); } me.callParent(arguments); delete me.triggerElement; }, /** * 現在のイベントのターゲットであるXY位置にこのツールチップを表示します。 */ show: function (xy) { var me = this; // Show this Component first, so that sizing can be calculated // pre-show it off screen so that the el will have dimensions this.callParent(); if (this.hidden === false) { if (me.anchor) { me.anchor = me.origAnchor; } if (!me.calledFromShowAt) { // If the caller was this.showFromDelay(), the XY coords may have been cached. me.showAt(xy || me.getTargetXY()); } if (me.anchor) { me.syncAnchor(); me.anchorEl.show(); } else { me.anchorEl.hide(); } } }, // @inheritdoc showAt: function(xy) { var me = this; me.lastActive = new Date(); me.clearTimers(); me.calledFromShowAt = true; // Only call if this is hidden. May have been called from show above. if (!me.isVisible()) { this.callParent(arguments); } // Show may have been vetoed. if (me.isVisible()) { me.setPagePosition(xy[0], xy[1]); if (me.constrainPosition || me.constrain) { me.doConstrain(); } me.toFront(true); me.el.sync(true); if (me.dismissDelay && me.autoHide !== false) { me.dismissTimer = Ext.defer(me.hide, me.dismissDelay, me); } if (me.anchor) { me.syncAnchor(); if (!me.anchorEl.isVisible()) { me.anchorEl.show(); } } else { me.anchorEl.hide(); } } delete me.calledFromShowAt; }, // @private syncAnchor: function() { var me = this, anchorPos, targetPos, offset; switch (me.tipAnchor.charAt(0)) { case 't': anchorPos = 'b'; targetPos = 'tl'; offset = [20 + me.anchorOffset, 1]; break; case 'r': anchorPos = 'l'; targetPos = 'tr'; offset = [ - 1, 12 + me.anchorOffset]; break; case 'b': anchorPos = 't'; targetPos = 'bl'; offset = [20 + me.anchorOffset, -1]; break; default: anchorPos = 'r'; targetPos = 'tl'; offset = [1, 12 + me.anchorOffset]; break; } me.anchorEl.alignTo(me.el, anchorPos + '-' + targetPos, offset); me.anchorEl.setStyle('z-index', parseInt(me.el.getZIndex(), 10) || 0 + 1).setVisibilityMode(Ext.Element.DISPLAY); }, // @private setPagePosition: function(x, y) { var me = this; me.callParent(arguments); if (me.anchor) { me.syncAnchor(); } }, _timerNames: {}, // @private clearTimer: function (name) { var me = this, names = me._timerNames, propName = names[name] || (names[name] = name + 'Timer'), timer = me[propName]; if (timer) { clearTimeout(timer); me[propName] = null; } }, // @private clearTimers: function() { var me = this; me.clearTimer('show'); me.clearTimer('dismiss'); me.clearTimer('hide'); }, // @private onShow: function() { var me = this; me.callParent(); me.mon(Ext.getDoc(), 'mousedown', me.onDocMouseDown, me); }, // @private onHide: function() { var me = this; me.callParent(); me.mun(Ext.getDoc(), 'mousedown', me.onDocMouseDown, me); }, // @private onDocMouseDown: function(e) { var me = this; if (!me.closable && !e.within(me.el.dom)) { me.disable(); Ext.defer(me.doEnable, 100, me); } }, // @private doEnable: function() { if (!this.isDestroyed) { this.enable(); } }, // @private onDisable: function() { this.callParent(); this.clearTimers(); this.hide(); }, beforeDestroy: function() { var me = this; me.clearTimers(); Ext.destroy(me.anchorEl); delete me.anchorEl; delete me.target; delete me.anchorTarget; delete me.triggerElement; me.callParent(); }, // @private onDestroy: function() { Ext.getDoc().un('mousedown', this.onDocMouseDown, this); this.callParent(); } });