Mercurial > hg > digilib

annotate client/digitallibrary/jquery/jquery-digilib-plugins.txt @ 797:755848b96fc1 stream

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
first version using officially approved Servlet 3.0 async support.
author robcast
date Sat, 19 Feb 2011 22:01:12 +0100
parents 32d1d6601968
children 2fb1f576375d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
786
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
1
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
2 The plugin API of jquery.digilib
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
3 --------------------------------
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
4
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
5 * The plugin Javascript file has to be loaded after jquery.digilib.js.
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
6
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
7 * The plugin should be written as a closure on jQuery (like a jquery plugin) exporting a plugin object as its interface:
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
8
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
9 var plugin = {
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
10 name : 'mydigilibplugin',
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
11 install : install,
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
12 init : init,
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
13 buttons : {},
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
14 actions : {},
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
15 fn : {},
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
16 plugins : {},
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
17 defaults : {}
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
18 };
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
19
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
20 The "name" string, "install" function and "init" function are provided by the plugin and called by digilib.
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
21 "buttons", "actions", "fn" and "plugins" are shared objects provided by digilib.
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
22 "buttons" is the array of button objects. The plugin can add its own buttons to this array.
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
23 "actions" is the array of action objects. The plugin can add its own actions to this array.
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
24 "fn" is an object with functions from digilib.
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
25 "plugins" is an object with all digilib plugin objects.
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
26 "defaults" is an object with all digilib defaults.
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
27
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
28 * the plugin object is passed to digilib in the "plugin" action on loading the plugin javascript file:
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
29
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
30 $.fn.digilib('plugin', plugin);
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
31
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
32 digilib then calls the "install" function on the populated plugin object (i.e. this = plugin) with the plugin object as parameter.
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
33
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
34 * digilib calls the "init" function from the plugin object with the data object instance as a parameter in digilibs init phase.
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
35
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
36 * further actions should be implemented as custom events on the data object.
912519475259 documentation for new plugin api in jquery-digilib-plugin.txt.
robcast
parents:
diff changeset
37
789
32d1d6601968 added redisplay handler to birdseye. updated plugin docu.
robcast
parents: 786
diff changeset
38 * events triggered by digilib on the data object:
32d1d6601968 added redisplay handler to birdseye. updated plugin docu.
robcast
parents: 786
diff changeset
39 "setup": in the init phase, after scalerDiv and buttons have been set up.
32d1d6601968 added redisplay handler to birdseye. updated plugin docu.
robcast
parents: 786
diff changeset
40 "update", updateDisplay(): after small updates in the display, e.g. when the scaler-img finished loading.
32d1d6601968 added redisplay handler to birdseye. updated plugin docu.
robcast
parents: 786
diff changeset
41 "redisplay", redisplay(): after changes in the display, e.g. after changing zoom factor.
32d1d6601968 added redisplay handler to birdseye. updated plugin docu.
robcast
parents: 786
diff changeset
42 "dragZoom(newZoomArea)": while dragging the zoom area (with parameter newZoomArea).