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

comparison client/digitallibrary/jquery/jquery.digilib.js @ 713:c1fa722c570e jquery

more cosmetics: added options to validate with http://www.jslint.com still doesn't fully validate because of "== null" and if without block. removed unnecessary semicolons after if and for.

author	robcast
date	Sun, 30 Jan 2011 17:58:56 +0100
parents	eab17859be79
children	667a316edb89

comparison

equal deleted inserted replaced

-:eab17859be79
+:c1fa722c570e
-/*
+/* Copyright (c) 2011 Martin Raspe, Robert Casties
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+You should have received a copy of the GNU Lesser General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+Authors:
+Martin Raspe, Robert Casties, 11.1.2011
+*/
+/**
 * digilib jQuery plugin
 *
 */
+/*jslint browser: true, debug: true, forin: true */
 // fallback for console.log calls
 if (typeof(console) === 'undefined') {
 var console = {
 log : function(){},
 debug : function(){},
 error : function(){}
 };
 var customConsole = true;
-};
+}
 (function($) {
 var buttons = {
 reference : {
 onclick : "reference",
 // merge query parameters
 if (isFullscreen) {
 params = queryParams;
 } else {
 params = parseImgParams($elem);
-};
+}
 // store $(this) element in the settings
 elemSettings = $.extend({}, settings, params);
 data = {
 $elem : $elem,
 settings : elemSettings,
 // create HTML structure for scaler
 setupScalerDiv(data);
 // add buttons
 for (var i = 0; i < elemSettings.visibleButtonSets; ++i) {
 showButtons(data, true, i);
-};
+}
 // bird's eye view creation
 if (elemSettings.isBirdDivVisible) {
 setupBirdDiv(data);
-};
+}
 // about window creation - TODO: could be deferred? restrict to only one item?
 setupAboutDiv(data);
 // TODO: the actual moving code
 setupZoomDrag(data);
 });
 resetData(data);
 // delete all digilib parameters
 for (var i = 0; i < paramNames.length; i++) {
 var paramName = paramNames[i];
 delete settings[paramName];
-};
+}
 // fullscreen: restore only fn/pn parameters
 if (settings.interactionMode === 'fullscreen') {
-settings['fn'] = params.fn || ''; // no default defined
+settings.fn = params.fn || ''; // no default defined
-settings['pn'] = params.pn || defaults.pn;
+settings.pn = params.pn || defaults.pn;
 // embedded: restore original parameters
 } else {
 $.extend(settings, params);
-};
+}
 // TODO: should we really reset all user preferences here?
 settings.isBirdDivVisible = false;
 settings.visibleButtonSets = 1;
 redisplay(data);
 },
 var url;
 if (settings.interactionMode === 'fullscreen') {
 url = getDigilibUrl(data);
 } else {
 url = getScalerUrl(data);
-};
+}
 if (noprompt == null) {
 window.prompt("URL reference to the current view", url);
 }
 return url;
 },
 // returns URL and query string for Scaler
 var getScalerUrl = function (data) {
 var settings = data.settings;
 if (settings.scalerBaseUrl == null) {
 alert("ERROR: URL of digilib Scaler servlet missing!");
-};
+}
 packParams(data);
 var keys = settings.scalerParamNames;
 var queryString = getParamString(settings, keys, defaults);
 var url = settings.scalerBaseUrl + '?' + queryString;
 return url;
 var mk = settings.mk;
 if (mk.indexOf(";") >= 0) {
 var pa = mk.split(";");    // old format with ";"
 } else {
 var pa = mk.split(",");    // new format
-};
+}
 for (var i = 0; i < pa.length ; i++) {
 var pos = pa[i].split("/");
 if (pos.length > 1) {
 marks.push(geom.position(pos[0], pos[1]));
-};
+}
-};
+}
-};
+}
 data.marks = marks;
 // mo (Scaler flags)
 var flags = {};
 if (settings.mo) {
 var pa = settings.mo.split(",");
 for (var i = 0; i < pa.length ; i++) {
 flags[pa[i]] = pa[i];
-};
+}
-};
+}
 data.scalerFlags = flags;
 retrieveOptionsCookie(data);
 };
 // put objects back into parameters
 if (data.zoomArea) {
 settings.wx = cropFloat(data.zoomArea.x);
 settings.wy = cropFloat(data.zoomArea.y);
 settings.ww = cropFloat(data.zoomArea.width);
 settings.wh = cropFloat(data.zoomArea.height);
-};
+}
 // marks
 if (data.marks) {
 settings.mk = '';
 for (var i = 0; i < data.marks.length; i++) {
 if (i) {
 settings.mk += ',';
-};
+}
-settings.mk
+settings.mk += cropFloat(data.marks[i].x).toString() +
-+= cropFloat(data.marks[i].x).toString() + '/'
+'/' + cropFloat(data.marks[i].y).toString();
-+ cropFloat(data.marks[i].y).toString();
+}
-};
+}
-};
 // Scaler flags
 if (data.scalerFlags) {
 var mo = '';
 for (var f in data.scalerFlags) {
 if (mo) {
 data.dlOpts.buttons = settings.visibleButtonSets;
 var clop = '';
 for (var o in data.dlOpts) {
 if (clop) {
 clop += '&';
-};
+}
 clop += o + '=' + data.dlOpts[o];
-};
+}
 if (jQuery.cookie) {
 var ck = "digilib:fn:" + escape(settings.fn) + ":pn:" + settings.pn;
 console.debug("set cookie=", ck, " value=", clop);
 jQuery.cookie(ck, clop);
-};
+}
-};
+}
 };
 var retrieveOptionsCookie = function (data) {
 // clop (digilib options)
 var opts = {};
 var ck = "digilib:fn:" + escape(settings.fn) + ":pn:" + settings.pn;
 var cp = jQuery.cookie(ck);
 console.debug("get cookie=", ck, " value=", cp);
 // in query string format
 opts = parseQueryString(cp);
-};
+}
 data.dlOpts = opts;
 // birdview option
 if (opts.birdview != null) {
 settings.isBirdDivVisible = opts.birdview === '1';
-};
+}
 // visible button sets
 if (opts.buttons != null) {
 settings.visibleButtonSets = opts.buttons;
-};
+}
 };
 // clear digilib data for reset
 var resetData = function (data) {
+// TODO: we should reset instead of delete
 if (data.zoomArea) delete data.zoomArea;
 if (data.marks) delete data.marks;
 if (data.scalerFlags) delete data.scalerFlags;
 };
 // update location.href (browser URL) in fullscreen mode
 var url = getDigilibUrl(data);
 var history = window.history;
 if (typeof(history.pushState) === 'function') {
 console.debug("we could modify history, but we don't...");
-};
+}
 window.location = url;
 } else {
 // embedded mode -- just change img src
 var url = getScalerUrl(data);
 data.$img.attr('src', url);
-};
+}
 };
 // returns maximum size for scaler img in fullscreen mode
 var getFullscreenImgSize = function($elem) {
 var $win = $(window);
 var $img, scalerUrl;
 // fullscreen
 if (settings.interactionMode === 'fullscreen') {
 var imgSize = getFullscreenImgSize($elem);
 // fitwidth/height omits destination height/width
-if (data.dlOpts['fitheight'] == null) {
+if (data.dlOpts.fitheight == null) {
 settings.dw = imgSize.width;
-};
+}
-if (data.dlOpts['fitwidth'] == null) {
+if (data.dlOpts.fitwidth == null) {
 settings.dh = imgSize.height;
-};
+}
 $img = $('<img/>');
 scalerUrl = getScalerUrl(data);
 // embedded mode -- try to keep img tag
 } else {
 $img = $elem.find('img');
 scalerUrl = $img.attr('src');
 $img.detach();
 } else {
 $img = $('<img/>');
 scalerUrl = getScalerUrl(data);
-};
+}
 }
 // create new html
 $elem.empty(); // TODO: should we keep stuff for customization?
 var $scaler = $('<div class="scaler"/>');
 $elem.append($scaler);
 data.$birdImg = $birdImg;
 $birdImg.load(birdImgLoadedHandler(data));
 $birdImg.attr('src', birdUrl);
 if (data.settings.isBirdDivVisible) {
 $birdDiv.show();
-};
+}
 birdZoom(data);
 };
 // creates HTML structure for the about view in elem
 var setupAboutDiv = function (data) {
 // toggle visibility
 isVisible = !isVisible;
 } else {
 // set visibility
 isVisible = show;
-};
+}
 if (isVisible) {
 $div.fadeIn();
 } else {
 $div.fadeOut();
-};
+}
 return isVisible;
 };
 // display more (or less) button sets
 var showButtons = function (data, more, setIdx, animated) {
 if (data.$buttonSets && data.$buttonSets[setIdx]) {
 // set exists
 $set = data.$buttonSets[setIdx];
 } else {
 $set = createButtons(data, setIdx);
-};
+}
 if ($set == null) return false;
 var btnWidth = $set.width();
 // move remaining sets left and show new set
 if ($otherSets.length > 0) {
 $otherSets.animate({right : '+='+btnWidth+'px'}, atime,
 // move [0.5,0.5] to center
 trafo.concat(trafo.getTranslation(geom.position(-0.5, -0.5)));
 if (hmir) {
 // mirror about center
 trafo.concat(trafo.getMirror('y'));
-};
+}
 if (vmir) {
 // mirror about center
 trafo.concat(trafo.getMirror('x'));
-};
+}
 if (rot) {
 // rotate around center
 trafo.concat(trafo.getRotation(parseFloat(rot)));
-};
+}
 // move back
 trafo.concat(trafo.getTranslation(geom.position(0.5, 0.5)));
-};
+}
 // scale to screen position and size
 trafo.concat(trafo.getScale(picrect));
 trafo.concat(trafo.getTranslation(picrect));
 return trafo;
 };
 // TODO: digilib.showArrows(); // show arrow overlays for zoom navigation
 var $birdImg = data.$birdImg;
 // should the birdview adapt to mirror or rotation? decision: No. :-)
 if ($birdImg) {
 $birdImg.triggerHandler('load');
-};
+}
 };
 };
 // returns function for load event of bird's eye view img
 var birdImgLoadedHandler = function (data) {
 // create mark
 var html = '<div class="mark">'+(i+1)+'</div>';
 var $mark = $(html);
 $elem.append($mark);
 $mark.offset({left : mpos.x, top : mpos.y});
-};
+}
-};
+}
 };
 // show zoom area indicator on bird's eye view
 var renderbirdZoom = function (data) {
 var $birdZoom = data.$birdZoom;
 $birdZoom.width(coords.width);
 $birdZoom.height(coords.height);
 $birdZoom.offset(coords);
 $birdZoom.show();
 return;
-};
+}
 // nice animation for embedded mode :-)
 var makeCompleteFunction = function($birdZoom, normalSize) {
 return function() {
 if (normalSize) $birdZoom.hide();
 };
 // move birdZoom div, keeping size
 newRect = geom.rectangle(
 birdZoomRect.x + dx,
 birdZoomRect.y + dy,
 birdZoomRect.width,
-birdZoomRect.height
+birdZoomRect.height);
-);
 // stay within birdimage
 newRect.stayInside(birdImgRect);
 $birdZoom.offset({left : newRect.x, top : newRect.y});
 // $birdZoom.show();
 return false;
 $birdZoom.unbind("mousemove.digilib", birdZoomMove);
 $birdZoom.unbind("mouseup.digilib", birdZoomEndDrag);
 if (newRect == null) { // no movement happened
 startPos = birdZoomRect.getCenter();
 birdZoomMove(evt); // set center to click position
-};
+}
 if (data.zoomArea) {
 // should always be true
 var x = cropFloat((newRect.x - birdImgRect.x + 2) / birdImgRect.width);
 var y = cropFloat((newRect.y - birdImgRect.y + 2) / birdImgRect.height);
 data.zoomArea.x = x;
 data.zoomArea.y = y;
-};
+}
 settings.ws = 1; // zoomed is always fit
 redisplay(data);
 return false;
 };
 var $img = data.$img;
 var $bg = $elem.has('div.bgDrag');
 if ($bg.length === 0) {
 $bg = $('<div class="bgDrag" style="display:none; position:absolute"/>');
 $scaler.before($bg); // set as background
-};
+}
 var dragStart = function (evt) {
 // drag the image and load a new detail on mouse up
 // useless if not zoomed
 if (isFullArea(data.zoomArea)) return false;
-if(evt.preventDefault) evt.preventDefault(); // no Firefox drag and drop (NEEDED?)
 pt1 = geom.position(evt);
 $imgRect = geom.rectangle($img);
 $imgRect.adjustDiv($bg); // set background size
 // hide the scaler image, show it as background of div instead
 $bg.css({
 });
 $img.hide();
 $bg.show();
 $(document).bind("mousemove.digilib", dragMove);
 $(document).bind("mouseup.digilib", dragEnd);
-window.focus();
+return false;
 };
 var dragMove = function (evt) {
 // mousemove handler: drag
 var pos = geom.position(evt);
-if(evt.preventDefault) evt.preventDefault(); // no Firefox drag and drop (NEEDED?)
 dx = pos.x - pt1.x;
 dy = pos.y - pt1.y;
 // move the background image to the new position
 $bg.css({
 'background-position' : dx + "px " + dy + "px"
 'cursor' : 'default'
 });
 $(document).unbind("mousemove.digilib", dragMove);
 $(document).unbind("mouseup.digilib", dragEnd);
 // calculate relative offset
-if (dx == 0 && dy == 0) return false; // no movement
+if (dx === 0 && dy === 0) return false; // no movement
 // reload with scaler image showing the new ausschnitt
 // digilib.moveBy(x, y);
 var pos = geom.position(-dx, -dy);
 var newPos = data.imgTrafo.invtransform(pos);
 var newArea = data.zoomArea.setPt1(newPos);
 var setQuality = function (data, qual) {
 var flags = data.scalerFlags;
 // clear flags
 for (var i = 0; i < 3; ++i) {
 delete flags['q'+i];
-};
+}
 flags['q'+qual] = 'q'+qual;
 };
 // sets a key to a value (relative values with +/- if relative=true)
 var setNumValue = function(settings, key, value) {
-if (isNumber(value)) return settings[key] = value;
+if (isNumber(value)) {
-var sign = value.substring(0,1);
+settings[key] = value;
+return value;
+}
+var sign = value[0];
 if (sign === '+' || sign === '-') {
 if (settings[key] == null) {
 // this isn't perfect but still...
 settings[key] = 0;
-};
+}
 settings[key] = parseFloat(settings[key]) + parseFloat(value);
 } else {
 settings[key] = value;
-};
+}
 return settings[key];
 };
 // auxiliary function (from old dllib.js)
 isFullArea = function(area) {
 };
 };
 console.log = logFunction('_log');
 console.debug = logFunction('_debug');
 console.error = logFunction('_error');
-};
+}
 // hook plugin into jquery
 $.fn.digilib = function(action) {
 if (actions[action]) {
 // call action on this with the remaining arguments (inserting data as first argument)
 return actions[action].apply(this, args);
 } else if (typeof(action) === 'object' || !action) {
 // call init on this
 return actions.init.apply(this, arguments);
 } else {
-$.error( 'action ' + action + ' does not exist on jQuery.digilib' );
+$.error('action ' + action + ' does not exist on jQuery.digilib');
-};
+}
 };
 })(jQuery);