Changes between Version 9 and Version 10 of plugin

Timestamp:

Dec 7, 2010, 1:16:31 PM (14 years ago)

Author:

bpt

Comment:

--

plugin

@@ -1 +1 @@
 == Using plugins ==
 
-Click "Plugins -> Load Plugin" from the Transformer window menu bar.  You should be presented with a file browser, select a jar file containing one or more Batchable classes.    
-The plugin will add a new cascaded menu to the plugins menu, the cascaded menu will contain each "Batchable" class as both a single and a batch item on the "Plugins" sub menu.
-
-== Writing plugins ==
-
-To implement a plugin for JPsychoMorph you need to create a Java class that overrides the Facemorph.Batchable interface:
+Click "Plugins -> Load Plugin" from the Transformer window menu bar.  You should be presented with a file browser, select a jar file containing one or more Batchable and/or Plugin classes.  The plugin will add a new cascaded menu to the plugins menu, the cascaded menu will contain each "Batchable" class as both a single and a batch item on the "Plugins" sub menu.  Any Plugin classes may make additional changes to the user interface, such as adding a new menu.
+
+== Writing Batchable and Plugin classes ==
+
+JPsychomorph handles two plugin interfaces, the main one is Batchable, which allows single and batch processing of images.  The second interface, Plugin, is more general, and simply supports a setup and cleanup method.  The internal handling of these interface types is different.  For Batchable classes a new instance of the class is created each time it is used (in batch or single mode).  For Plugin classes a single instance is created on loading and the setup method is called, this instance persists until the programme closes or the plugin is unloaded.  A single jar file can contain a mixture of Plugin and Batchable classes, and all will be loaded or unloaded together.  If a class implements both interfaces, one instance will be created as the Plugin, and will persist until unloaded, another instance will be created each time for batch or single mode Batchable processing.  Any implementing class for either of these classes should have an empty (or no) constructor, if they do not they will not be loaded.
+
+These interfaces are part of the Facemorph library available here:
+
+ * http://users.aber.ac.uk/bpt/jpsychomorph/version4/facemorphlib.jar -- facemorphlib.jar
+
+Documentation for all the classes in the library is available here:
+
+ * http://users.aber.ac.uk/bpt/jpsychomorph/version4/javadoc/ -- facemorphlib documentation
+
+=== Writing Plugin classes ===
+
+The Plugin interface supports just two methods, setup and cleanup:
+
+{{{
+public interface Plugin {
+     public boolean setup(PsychoMorphForm psychomorph);
+     public boolean cleanup(PsychoMorphForm psychomorph);
+}
+}}}
+
+A very simple example of a Plugin is given below, this simply adds a menu "Boo!" to the Psychomorph window, with one item "Boo!", which when pressed brings up a dialog saying, you guessed, "Boo!".
+
+{{{
+
+import Facemorph.psychomorph.Batchable;
+import Facemorph.psychomorph.ImageZoomPanel;
+import Facemorph.psychomorph.Plugin;
+import Facemorph.psychomorph.PsychoMorphForm;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import javax.swing.JMenu;
+import javax.swing.JMenuItem;
+import javax.swing.JOptionPane;
+
+public class AddMenuTest  extends JMenu implements Plugin {
+    PsychoMorphForm psychomorph;
+    
+    public boolean setup(PsychoMorphForm psychomorph) {
+         this.psychomorph = psychomorph;
+        JMenuItem anItem = new JMenuItem("Boo!");
+        anItem.addActionListener(new ActionListener() {
+            public void actionPerformed(ActionEvent e) {
+                JOptionPane.showMessageDialog(AddMenuTest.this.psychomorph, "Boo!");
+            }
+        });
+
+        setText("Boo!");
+        add(anItem);
+        psychomorph.addMenu(this);
+
+        return true;
+    }
+
+    public boolean cleanup(PsychoMorphForm psychomorph) {
+        psychomorph.removeMenu(this);
+        return true;
+    }
+}
+
+}}}
+
+=== Writing Batchable classes ===
+
+To implement a Batchable plugin for JPsychoMorph you need to create a Java class that overrides the Facemorph.Batchable interface:
 
 {{{
@@ -17 +80 @@
 }}}
 
-This interface is part of the Facemorph library available here:
-
- * http://users.aber.ac.uk/bpt/jpsychomorph/version4/facemorphlib.jar -- facemorphlib.jar
-
-Documentation for all the classes in the library is available here:
-
- * http://users.aber.ac.uk/bpt/jpsychomorph/version4/javadoc/ -- facemorphlib documentation
 
 The main method in the Batchable interface is ''process'', which will be called for each image in the batch.  The ''single'' parameter is true if the processing is '''not''' operating in batch mode, but on a single loaded image.  This is useful for things like pushing undo information on the stack, which you may not want to do in batch mode. The ImageZoomPanel allows access to the currently loaded Image and Template.