digilib: client/digitallibrary/jquery/jquery.digilib.js comparison

comparison client/digitallibrary/jquery/jquery.digilib.js @ 644:bffc7d8c3641 jquery

renamed 'actions' to 'buttons' and 'methods' to 'actions' actionGroups now buttonGroups all functions in actions automatically get 'data' as first argument

author	robcast
date	Thu, 20 Jan 2011 19:37:19 +0100
parents	abf4c8db18c8
children	ce5c61b891f6

comparison

equal deleted inserted replaced

-:abf4c8db18c8
+:bffc7d8c3641
 error : function(){}
 };
 }
 (function($) {
-var actions = {
+var buttons = {
 reference : {
 onclick : "javascript:getRefWin()",
 tooltip : "get a reference URL",
 img : "reference.png"
 },
 'clop' : '',
 // mode of operation:
 // fullscreen = take parameters from page URL, keep state in page URL
 // embedded = take parameters from Javascript options, keep state inside object
 'interactionMode' : 'fullscreen',
-// actions
+// buttons
-'actions' : actions,
+'buttons' : buttons,
 // path to button images (must end with a slash)
 'buttonsImagePath' : '../greyskin/',
-// actions groups
+// buttons groups
-//'actionsStandard' : ["reference","zoomin","zoomout","zoomarea","zoomfull","pagewidth","back","fwd","page","bird","SEP","help","reset","options"],
+//'buttonsStandard' : ["reference","zoomin","zoomout","zoomarea","zoomfull","pagewidth","back","fwd","page","bird","SEP","help","reset","options"],
-'actionsStandard' : ["reference","zoomin","zoomout","zoomarea","zoomfull","pagewidth","mark","delmark","back","fwd","page","bird","SEP","help","reset","options"],
+'buttonsStandard' : ["reference","zoomin","zoomout","zoomarea","zoomfull","pagewidth","mark","delmark","back","fwd","page","bird","SEP","help","reset","options"],
-'actionsSpecial' : ["mark","delmark","hmir","vmir","rot","brgt","cont","rgb","quality","size","calibrationx","scale","SEP","options"],
+'buttonsSpecial' : ["mark","delmark","hmir","vmir","rot","brgt","cont","rgb","quality","size","calibrationx","scale","SEP","options"],
-'actionsCustom' : [],
+'buttonsCustom' : [],
 // is birdView shown?
 'isBirdDivVisible' : false,
 // dimensions of bird's eye window
 'birdDivOptions' : {'dw' : 200, 'dh' : 200},
 // is the "about" window shown?
 // affine geometry classes
 var geom = dlGeometry();
 var MAX_ZOOMAREA = geom.rectangle(0, 0, 1, 1);
-var methods = {
+var actions = {
 // digilib initialization
 init : function(options) {
 // settings for this digilib instance are merged from defaults and options
 var settings = $.extend({}, defaults, options);
 var isFullscreen = settings.interactionMode === 'fullscreen';
 $elem.data('digilib', data);
 }
 unpackParams(data);
 // create HTML structure
 setupScalerDiv(data);
-setupButtons(data, 'actionsStandard');
+setupButtons(data, 'buttonsStandard');
 // bird's eye view creation
 if (settings.isBirdDivVisible) {
 setupBirdDiv(data);
 }
 // about window creation - TODO: could be deferred? restrict to only one item?
 setupAboutDiv(data);
 });
 },
 // clean up digilib
-destroy : function() {
+destroy : function(data) {
 return this.each(function(){
 var $elem = $(this);
-var data = $elem.data('digilib');
 // Namespacing FTW
 $(window).unbind('.digilib'); // unbinds all digilibs(?)
 data.digilib.remove();
 $elem.removeData('digilib');
 });
 },
 // show or hide the 'about' window
-showAboutDiv : function(show) {
+showAboutDiv : function(data, show) {
-var $elem = $(this);
-var data = $elem.data('digilib');
 data.settings.isAboutDivVisible = showDiv(data.settings.isAboutDivVisible, data.$aboutDiv, show);
 },
 // event handler: toggles the visibility of the bird's eye window
-showBirdDiv : function (show) {
+showBirdDiv : function (data, show) {
-var $elem = $(this);
-var data = $elem.data('digilib');
 if (data.$birdDiv == null) {
 // no bird div -> create
 setupBirdDiv(data);
 }
 data.settings.isBirdDivVisible = showDiv(data.settings.isBirdDivVisible, data.$birdDiv, show);
 },
 // goto given page nr (+/-: relative)
-gotoPage : function (pageNr) {
+gotoPage : function (data, pageNr) {
-var $elem = $(this);
-var data = $elem.data('digilib');
 var settings = data.settings;
 var oldpn = settings.pn;
 var pn = setNumValue(settings, "pn", pageNr);
 if (pn == null) return false; // nothing happened
 if (pn < 1) {
 // then reload
 redisplay(data);
 },
 // zoom by a given factor
-zoomBy : function (factor) {
+zoomBy : function (data, factor) {
-var $elem = $(this);
-var data = $elem.data('digilib');
 zoomBy(data, factor);
 },
 // zoom out to full page
-zoomFull : function (mode) {
+zoomFull : function (data, mode) {
-var $elem = $(this);
-var data = $elem.data('digilib');
 data.zoomArea = MAX_ZOOMAREA;
 if (mode === 'width') {
 data.dlOpts.fitwidth = 1;
 delete data.dlOpts.fitheight;
 } else if (mode === 'height') {
 }
 redisplay(data);
 },
 // set a mark by clicking (or giving a position)
-setMark : function (mpos) {
+setMark : function (data, mpos) {
-var $elem = $(this);
-var data = $elem.data('digilib');
 if (mpos == null) {
 // interactive
 setMark(data);
 } else {
 // use position
 redisplay(data);
 }
 },
 // remove the last mark
-removeMark : function () {
+removeMark : function (data) {
-var $elem = $(this);
-var data = $elem.data('digilib');
 data.marks.pop();
 redisplay(data);
 }
 };
 var $buttonsDiv = $('<div class="buttons"></div>');
 $elem.append($buttonsDiv);
 var actionNames = settings[actionGroup];
 for (var i = 0; i < actionNames.length; i++) {
 var actionName = actionNames[i];
-var actionSettings = settings.actions[actionName];
+var buttonSettings = settings.buttons[actionName];
 // construct the button html
 var $button = $('<div class="button"></div>');
 var $a = $('<a/>');
 var $img = $('<img class="button"/>');
 $buttonsDiv.append($button);
 $button.append($a);
 $a.append($img);
 // add attributes and bindings
-$button.attr('title', actionSettings.tooltip);
+$button.attr('title', buttonSettings.tooltip);
 $button.addClass('button-' + actionName);
 // create handler for the buttons
 $a.bind('click.digilib', (function () {
-// we create a new closure to capture the value of method
+// we create a new closure to capture the value of action
-var method = actionSettings.onclick;
+var action = buttonSettings.onclick;
-if ($.isArray(method)) {
+if ($.isArray(action)) {
-// the handler function calls digilib with method and parameters
+// the handler function calls digilib with action and parameters
 return function (evt) {
-console.debug('click method=', method, ' evt=', evt);
+console.debug('click action=', action, ' evt=', evt);
-$elem.digilib.apply($elem, method);
+$elem.digilib.apply($elem, action);
 return false;
 };
 } else {
-// the handler function calls digilib with method
+// the handler function calls digilib with action
 return function (evt) {
-console.debug('click method=', method, ' evt=', evt);
+console.debug('click action=', action, ' evt=', evt);
-$elem.digilib(method);
+$elem.digilib(action);
 return false;
 };
 }
 })());
-$img.attr('src', settings.buttonsImagePath + actionSettings.img);
+$img.attr('src', settings.buttonsImagePath + buttonSettings.img);
 }
 }
 return $buttonsDiv;
 };
 var setNumValue = function(settings, key, value) {
 if (isNumber(value)) return settings[key] = value;
 var sign = value.substring(0,1);
 if (sign === '+' || sign === '-') {
 if (settings[key] == null) {
-// this doesn't make much sense but still...
+// this isn't perfect but still...
 settings[key] = 0;
 }
 settings[key] = parseFloat(settings[key]) + parseFloat(value);
 } else {
 settings[key] = value;
 var cropFloat = function (x) {
 return parseInt(10000 * x, 10) / 10000;
 };
 // hook plugin into jquery
-$.fn.digilib = function(method) {
+$.fn.digilib = function(action) {
-if (methods[method]) {
+if (actions[action]) {
-// call method on this with the remaining arguments
+// call action on this with the remaining arguments (inserting data as first argument)
-return methods[method].apply(this, Array.prototype.slice.call(arguments, 1));
+var $elem = $(this);
-} else if (typeof(method) === 'object' || !method) {
+var data = $elem.data('digilib');
+var args = Array.prototype.slice.call(arguments, 1);
+args.unshift(data);
+return actions[action].apply(this, args);
+} else if (typeof(action) === 'object' || !action) {
 // call init on this
-return methods.init.apply(this, arguments);
+return actions.init.apply(this, arguments);
 } else {
-$.error( 'Method ' + method + ' does not exist on jQuery.digilib' );
+$.error( 'action ' + action + ' does not exist on jQuery.digilib' );
 }
 };
 })(jQuery);