Mercurial > hg > digilib-old
view client/digitallibrary/jquery/jquery.digilib.js @ 628:1f077f8afc5e jquery
changed methods to pass "data" around instead of "settings"
renamed makeParamString to getParamString
author | robcast |
---|---|
date | Tue, 18 Jan 2011 00:11:53 +0100 |
parents | c2566e470569 |
children | b426efcc8a8e |
line wrap: on
line source
/* * digilib jQuery plugin * */ (function($) { var actions = { reference : { onclick : "javascript:getRefWin()", tooltip : "get a reference URL", img : "reference.png" }, zoomin : { onclick : "javascript:dl.zoomBy(1.4)", tooltip : "zoom in", img : "zoom-in.png" }, zoomout : { onclick : "javascript:zoomBy(0.7)", tooltip : "zoom out", img : "zoom-out.png" }, zoomarea : { onclick : "javascript:zoomArea()", tooltip : "zoom area", img : "zoom-area.png" }, zoomfull : { onclick : "javascript:zoomFullpage()", tooltip : "view the whole image", img : "zoom-full.png" }, pagewidth : { onclick : "javascript:zoomFullpage('width')", tooltip : "page width", img : "pagewidth.png" }, back : { onclick : ["gotoPage", "-1"], tooltip : "goto previous image", img : "back.png" }, fwd : { onclick : ["gotoPage", "+1"], tooltip : "goto next image", img : "fwd.png" }, page : { onclick : "javascript:gotoPageWin()", tooltip : "specify image", img : "page.png" }, bird : { onclick : "toggleBirdDiv", tooltip : "show bird's eye view", img : "birds-eye.png" }, help : { onclick : "toggleAboutDiv", tooltip : "about Digilib", img : "help.png" }, reset : { onclick : "javascript:resetImage()", tooltip : "reset image", img : "reset.png" }, mark : { onclick : "javascript:setMark()", tooltip : "set a mark", img : "mark.png" }, delmark : { onclick : "javascript:removeMark()", tooltip : "delete the last mark", img : "delmark.png" }, hmir : { onclick : "javascript:mirror('h')", tooltip : "mirror horizontally", img : "mirror-horizontal.png" }, vmir : { onclick : "javascript:mirror('v')", tooltip : "mirror vertically", img : "mirror-vertical.png" }, rot : { onclick : "javascript:setParamWin('rot', 'Rotate (0..360) clockwise')", tooltip : "rotate image", img : "rotate.png" }, brgt : { onclick : "javascript:setParamWin('brgt', 'Brightness (-255..255)')", tooltip : "set brightness", img : "brightness.png" }, cont : { onclick : "javascript:setParamWin('cont', 'Contrast (0..8)')", tooltip : "set contrast", img : "contrast.png" }, rgb : { onclick : "javascript:setParamWin('rgb', '...')", tooltip : "set rgb values", img : "rgb.png" }, quality : { onclick : "javascript:setQualityWin('Quality (0..2)')", tooltip : "set image quality", img : "quality.png" }, size : { onclick : "javascript:toggleSizeMenu()", tooltip : "set page size", img : "size.png" }, calibrationx : { onclick : "javascript:calibrate('x')", tooltip : "calibrate screen x-ratio", img : "calibration-x.png" }, scale : { onclick : "javascript:toggleScaleMenu()", tooltip : "change image scale", img : "original-size.png" }, options : { onclick : "javascript:toggleOptionDiv()", tooltip : "hide options", img : "options.png" }, SEP : { img : "sep.png" } }; var defaults = { // the root digilib element, for easy retrieval 'digilibRoot' : null, // version of this script 'version' : 'jquery.digilib.js 1.0', // logo url 'logoUrl' : '../img/digilib-logo-text1.png', // repository url 'reposUrl' : 'http://digilib.berlios.de', // base URL to Scaler servlet 'scalerBaseUrl' : 'http://digilib.mpiwg-berlin.mpg.de/digitallibrary/servlet/Scaler', // list of Scaler parameters 'scalerParamNames' : ['fn','pn','dw','dh','ww','wh','wx','wy','ws','mo', 'rot','cont','brgt','rgbm','rgba','ddpi','ddpix','ddpiy'], // Scaler parameter defaults 'ww' : 1.0, 'wh' : 1.0, 'wx' : 0.0, 'wy' : 0.0, 'ws' : 1.0, // mode of operation. // fullscreen: takes parameters from page URL, keeps state in page URL // embedded: takes parameters from Javascript options, keeps state inside object 'interactionMode' : 'fullscreen', // actions 'actions' : actions, // path to button images (must end with a slash) 'buttonsImagePath' : '../greyskin/', // actions groups 'actionsStandard' : ["reference","zoomin","zoomout","zoomarea","zoomfull","pagewidth","back","fwd","page","bird","SEP","help","reset","options"], 'actionsSpecial' : ["mark","delmark","hmir","vmir","rot","brgt","cont","rgb","quality","size","calibrationx","scale","SEP","options"], 'actionsCustom' : [], // is birdView shown? 'isBirdDivVisible' : false, // dimensions of bird's eye window 'birdMaxX' : 200, 'birdMaxY' : 200, // is the "about" window shown? 'isAboutDivVisible' : false }; // parameters from the query string var queryParams = {}; // affine geometry classes var geom = dlGeometry(); var methods = { // 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'; if (isFullscreen) { queryParams = parseQueryParams(); }; return this.each(function() { var $elem = $(this); var data = $elem.data('digilib'); var elemSettings; // if the plugin hasn't been initialized yet if (!data) { // merge query parameters if (isFullscreen) { elemSettings = $.extend({}, settings, queryParams); } else { elemSettings = $.extend({}, settings, parseImgParams($elem)); }; // store $(this) element in the settings elemSettings.digilibRoot = $elem; data = { target : $elem, settings : elemSettings }; // store in data element $elem.data('digilib', data); } // create HTML structure setupScalerDiv(data); setupButtons(data, 'actionsStandard'); // bird's eye view creation - TODO: could be deferred? setupBirdviewDiv(data); // about window creation - TODO: could be deferred? restrict to only one item? setupAboutDiv(data); }); }, // clean up digilib destroy : function() { return this.each(function(){ var $this = $(this); var data = $this.data('digilib'); // Namespacing FTW $(window).unbind('.digilib'); // unbinds all digilibs(?) data.digilib.remove(); $this.removeData('digilib'); }); }, // event handler: toggles the visibility of the 'about' window toggleAboutDiv : function () { var $elem = $(this); // the clicked button var settings = $elem.data('digilib').settings; var $root = settings.digilibRoot; var $about = $root.find('div.about'); settings.isAboutDivVisible = !settings.isAboutDivVisible; if (settings.isAboutDivVisible) { $about.fadeIn(); } else { $about.fadeOut(); }; return false; }, // event handler: toggles the visibility of the bird's eye window toggleBirdDiv : function () { // TODO: red frame functionality var $elem = $(this); // the clicked button var settings = $elem.data('digilib').settings; var $root = settings.digilibRoot; var $bird = $root.find('div.birdview'); settings.isBirdDivVisible = !settings.isBirdDivVisible; if (settings.isBirdDivVisible) { $bird.fadeIn(); } else { $bird.fadeOut(); }; return false; }, // goto given page nr (+/-: relative) gotoPage : function(pageNr, keepMarks) { var $elem = $(this); // the clicked button var settings = $elem.data('digilib').settings; var oldpn = settings.pn; var pn = setNumValue(settings, "pn", pageNr); if (pn == null) return false; // nothing happened if (pn < 1) { alert("no such page (page number too low)"); settings.pn = oldpn; return false; }; if (settings.pt) { if (pn > settings.pt) { alert("no such page (page number too high)"); settings.pn = oldpn; return false; } }; // TODO: keepMarks var $root = settings.digilibRoot; var $img = $root.find('img.pic'); display($img, settings); return false; } }; // sets a key to a value (relative values with +/- if relative=true) var setNumValue = function(settings, key, value) { // TODO: type and error checking if (settings[key] == null) return null; var sign = value.substring(0,1); if (sign === '+' || sign === '-') { settings[key] = parseFloat(settings[key]) + parseFloat(value); } else { settings[key] = value; } return settings[key]; }; // returns parameters from page url var parseQueryParams = function() { return parseQueryString(location.search.slice(1)); }; // returns parameters taken from embedded img-element var parseImgParams = function($elem) { var src = $elem.find('img').first().attr('src'); if (!src) { return null; } var pos = src.indexOf('?'); var query = (pos < 0) ? '' : src.substring(pos + 1); var scalerUrl = src.substring(0, pos); var params = parseQueryString(query); params.scalerBaseUrl = scalerUrl; // console.log(hash); return params; }; // parses query parameter string into parameter object var parseQueryString = function(query) { var pairs = query.split("&"); var params = {}; for (var i = 0; i < pairs.length; i++) { var pair = pairs[i].split("="); if (pair.length === 2) { params[pair[0]] = pair[1]; }; }; return params; }; // returns a query string from key names from a parameter hash var getParamString = function (settings, keys) { var paramString = ''; var latter = false; for (i = 0; i < keys.length; ++i) { var key = keys[i]; if (settings[key]) { // first param gets no '&' paramString += latter ? '&' : ''; latter = true; // add parm=val paramString += key + '=' + settings[key]; }; } return paramString; }; // returns URL and query string for Scaler var getScalerString = function (settings) { var keys = settings.scalerParamNames; var queryString = getParamString(settings, keys); var url = settings.scalerBaseUrl + '?' + queryString; return url; }; // returns maximum size for scaler img in fullscreen mode var getFullscreenImgSize = function($elem) { var winH = $(window).height(); var winW = $(window).width(); // TODO: account for borders? return geom.size(winW, winH); }; // (re)load the img from a new scaler URL var display = function ($img, settings) { // TODO: update location.href (browser URL) in fullscreen mode var scalerUrl = getScalerString(settings); $img.attr('src', scalerUrl); // TODO: update bird view? }; // creates HTML structure for digilib in elem var setupScalerDiv = function (data) { var settings = data.settings; var $elem = data.target; var $img; if (settings.interactionMode === 'fullscreen') { // fullscreen var imgSize = getFullscreenImgSize($elem); settings.dw = imgSize.width; settings.dh = imgSize.height; $img = $('<img/>'); display($img, settings); } else { // embedded mode -- try to keep img tag $img = $elem.find('img'); if ($img.length > 0) { console.debug("img detach:",$img); $img.detach(); } else { $img = $('<img/>'); display($img, settings); } } // create new html $elem.empty(); // TODO: should we keep stuff for customization? var $scaler = $('<div class="scaler"/>'); $elem.append($scaler); $scaler.append($img); $img.addClass('pic'); data.img = $img; $img.load(scalerImgLoadedFn(data)); }; // creates HTML structure for buttons in elem var setupButtons = function (data, actionGroup) { var $elem = data.target; var settings = data.settings; if (settings.interactionMode === 'fullscreen') { // fullscreen -- create new 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]; // 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.addClass('button-' + actionName); // let the clicked <a> element know about the digilib context $a.data('digilib', { 'action' : actionName, 'settings' : settings } ); $a.bind('click', function() { var $elem = $(this); // get the context data var data = $elem.data('digilib'); // find the action for the clicked element var method = data.settings.actions[data.action].onclick; if ($.isArray(method)) { $elem.digilib.apply(this, method); } else { $elem.digilib(method); }; console.log(method); }); // binding mit closure //(function(){ var action = actionSettings.onclick; // $a.bind('click', function(){ console.log( action )} ); //})(); $img.attr('src', settings.buttonsImagePath + actionSettings.img); }; } return $buttonsDiv; }; // creates HTML structure for the bird's eye view in elem var setupBirdviewDiv = function (data) { var $elem = data.target; var settings = data.settings; // use only the relevant parameters var keys = ['fn','pn','dw','dh']; var birdDimensions = { 'dw' : settings.birdMaxX, 'dh' : settings.birdMaxY }; var birdSettings = $.extend({}, settings, birdDimensions); var birdUrl = settings.scalerBaseUrl + '?' + getParamString(birdSettings, keys); // the bird's eye div var $birdviewDiv = $('<div class="birdview" style="display:none"/>'); // the detail indicator frame var $birdzoomDiv = $('<div class="birdzoom"/>'); // the small image var $birdImg = $('<img class="birdimg"/>'); $elem.append($birdviewDiv); $birdviewDiv.append($birdzoomDiv); $birdviewDiv.append($birdImg); $birdImg.attr('src', birdUrl); }; // creates HTML structure for the about view in elem var setupAboutDiv = function (data) { var $elem = data.target; var settings = data.settings; var $aboutDiv = $('<div class="about" style="display:none"/>'); var $header = $('<p>Digilib Graphic Viewer</p>'); var $link = $('<a/>'); var $logo = $('<img class="logo" title="digilib"/>'); var $content = $('<p/>'); $elem.append($aboutDiv); $aboutDiv.append($header); $aboutDiv.append($link); $aboutDiv.append($content); $link.append($logo); $logo.attr('src', settings.logoUrl); $link.attr('href', settings.reposUrl); $content.text('Version: ' + settings.version); // let the element know about the digilib context $aboutDiv.data('digilib', { 'settings' : settings } ); $aboutDiv.bind('click', function() { console.log($(this)); $(this).digilib('toggleAboutDiv'); }); }; // returns function for load event of scaler img var scalerImgLoadedFn = function(data) { var settings = data.settings; var $elem = data.target; var $img = data.img; return function() { console.debug("img loaded! this=", this, " data=", data); var area = geom.rectangle(settings.wx, settings.wy, settings.ww, settings.wh); settings.zoomArea = area; // create Transform from current area and picsize var picpos = $img.offset(); var picrect = geom.rectangle(picpos.left, picpos.top, $img.width(), $img.height()); var trafo = geom.transform(); // subtract area offset and size trafo.concat(trafo.getTranslation(geom.position(area.x, area.y))); trafo.concat(trafo.getScale(geom.size(1/area.width, 1/area.height))); // scale to screen size trafo.concat(trafo.getScale(picrect)); trafo.concat(trafo.getTranslation(picrect)); data.imgTrafo = trafo; // display marks //digilib.renderMarks(); //digilib.showBirdDiv(isBirdDivVisible); //digilib.showArrows(); // show arrow overlays for zoom navigation }; }; // hook plugin into jquery $.fn.digilib = function(method) { if (methods[method]) { return methods[method].apply(this, Array.prototype.slice.call(arguments, 1)); } else if (typeof(method) === 'object' || !method) { return methods.init.apply(this, arguments); } else { $.error( 'Method ' + method + ' does not exist on jQuery.digilib' ); } }; })(jQuery);