Mercurial > hg > digilib-old

changeset 1048:4aa90cccb3e4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
make plugins independent from buttons plugin
author hertzhaft
date Mon, 26 Mar 2012 00:56:05 +0200
parents 4f17420392a9
children 32096eff13c7
files webapp/src/main/webapp/jquery/jquery.digilib.birdseye.js webapp/src/main/webapp/jquery/jquery.digilib.css webapp/src/main/webapp/jquery/jquery.digilib.dialogs.js webapp/src/main/webapp/jquery/jquery.digilib.regions.js
diffstat 4 files changed, 82 insertions(+), 83 deletions(-) [+]
line wrap: on
line diff
--- a/webapp/src/main/webapp/jquery/jquery.digilib.birdseye.js	Sun Mar 25 22:05:23 2012 +0200
+++ b/webapp/src/main/webapp/jquery/jquery.digilib.birdseye.js	Mon Mar 26 00:56:05 2012 +0200
@@ -62,7 +62,8 @@
         // add buttons
         $.extend(digilib.buttons, buttons);
         // insert in button list -- not elegant
-        if (digilib.defaults.buttonSettings != null) {
+        if (digilib.plugins.buttons != null) {
+            // if (digilib.defaults.buttonSettings != null) {
             digilib.defaults.buttonSettings.fullscreen.standardSet.splice(9, 0, 'bird');
             digilib.defaults.buttonSettings.embedded.standardSet.splice(5, 0, 'bird');
         }
--- a/webapp/src/main/webapp/jquery/jquery.digilib.css	Sun Mar 25 22:05:23 2012 +0200
+++ b/webapp/src/main/webapp/jquery/jquery.digilib.css	Mon Mar 26 00:56:05 2012 +0200
@@ -104,7 +104,7 @@
     display: none;
 }
 
-div.dl-digilib div.dl-regionHTML {
+div.dl-digilib div.dl-regionInfo {
     display: none;
     position: absolute;
 	top: 100px;
@@ -117,7 +117,7 @@
 	z-index: 1000;
 }
 
-div.dl-digilib div.dl-regionHTML a {
+div.dl-digilib div.dl-regionInfo a {
     color: white;
     text-decoration: none;
     font-size: 11px;
@@ -177,6 +177,7 @@
     display: none;
 	border: 1px solid lightcyan;
 	background-color: lightgrey;
+	background: transparent;
 	width: 300px;
 	padding:10px;	
     }
--- a/webapp/src/main/webapp/jquery/jquery.digilib.dialogs.js	Sun Mar 25 22:05:23 2012 +0200
+++ b/webapp/src/main/webapp/jquery/jquery.digilib.dialogs.js	Mon Mar 26 00:56:05 2012 +0200
@@ -145,6 +145,17 @@
         });
     };
 
+    var setButtonActions = function () {
+        if (fn.setButtonAction == null) {
+            console.debug('dialogs: could not assign button actions. Maybe jquery.digilib.buttons.js was not loaded?');
+            return;
+            }
+        console.debug('dialogs: assign new button actions. digilib:', digilib);
+        fn.setButtonAction('calibrationx', 'dialogCalibration');
+        fn.setButtonAction('scale', 'dialogScaleMode');
+    };
+
+
     // plugin installation called by digilib on plugin object.
     var install = function (plugin) {
         digilib = plugin;
@@ -155,8 +166,7 @@
         // add defaults, actions, buttons
         $.extend(true, digilib.defaults, defaults); // make deep copy
         $.extend(digilib.actions, actions);
-        fn.setButtonAction('calibrationx', 'dialogCalibration');
-        fn.setButtonAction('scale', 'dialogScaleMode');
+        setButtonActions();
         // export functions
         fn.showCalibrationDialog = showCalibrationDialog;
         fn.showScaleModeDialog = showScaleModeDialog;
--- a/webapp/src/main/webapp/jquery/jquery.digilib.regions.js	Sun Mar 25 22:05:23 2012 +0200
+++ b/webapp/src/main/webapp/jquery/jquery.digilib.regions.js	Mon Mar 26 00:56:05 2012 +0200
@@ -17,7 +17,12 @@
     // the digilib object
     var digilib = null;
     // the functions made available by digilib
-    var fn = null;
+    var fn = {
+        // dummy function to avoid errors, gets overwritten by buttons plugin
+        highlightButtons : function () {
+            console.debug('regions: dummy function - highlightButtons');
+            }
+        };
     // affine geometry plugin
     var geom = null;
 
@@ -37,7 +42,7 @@
             tooltip : "show or hide regions",
             icon : "regions.png"
             },
-        regionhtml : {
+        regioninfo : {
             onclick : "showRegionInfo",
             tooltip : "show information about regions",
             icon : "regioninfo.png"
@@ -49,8 +54,6 @@
         'isRegionVisible' : true,
         // are region numbers shown?
         'showRegionNumbers' : true,
-        // is window with region HTML shown?
-        'showRegionInfo' : false,
         // is there region content in the page?
         'processHtmlRegions' : false,
         // region defined by users and in the URL
@@ -62,7 +65,7 @@
         // css selector for area elements (should additionally be marked with class "keep")
         'regionContentSelector' : 'map.dl-regioncontent area',
         // buttonset of this plugin
-        'regionSet' : ['regions', 'addregion', 'delregion', 'regionhtml', 'lessoptions'],
+        'regionSet' : ['regions', 'addregion', 'delregion', 'regioninfo', 'lessoptions'],
         // url param for regions
         'rg' : null
         };
@@ -157,22 +160,43 @@
             renderRegions(data, 1);
         },
 
-        // show/hide region HTML code 
+        // show region info in a window
         "showRegionInfo" : function (data) {
-            var show = !data.settings.showRegionInfo;
-            data.settings.showRegionInfo = show;
-            fn.highlightButtons(data, 'regionhtml', show);
-            var $html = data.$htmlDiv;
-            if (!show) {
-                // empty the div
-                $html.fadeOut(function () { 
-                    $html.contents().remove();
+            var $elem = data.$elem;
+            var cssPrefix = data.settings.cssPrefix;
+            var $info = $elem.find('#'+cssPrefix+'regionInfo');
+            if ($info.length > 0) {
+                fn.withdraw($info);
+                return;
+                }
+            var html = '\
+                <div id="'+cssPrefix+'regionInfo" class="'+cssPrefix+'keep '+cssPrefix+'regionInfo">\
+                    <div class="'+cssPrefix+'infoheader">\
+                        <div class="'+cssPrefix+'infobutton html">HTML</div>\
+                        <div class="'+cssPrefix+'infobutton svgattr">SVG</div>\
+                        <div class="'+cssPrefix+'infobutton digilib">Digilib</div>\
+                        <div class="'+cssPrefix+'infobutton x">X</div>\
+                    </div>\
+                </div>';
+            $info = $(html);
+            $info.appendTo($elem);
+            $info.append(regionInfoHTML(data));
+            $info.append(regionInfoSVG(data));
+            $info.append(regionInfoDigilib(data));
+            var bind = function(name) {
+                $info.find('div.'+name).on('click.regioninfo', function () {
+                    $info.find('div.'+cssPrefix+'info').hide();
+                    $info.find('div.'+cssPrefix+name).show();
                     });
-                return;
-            }
-            regionInfo(data);
+                };
+            bind('html');
+            bind('svgattr');
+            bind('digilib');
+            $info.find('.x').on('click.regioninfo', function () {
+                fn.withdraw($info);
+                });
+            $info.fadeIn();
         }
-
     };
 
     // store a region div
@@ -185,36 +209,6 @@
         console.debug("regions", data.regions, "regionRect", regionRect);
     };
 
-    // clickable header
-    var regionInfoHeader = function (data) {
-        var cssPrefix = data.settings.cssPrefix;
-        var $infoDiv = $('<div class="'+cssPrefix+'infoheader"/>');
-        var $h01 = $('<div class="'+cssPrefix+'infobutton">HTML</div>'); 
-        var $h02 = $('<div class="'+cssPrefix+'infobutton">SVG</div>'); 
-        var $h03 = $('<div class="'+cssPrefix+'infobutton">Digilib</div>'); 
-        var $h04 = $('<div class="'+cssPrefix+'infobutton">X</div>');
-        var bind = function($div, name) {
-            $div.on('click.regioninfo', function () {
-                var $top = $(this).parent().parent();
-                $top.find('.'+cssPrefix+'info').hide();
-                $top.find('.'+cssPrefix+ name).show();
-                });
-            };
-        bind($h01, 'html');
-        bind($h02, 'svgattr');
-        bind($h03, 'digilib');
-        var $html = data.$htmlDiv;
-        $h04.on('click.regioninfo', function () {
-            data.settings.showRegionInfo = false;
-            fn.highlightButtons(data, 'regionhtml', false);
-            $html.fadeOut(function () { 
-                $html.contents().remove();
-                });
-            });
-        $infoDiv.append($h01, $h02, $h03, $h04);
-        return $infoDiv;
-    };
-
     // html for later insertion
     var regionInfoHTML = function (data) {
         var cssPrefix = data.settings.cssPrefix;
@@ -258,16 +252,6 @@
         return $infoDiv;
     };
 
-    // show region info in a window
-    var regionInfo = function (data) {
-        var $html = data.$htmlDiv;
-        $html.append(regionInfoHeader(data));
-        $html.append(regionInfoHTML(data));
-        $html.append(regionInfoSVG(data));
-        $html.append(regionInfoDigilib(data));
-        $html.fadeIn();
-    };
-
     // add a region to data.$elem
     var addRegionDiv = function (data, index, attributes) {
         var settings = data.settings;
@@ -465,14 +449,13 @@
         var data = this;
         var settings = data.settings;
         console.debug("regions: handleSetup", settings.rg);
+        // regions with content are given in HTML divs
         if (settings.processHtmlRegions) {
-            // regions with content are given in HTML divs
             createRegionsFromHTML(data);
         }
+        // regions are defined in the URL
         if (settings.processUserRegions) {
-            // regions are defined in the URL
             createRegionsFromURL(data);
-            fn.highlightButtons(data, 'regionhtml', data.settings.showRegionInfo);
         }
     };
 
@@ -482,15 +465,29 @@
         console.debug("regions: handleUpdate");
         var settings = data.settings;
         fn.highlightButtons(data, 'regions' , settings.isRegionVisible);
-        fn.highlightButtons(data, 'regionhtml' , settings.showRegionInfo);
         renderRegions(data);
     };
 
+    // additional buttons
+    var installButtons = function (data) {
+        var settings = data.settings;
+        var mode = settings.interactionMode;
+        var buttonSettings = settings.buttonSettings[mode];
+        // configure buttons through digilib "regionSet" option
+        var buttonSet = settings.regionSet || regionSet; 
+        // set regionSet to [] or '' for no buttons (when showing regions only)
+        if (buttonSet.length && buttonSet.length > 0) {
+            buttonSettings.regionSet = buttonSet;
+            buttonSettings.buttonSets.push('regionSet');
+            }
+    };
+
     // plugin installation called by digilib on plugin object.
     var install = function(plugin) {
         digilib = plugin;
         console.debug('installing regions plugin. digilib:', digilib);
-        fn = digilib.fn;
+        // import digilib functions
+        $.extend(fn, digilib.fn);
         // import geometry classes
         geom = fn.geometry;
         // add defaults, actions, buttons
@@ -507,26 +504,16 @@
         var cssPrefix = data.settings.cssPrefix;
         // regions array
         data.regions = [];
-        // regions div
-        var $html = $('<div class="'+cssPrefix+'keep '+cssPrefix+'regionHTML"/>');
-        $elem.append($html);
-        data.$htmlDiv = $html;
-        // install event handler
+        // install event handlers
         var $data = $(data);
         $data.on('setup', handleSetup);
         $data.on('update', handleUpdate);
+        // install buttons
         if (settings.processUserRegions) {
-            var mode = settings.interactionMode;
             // add "rg" to digilibParamNames
             settings.digilibParamNames.push('rg');
-            // additional buttons
-            var buttonSettings = settings.buttonSettings[mode];
-            // configure buttons through digilib "regionSet" option
-            var buttonSet = settings.regionSet || regionSet; 
-            // set regionSet to [] or '' for no buttons (when showing regions only)
-            if (buttonSet.length && buttonSet.length > 0) {
-                buttonSettings.regionSet = buttonSet;
-                buttonSettings.buttonSets.push('regionSet');
+            if (digilib.plugins.buttons != null) {
+                installButtons(data);
             }
         }
     };
@@ -534,7 +521,7 @@
     // plugin object with name and install/init methods
     // shared objects filled by digilib on registration
     var pluginProperties = {
-            name : 'region',
+            name : 'regions',
             install : install,
             init : init,
             buttons : {},