Team:UC Davis/lightbox/js

From 2011.igem.org

(Difference between revisions)
Line 1: Line 1:
 +
/*
 +
Lightbox JS: Fullsize Image Overlays
 +
by Lokesh Dhakar - http://www.huddletogether.com
 +
For more information on this script, visit:
 +
http://huddletogether.com/projects/lightbox/
-
    Table of Contents
+
Licensed under the Creative Commons Attribution 2.5 License - http://creativecommons.org/licenses/by/2.5/
-
    -----------------
+
(basically, do anything you want, just leave my name and link)
-
    Configuration
+
 +
Table of Contents
 +
-----------------
 +
Configuration
 +
 +
Functions
 +
- getPageScroll()
 +
- getPageSize()
 +
- pause()
 +
- getKey()
 +
- listenKey()
 +
- showLightbox()
 +
- hideLightbox()
 +
- initLightbox()
 +
- addLoadEvent()
 +
 +
Function Calls
 +
- addLoadEvent(initLightbox)
-
    Lightbox Class Declaration
 
-
    - initialize()
 
-
    - updateImageList()
 
-
    - start()
 
-
    - changeImage()
 
-
    - resizeImageContainer()
 
-
    - showImage()
 
-
    - updateDetails()
 
-
    - updateNav()
 
-
    - enableKeyboardNav()
 
-
    - disableKeyboardNav()
 
-
    - keyboardAction()
 
-
    - preloadNeighborImages()
 
-
    - end()
 
-
   
 
-
    Function Calls
 
-
    - document.observe()
 
-
 
 
*/
*/
-
// -----------------------------------------------------------------------------------
+
 
 +
 
//
//
-
// Configurationl
+
// Configuration
//
//
-
LightboxOptions = Object.extend({
 
-
    fileLoadingImage:        'images/loading.gif',   
 
-
    fileBottomNavCloseImage: 'images/closelabel.gif',
 
-
    overlayOpacity: 0.8,  // controls transparency of shadow overlay
+
// If you would like to use a custom loading image or close button reference them in the next two lines.
 +
var loadingImage = 'loading.gif';
 +
var closeButton = 'close.gif';
-
    animate: true,        // toggles resizing animations
 
-
    resizeSpeed: 7,        // controls the speed of the image resizing animations (1=slowest and 10=fastest)
 
-
    borderSize: 10,        //if you adjust the padding in the CSS, you will need to update this variable
 
-
// When grouping images this is used to write: Image # of #.
 
-
// Change it for non-english localization
 
-
labelImage: "Image",
 
-
labelOf: "of"
 
-
}, window.LightboxOptions || {});
 
-
// -----------------------------------------------------------------------------------
 
-
var Lightbox = Class.create();
+
//
 +
// getPageScroll()
 +
// Returns array with x,y page scroll values.
 +
// Core code from - quirksmode.org
 +
//
 +
function getPageScroll(){
-
Lightbox.prototype = {
+
var yScroll;
-
    imageArray: [],
+
-
    activeImage: undefined,
+
-
   
+
-
    // initialize()
+
-
    // Constructor runs on completion of the DOM loading. Calls updateImageList and then
+
-
    // the function inserts html at the bottom of the page which is used to display the shadow
+
-
    // overlay and the image container.
+
-
    //
+
-
    initialize: function() {   
+
-
       
+
-
        this.updateImageList();
+
-
       
+
-
        this.keyboardAction = this.keyboardAction.bindAsEventListener(this);
+
-
        if (LightboxOptions.resizeSpeed > 10) LightboxOptions.resizeSpeed = 10;
+
if (self.pageYOffset) {
-
        if (LightboxOptions.resizeSpeed < 1)  LightboxOptions.resizeSpeed = 1;
+
yScroll = self.pageYOffset;
 +
} else if (document.documentElement && document.documentElement.scrollTop){ // Explorer 6 Strict
 +
yScroll = document.documentElement.scrollTop;
 +
} else if (document.body) {// all other Explorers
 +
yScroll = document.body.scrollTop;
 +
}
-
    this.resizeDuration = LightboxOptions.animate ? ((11 - LightboxOptions.resizeSpeed) * 0.15) : 0;
+
arrayPageScroll = new Array('',yScroll)  
-
    this.overlayDuration = LightboxOptions.animate ? 0.2 : 0; // shadow fade in/out duration
+
return arrayPageScroll;
-
 
+
}
-
        // When Lightbox starts it will resize itself from 250 by 250 to the current image dimension.
+
-
        // If animations are turned off, it will be hidden as to prevent a flicker of a
+
-
        // white 250 by 250 box.
+
-
        var size = (LightboxOptions.animate ? 250 : 1) + 'px';
+
-
       
+
-
 
+
-
        // Code inserts html at the bottom of the page that looks similar to this:
+
-
        //
+
-
        //  <div id="overlay"></div>
+
-
        //  <div id="lightbox">
+
-
        //      <div id="outerImageContainer">
+
-
        //          <div id="imageContainer">
+
-
        //              <img id="lightboxImage">
+
-
        //              <div style="" id="hoverNav">
+
-
        //                  <a href="#" id="prevLink"></a>
+
-
        //                  <a href="#" id="nextLink"></a>
+
-
        //              </div>
+
-
        //              <div id="loading">
+
-
        //                  <a href="#" id="loadingLink">
+
-
        //                      <img src="images/loading.gif">
+
-
        //                  </a>
+
-
        //              </div>
+
-
        //          </div>
+
-
        //      </div>
+
-
        //      <div id="imageDataContainer">
+
-
        //          <div id="imageData">
+
-
        //              <div id="imageDetails">
+
-
        //                  <span id="caption"></span>
+
-
        //                  <span id="numberDisplay"></span>
+
-
        //              </div>
+
-
        //              <div id="bottomNav">
+
-
        //                  <a href="#" id="bottomNavClose">
+
-
        //                      <img src="images/close.gif">
+
-
        //                  </a>
+
-
        //              </div>
+
-
        //          </div>
+
-
        //      </div>
+
-
        //  </div>
+
-
        var objBody = $$('body')[0];
 
-
objBody.appendChild(Builder.node('div',{id:'overlay'}));
+
//
 +
// getPageSize()
 +
// Returns array with page width, height and window width, height
 +
// Core code from - quirksmode.org
 +
// Edit for Firefox by pHaez
 +
//
 +
function getPageSize(){
-
        objBody.appendChild(Builder.node('div',{id:'lightbox'}, [
+
var xScroll, yScroll;
-
            Builder.node('div',{id:'outerImageContainer'},
+
-
                Builder.node('div',{id:'imageContainer'}, [
+
if (window.innerHeight && window.scrollMaxY) {
-
                    Builder.node('img',{id:'lightboxImage'}),
+
xScroll = document.body.scrollWidth;
-
                    Builder.node('div',{id:'hoverNav'}, [
+
yScroll = window.innerHeight + window.scrollMaxY;
-
                        Builder.node('a',{id:'prevLink', href: '#' }),
+
} else if (document.body.scrollHeight > document.body.offsetHeight){ // all but Explorer Mac
-
                        Builder.node('a',{id:'nextLink', href: '#' })
+
xScroll = document.body.scrollWidth;
-
                    ]),
+
yScroll = document.body.scrollHeight;
-
                    Builder.node('div',{id:'loading'},  
+
} else { // Explorer Mac...would also work in Explorer 6 Strict, Mozilla and Safari
-
                        Builder.node('a',{id:'loadingLink', href: '#' },
+
xScroll = document.body.offsetWidth;
-
                            Builder.node('img', {src: LightboxOptions.fileLoadingImage})
+
yScroll = document.body.offsetHeight;
-
                        )
+
}
-
                    )
+
-
                ])
+
var windowWidth, windowHeight;
-
            ),
+
if (self.innerHeight) { // all except Explorer
-
            Builder.node('div', {id:'imageDataContainer'},
+
windowWidth = self.innerWidth;
-
                Builder.node('div',{id:'imageData'}, [
+
windowHeight = self.innerHeight;
-
                    Builder.node('div',{id:'imageDetails'}, [
+
} else if (document.documentElement && document.documentElement.clientHeight) { // Explorer 6 Strict Mode
-
                        Builder.node('span',{id:'caption'}),
+
windowWidth = document.documentElement.clientWidth;
-
                        Builder.node('span',{id:'numberDisplay'})
+
windowHeight = document.documentElement.clientHeight;
-
                    ]),
+
} else if (document.body) { // other Explorers
-
                    Builder.node('div',{id:'bottomNav'},
+
windowWidth = document.body.clientWidth;
-
                        Builder.node('a',{id:'bottomNavClose', href: '#' },
+
windowHeight = document.body.clientHeight;
-
                            Builder.node('img', { src: LightboxOptions.fileBottomNavCloseImage })
+
}
-
                        )
+
-
                    )
+
// for small pages with total height less then height of the viewport
-
                ])
+
if(yScroll < windowHeight){
-
            )
+
pageHeight = windowHeight;
-
        ]));
+
} else {
 +
pageHeight = yScroll;
 +
}
 +
// for small pages with total width less then width of the viewport
 +
if(xScroll < windowWidth){
 +
pageWidth = windowWidth;
 +
} else {
 +
pageWidth = xScroll;
 +
}
-
$('overlay').hide().observe('click', (function() { this.end(); }).bind(this));
 
-
$('lightbox').hide().observe('click', (function(event) { if (event.element().id == 'lightbox') this.end(); }).bind(this));
 
-
$('outerImageContainer').setStyle({ width: size, height: size });
 
-
$('prevLink').observe('click', (function(event) { event.stop(); this.changeImage(this.activeImage - 1); }).bindAsEventListener(this));
 
-
$('nextLink').observe('click', (function(event) { event.stop(); this.changeImage(this.activeImage + 1); }).bindAsEventListener(this));
 
-
$('loadingLink').observe('click', (function(event) { event.stop(); this.end(); }).bind(this));
 
-
$('bottomNavClose').observe('click', (function(event) { event.stop(); this.end(); }).bind(this));
 
-
        var th = this;
+
arrayPageSize = new Array(pageWidth,pageHeight,windowWidth,windowHeight)  
-
        (function(){
+
return arrayPageSize;
-
            var ids =
+
}
-
                'overlay lightbox outerImageContainer imageContainer lightboxImage hoverNav prevLink nextLink loading loadingLink ' +
+
-
                'imageDataContainer imageData imageDetails caption numberDisplay bottomNav bottomNavClose';  
+
-
            $w(ids).each(function(id){ th[id] = $(id); });
+
-
        }).defer();
+
-
    },
+
-
    //
 
-
    // updateImageList()
 
-
    // Loops through anchor tags looking for 'lightbox' references and applies onclick
 
-
    // events to appropriate links. You can rerun after dynamically adding images w/ajax.
 
-
    //
 
-
    updateImageList: function() { 
 
-
        this.updateImageList = Prototype.emptyFunction;
 
-
        document.observe('click', (function(event){
+
//
-
            var target = event.findElement('a[rel^=lightbox]') || event.findElement('area[rel^=lightbox]');
+
// pause(numberMillis)
-
            if (target) {
+
// Pauses code execution for specified time. Uses busy code, not good.
-
                event.stop();
+
// Code from http://www.faqts.com/knowledge_base/view.phtml/aid/1602
-
                this.start(target);
+
//
-
            }
+
function pause(numberMillis) {
-
        }).bind(this));
+
var now = new Date();
-
    },
+
var exitTime = now.getTime() + numberMillis;
-
   
+
while (true) {
-
    //
+
now = new Date();
-
    //  start()
+
if (now.getTime() > exitTime)
-
    //  Display overlay and lightbox. If image is part of a set, add siblings to imageArray.
+
return;
-
    //
+
}
-
    start: function(imageLink) {   
+
}
-
        $$('select', 'object', 'embed').each(function(node){ node.style.visibility = 'hidden' });
+
//
 +
// getKey(key)
 +
// Gets keycode. If 'x' is pressed then it hides the lightbox.
 +
//
-
        // stretch overlay to fill page and fade in
+
function getKey(e){
-
        var arrayPageSize = this.getPageSize();
+
if (e == null) { // ie
-
        $('overlay').setStyle({ width: arrayPageSize[0] + 'px', height: arrayPageSize[1] + 'px' });
+
keycode = event.keyCode;
 +
} else { // mozilla
 +
keycode = e.which;
 +
}
 +
key = String.fromCharCode(keycode).toLowerCase();
 +
 +
if(key == 'x'){ hideLightbox(); }
 +
}
-
        new Effect.Appear(this.overlay, { duration: this.overlayDuration, from: 0.0, to: LightboxOptions.overlayOpacity });
 
-
        this.imageArray = [];
+
//
-
        var imageNum = 0;     
+
// listenKey()
 +
//
 +
function listenKey () { document.onkeypress = getKey; }
 +
-
        if ((imageLink.getAttribute("rel") == 'lightbox')){
+
//
-
            // if image is NOT part of a set, add single image to imageArray
+
// showLightbox()
-
            this.imageArray.push([imageLink.href, imageLink.title]);       
+
// Preloads images. Pleaces new image in lightbox then centers and displays.
-
        } else {
+
//
-
            // if image is part of a set..
+
function showLightbox(objLink)
-
            this.imageArray =  
+
{
-
                $$(imageLink.tagName + '[href][rel="' + imageLink.rel + '"]').
+
// prep objects
-
                collect(function(anchor){ return [anchor.href, anchor.title]; }).
+
var objOverlay = document.getElementById('overlay');
-
                uniq();
+
var objLightbox = document.getElementById('lightbox');
-
           
+
var objCaption = document.getElementById('lightboxCaption');
-
            while (this.imageArray[imageNum][0] != imageLink.href) { imageNum++; }
+
var objImage = document.getElementById('lightboxImage');
-
        }
+
var objLoadingImage = document.getElementById('loadingImage');
 +
var objLightboxDetails = document.getElementById('lightboxDetails');
-
        // calculate top and left offset for the lightbox
+
-
        var arrayPageScroll = document.viewport.getScrollOffsets();
+
var arrayPageSize = getPageSize();
-
        var lightboxTop = arrayPageScroll[1] + (document.viewport.getHeight() / 10);
+
var arrayPageScroll = getPageScroll();
-
        var lightboxLeft = arrayPageScroll[0];
+
-
        this.lightbox.setStyle({ top: lightboxTop + 'px', left: lightboxLeft + 'px' }).show();
+
-
       
+
-
        this.changeImage(imageNum);
+
-
    },
+
-
    //
+
// center loadingImage if it exists
-
    //  changeImage()
+
if (objLoadingImage) {
-
    //  Hide most elements and preload image in preparation for resizing image container.
+
objLoadingImage.style.top = (arrayPageScroll[1] + ((arrayPageSize[3] - 35 - objLoadingImage.height) / 2) + 'px');
-
    //
+
objLoadingImage.style.left = (((arrayPageSize[0] - 20 - objLoadingImage.width) / 2) + 'px');
-
    changeImage: function(imageNum) { 
+
objLoadingImage.style.display = 'block';
-
       
+
}
-
        this.activeImage = imageNum; // update global var
+
-
        // hide elements during transition
+
// set height of Overlay to take up whole page and show
-
        if (LightboxOptions.animate) this.loading.show();
+
objOverlay.style.height = (arrayPageSize[1] + 'px');
-
        this.lightboxImage.hide();
+
objOverlay.style.display = 'block';
-
        this.hoverNav.hide();
+
-
        this.prevLink.hide();
+
-
        this.nextLink.hide();
+
-
// HACK: Opera9 does not currently support scriptaculous opacity and appear fx
+
-
        this.imageDataContainer.setStyle({opacity: .0001});
+
-
        this.numberDisplay.hide();     
+
-
       
+
-
        var imgPreloader = new Image();
+
-
       
+
-
        // once image is preloaded, resize image container
+
-
        imgPreloader.onload = (function(){
+
-
            this.lightboxImage.src = this.imageArray[this.activeImage][0];
+
-
            /*Bug Fixed by Andy Scott*/
+
-
            this.lightboxImage.width = imgPreloader.width;
+
-
            this.lightboxImage.height = imgPreloader.height;
+
-
            /*End of Bug Fix*/
+
-
            this.resizeImageContainer(imgPreloader.width, imgPreloader.height);
+
-
        }).bind(this);
+
-
        imgPreloader.src = this.imageArray[this.activeImage][0];
+
-
    },
+
-
    //
+
// preload image
-
    //  resizeImageContainer()
+
imgPreload = new Image();
-
    //
+
-
    resizeImageContainer: function(imgWidth, imgHeight) {
+
-
        // get current width and height
+
imgPreload.onload=function(){
-
        var widthCurrent  = this.outerImageContainer.getWidth();
+
objImage.src = objLink.href;
-
        var heightCurrent = this.outerImageContainer.getHeight();
+
-
        // get new width and height
+
// center lightbox and make sure that the top and left values are not negative
-
        var widthNew  = (imgWidth  + LightboxOptions.borderSize * 2);
+
// and the image placed outside the viewport
-
        var heightNew = (imgHeight + LightboxOptions.borderSize * 2);
+
var lightboxTop = arrayPageScroll[1] + ((arrayPageSize[3] - 35 - imgPreload.height) / 2);
 +
var lightboxLeft = ((arrayPageSize[0] - 20 - imgPreload.width) / 2);
 +
 +
objLightbox.style.top = (lightboxTop < 0) ? "0px" : lightboxTop + "px";
 +
objLightbox.style.left = (lightboxLeft < 0) ? "0px" : lightboxLeft + "px";
-
        // scalars based on change from old to new
 
-
        var xScale = (widthNew  / widthCurrent)  * 100;
 
-
        var yScale = (heightNew / heightCurrent) * 100;
 
-
        // calculate size difference between new and old image, and resize if necessary
+
objLightboxDetails.style.width = imgPreload.width + 'px';
-
        var wDiff = widthCurrent - widthNew;
+
-
        var hDiff = heightCurrent - heightNew;
+
if(objLink.getAttribute('title')){
 +
objCaption.style.display = 'block';
 +
//objCaption.style.width = imgPreload.width + 'px';
 +
objCaption.innerHTML = objLink.getAttribute('title');
 +
} else {
 +
objCaption.style.display = 'none';
 +
}
 +
 +
// A small pause between the image loading and displaying is required with IE,
 +
// this prevents the previous image displaying for a short burst causing flicker.
 +
if (navigator.appVersion.indexOf("MSIE")!=-1){
 +
pause(250);
 +
}
-
        if (hDiff != 0) new Effect.Scale(this.outerImageContainer, yScale, {scaleX: false, duration: this.resizeDuration, queue: 'front'});  
+
if (objLoadingImage) { objLoadingImage.style.display = 'none'; }
-
        if (wDiff != 0) new Effect.Scale(this.outerImageContainer, xScale, {scaleY: false, duration: this.resizeDuration, delay: this.resizeDuration});
+
-
        // if new and old image are same size and no scaling transition is necessary,
+
// Hide select boxes as they will 'peek' through the image in IE
-
        // do a quick pause to prevent image flicker.
+
selects = document.getElementsByTagName("select");
-
        var timeout = 0;
+
         for (i = 0; i != selects.length; i++) {
-
         if ((hDiff == 0) && (wDiff == 0)){
+
                selects[i].style.visibility = "hidden";
-
            timeout = 100;
+
-
            if (Prototype.Browser.IE) timeout = 250;  
+
         }
         }
-
        (function(){
+
-
            this.prevLink.setStyle({ height: imgHeight + 'px' });
+
objLightbox.style.display = 'block';
-
            this.nextLink.setStyle({ height: imgHeight + 'px' });
+
-
            this.imageDataContainer.setStyle({ width: widthNew + 'px' });
+
-
            this.showImage();
+
// After image is loaded, update the overlay height as the new image might have
-
        }).bind(this).delay(timeout / 1000);
+
// increased the overall page height.
-
    },
+
arrayPageSize = getPageSize();
-
   
+
objOverlay.style.height = (arrayPageSize[1] + 'px');
-
    //
+
-
    //  showImage()
+
// Check for 'x' keypress
-
    //  Display image and begin preloading neighbors.
+
listenKey();
-
    //
+
-
    showImage: function(){
+
-
        this.loading.hide();
+
-
        new Effect.Appear(this.lightboxImage, {
+
-
            duration: this.resizeDuration,
+
-
            queue: 'end',
+
-
            afterFinish: (function(){ this.updateDetails(); }).bind(this)
+
-
        });
+
-
        this.preloadNeighborImages();
+
-
    },
+
-
    //
+
return false;
-
    //  updateDetails()
+
}
-
    //  Display caption, image number, and bottom nav.
+
-
    //
+
-
    updateDetails: function() {
+
-
   
+
-
        this.caption.update(this.imageArray[this.activeImage][1]).show();
+
-
        // if image is part of set display 'Image x of x'
+
imgPreload.src = objLink.href;
-
        if (this.imageArray.length > 1){
+
-
            this.numberDisplay.update( LightboxOptions.labelImage + ' ' + (this.activeImage + 1) + ' ' + LightboxOptions.labelOf + '  ' + this.imageArray.length).show();
+
}
-
        }
+
-
        new Effect.Parallel(
 
-
            [
 
-
                new Effect.SlideDown(this.imageDataContainer, { sync: true, duration: this.resizeDuration, from: 0.0, to: 1.0 }),
 
-
                new Effect.Appear(this.imageDataContainer, { sync: true, duration: this.resizeDuration })
 
-
            ],
 
-
            {
 
-
                duration: this.resizeDuration,
 
-
                afterFinish: (function() {
 
-
                // update overlay size and update nav
 
-
                var arrayPageSize = this.getPageSize();
 
-
                this.overlay.setStyle({ width: arrayPageSize[0] + 'px', height: arrayPageSize[1] + 'px' });
 
-
                this.updateNav();
 
-
                }).bind(this)
 
-
            }
 
-
        );
 
-
    },
 
-
    //
 
-
    //  updateNav()
 
-
    //  Display appropriate previous and next hover navigation.
 
-
    //
 
-
    updateNav: function() {
 
-
        this.hoverNav.show();             
 
-
        // if not first image in set, display prev image button
 
-
        if (this.activeImage > 0) this.prevLink.show();
 
-
        // if not last image in set, display next image button
+
//
-
        if (this.activeImage < (this.imageArray.length - 1)) this.nextLink.show();
+
// hideLightbox()
-
       
+
//
-
        this.enableKeyboardNav();
+
function hideLightbox()
-
    },
+
{
 +
// get objects
 +
objOverlay = document.getElementById('overlay');
 +
objLightbox = document.getElementById('lightbox');
-
    //
+
// hide lightbox and overlay
-
    //  enableKeyboardNav()
+
objOverlay.style.display = 'none';
-
    //
+
objLightbox.style.display = 'none';
-
    enableKeyboardNav: function() {
+
-
        document.observe('keydown', this.keyboardAction);  
+
-
    },
+
-
    //
+
// make select boxes visible
-
    //  disableKeyboardNav()
+
selects = document.getElementsByTagName("select");
-
     //
+
     for (i = 0; i != selects.length; i++) {
-
    disableKeyboardNav: function() {
+
selects[i].style.visibility = "visible";
-
        document.stopObserving('keydown', this.keyboardAction);  
+
}
-
    },
+
-
    //
+
// disable keypress listener
-
    //  keyboardAction()
+
document.onkeypress = '';
-
    //
+
}
-
    keyboardAction: function(event) {
+
-
        var keycode = event.keyCode;
+
-
        var escapeKey;
 
-
        if (event.DOM_VK_ESCAPE) {  // mozilla
 
-
            escapeKey = event.DOM_VK_ESCAPE;
 
-
        } else { // ie
 
-
            escapeKey = 27;
 
-
        }
 
-
        var key = String.fromCharCode(keycode).toLowerCase();
 
-
       
 
-
        if (key.match(/x|o|c/) || (keycode == escapeKey)){ // close lightbox
 
-
            this.end();
 
-
        } else if ((key == 'p') || (keycode == 37)){ // display previous image
 
-
            if (this.activeImage != 0){
 
-
                this.disableKeyboardNav();
 
-
                this.changeImage(this.activeImage - 1);
 
-
            }
 
-
        } else if ((key == 'n') || (keycode == 39)){ // display next image
 
-
            if (this.activeImage != (this.imageArray.length - 1)){
 
-
                this.disableKeyboardNav();
 
-
                this.changeImage(this.activeImage + 1);
 
-
            }
 
-
        }
 
-
    },
 
-
    //
 
-
    //  preloadNeighborImages()
 
-
    //  Preload previous and next images.
 
-
    //
 
-
    preloadNeighborImages: function(){
 
-
        var preloadNextImage, preloadPrevImage;
 
-
        if (this.imageArray.length > this.activeImage + 1){
 
-
            preloadNextImage = new Image();
 
-
            preloadNextImage.src = this.imageArray[this.activeImage + 1][0];
 
-
        }
 
-
        if (this.activeImage > 0){
 
-
            preloadPrevImage = new Image();
 
-
            preloadPrevImage.src = this.imageArray[this.activeImage - 1][0];
 
-
        }
 
-
   
 
-
    },
 
-
    //
+
//
-
    // end()
+
// initLightbox()
-
    //
+
// Function runs on window load, going through link tags looking for rel="lightbox".
-
    end: function() {
+
// These links receive onclick events that enable the lightbox display for their targets.
-
        this.disableKeyboardNav();
+
// The function also inserts html markup at the top of the page which will be used as a
-
        this.lightbox.hide();
+
// container for the overlay pattern and the inline image.
-
        new Effect.Fade(this.overlay, { duration: this.overlayDuration });
+
//
-
        $$('select', 'object', 'embed').each(function(node){ node.style.visibility = 'visible' });
+
function initLightbox()
-
    },
+
{
 +
 +
if (!document.getElementsByTagName){ return; }
 +
var anchors = document.getElementsByTagName("a");
-
    //
+
// loop through all anchor tags
-
    //  getPageSize()
+
for (var i=0; i<anchors.length; i++){
-
    //
+
var anchor = anchors[i];
-
    getPageSize: function() {
+
 
-
       
+
if (anchor.getAttribute("href") && (anchor.getAttribute("rel") == "lightbox")){
-
    var xScroll, yScroll;
+
anchor.onclick = function () {showLightbox(this); return false;}
-
+
-
if (window.innerHeight && window.scrollMaxY) {
+
-
xScroll = window.innerWidth + window.scrollMaxX;
+
-
yScroll = window.innerHeight + window.scrollMaxY;
+
-
} else if (document.body.scrollHeight > document.body.offsetHeight){ // all but Explorer Mac
+
-
xScroll = document.body.scrollWidth;
+
-
yScroll = document.body.scrollHeight;
+
-
} else { // Explorer Mac...would also work in Explorer 6 Strict, Mozilla and Safari
+
-
xScroll = document.body.offsetWidth;
+
-
yScroll = document.body.offsetHeight;
+
}
}
 +
}
 +
 +
// the rest of this code inserts html at the top of the page that looks like this:
 +
//
 +
// <div id="overlay">
 +
// <a href="#" onclick="hideLightbox(); return false;"><img id="loadingImage" /></a>
 +
// </div>
 +
// <div id="lightbox">
 +
// <a href="#" onclick="hideLightbox(); return false;" title="Click anywhere to close image">
 +
// <img id="closeButton" />
 +
// <img id="lightboxImage" />
 +
// </a>
 +
// <div id="lightboxDetails">
 +
// <div id="lightboxCaption"></div>
 +
// <div id="keyboardMsg"></div>
 +
// </div>
 +
// </div>
 +
 +
var objBody = document.getElementsByTagName("body").item(0);
 +
 +
// create overlay div and hardcode some functional styles (aesthetic styles are in CSS file)
 +
var objOverlay = document.createElement("div");
 +
objOverlay.setAttribute('id','overlay');
 +
objOverlay.onclick = function () {hideLightbox(); return false;}
 +
objOverlay.style.display = 'none';
 +
objOverlay.style.position = 'absolute';
 +
objOverlay.style.top = '0';
 +
objOverlay.style.left = '0';
 +
objOverlay.style.zIndex = '90';
 +
objOverlay.style.width = '100%';
 +
objBody.insertBefore(objOverlay, objBody.firstChild);
 +
 +
var arrayPageSize = getPageSize();
 +
var arrayPageScroll = getPageScroll();
 +
 +
// preload and create loader image
 +
var imgPreloader = new Image();
 +
 +
// if loader image found, create link to hide lightbox and create loadingimage
 +
imgPreloader.onload=function(){
 +
 +
var objLoadingImageLink = document.createElement("a");
 +
objLoadingImageLink.setAttribute('href','#');
 +
objLoadingImageLink.onclick = function () {hideLightbox(); return false;}
 +
objOverlay.appendChild(objLoadingImageLink);
-
var windowWidth, windowHeight;
+
var objLoadingImage = document.createElement("img");
-
+
objLoadingImage.src = loadingImage;
-
if (self.innerHeight) { // all except Explorer
+
objLoadingImage.setAttribute('id','loadingImage');
-
if(document.documentElement.clientWidth){
+
objLoadingImage.style.position = 'absolute';
-
windowWidth = document.documentElement.clientWidth;
+
objLoadingImage.style.zIndex = '150';
-
} else {
+
objLoadingImageLink.appendChild(objLoadingImage);
-
windowWidth = self.innerWidth;
+
-
}
+
-
windowHeight = self.innerHeight;
+
-
} else if (document.documentElement && document.documentElement.clientHeight) { // Explorer 6 Strict Mode
+
-
windowWidth = document.documentElement.clientWidth;
+
-
windowHeight = document.documentElement.clientHeight;
+
-
} else if (document.body) { // other Explorers
+
-
windowWidth = document.body.clientWidth;
+
-
windowHeight = document.body.clientHeight;
+
-
}
+
-
// for small pages with total height less then height of the viewport
+
imgPreloader.onload=function(){}; // clear onLoad, as IE will flip out w/animated gifs
-
if(yScroll < windowHeight){
+
 
-
pageHeight = windowHeight;
+
return false;
-
} else {
+
}
-
pageHeight = yScroll;
+
 
-
}
+
imgPreloader.src = loadingImage;
 +
 
 +
// create lightbox div, same note about styles as above
 +
var objLightbox = document.createElement("div");
 +
objLightbox.setAttribute('id','lightbox');
 +
objLightbox.style.display = 'none';
 +
objLightbox.style.position = 'absolute';
 +
objLightbox.style.zIndex = '100';
 +
objBody.insertBefore(objLightbox, objOverlay.nextSibling);
-
// for small pages with total width less then width of the viewport
+
// create link
-
if(xScroll < windowWidth){
+
var objLink = document.createElement("a");
-
pageWidth = xScroll;
+
objLink.setAttribute('href','#');
-
} else {
+
objLink.setAttribute('title','Click to close');
-
pageWidth = windowWidth;
+
objLink.onclick = function () {hideLightbox(); return false;}
-
}
+
objLightbox.appendChild(objLink);
-
return [pageWidth,pageHeight];
+
// preload and create close button image
 +
var imgPreloadCloseButton = new Image();
 +
 
 +
// if close button image found,
 +
imgPreloadCloseButton.onload=function(){
 +
 
 +
var objCloseButton = document.createElement("img");
 +
objCloseButton.src = closeButton;
 +
objCloseButton.setAttribute('id','closeButton');
 +
objCloseButton.style.position = 'absolute';
 +
objCloseButton.style.zIndex = '200';
 +
objLink.appendChild(objCloseButton);
 +
 
 +
return false;
}
}
 +
 +
imgPreloadCloseButton.src = closeButton;
 +
 +
// create image
 +
var objImage = document.createElement("img");
 +
objImage.setAttribute('id','lightboxImage');
 +
objLink.appendChild(objImage);
 +
 +
// create details div, a container for the caption and keyboard message
 +
var objLightboxDetails = document.createElement("div");
 +
objLightboxDetails.setAttribute('id','lightboxDetails');
 +
objLightbox.appendChild(objLightboxDetails);
 +
 +
// create caption
 +
var objCaption = document.createElement("div");
 +
objCaption.setAttribute('id','lightboxCaption');
 +
objCaption.style.display = 'none';
 +
objLightboxDetails.appendChild(objCaption);
 +
 +
// create keyboard message
 +
var objKeyboardMsg = document.createElement("div");
 +
objKeyboardMsg.setAttribute('id','keyboardMsg');
 +
objKeyboardMsg.innerHTML = 'press <a href="#" onclick="hideLightbox(); return false;"><kbd>x</kbd></a> to close';
 +
objLightboxDetails.appendChild(objKeyboardMsg);
 +
 +
}
}
-
document.observe('dom:loaded', function () { new Lightbox(); });
+
 
 +
 
 +
 
 +
//
 +
// addLoadEvent()
 +
// Adds event to window.onload without overwriting currently assigned onload functions.
 +
// Function found at Simon Willison's weblog - http://simon.incutio.com/
 +
//
 +
function addLoadEvent(func)
 +
{
 +
var oldonload = window.onload;
 +
if (typeof window.onload != 'function'){
 +
    window.onload = func;
 +
} else {
 +
window.onload = function(){
 +
oldonload();
 +
func();
 +
}
 +
}
 +
 
 +
}
 +
 
 +
 
 +
 
 +
addLoadEvent(initLightbox); // run initLightbox onLoad

Revision as of 22:22, 25 August 2011

/* Lightbox JS: Fullsize Image Overlays by Lokesh Dhakar - http://www.huddletogether.com

For more information on this script, visit: http://huddletogether.com/projects/lightbox/

Licensed under the Creative Commons Attribution 2.5 License - http://creativecommons.org/licenses/by/2.5/ (basically, do anything you want, just leave my name and link)

Table of Contents ----------------- Configuration

Functions - getPageScroll() - getPageSize() - pause() - getKey() - listenKey() - showLightbox() - hideLightbox() - initLightbox() - addLoadEvent()

Function Calls - addLoadEvent(initLightbox)

  • /


// // Configuration //

// If you would like to use a custom loading image or close button reference them in the next two lines. var loadingImage = 'loading.gif'; var closeButton = 'close.gif';



// // getPageScroll() // Returns array with x,y page scroll values. // Core code from - quirksmode.org // function getPageScroll(){

var yScroll;

if (self.pageYOffset) { yScroll = self.pageYOffset; } else if (document.documentElement && document.documentElement.scrollTop){ // Explorer 6 Strict yScroll = document.documentElement.scrollTop; } else if (document.body) {// all other Explorers yScroll = document.body.scrollTop; }

arrayPageScroll = new Array(,yScroll) return arrayPageScroll; }


// // getPageSize() // Returns array with page width, height and window width, height // Core code from - quirksmode.org // Edit for Firefox by pHaez // function getPageSize(){

var xScroll, yScroll;

if (window.innerHeight && window.scrollMaxY) { xScroll = document.body.scrollWidth; yScroll = window.innerHeight + window.scrollMaxY; } else if (document.body.scrollHeight > document.body.offsetHeight){ // all but Explorer Mac xScroll = document.body.scrollWidth; yScroll = document.body.scrollHeight; } else { // Explorer Mac...would also work in Explorer 6 Strict, Mozilla and Safari xScroll = document.body.offsetWidth; yScroll = document.body.offsetHeight; }

var windowWidth, windowHeight; if (self.innerHeight) { // all except Explorer windowWidth = self.innerWidth; windowHeight = self.innerHeight; } else if (document.documentElement && document.documentElement.clientHeight) { // Explorer 6 Strict Mode windowWidth = document.documentElement.clientWidth; windowHeight = document.documentElement.clientHeight; } else if (document.body) { // other Explorers windowWidth = document.body.clientWidth; windowHeight = document.body.clientHeight; }

// for small pages with total height less then height of the viewport if(yScroll < windowHeight){ pageHeight = windowHeight; } else { pageHeight = yScroll; }

// for small pages with total width less then width of the viewport if(xScroll < windowWidth){ pageWidth = windowWidth; } else { pageWidth = xScroll; }


arrayPageSize = new Array(pageWidth,pageHeight,windowWidth,windowHeight) return arrayPageSize; }


// // pause(numberMillis) // Pauses code execution for specified time. Uses busy code, not good. // Code from http://www.faqts.com/knowledge_base/view.phtml/aid/1602 // function pause(numberMillis) { var now = new Date(); var exitTime = now.getTime() + numberMillis; while (true) { now = new Date(); if (now.getTime() > exitTime) return; } }

// // getKey(key) // Gets keycode. If 'x' is pressed then it hides the lightbox. //

function getKey(e){ if (e == null) { // ie keycode = event.keyCode; } else { // mozilla keycode = e.which; } key = String.fromCharCode(keycode).toLowerCase();

if(key == 'x'){ hideLightbox(); } }


// // listenKey() // function listenKey () { document.onkeypress = getKey; }


// // showLightbox() // Preloads images. Pleaces new image in lightbox then centers and displays. // function showLightbox(objLink) { // prep objects var objOverlay = document.getElementById('overlay'); var objLightbox = document.getElementById('lightbox'); var objCaption = document.getElementById('lightboxCaption'); var objImage = document.getElementById('lightboxImage'); var objLoadingImage = document.getElementById('loadingImage'); var objLightboxDetails = document.getElementById('lightboxDetails');


var arrayPageSize = getPageSize(); var arrayPageScroll = getPageScroll();

// center loadingImage if it exists if (objLoadingImage) { objLoadingImage.style.top = (arrayPageScroll[1] + ((arrayPageSize[3] - 35 - objLoadingImage.height) / 2) + 'px'); objLoadingImage.style.left = (((arrayPageSize[0] - 20 - objLoadingImage.width) / 2) + 'px'); objLoadingImage.style.display = 'block'; }

// set height of Overlay to take up whole page and show objOverlay.style.height = (arrayPageSize[1] + 'px'); objOverlay.style.display = 'block';

// preload image imgPreload = new Image();

imgPreload.onload=function(){ objImage.src = objLink.href;

// center lightbox and make sure that the top and left values are not negative // and the image placed outside the viewport var lightboxTop = arrayPageScroll[1] + ((arrayPageSize[3] - 35 - imgPreload.height) / 2); var lightboxLeft = ((arrayPageSize[0] - 20 - imgPreload.width) / 2);

objLightbox.style.top = (lightboxTop < 0) ? "0px" : lightboxTop + "px"; objLightbox.style.left = (lightboxLeft < 0) ? "0px" : lightboxLeft + "px";


objLightboxDetails.style.width = imgPreload.width + 'px';

if(objLink.getAttribute('title')){ objCaption.style.display = 'block'; //objCaption.style.width = imgPreload.width + 'px'; objCaption.innerHTML = objLink.getAttribute('title'); } else { objCaption.style.display = 'none'; }

// A small pause between the image loading and displaying is required with IE, // this prevents the previous image displaying for a short burst causing flicker. if (navigator.appVersion.indexOf("MSIE")!=-1){ pause(250); }

if (objLoadingImage) { objLoadingImage.style.display = 'none'; }

// Hide select boxes as they will 'peek' through the image in IE selects = document.getElementsByTagName("select"); 

       for (i = 0; i != selects.length; i++) {
               selects[i].style.visibility = "hidden";
       }


objLightbox.style.display = 'block';

// After image is loaded, update the overlay height as the new image might have // increased the overall page height. arrayPageSize = getPageSize(); objOverlay.style.height = (arrayPageSize[1] + 'px');

// Check for 'x' keypress listenKey();

return false; }

imgPreload.src = objLink.href;

}



// // hideLightbox() // function hideLightbox() { // get objects objOverlay = document.getElementById('overlay'); objLightbox = document.getElementById('lightbox');

// hide lightbox and overlay objOverlay.style.display = 'none'; objLightbox.style.display = 'none';

// make select boxes visible selects = document.getElementsByTagName("select"); 

   for (i = 0; i != selects.length; i++) {

selects[i].style.visibility = "visible"; }

// disable keypress listener document.onkeypress = ; }



// // initLightbox() // Function runs on window load, going through link tags looking for rel="lightbox". // These links receive onclick events that enable the lightbox display for their targets. // The function also inserts html markup at the top of the page which will be used as a // container for the overlay pattern and the inline image. // function initLightbox() {

if (!document.getElementsByTagName){ return; } var anchors = document.getElementsByTagName("a");

// loop through all anchor tags for (var i=0; i<anchors.length; i++){ var anchor = anchors[i];

if (anchor.getAttribute("href") && (anchor.getAttribute("rel") == "lightbox")){ anchor.onclick = function () {showLightbox(this); return false;} } }

// the rest of this code inserts html at the top of the page that looks like this: //

//

// <a href="#" onclick="hideLightbox(); return false;"><img id="loadingImage" /></a>

//
//

var objBody = document.getElementsByTagName("body").item(0);

// create overlay div and hardcode some functional styles (aesthetic styles are in CSS file) var objOverlay = document.createElement("div"); objOverlay.setAttribute('id','overlay'); objOverlay.onclick = function () {hideLightbox(); return false;} objOverlay.style.display = 'none'; objOverlay.style.position = 'absolute'; objOverlay.style.top = '0'; objOverlay.style.left = '0'; objOverlay.style.zIndex = '90'; 

	objOverlay.style.width = '100%';

objBody.insertBefore(objOverlay, objBody.firstChild);

var arrayPageSize = getPageSize(); var arrayPageScroll = getPageScroll();

// preload and create loader image var imgPreloader = new Image();

// if loader image found, create link to hide lightbox and create loadingimage imgPreloader.onload=function(){

var objLoadingImageLink = document.createElement("a"); objLoadingImageLink.setAttribute('href','#'); objLoadingImageLink.onclick = function () {hideLightbox(); return false;} objOverlay.appendChild(objLoadingImageLink);

var objLoadingImage = document.createElement("img"); objLoadingImage.src = loadingImage; objLoadingImage.setAttribute('id','loadingImage'); objLoadingImage.style.position = 'absolute'; objLoadingImage.style.zIndex = '150'; objLoadingImageLink.appendChild(objLoadingImage);

imgPreloader.onload=function(){}; // clear onLoad, as IE will flip out w/animated gifs

return false; }

imgPreloader.src = loadingImage;

// create lightbox div, same note about styles as above var objLightbox = document.createElement("div"); objLightbox.setAttribute('id','lightbox'); objLightbox.style.display = 'none'; objLightbox.style.position = 'absolute'; objLightbox.style.zIndex = '100'; objBody.insertBefore(objLightbox, objOverlay.nextSibling);

// create link var objLink = document.createElement("a"); objLink.setAttribute('href','#'); objLink.setAttribute('title','Click to close'); objLink.onclick = function () {hideLightbox(); return false;} objLightbox.appendChild(objLink);

// preload and create close button image var imgPreloadCloseButton = new Image();

// if close button image found, imgPreloadCloseButton.onload=function(){

var objCloseButton = document.createElement("img"); objCloseButton.src = closeButton; objCloseButton.setAttribute('id','closeButton'); objCloseButton.style.position = 'absolute'; objCloseButton.style.zIndex = '200'; objLink.appendChild(objCloseButton);

return false; }

imgPreloadCloseButton.src = closeButton;

// create image var objImage = document.createElement("img"); objImage.setAttribute('id','lightboxImage'); objLink.appendChild(objImage);

// create details div, a container for the caption and keyboard message var objLightboxDetails = document.createElement("div"); objLightboxDetails.setAttribute('id','lightboxDetails'); objLightbox.appendChild(objLightboxDetails);

// create caption var objCaption = document.createElement("div"); objCaption.setAttribute('id','lightboxCaption'); objCaption.style.display = 'none'; objLightboxDetails.appendChild(objCaption);

// create keyboard message var objKeyboardMsg = document.createElement("div"); objKeyboardMsg.setAttribute('id','keyboardMsg'); objKeyboardMsg.innerHTML = 'press <a href="#" onclick="hideLightbox(); return false;"><kbd>x</kbd></a> to close'; objLightboxDetails.appendChild(objKeyboardMsg);


}



// // addLoadEvent() // Adds event to window.onload without overwriting currently assigned onload functions. // Function found at Simon Willison's weblog - http://simon.incutio.com/ // function addLoadEvent(func) { var oldonload = window.onload; if (typeof window.onload != 'function'){ 

   	window.onload = func;

} else { window.onload = function(){ oldonload(); func(); } }

}


addLoadEvent(initLightbox); // run initLightbox onLoad

Retrieved from "http://2011.igem.org/Team:UC_Davis/lightbox/js"