annotate client/digitallibrary/jquery/jquery.digilib.js @ 608:774a3f60efd5 jquery

start work on scaler call
author robcast
date Fri, 14 Jan 2011 11:23:56 +0100
parents f5d5cae64828
children 435f81210a33
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
604
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
1 /*
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
2 * digilib jQuery plugin
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
3 *
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
4 */
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
5
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
6 (function($) {
605
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
7
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
8 var defaults = {
608
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
9 // base URL to Scaler servlet
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
10 'scalerBaseUrl' : 'http://digilib.mpiwg-berlin.mpg.de/digitallibrary/servlet/Scaler',
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
11 // list of Scaler parameters
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
12 'scalerParamNames' : ['fn','pn','dw','dh','ww','wh','wx','wy','ws','mo'],
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
13 // digilib image path
607
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
14 'fn' : '',
608
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
15 // mode of operation.
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
16 // fullscreen: takes parameters from page URL, keeps state in page URL
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
17 // embedded: takes parameters from Javascript options, keeps state inside object
605
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
18 'interactionMode' : 'fullscreen'
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
19 };
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
20
608
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
21 // parameters from the query string
607
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
22 var queryParams = {};
608
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
23
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
24 // affine geometry classes
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
25 var geom = dlGeometry();
604
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
26
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
27 var methods = {
608
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
28 // digilib initialization
604
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
29 init : function(options) {
608
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
30 // settings for this digilib instance are merged from defaults and options
607
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
31 var settings = $.extend({}, defaults, options);
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
32 var isFullscreen = settings.interactionMode === 'fullscreen';
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
33 if (isFullscreen) {
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
34 queryParams = parseQueryParams();
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
35 };
604
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
36 return this.each(function() {
605
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
37 var $elem = $(this);
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
38 var data = $elem.data('digilib');
607
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
39 var elemSettings;
608
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
40 // if the plugin hasn't been initialized yet
604
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
41 if (!data) {
605
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
42 // merge query parameters
607
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
43 if (isFullscreen) {
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
44 elemSettings = $.extend({}, settings, queryParams);
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
45 } else {
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
46 elemSettings = $.extend({}, settings, parseImgParams($elem));
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
47 };
605
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
48 // store in data element
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
49 $elem.data('digilib', {
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
50 target : $elem,
607
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
51 settings : elemSettings
604
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
52 });
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
53 }
608
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
54 // create HTML structure
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
55 setupScalerDiv($elem, elemSettings);
604
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
56 });
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
57 },
608
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
58
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
59 // clean up digilib
604
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
60 destroy : function() {
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
61 return this.each(function(){
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
62 var $this = $(this);
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
63 var data = $this.data('digilib');
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
64 // Namespacing FTW
605
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
65 $(window).unbind('.digilib'); // unbinds all digilibs(?)
604
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
66 data.digilib.remove();
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
67 $this.removeData('digilib');
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
68 });
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
69 }
605
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
70 };
604
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
71
608
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
72 // returns parameters from page url
607
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
73 var parseQueryParams = function() {
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
74 return parseQueryString(location.search.slice(1));
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
75 };
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
76
608
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
77 // returns parameters taken from embedded img-element
607
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
78 var parseImgParams = function($elem) {
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
79 var src = $elem.children('img').attr('src');
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
80 var pos = src.indexOf('?');
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
81 var query = (pos < 0) ? '' : src.substring(pos + 1);
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
82 var scalerUrl = src.substring(0, pos);
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
83 var hash = parseQueryString(query);
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
84 hash.scalerUrl = scalerUrl;
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
85 // console.log(hash);
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
86 return hash;
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
87 };
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
88
608
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
89 // parses query parameter string into parameter object
607
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
90 var parseQueryString = function(query) {
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
91 var pairs = query.split("&");
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
92 var hash = {};
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
93 for (var i = 0; i < pairs.length; i++) {
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
94 var pair = pairs[i].split("=");
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
95 if (pair.length === 2) {
608
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
96 hash[pair[0]] = pair[1];
607
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
97 };
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
98 };
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
99 return hash;
f5d5cae64828 parameter parsing
hertzhaft
parents: 605
diff changeset
100 };
604
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
101
608
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
102 // returns URL and query string for Scaler
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
103 var getScalerString = function (settings) {
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
104 var url = settings.scalerUrl;
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
105
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
106 };
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
107
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
108 // creates HTML structure for digilib in elem
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
109 var setupScalerDiv = function ($elem, settings) {
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
110 if (settings.interactionMode === 'fullscreen') {
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
111 // fullscreen -- create new
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
112 $elem.empty(); // TODO: should we keep stuff for customization?
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
113 var scalerHTML = '<div class="scaler"><img class="pic"/></div>';
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
114 $elem.add(scalerHTML);
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
115
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
116 }
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
117 };
774a3f60efd5 start work on scaler call
robcast
parents: 607
diff changeset
118
605
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
119 // hook plugin into jquery
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
120 $.fn.digilib = function(method) {
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
121 if (methods[method]) {
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
122 return methods[method].apply(this, Array.prototype.slice.call(arguments, 1));
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
123 } else if (typeof(method) === 'object' || !method) {
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
124 return methods.init.apply(this, arguments);
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
125 } else {
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
126 $.error( 'Method ' + method + ' does not exist on jQuery.digilib' );
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
127 }
aee94e4a8c48 next version zero of jquery.digilib
robcast
parents: 604
diff changeset
128 };
604
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
129
3a2942d2d5cd version zero of jquery.digilib
robcast
parents:
diff changeset
130 })(jQuery);