ux/Lightbox.js
[roojs1] / 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     this.imageArray = [];
49     Roo.apply(this,cfg);
50     this.initialize();
51 }
52
53 Roo.apply(Roo.ux.Lightbox.prototype,  
54 {
55     // optiosn..
56     /**
57      * @cfg fileLoadingImage {string} loading image
58      */
59     fileLoadingImage:        '/lightbox/images/loading.gif',     
60     /**
61      * @cfg fileBottomNavCloseImage {string} close image
62      */
63     fileBottomNavCloseImage: '/lightbox/images/closelabel.gif',
64     /**
65      * @cfg overlayOpacity {number} controls transparency of shadow overlay
66      */
67     overlayOpacity: 0.8,   
68     /**
69      * @cfg fileLoadingImage {boolean} toggles resizing animations
70      */
71     animate: true,          
72     /**
73      * @cfg resizeSpeed {number} controls the speed of the image 
74      * resizing animations (1=slowest and 10=fastest)
75      */
76     resizeSpeed: 9,
77     /**
78      * @cfg borderSize {number} if you adjust the padding in the CSS, 
79      * you will need to update this variable
80      */
81     borderSize: 10,
82     /**
83      * @cfg labelImage {string} When grouping images this is used to write: Image # of #.
84      * Change it for non-english localization
85      */
86         labelImage: "Image",
87         /**
88      * @cfg labelOf {string}  When grouping images this is used to write: Image # of #.
89      */
90     labelOf: "of",
91     
92     
93     
94     
95     /**
96      * List of images
97      */
98     imageArray: false,
99     
100     /**
101      * Current image.
102      * 
103      */
104      
105     activeImage: undefined,
106     
107     /**
108      * initialize() 
109      *  Constructor runs on completion of the DOM loading. Calls updateImageList and then
110      * the function inserts html at the bottom of the page which is used to display the shadow 
111      *  overlay and the image container.
112      * 
113      * 
114      */
115     initialize: function() {    
116         
117         this.updateImageList();
118         this.initializeCSS();
119         // TBD this.keyboardAction = this.keyboardAction.bindAsEventListener(this);
120         this.resizeSpeed  = Math.min(this.resizeSpeed, 10);
121         this.resizeSpeed  = Math.max(this.resizeSpeed, 1);
122         
123             this.resizeDuration = this.animate ? ((11 - this.resizeSpeed) * 0.15) : 0;
124             this.overlayDuration = this.animate ? 0.2 : 0;  // shadow fade in/out duration
125
126         // When Lightbox starts it will resize itself from 250 by 250 to the current image dimension.
127         // If animations are turned off, it will be hidden as to prevent a flicker of a
128         // white 250 by 250 box.
129         var size = (this.animate ? 250 : 1) + 'px';
130         var dh = Roo.DomHelper;
131         this.el = Roo.DomHelper.append(document.body, {
132                 html: 
133                   '<div class="roo-lightbox-overlay"></div>' +
134                   '<div class="roo-lightbox">' +
135                   '   <div class="outer-image-container">' +
136                   '       <div class="image-container">' +
137                   '           <img class="lightbox-image">' +
138                   '           <div style="" class="hover-nav">' +
139                   '               <a href="#" class="prev-link"></a>' +
140                   '               <a href="#" class="next-link"></a>' +
141                   '           </div>' +
142                   '           <div class="loading">' +
143                   '               <a href="#" class="loading-link">&nbsp;</a>' +
144                   '           </div>' +
145                   '       </div>' +
146                   '   </div>' +
147                   '   <div class="image-data-container">' +
148                   '       <div class="image-data">' +
149                   '           <div class="image-details">' +
150                   '               <span class="caption"></span>' +
151                   '               <span class="number-display"></span>' +
152                   '           </div>' +
153                   '           <div class="bottom-nav">' +
154                   '               <div href="#" class="bottom-nav-close"></div>' +
155                   '           </div>' +
156                   '       </div>' +
157                   '   </div>' +
158                  '</div>'
159             }, true);
160          
161          
162         
163         var th = this;
164         
165         var ids = 'roo-lightbox outer-image-container image-container ' + 
166             'lightbox-image hover-nav prev-link next-link loading loading-link ' + 
167             'image-data-container image-data image-details caption number-display ' +
168             'bottom-nav bottom-nav-close roo-lightbox-overlay';   
169             
170         Roo.each(ids.split(' '), 
171             function(id){ 
172                 var vid = id.replace(/\-/g,'');
173                 Roo.log(id);
174                 th[vid] = th.el.child('.'+id); 
175                 if (!th[vid]) {
176                     return;
177                 }
178                 
179                 th[vid].setVisibilityMode(Roo.Element.DISPLAY);
180             });
181         this.lightbox = this.roolightbox;
182
183         this.overlay = this.roolightboxoverlay;
184         this.overlay.hide();
185         this.overlay.on('click', this.end, this);
186         
187                 this.lightbox.hide();
188         this.lightbox.on('click',  function(event) { 
189                 if (Roo.get(event.getTarget()).hasClass('lightbox')) {
190                     this.end(); 
191                 }
192             }, this);
193             
194                 this.outerimagecontainer.setStyle({ width: size, height: size });
195         
196                 this.prevlink.on('click', 
197             function(event) { 
198                 event.stopEvent(); 
199                 this.changeImage(this.activeImage - 1); 
200             }, this);
201             
202                 this.nextlink.on('click', 
203             function(event) { 
204                 event.stopEvent(); 
205                 this.changeImage(this.activeImage + 1); 
206             },this);
207             
208                 this.loadinglink.on('click', 
209             function(event) { 
210                 event.stopEvent(); 
211                 this.end(); 
212             }, this);
213             
214                 this.bottomnavclose.on('click',  
215             function(event) { 
216                 event.stopEvent(); 
217                 this.end(); 
218             }, this);
219
220        
221     },
222
223     initializeCSS: function() {    
224         if (typeof(Roo.ux.Lightbox.css) != 'undefined') {
225             return;
226         }
227         Roo.ux.Lightbox.css = Roo.util.CSS.createStyleSheet( {
228             '.roo-lightbox' : {
229                 position: 'absolute',
230                 left: 0,
231                 width: '100%',
232                 'text-align': 'center',
233                 'line-height': 0,
234             },
235             '.roo-lightbox a img' : { border: 'none'  },
236             '.roo-lightbox .outer-image-container' : {
237                 position: 'relative',
238                 'background-color': '#fff',
239                 width: '250px',
240                 height: '250px',
241                 margin: '0 auto'
242             },
243             
244             '.roo-lightbox image-container'  :{ padding: '10px'  },
245
246             '.roo-lightbox .loading' : { 
247                 position:'absolute', 
248                 top:'40%',
249                 left:'0%',
250                 height:'25%',
251                 width:'100%',
252                 'text-align':'center',
253                 'line-height':'0'
254             
255             },
256             '.roo-lightbox loading a' : { 
257                 background:'url(../images/loading.gif) 0 0 no-repeat', 
258                 display:'block',
259                 width:'32px',
260                 height:'32px',
261                 cursor:'pointer'
262             },
263             '.roo-lightbox bottom-nav-close' : {
264                 background:'url(../images/close.gif) 0 0 no-repeat', 
265                 height:'26px',
266                 width:'26px',
267                 cursor:'pointer'
268             },
269             '.roo-lightbox .hoverNav' :{ 
270                 position:'absolute', 
271                 top:'0', 
272                 left:'0', 
273                 height:'100%', 
274                 width:'100%', 
275                 'z-index':'10'
276             },
277             '.roo-lightbox .image-container>.hover-nav' :{ left:'0' },
278             '.roo-lightbox .hover-nav a' :{ outline:'none'},
279
280             '.roo-lightbox .prev-link, .roo-lightbox .next-link' : { 
281                 width:'49%', 
282                 height:'100%', 
283                 'background-image':'url(data:image/gif;base64,AAAA)', 
284                 display:'block' 
285             },
286             '.roo-lightbox .prev-link' : { left:'0','float':'left'},
287             '.roo-lightbox .next-link' : { right:'0','float':'right'},
288             '.roo-lightbox .prev-link:hover, .roo-lightbox .prev-link:visited:hover ' :{ 
289                     background:'url(../images/prevlabel.gif) left 15% no-repeat'
290             },
291             '.roo-lightbox .next-link:hover, .roo-lightbox .next-link:visited:hover ' :{ 
292                 background:'url(../images/nextlabel.gif) right 15% no-repeat'
293             },
294
295             '.roo-lightbox .image-data-container' : { 
296                 font: '10px Verdana, Helvetica, sans-serif',
297                 'background-color': '#fff',
298                 margin: '0 auto',
299                 'line-height': '1.4em', 
300                 overflow: 'auto', 
301                 width: '100%'
302             },
303
304             '.roo-lightbox .image-data' : { padding:'0 10px', color: '#666' },
305             '.roo-lightbox .image-data .image-details ' : { width: '70%', 'float': 'left', 'text-align': 'left'}  ,
306             '.roo-lightbox .image-data .caption' : { 'font-weight': 'bold' },
307             '.roo-lightbox .image-data .numberDisplay' : { 'display': 'block', clear: 'left', 'padding-bottom': '1.0em'  } ,   
308             '.roo-lightbox .image-data .bottomNavClose' : {  'float': 'right',  'padding-bottom': '0.7em','outline': 'none'} ,
309             '.roo-lightbox-overlay' : {
310                 'background-color': 'black',
311                 height: '500px',
312                 left: '0px',
313                 position: 'absolute',
314                 top: '0px',
315                 width: '100%',
316                 'z-index': '90'
317             }
318         });
319     },
320
321
322     
323     /**
324      * updateImageList()
325      * Loops through anchor tags looking for 'lightbox' references and applies onclick
326      * events to appropriate links. You can rerun after dynamically adding images w/ajax.
327      * 
328      */
329     updateImageList: function() {   
330         this.updateImageList = Roo.emptyFn;
331         if (this.imageArray.length) {
332             return;
333         }
334         Roo.each(Roo.DomQuery.select('a[rel^=lightbox]'), function(e) {
335             this.imageArray.push(Roo.get(e));
336             Roo.get(e).on('click', (function(event, tg, tga,tgb) {
337                
338              
339                 event.stopEvent();
340                 this.start(tgb);
341             }).createDelegate(this, [e], true));
342         }, this)
343         
344     },
345     
346     /**
347     * start()
348     *  Display overlay and lightbox. If image is part of a set, add siblings to imageArray.
349     */
350     start: function(imageLink) {
351         /*
352         // hide all the objects that cause problems..
353         $$('select', 'object', 'embed').each(
354             function(node){ 
355             node.style.visibility = 'hidden' }
356         );
357         */
358         // stretch overlay to fill page and fade in
359         //var arrayPageSize = this.getPageSize();
360         
361         this.overlay.setHeight(Roo.lib.Dom.getDocumentHeight()) ;
362         this.overlay.setWidth(Roo.lib.Dom.getDocumentWidth());
363         this.overlay.fadeIn({
364                 endOpacity: this.overlayOpacity, 
365                 easing: 'easeOut',
366                 duration: this.overlayDuration
367         });
368          
369         //this.imageArray = [];
370         var imageNum = 0;       
371         
372         if (imageLink) {
373             imageLink = Roo.get(imageLink);
374             //console.log(imageLink.id);
375             Roo.each(this.imageArray, function (e, i) {
376               //  console.log(e.id);
377                 if (e.id == imageLink.id) {
378                     imageNum = i;
379                 }
380             });
381         }
382         
383         // let's assume the constructor sorts out the list of images..
384         /*
385         if ((imageLink.rel == 'lightbox')){
386             // if image is NOT part of a set, add single image to imageArray
387             this.imageArray.push([imageLink.href, imageLink.title]);         
388         } else {
389             // if image is part of a set..
390             this.imageArray = 
391                 $$(imageLink.tagName + '[href][rel="' + imageLink.rel + '"]').
392                 collect(function(anchor){ return [anchor.href, anchor.title]; }).
393                 uniq();
394             
395             while (this.imageArray[imageNum][0] != imageLink.href) { imageNum++; }
396         }
397         */
398         var s = Roo.get(document).getScroll();
399         
400         // calculate top and left offset for the lightbox 
401         // weird.. why / 10?
402         var lightboxTop = s.top + (Roo.lib.Dom.getViewHeight() / 10);
403         var lightboxLeft = s.left
404         this.lightbox.setStyle({ 
405             top: lightboxTop + 'px', 
406             left: lightboxLeft + 'px' ,
407             zIndex : 1000
408         })
409         //console.log("show lightbox");
410         this.lightbox.show();
411         
412         
413         
414         this.changeImage(imageNum);
415     },
416
417     //
418     //  changeImage()
419     //  Hide most elements and preload image in preparation for resizing image container.
420     //
421     changeImage: function(imageNum) {   
422         
423         this.activeImage = imageNum; // update global var
424
425         // hide elements during transition
426         if (this.animate) {
427             this.loading.setStyle({
428                 zIndex :1200
429             });
430             this.loading.show();
431             this.loadinglink.setX( (Roo.lib.Dom.getViewWidth() / 2) - 16);
432             //this.loadingLink.show();
433             // center the loading?
434             
435         }
436         
437         this.hovernav.hide();
438         this.prevlink.hide();
439         this.nextlink.hide();
440                 // HACK: Opera9 does not currently support scriptaculous opacity and appear fx
441         this.imagedatacontainer.setStyle({opacity: .0001});
442         this.numberdisplay.hide();
443         
444         var imgPreloader =  Roo.DomHelper.append(document.body, { tag: 'img' } , true);
445         // once image is preloaded, resize image container
446
447         imgPreloader.on('load', function() {
448             
449             this.lightboximage.dom.src = this.imageArray[this.activeImage].dom.href;
450             
451             this.resizeImageContainer(imgPreloader.getWidth(), imgPreloader.getHeight());
452             imgPreloader.remove();
453         }, this);
454         imgPreloader.dom.src = this.imageArray[this.activeImage].dom.href;
455     },
456
457     
458     
459     //
460     //  resizeImageContainer()
461     //
462     resizeImageContainer: function(imgWidth, imgHeight) {
463
464         // make sure we have some sensible sizes..
465         imgWidth = Math.max(50, imgWidth);
466         imgHeight = Math.max(50, imgHeight);
467         
468         // get current width and height
469         var widthCurrent  = this.outerimagecontainer.getWidth();
470         var heightCurrent = this.outerimagecontainer.getHeight();
471         
472         //fixme need better calcs.
473         var w = window;
474         var ww = w.innerWidth || (w.document.documentElement.clientWidth || w.document.body.clientWidth);
475         var wh = w.innerHeight || (w.document.documentElement.clientHeight || w.document.body.clientHeight);
476         
477         ww -= 150;
478         wh -= 150;
479         // get new width and height
480         var bs =  this.borderSize * 2;
481         
482         var widthNew  =  imgWidth  + bs;
483         var heightNew =  imgHeight + bs;
484         
485         if (widthNew > ww || heightNew > wh) {
486             // bigger than window.
487             // scale here... - bit nasty..
488             var rescale = 1.1 * Math.max( widthNew / ww , heightNew  / wh);
489              //console.log(rescale);
490             imgWidth = Math.floor(imgWidth / rescale);
491             imgHeight = Math.floor(imgHeight / rescale);
492             widthNew  =  imgWidth  + bs;
493             heightNew =  imgHeight + bs;
494                     
495             
496         }
497         
498         this.lightboximage.set( { width : imgWidth, height : imgHeight });
499         
500         
501         // scalars based on change from old to new
502         var xScale = (widthNew  / widthCurrent)  * 100;
503         var yScale = (heightNew / heightCurrent) * 100;
504
505         // calculate size difference between new and old image, and resize if necessary
506         var wDiff = widthCurrent - widthNew;
507         var hDiff = heightCurrent - heightNew;
508         
509          
510         this.outerimagecontainer.animate(
511             { width: {to: widthNew}, height: {to: heightNew} },
512             this.resizeDuration,
513             null, // on complete
514             'easeOut', // easing
515             'run' // effect
516         
517         )        
518        
519         
520         // if new and old image are same size and no scaling transition is necessary, 
521         // do a quick pause to prevent image flicker.
522         var timeout = 0;
523         if ((hDiff == 0) && (wDiff == 0)){
524             timeout = 100;
525             if (Roo.isIE) timeout = 250;   
526         }
527
528         (function(){
529             this.prevlink.setStyle({ height: imgHeight + 'px' });
530             this.nextlink.setStyle({ height: imgHeight + 'px' });
531             this.imagedatacontainer.setStyle({ width: widthNew + 'px'}); // the text area..
532             this.showImage();
533         }).defer(timeout / 1000, this);
534     },
535     
536     //
537     //  showImage()
538     //  Display image and begin preloading neighbors.
539     //
540     showImage: function(){
541         
542         this.loading.hide();
543         //this.loadingLink.hide();
544         var _this=  this;
545         this.lightboximage.animate( 
546             {
547                 opacity : {  to: 1.0 }
548             },
549             this.resizeDuration,
550             function(){ 
551                 _this.updateDetails(); 
552             }
553             
554         );
555         this.preloadNeighborImages();
556     },
557
558     //
559     //  updateDetails()
560     //  Display caption, image number, and bottom nav.
561     //
562     updateDetails: function() {
563     
564         // if caption is not null
565         if (this.imageArray[this.activeImage].dom.title  != ""){
566             this.caption.update(this.imageArray[this.activeImage].dom.title);
567             this.caption.show();
568         }
569         
570         // if image is part of set display 'Image x of x' 
571         if (this.imageArray.length > 1){
572             this.numberdisplay.update(
573                 this.labelImage + ' ' + (this.activeImage + 1) + ' ' + this.labelOf + '  ' + this.imageArray.length)
574             this.numberdisplay.show();
575         }
576         var _this = this;
577         this.imagedatacontainer.animate(
578             {
579                 //slide down ?: , from: 0.0, to: 1.0 
580                 opacity :  {  to: 1.0 }
581             },
582             this.resizeDuration,
583             function() {
584                         // update overlay size and update nav
585                         //var arrayPageSize = this.getPageSize();
586                         //this.overlay.setStyle({ height: arrayPageSize[1] + 'px' });
587                         _this.updateNav();
588             }
589              
590         );
591     },
592
593     //
594     //  updateNav()
595     //  Display appropriate previous and next hover navigation.
596     //
597     updateNav: function() {
598
599         this.hovernav.show();               
600
601         // if not first image in set, display prev image button
602         if (this.activeImage > 0) this.prevlink.show();
603
604         // if not last image in set, display next image button
605         if (this.activeImage < (this.imageArray.length - 1)) this.nextlink.show();
606         
607         this.enableKeyboardNav();
608     },
609
610     //
611     //  enableKeyboardNav()
612     //
613     enableKeyboardNav: function() {
614         Roo.get(document.body).on('keydown', this.keyboardAction, this); 
615     },
616
617     //
618     //  disableKeyboardNav()
619     //
620     disableKeyboardNav: function() {
621         Roo.get(document.body).un('keydown', this.keyboardAction, this); 
622     },
623
624     //
625     //  keyboardAction()
626     //
627     keyboardAction: function(event)
628     {
629         var keycode = event.keyCode;
630
631         var escapeKey;
632         if (event.DOM_VK_ESCAPE) {  // mozilla
633             escapeKey = event.DOM_VK_ESCAPE;
634         } else { // ie
635             escapeKey = 27;
636         }
637
638         var key = String.fromCharCode(keycode).toLowerCase();
639         
640         if (key.match(/x|o|c/) || (keycode == escapeKey)){ // close lightbox
641             this.end();
642         } else if ((key == 'p') || (keycode == 37)){ // display previous image
643             if (this.activeImage != 0){
644                 this.disableKeyboardNav();
645                 this.changeImage(this.activeImage - 1);
646             }
647         } else if ((key == 'n') || (keycode == 39)){ // display next image
648             if (this.activeImage != (this.imageArray.length - 1)){
649                 this.disableKeyboardNav();
650                 this.changeImage(this.activeImage + 1);
651             }
652         }
653     },
654
655     //
656     //  preloadNeighborImages()
657     //  Preload previous and next images.
658     //
659     preloadNeighborImages: function(){
660         var preloadNextImage, preloadPrevImage;
661         if (this.imageArray.length > this.activeImage + 1){
662             preloadNextImage = Roo.DomHelper.append(document.body, { tag: 'img' } , true);
663             preloadNextImage.on('load', function() { preloadNextImage.remove() });
664             preloadNextImage.dom.src = this.imageArray[this.activeImage + 1].dom.href;
665         }
666         if (this.activeImage > 0){
667             preloadPrevImage = Roo.DomHelper.append(document.body, { tag: 'img' } , true);
668             preloadPrevImage.on('load', function() { preloadPrevImage.remove() });
669             preloadPrevImage.dom.src = this.imageArray[this.activeImage - 1].dom.href;
670         }
671     
672     },
673
674     //
675     //  end()
676     //
677     end: function() {
678         this.disableKeyboardNav();
679         //console.log('lightbox hide');
680         this.lightbox.hide();
681         this.loading.hide();
682         this.overlay.hide();
683         Roo.get(document.body).unmask();
684         // show all the objects that cause problems..
685         //$$('select', 'object', 'embed').each(function(node){ node.style.visibility = 'visible' });
686     }
687
688      
689 });
690