git.roojs.org Git - roojs1/blob - ux/Lightbox.js

   1 /* <script type="text/javascript">
   2 // -----------------------------------------------------------------------------------
   3 // Roo lightbox - based on..
   4 //
   5 //      Lightbox v2.04
   6 //      by Lokesh Dhakar - http://www.lokeshdhakar.com
   7 //      Last Modification: 2/9/08
   8 //
   9 //      For more information, visit:
  10 //      http://lokeshdhakar.com/projects/lightbox2/
  11 //
  12 //      Licensed under the Creative Commons Attribution 2.5 License - http://creativecommons.org/licenses/by/2.5/
  13 //      - Free for use in both personal and commercial projects
  14 //              - Attribution requires leaving author name, author link, and the license info intact.
  15 //
  16 //  Thanks: Scott Upton(uptonic.com), Peter-Paul Koch(quirksmode.com), and Thomas Fuchs(mir.aculo.us) for ideas, libs, and snippets.
  17 //              Artemy Tregubenko (arty.name) for cleanup and help in updating to latest ver of proto-aculous.
  18 //
  19 // -----------------------------------------------------------------------------------
  20 /*
  21
  22     Table of Contents
  23     -----------------
  24     Configuration
  25
  26     Lightbox Class Declaration
  27     - initialize()
  28     - updateImageList()
  29     - start()
  30     - changeImage()
  31     - resizeImageContainer()
  32     - showImage()
  33     - updateDetails()
  34     - updateNav()
  35     - enableKeyboardNav()
  36     - disableKeyboardNav()
  37     - keyboardAction()
  38     - preloadNeighborImages()
  39     - end()
  40
  41     Function Calls
  42     - document.observe()
  43
  44 */
  45 Roo.namespace('Roo.ux');
  46
  47 Roo.ux.Lightbox = function(cfg) {
  48     Roo.apply(this,cfg);
  49     this.initialize();
  50 }
  51
  52 Roo.apply(Roo.ux.Lightbox.prototype,
  53 {
  54     // optiosn..
  55     /**
  56      * @cfg fileLoadingImage {string} loading image
  57      */
  58     fileLoadingImage:        '/lightbox/images/loading.gif',
  59     /**
  60      * @cfg fileBottomNavCloseImage {string} close image
  61      */
  62     fileBottomNavCloseImage: '/lightbox/images/closelabel.gif',
  63     /**
  64      * @cfg overlayOpacity {number} controls transparency of shadow overlay
  65      */
  66     overlayOpacity: 0.8,
  67     /**
  68      * @cfg fileLoadingImage {boolean} toggles resizing animations
  69      */
  70     animate: true,
  71     /**
  72      * @cfg resizeSpeed {number} controls the speed of the image
  73      * resizing animations (1=slowest and 10=fastest)
  74      */
  75     resizeSpeed: 9,
  76     /**
  77      * @cfg borderSize {number} if you adjust the padding in the CSS,
  78      * you will need to update this variable
  79      */
  80     borderSize: 10,
  81     /**
  82      * @cfg labelImage {string} When grouping images this is used to write: Image # of #.
  83      * Change it for non-english localization
  84      */
  85         labelImage: "Image",
  86         /**
  87      * @cfg labelOf {string}  When grouping images this is used to write: Image # of #.
  88      */
  89     labelOf: "of",
  90
  91
  92
  93
  94     /**
  95      * List of images
  96      */
  97     imageArray: [],
  98
  99     /**
 100      * Current image.
 101      *
 102      */
 103
 104     activeImage: undefined,
 105
 106     /**
 107      * initialize()
 108      *  Constructor runs on completion of the DOM loading. Calls updateImageList and then
 109      * the function inserts html at the bottom of the page which is used to display the shadow
 110      *  overlay and the image container.
 111      *
 112      *
 113      */
 114     initialize: function() {
 115
 116         this.updateImageList();
 117
 118         // TBD this.keyboardAction = this.keyboardAction.bindAsEventListener(this);
 119         this.resizeSpeed  = Math.min(this.resizeSpeed, 10);
 120         this.resizeSpeed  = Math.max(this.resizeSpeed, 1);
 121
 122             this.resizeDuration = this.animate ? ((11 - this.resizeSpeed) * 0.15) : 0;
 123             this.overlayDuration = this.animate ? 0.2 : 0;  // shadow fade in/out duration
 124
 125         // When Lightbox starts it will resize itself from 250 by 250 to the current image dimension.
 126         // If animations are turned off, it will be hidden as to prevent a flicker of a
 127         // white 250 by 250 box.
 128         var size = (this.animate ? 250 : 1) + 'px';
 129         var dh = Roo.DomHelper;
 130         this.el = dh.append(document.body, {
 131                 html:
 132                //   '<div id="overlay"></div>' +
 133                   '<div id="lightbox">' +
 134                   '   <div id="outerImageContainer">' +
 135                   '       <div id="imageContainer">' +
 136                   '           <img id="lightboxImage">' +
 137                   '           <div style="" id="hoverNav">' +
 138                   '               <a href="#" id="prevLink"></a>' +
 139                   '               <a href="#" id="nextLink"></a>' +
 140                   '           </div>' +
 141                   '           <div id="loading">' +
 142                   '               <a href="#" id="loadingLink">&nbsp;</a>' +
 143                   '           </div>' +
 144                   '       </div>' +
 145                   '   </div>' +
 146                   '   <div id="imageDataContainer">' +
 147                   '       <div id="imageData">' +
 148                   '           <div id="imageDetails">' +
 149                   '               <span id="caption"></span>' +
 150                   '               <span id="numberDisplay"></span>' +
 151                   '           </div>' +
 152                   '           <div id="bottomNav">' +
 153                   '               <div href="#" id="bottomNavClose"></div>' +
 154                   '           </div>' +
 155                   '       </div>' +
 156                   '   </div>' +
 157                  '</div>'
 158             }, true);
 159
 160
 161
 162         var th = this;
 163
 164         var ids =
 165             'lightbox outerImageContainer imageContainer ' +
 166             'lightboxImage hoverNav prevLink nextLink loading loadingLink ' +
 167             'imageDataContainer imageData imageDetails caption numberDisplay '
 168             'bottomNav bottomNavClose';
 169
 170         Roo.each(ids.split(' '),
 171             function(id){
 172
 173                 th[id] = Roo.get(id);
 174                 if (!th[id]) {
 175                     return;
 176                    }
 177                 th[id].setVisibilityMode(Roo.Element.DISPLAY);
 178             });
 179
 180
 181                 //Roo.get('overlay').hide();
 182         //Roo.get('overlay').on('click', this.end, this);
 183                 Roo.get('lightbox').hide();
 184         Roo.get('lightbox').on('click',  function(event) {
 185                 if (event.getTarget().id == 'lightbox') {
 186                     this.end();
 187                 }
 188             }, this);
 189
 190                 Roo.get('outerImageContainer').setStyle({ width: size, height: size });
 191
 192                 Roo.get('prevLink').on('click',
 193             function(event) {
 194                 event.stopEvent();
 195                 this.changeImage(this.activeImage - 1);
 196             }, this);
 197
 198                 Roo.get('nextLink').on('click',
 199             function(event) {
 200                 event.stopEvent();
 201                 this.changeImage(this.activeImage + 1);
 202             },this);
 203
 204                 Roo.get('loadingLink').on('click',
 205             function(event) {
 206                 event.stopEvent();
 207                 this.end();
 208             }, this);
 209
 210                 Roo.get('bottomNavClose').on('click',
 211             function(event) {
 212                 event.stopEvent();
 213                 this.end();
 214             }, this);
 215
 216
 217     },
 218
 219     /**
 220      * updateImageList()
 221      * Loops through anchor tags looking for 'lightbox' references and applies onclick
 222      * events to appropriate links. You can rerun after dynamically adding images w/ajax.
 223      *
 224      */
 225     updateImageList: function() {
 226         this.updateImageList = Roo.emptyFn;
 227
 228         Roo.each(Roo.DomQuery.select('a[rel^=lightbox]'), function(e) {
 229             this.imageArray.push(Roo.get(e));
 230             Roo.get(e).on('click', function(event) {
 231                 event.stopEvent();
 232                 this.start(event.getTarget());
 233             }, this);
 234         }, this)
 235
 236     },
 237
 238     /**
 239     * start()
 240     *  Display overlay and lightbox. If image is part of a set, add siblings to imageArray.
 241     */
 242     start: function(imageLink) {
 243         /*
 244         // hide all the objects that cause problems..
 245         $$('select', 'object', 'embed').each(
 246             function(node){
 247             node.style.visibility = 'hidden' }
 248         );
 249         */
 250         // stretch overlay to fill page and fade in
 251         //var arrayPageSize = this.getPageSize();
 252         Roo.get(document.body).mask(false);
 253         Roo.get(document.body)._mask.setHeight(Roo.lib.Dom.getDocumentHeight())
 254         //new Effect.Appear(this.overlay,
 255         //    { duration: this.overlayDuration, from: 0.0, to: this.overlayOpacity });
 256
 257         //this.imageArray = [];
 258         var imageNum = 0;
 259
 260         if (imageLink) {
 261             imageLink = Roo.get(imageLink);
 262             Roo.each(this.imageArray, function (e, i) {
 263                 if (e.id == imageLink.id) {
 264                     imageNum = i;
 265                 }
 266             })
 267         }
 268
 269         // let's assume the constructor sorts out the list of images..
 270         /*
 271         if ((imageLink.rel == 'lightbox')){
 272             // if image is NOT part of a set, add single image to imageArray
 273             this.imageArray.push([imageLink.href, imageLink.title]);
 274         } else {
 275             // if image is part of a set..
 276             this.imageArray =
 277                 $$(imageLink.tagName + '[href][rel="' + imageLink.rel + '"]').
 278                 collect(function(anchor){ return [anchor.href, anchor.title]; }).
 279                 uniq();
 280
 281             while (this.imageArray[imageNum][0] != imageLink.href) { imageNum++; }
 282         }
 283         */
 284         var s = Roo.get(document).getScroll();
 285
 286         // calculate top and left offset for the lightbox
 287         // weird.. why / 10?
 288         var lightboxTop = s.top + (Roo.lib.Dom.getViewHeight() / 10);
 289         var lightboxLeft = s.left
 290         this.lightbox.setStyle({
 291             top: lightboxTop + 'px',
 292             left: lightboxLeft + 'px' ,
 293             zIndex : Roo.get(document.body)._mask.getStyle('zIndex') * 1.1
 294         })
 295         //console.log("show lightbox");
 296         this.lightbox.show();
 297
 298
 299
 300         this.changeImage(imageNum);
 301     },
 302
 303     //
 304     //  changeImage()
 305     //  Hide most elements and preload image in preparation for resizing image container.
 306     //
 307     changeImage: function(imageNum) {
 308
 309         this.activeImage = imageNum; // update global var
 310
 311         // hide elements during transition
 312         if (this.animate) {
 313             this.loading.setStyle({
 314                 zIndex : Roo.get(document.body)._mask.getStyle('zIndex') * 1.2
 315             });
 316             this.loading.show();
 317             this.loadingLink.setX( (Roo.lib.Dom.getViewWidth() / 2) - 16);
 318             //this.loadingLink.show();
 319             // center the loading?
 320
 321         }
 322
 323         this.hoverNav.hide();
 324         this.prevLink.hide();
 325         this.nextLink.hide();
 326                 // HACK: Opera9 does not currently support scriptaculous opacity and appear fx
 327         this.imageDataContainer.setStyle({opacity: .0001});
 328         this.numberDisplay.hide();
 329
 330         var imgPreloader =  Roo.DomHelper.append(document.body, { tag: 'img' } , true);
 331         // once image is preloaded, resize image container
 332
 333
 334         imgPreloader.on('load', function() {
 335             this.lightboxImage.dom.src = this.imageArray[this.activeImage].dom.href;
 336
 337             this.resizeImageContainer(imgPreloader.getWidth(), imgPreloader.getHeight());
 338             imgPreloader.remove();
 339         }, this);
 340         imgPreloader.dom.src = this.imageArray[this.activeImage].dom.href;
 341     },
 342
 343     //
 344     //  resizeImageContainer()
 345     //
 346     resizeImageContainer: function(imgWidth, imgHeight) {
 347
 348         // make sure we have some sensible sizes..
 349         imgWidth = Math.max(50, imgWidth);
 350         imgHeight = Math.max(50, imgHeight);
 351
 352         // get current width and height
 353         var widthCurrent  = this.outerImageContainer.getWidth();
 354         var heightCurrent = this.outerImageContainer.getHeight();
 355
 356         //fixme need better calcs.
 357         var w = window;
 358         var ww = w.innerWidth || (w.document.documentElement.clientWidth || w.document.body.clientWidth);
 359         var wh = w.innerHeight || (w.document.documentElement.clientHeight || w.document.body.clientHeight);
 360
 361         ww -= 150;
 362         wh -= 150;
 363         // get new width and height
 364         var bs =  this.borderSize * 2;
 365
 366         var widthNew  =  imgWidth  + bs;
 367         var heightNew =  imgHeight + bs;
 368
 369         if (widthNew > ww || heightNew > wh) {
 370             // bigger than window.
 371             // scale here... - bit nasty..
 372             var rescale = 1.1 * Math.max( widthNew / ww , heightNew  / wh);
 373              //console.log(rescale);
 374             imgWidth = Math.floor(imgWidth / rescale);
 375             imgHeight = Math.floor(imgHeight / rescale);
 376             widthNew  =  imgWidth  + bs;
 377             heightNew =  imgHeight + bs;
 378
 379
 380         }
 381
 382         this.lightboxImage.set( { width : imgWidth, height : imgHeight });
 383
 384
 385         // scalars based on change from old to new
 386         var xScale = (widthNew  / widthCurrent)  * 100;
 387         var yScale = (heightNew / heightCurrent) * 100;
 388
 389         // calculate size difference between new and old image, and resize if necessary
 390         var wDiff = widthCurrent - widthNew;
 391         var hDiff = heightCurrent - heightNew;
 392
 393
 394         this.outerImageContainer.animate(
 395             { width: {to: widthNew}, height: {to: heightNew} },
 396             this.resizeDuration,
 397             null, // on complete
 398             'easeOut', // easing
 399             'run' // effect
 400
 401         )
 402
 403
 404         // if new and old image are same size and no scaling transition is necessary,
 405         // do a quick pause to prevent image flicker.
 406         var timeout = 0;
 407         if ((hDiff == 0) && (wDiff == 0)){
 408             timeout = 100;
 409             if (Roo.isIE) timeout = 250;
 410         }
 411
 412         (function(){
 413             this.prevLink.setStyle({ height: imgHeight + 'px' });
 414             this.nextLink.setStyle({ height: imgHeight + 'px' });
 415             this.imageDataContainer.setStyle({ width: widthNew + 'px',}); // the text area..
 416             this.showImage();
 417         }).defer(timeout / 1000, this);
 418     },
 419
 420     //
 421     //  showImage()
 422     //  Display image and begin preloading neighbors.
 423     //
 424     showImage: function(){
 425
 426         this.loading.hide();
 427         //this.loadingLink.hide();
 428         var _this=  this;
 429         this.lightboxImage.animate(
 430             {
 431                 opacity : {  to: 1.0 }
 432             },
 433             this.resizeDuration,
 434             function(){
 435                 _this.updateDetails();
 436             }
 437
 438         );
 439         this.preloadNeighborImages();
 440     },
 441
 442     //
 443     //  updateDetails()
 444     //  Display caption, image number, and bottom nav.
 445     //
 446     updateDetails: function() {
 447
 448         // if caption is not null
 449         if (this.imageArray[this.activeImage].dom.title  != ""){
 450             this.caption.update(this.imageArray[this.activeImage].dom.title);
 451             this.caption.show();
 452         }
 453
 454         // if image is part of set display 'Image x of x'
 455         if (this.imageArray.length > 1){
 456             this.numberDisplay.update(
 457                 this.labelImage + ' ' + (this.activeImage + 1) + ' ' + this.labelOf + '  ' + this.imageArray.length)
 458             this.numberDisplay.show();
 459         }
 460         var _this = this;
 461         this.imageDataContainer.animate(
 462             {
 463                 //slide down ?: , from: 0.0, to: 1.0
 464                 opacity :  {  to: 1.0 }
 465             },
 466             this.resizeDuration,
 467             function() {
 468                         // update overlay size and update nav
 469                         //var arrayPageSize = this.getPageSize();
 470                         //this.overlay.setStyle({ height: arrayPageSize[1] + 'px' });
 471                         _this.updateNav();
 472             }
 473
 474         );
 475     },
 476
 477     //
 478     //  updateNav()
 479     //  Display appropriate previous and next hover navigation.
 480     //
 481     updateNav: function() {
 482
 483         this.hoverNav.show();
 484
 485         // if not first image in set, display prev image button
 486         if (this.activeImage > 0) this.prevLink.show();
 487
 488         // if not last image in set, display next image button
 489         if (this.activeImage < (this.imageArray.length - 1)) this.nextLink.show();
 490
 491         this.enableKeyboardNav();
 492     },
 493
 494     //
 495     //  enableKeyboardNav()
 496     //
 497     enableKeyboardNav: function() {
 498         Roo.get(document.body).on('keydown', this.keyboardAction, this);
 499     },
 500
 501     //
 502     //  disableKeyboardNav()
 503     //
 504     disableKeyboardNav: function() {
 505         Roo.get(document.body).un('keydown', this.keyboardAction, this);
 506     },
 507
 508     //
 509     //  keyboardAction()
 510     //
 511     keyboardAction: function(event) {
 512         var keycode = event.keyCode;
 513
 514         var escapeKey;
 515         if (event.DOM_VK_ESCAPE) {  // mozilla
 516             escapeKey = event.DOM_VK_ESCAPE;
 517         } else { // ie
 518             escapeKey = 27;
 519         }
 520
 521         var key = String.fromCharCode(keycode).toLowerCase();
 522
 523         if (key.match(/x|o|c/) || (keycode == escapeKey)){ // close lightbox
 524             this.end();
 525         } else if ((key == 'p') || (keycode == 37)){ // display previous image
 526             if (this.activeImage != 0){
 527                 this.disableKeyboardNav();
 528                 this.changeImage(this.activeImage - 1);
 529             }
 530         } else if ((key == 'n') || (keycode == 39)){ // display next image
 531             if (this.activeImage != (this.imageArray.length - 1)){
 532                 this.disableKeyboardNav();
 533                 this.changeImage(this.activeImage + 1);
 534             }
 535         }
 536     },
 537
 538     //
 539     //  preloadNeighborImages()
 540     //  Preload previous and next images.
 541     //
 542     preloadNeighborImages: function(){
 543         var preloadNextImage, preloadPrevImage;
 544         if (this.imageArray.length > this.activeImage + 1){
 545             preloadNextImage = Roo.DomHelper.append(document.body, { tag: 'img' } , true);
 546             preloadNextImage.on('load', function() { preloadNextImage.remove() });
 547             preloadNextImage.dom.src = this.imageArray[this.activeImage + 1].dom.href;
 548         }
 549         if (this.activeImage > 0){
 550             preloadPrevImage = Roo.DomHelper.append(document.body, { tag: 'img' } , true);
 551             preloadNextImage.on('load', function() { preloadNextImage.remove() });
 552
 553         }
 554
 555     },
 556
 557     //
 558     //  end()
 559     //
 560     end: function() {
 561         this.disableKeyboardNav();
 562         //console.log('lightbox hide');
 563         this.lightbox.hide();
 564         this.loading.hide();
 565         Roo.get(document.body).unmask();
 566         // show all the objects that cause problems..
 567         //$$('select', 'object', 'embed').each(function(node){ node.style.visibility = 'visible' });
 568     }
 569
 570
 571 });
 572