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