/*
balloon.js -- a DHTML library for balloon tooltips
$Id: balloon.js,v 1.1.2.13 2007/11/03 21:22:28 sheldon_mckay Exp $
See http://www.gmod.org/wiki/index.php/Popup_Balloons
for documentation.
Copyright (c) 2007 Sheldon McKay, Cold Spring Harbor Laboratory
This balloon tooltip package and associated files not otherwise copyrighted are
distributed under the MIT-style license:
http://opensource.org/licenses/mit-license.php
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
If publications result from research using this SOFTWARE, we ask that
CSHL and the author be acknowledged as scientifically appropriate.
*/
// These global variables are necessary to avoid losing scope when
//setting the balloon timeout and for inter-object communication
var currentBalloonClass;
var balloonIsVisible
var balloonIsSticky;
var balloonInvisibleSelects;
// If using this library from dynamically generated HTML in IE, such as
// CGI scripts, set this variable to false. It will prevent
// balloons from firing until the page is fully loaded in IE.
var balloonOK = false;
window.onload = function(){ balloonOK = true; }
///////////////////////////////////////////////////
// Constructor for Balloon class //
// Balloon configuration //
// Reset these values for custom balloon designs //
///////////////////////////////////////////////////
var Balloon = function() {
// Location of optional ajax handler that returns tooltip contents
//this.helpUrl = '/cgi-bin/help.pl';
// maxium allowed balloon width
this.minWidth = 150;
// minimum allowed balloon width
this.maxWidth = 600;
// Default tooltip text size
this.balloonTextSize = '90%';
// Delay (milliseconds) before balloon is displayed
this.delayTime = 500;
// Vertical Distance from cursor location
this.vOffset = 10;
// text-padding within the balloon
this.padding = 10;
// width of shadow (space aroung whole balloon)
// This can be zero if there is no shadow and the
// edges of the balloon are also the edges of the image
this.shadow = 20;
// images of balloon body. If the browser is IE < 7, png alpha
// channels will not work. An optional alternative image can be
// provided. It should have the same dimensions as the default png image
this.balloonImage = 'http://www.wsrphoto.com/web-images/balloon.png'; // with alpha channels
this.ieImage = 'http://www.wsrphoto.com/web-images/balloon_ie.png'; // indexed color, transparent background
// whether the balloon should have a stem
this.stem = true;
// The height (px) of the stem and the extent to which the
// stem image should overlaps the balloon image.
this.stemHeight = 32;
this.stemOverlap = 3;
// A stem for each of the four orientations
this.upLeftStem = 'http://www.wsrphoto.com/web-images/up_left.png';
this.downLeftStem = 'http://www.wsrphoto.com/web-images/down_left.png';
this.upRightStem = 'http://www.wsrphoto.com/web-images/up_right.png';
this.downRightStem = 'http://www.wsrphoto.com/web-images/down_right.png';
// A close button for sticky balloons
this.closeButton = 'http://www.wsrphoto.com/web-images/close.png';
}
//////////////////////////////////////////////////////////////////////////
// This is the function that is called on mouseover. It has a built-in //
// delay time to avoid balloons popping up on rapid mouseover events //
//////////////////////////////////////////////////////////////////////////
Balloon.prototype.showTooltip = function(evt,caption,sticky,width) {
// Awful IE bug, page load aborts if the balloon is fired
// before the page is fully loaded.
if (this.isIE() && !balloonOK) return false;
// Check for mouseover (vs. mousedown or click)
var mouseOver = evt.type.match('mouseover','i');
// Don't fire on mouseover if a non-sticky balloon is visible
if (balloonIsVisible && !balloonIsSticky && mouseOver) return false;
// Don't start a non-sticky balloon if a sticky one is visible
if (balloonIsVisible && balloonIsSticky && !sticky) return false;
// Ignore repeated firing of mouseover->mouseout events on
// the same element (Safari)
var el = this.getEventTarget(evt);
if (sticky && mouseOver && this.isSameElement(el,this.currentElement)) return false;
this.firingElement = el;
// A new sticky balloon can erase an old one
if (sticky) this.hideTooltip(1);
// attach a mouseout event handler to the target element
var closeBalloon = function() {
var override = balloonIsSticky && !balloonIsVisible;
Balloon.prototype.hideTooltip(override)
}
el.onmouseout = closeBalloon;;
balloonIsSticky = sticky;
// force balloon width and/or height if requested
this.width = width;
// Set the active mousover coordinates
this.setActiveCoordinates(evt);
this.hideTooltip();
// if this is IE < 7 use an alternative image if one is provided
if (this.isOldIE() && this.ieImage) {
this.balloonImage = this.ieImage;
this.ieImage = null;
}
// look for a url in the balloon contents
var match;
if (match = caption.match(/^url:(\S+)/)) {
caption = '';
this.activeUrl = match[1];
}
// or if the contents are to be retrieved from an element
else if (match = caption.match(/^load:(\S+)/)) {
if (!document.getElementById(match[1])) alert ('problem locating element '+load[1]);
caption = document.getElementById(match[1]).innerHTML;
}
// or if the text is a bare hyperlink
else if (caption.match(/^(https?:|\/|ftp:)\S+$/i)) {
this.activeUrl = caption;
caption = '';
}
// create the balloon object
currentBalloonClass = this;
this.balloon = this.makeBalloon();
// prepare the contents
this.wrapper = this.wrapContents(caption);
// Balloon will be created after delayTime unless a mouseout happens first
this.timeoutTooltip = window.setTimeout(this.doShowTooltip,this.delayTime);
}
/////////////////////////////////////////////////////////////////////
// Tooltip rendering function
/////////////////////////////////////////////////////////////////////
Balloon.prototype.doShowTooltip = function() {
var bSelf = currentBalloonClass;
var balloon = bSelf.balloon;
// Stop firing if a balloon is already being displayed
if (balloonIsVisible) return false;
// record which element owns the balloon
bSelf.currentElement = bSelf.firingElement;
// make sure user-configured numbers are not strings
bSelf.parseIntAll();
// Hide the off-screen contents container
bSelf.setStyle(this.container,'display','none');
// window dimensions
var pageWidth = YAHOO.util.Dom.getViewportWidth();
var pageCen = Math.round(pageWidth/2);
var pageHeight = YAHOO.util.Dom.getViewportHeight();
var pageLeft = YAHOO.util.Dom.getDocumentScrollLeft();
var pageTop = YAHOO.util.Dom.getDocumentScrollTop();
var pageMid = pageTop + Math.round(pageHeight/2);
// balloon orientation
var vOrient = bSelf.activeTop > pageMid ? 'up' : 'down';
var hOrient = bSelf.activeRight > pageCen ? 'left' : 'right';
// sticky balloons need a close control
if (balloonIsSticky) {
var style =
'margin-right:-'+Math.round(bSelf.padding/2 - 1)+'px;float:right;'+
'cursor:pointer;margin-top:-'+Math.round(bSelf.padding/2 - 1)+'px;float:right';
bSelf.wrapper.innerHTML =
''+bSelf.wrapper.innerHTML;
}
// how and where to draw the balloon
bSelf.setBalloonStyle(vOrient,hOrient,pageWidth,pageLeft);
balloonIsVisible = true;
// in IE < 7, hide