digilib-old: webapp/src/main/webapp/jquery/jquery.digilib.js comparison

comparison webapp/src/main/webapp/jquery/jquery.digilib.js @ 954:36102de2301e

code cosmetics

author	robcast
date	Wed, 04 Jan 2012 14:26:55 +0100
parents	3d5e7458f9ae
children	c8c441d1d7a0

comparison

equal deleted inserted replaced

-:3d5e7458f9ae
+:36102de2301e
 'zoomArrowWidth' : 32,
 // by what percentage should the arrows move the zoomed area?
 'zoomArrowMoveFactor' : 0.5,
 // is the "about" window shown?
 'isAboutDivVisible' : false,
-// default size of background image for drag-scroll (same as Bird's Eye View image)
+// default size of preview image for drag-scroll (same as Bird's Eye View image)
-'bgImgWidth' : 200,
+'previewImgWidth' : 200,
-'bgImgHeight' : 200,
+'previewImgHeight' : 200,
-// maximum width or height of background image for drag-scroll
+// maximum width or height of preview background image for drag-scroll
 'maxBgSize' : 10000,
 // parameters used by background image
-'bgImgParamNames' : ['fn','pn','dw','dh','mo','rot'],
+'previewImgParamNames' : ['fn','pn','dw','dh','mo','rot'],
 // reserved space in full page display (default value accounts for vertical scrollbar)
 'scalerInset' : 10
 };
 // list of plugins
 var EPSILON = 0.0001;
 // list of buttons
 var buttons = {};
 var actions = {
-// init: digilib initialization
+/** init: digilib initialization
+*
+* @param options
+* @returns
+*/
 init : function(options) {
 // import geometry classes
 if (plugins.geometry == null) {
 $.error("jquery.digilib.geometry plugin not found!");
 // last straw: old version
 // send setup event
 $(data).trigger('setup');
 });
 },
-// destroy: clean up digilib
+/** destroy: clean up digilib
+*
+* @param data
+* @returns
+*/
 destroy : function(data) {
 return this.each(function(){
 var $elem = $(this);
 $(window).off('.digilib'); // unbind all digilibs(?)
 data.digilib.remove();
 $elem.removeData('digilib');
 });
 },
-// show or hide the 'about' window
+/** show or hide the 'about' window
+*
+* @param data
+* @param show
+*/
 showAboutDiv : function(data, show) {
 var on = showDiv(data.settings.isAboutDivVisible, data.$aboutDiv, show);
 data.settings.isAboutDivVisible = on;
 //FIXME: highlightButtons(data, 'help', on);
 },
-// goto given page nr (+/-: relative)
+/** goto given page nr (+/-: relative)
+*
+* @param data
+* @param pageNr
+* @returns {Boolean}
+*/
 gotoPage : function (data, pageNr) {
 var settings = data.settings;
 var oldpn = settings.pn;
 if (pageNr == null) {
 pageNr = window.prompt("Goto page number", oldpn);
 data.zoomArea = FULL_AREA.copy();
 // then reload
 redisplay(data);
 },
-// zoom by a given factor
+/** zoom by a given factor
+*
+* @param data
+* @param factor
+*/
 zoomBy : function (data, factor) {
 zoomBy(data, factor);
 },
-// zoom to area (or interactive)
+/** zoom to area (or interactive)
+*
+* @param data
+* @param area
+*/
 zoomArea : function (data, area) {
 if (area == null) {
 // interactively
 zoomArea(data);
 } else {
 data.zoomArea = geom.rectangle(area);
 redisplay(data);
 }
 },
-// zoom out to full page
+/** zoom out to full page
+*
+* @param data
+* @param mode
+*/
 zoomFull : function (data, mode) {
 data.zoomArea = FULL_AREA.copy();
 if (mode === 'width') {
 data.dlOpts.fitwidth = 1;
 delete data.dlOpts.fitheight;
 delete data.dlOpts.fitheight;
 }
 redisplay(data);
 },
-// move zoomed area
+/** move zoomed area
+*
+* @param data
+* @param dx
+* @param dy
+*/
 moveZoomArea : function (data, dx, dy) {
 var za = data.zoomArea.copy();
 var factor = data.settings.zoomArrowMoveFactor;
 var deltaX = dx * factor * za.width;
 var deltaY = dy * factor * za.height;
 za = FULL_AREA.fit(za);
 setZoomArea(data, za);
 redisplay(data);
 },
-// set a mark by clicking (or giving a position)
+/** set a mark by clicking (or giving a position)
+*
+* @param data
+* @param mpos
+*/
 setMark : function (data, mpos) {
 if (mpos == null) {
 // interactive
 setMark(data);
 } else {
 data.marks.push(pos);
 redisplay(data);
 }
 },
-// remove the last mark
+/** remove the last mark
+*
+* @param data
+*/
 removeMark : function (data) {
 data.marks.pop();
 redisplay(data);
 },
-// mirror the image
+/** mirror the image
+*
+* @param data
+* @param mode
+*/
 mirror : function (data, mode) {
 var flags = data.scalerFlags;
 if (mode === 'h') {
 if (flags.hmir) {
 delete flags.hmir;
 }
 }
 redisplay(data);
 },
-// rotate the image
+/** rotate the image
+*
+* @param data
+* @param angle
+*/
 rotate : function (data, angle) {
 var rot = data.settings.rot;
 if (angle == null) {
 angle = window.prompt("Rotation angle:", rot);
 }
 data.settings.rot = angle;
 redisplay(data);
 },
-// change brightness
+/** change brightness
+*
+* @param data
+* @param factor
+*/
 brightness : function (data, factor) {
 var brgt = data.settings.brgt;
 if (factor == null) {
 factor = window.prompt("Brightness (-255..255)", brgt);
 }
 data.settings.brgt = factor;
 redisplay(data);
 },
-// change contrast
+/** change contrast
+*
+* @param data
+* @param factor
+*/
 contrast : function (data, factor) {
 var cont = data.settings.cont;
 if (factor == null) {
 factor = window.prompt("Contrast (-8, 8)", cont);
 }
 data.settings.cont = factor;
 redisplay(data);
 },
-// reset image parameters to defaults TODO: improve this!
+/** reset image parameters to defaults
+* TODO: improve this!
+*
+* @param data
+*/
 reset : function (data) {
 var settings = data.settings;
 var paramNames = settings.digilibParamNames;
 var params = data.queryParams;
 // delete all digilib parameters
 delete data.dlOpts.fitwidth;
 delete data.dlOpts.fitheight;
 redisplay(data);
 },
-// presents a reference url (returns value if noprompt)
+/** presents a reference url (returns value if noprompt)
+*
+* @param data
+* @param noprompt
+* @returns
+*/
 reference : function (data, noprompt) {
 var url = getDigilibUrl(data);
 if (noprompt == null) {
 window.prompt("URL reference to the current view", url);
 }
 return url;
 },
-// set image quality
+/** set image quality
+*
+* @param data
+* @param qual
+*/
 setQuality : function (data, qual) {
 var oldq = getQuality(data);
 if (qual == null) {
 qual = window.prompt("Image quality (0..2)", oldq);
 }
 setQuality(data, qual);
 redisplay(data);
 }
 },
-// calibrate (only faking)
+/** calibrate (only faking)
+*
+* @param data
+* @param res
+*/
 calibrate : function (data, res) {
 var oldRes = data.settings.ddpi;
 if (res == null) {
 res = window.prompt("Display resolution (dpi)", oldRes);
 }
 data.settings.ddpi = res;
 redisplay(data);
 }
 },
-// set image scale mode
+/** set image scale mode
+*
+* @param data
+* @param mode
+*/
 setScaleMode : function (data, mode) {
 var oldM = getScaleMode(data);
 if (mode == null) {
 mode = window.prompt("Image scale mode (screen, pixel, size)", oldM);
 }
 }
 // end of actions
 };
-// returns parameters from page url
+/** return parameters from page url
+*
+*/
 var parseQueryParams = function() {
 return parseQueryString(window.location.search.slice(1));
 };
-// returns parameters from embedded img-element
+/** returns parameters 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 params = parseQueryString(query);
 params.scalerBaseUrl = scalerUrl;
 return params;
 };
-// parses query parameter string into parameter object
+/** parses query parameter string into parameter object
+*
+*/
 var parseQueryString = function(query) {
 var params = {};
 if (query == null) return params;
 var pairs = query.split("&");
 //var keys = [];
 }
 }
 return params;
 };
-// returns a query string from key names from a parameter hash (ignoring if the same value is in defaults)
+/** return a query string from key names from a parameter hash
+* (ignores keys if the same value is in defaults)
+*
+*/
 var getParamString = function (settings, keys, defaults) {
 var paramString = '';
 var nx = false;
 for (var i = 0; i < keys.length; ++i) {
 var key = keys[i];
 }
 }
 return paramString;
 };
-// returns URL and query string for Scaler
+/** returns URL and query string for Scaler
+*
+*/
 var getScalerUrl = function (data) {
 packParams(data);
 var settings = data.settings;
 if (settings.scalerBaseUrl == null) {
 alert("ERROR: URL of digilib Scaler servlet missing!");
 var queryString = getParamString(settings, keys, defaults);
 var url = settings.scalerBaseUrl + '?' + queryString;
 return url;
 };
-// returns URL for bird's eye view image
+/** returns URL for preview background image
-var getBgImgUrl = function (data, moreParams) {
+*
+*/
+var getPreviewImgUrl = function (data, moreParams) {
 var settings = data.settings;
 var bgOptions = {
-dw : settings.bgImgWidth,
+dw : settings.previewImgWidth,
-dh : settings.bgImgHeight
+dh : settings.previewImgHeight
 };
 var bgSettings = $.extend({}, settings, bgOptions);
 // filter scaler flags (use only hmir and vmir)
 if (bgSettings.mo != null) {
 var mo = '';
 if (data.scalerFlags.vmir != null) {
 mo += 'vmir';
 }
 bgSettings.mo = mo;
 }
-var params = getParamString(bgSettings, settings.bgImgParamNames, defaults);
+var params = getParamString(bgSettings, settings.previewImgParamNames, defaults);
 var url = settings.scalerBaseUrl + '?' + params;
 return url;
 };
-// returns URL and query string for current digilib
+/** returns URL and query string for current digilib
+*
+*/
 var getDigilibUrl = function (data) {
 packParams(data);
 var settings = data.settings;
 var paramList = settings.additionalParamNames.concat(settings.digilibParamNames);
 if (settings.suppressParamNames != null) {
 	url = url.substring(0, pos);
 }
 return url + '?' + queryString;
 };
-// loads image information from digilib server via HTTP
+/** loads image information from digilib server via HTTP
+*
+*/
 var loadImageInfo = function (data) {
 var settings = data.settings;
 // bind default function (only once)
 $(data).off('imageInfo', handleImageInfo);
 $(data).on('imageInfo', handleImageInfo);
 // send event
 $(data).trigger('imageInfo', [json]);
 });
 };
-// processes some parameters into objects and stuff
+/** processes some parameters into objects and stuff
+*
+*/
 var unpackParams = function (data) {
 var settings = data.settings;
 // zoom area
 var zoomArea = geom.rectangle(settings.wx, settings.wy, settings.ww, settings.wh);
 data.zoomArea = zoomArea;
 data.scalerFlags = flags;
 data.scaleMode = getScaleMode(data);
 retrieveOptions(data);
 };
-// put area into parameters
+/** put area into parameters
+*
+*/
 var packArea = function (settings, area) {
 if (!area) return;
 // zoom area
 settings.wx = cropFloat(area.x);
 settings.wy = cropFloat(area.y);
 settings.ww = cropFloat(area.width);
 settings.wh = cropFloat(area.height);
 };
-// put marks into parameters
+/** put marks into parameters
+*
+*/
 var packMarks = function (settings, marks) {
 if (!marks) return;
 settings.mk = '';
 for (var i = 0; i < marks.length; i++) {
 if (i) {
 cropFloatStr(marks[i].x) + '/' +
 cropFloatStr(marks[i].y);
 }
 };
-// pack scaler flags into parameters
+/** pack scaler flags into parameters
+*
+*/
 var packScalerFlags = function (settings, flags) {
 if (!flags) return;
 var mo = '';
 for (var f in flags) {
 if (mo) {
 mo += f;
 }
 settings.mo = mo;
 };
-// put objects back into parameters
+/** put objects back into parameters
+*
+*/
 var packParams = function (data) {
 var settings = data.settings;
 packArea(settings, data.zoomArea);
 packMarks(settings, data.marks);
 packScalerFlags(settings, data.scalerFlags);
 // store user interface options in cookie
 storeOptions(data);
 };
+/** store digilib options in a cookie
+*
+*/
 var storeOptions = function (data) {
-// save digilib options in cookie
 var settings = data.settings;
 if (data.dlOpts) {
 // save digilib settings in options
 data.dlOpts.birdview = settings.isBirdDivVisible ? 1 : 0;
 data.dlOpts.buttons = settings.visibleButtonSets;
 console.debug("set cookie=", ck, " value=", qs);
 $.cookie(ck, qs);
 }
 };
+/** restrieve digilib options from a cookie
+*
+*/
 var retrieveOptions = function (data) {
 // clop (digilib options)
 var opts = {};
 var settings = data.settings;
 if ($.cookie) {
 // send event
 $(data).trigger('update');
 };
 /** handle "update" display event.
-* updates overlays etc.
+* updates image transform, redraws marks etc.
 */
 var handleUpdate = function (evt) {
 	var data = this;
 updateImgTrafo(data);
 renderMarks(data);
 };
 if (newZoomArea != null) {
 	// check if aspect ratio has changed
 	if (newZoomArea.getAspect() !== data.zoomArea.getAspect()) {
 		console.debug("aspect ratio changed!");
+		// what now?
 	}
 	// get transform for new zoomArea
 	imgTrafo = getImgTrafo($img, newZoomArea, data.settings.rot,
 					data.scalerFlags.hmir, data.scalerFlags.vmir,
 					data.scaleMode, data);
 // additional full-size background using CSS3
 fullRect = imgTrafo.transform(FULL_AREA);
 if (fullRect.height < data.settings.maxBgSize && fullRect.width < data.settings.maxBgSize) {
 // correct offset because background is relative
 fullRect.addPosition(scalerPos.neg());
-var url = getBgImgUrl(data);
+var url = getPreviewImgUrl(data);
 // add second background url, size and position
 scalerCss['background-image'] += ', url(' + url + ')';
 scalerCss[data.bgSizeName] += ', ' + Math.round(fullRect.width) + 'px ' + Math.round(fullRect.height) + 'px';
 scalerCss['background-position'] += ', ' + Math.round(fullRect.x) + 'px '+ Math.round(fullRect.y) + 'px';
 }