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