[Openpcl-svncommits] SF.net SVN: openpcl: [183] openpcl/src/com/openpcl/viewer/api

[<doc...@us...>]

Revision: 183
          http://openpcl.svn.sourceforge.net/openpcl/?rev=183&view=rev
Author:   documentsystems
Date:     2007-11-05 11:39:46 -0800 (Mon, 05 Nov 2007)

Log Message:
-----------
Howard Hoagland. Added the actionSaveAs() to the two Interface files IOpenPCL and IPluginHooksOpenPCL.

Modified Paths:
--------------
    openpcl/src/com/openpcl/viewer/api/IOpenPCL.java
    openpcl/src/com/openpcl/viewer/api/IPluginHooksOpenPCL.java

Modified: openpcl/src/com/openpcl/viewer/api/IOpenPCL.java
===================================================================
--- openpcl/src/com/openpcl/viewer/api/IOpenPCL.java	2007-10-30 22:47:39 UTC (rev 182)
+++ openpcl/src/com/openpcl/viewer/api/IOpenPCL.java	2007-11-05 19:39:46 UTC (rev 183)
@@ -228,6 +228,9 @@
   /** Zoom to passed in zoom factor */
   public void actionZoomTo(double pZoomFactor);
   
+  /** This gets executed when the user clicks the Save As icon on the toolbar. */
+  public void actionSaveAs();
+
   /** Save one page only as PCL file */
   public void actionSaveOnePageToPclFile();
   

Modified: openpcl/src/com/openpcl/viewer/api/IPluginHooksOpenPCL.java
===================================================================
--- openpcl/src/com/openpcl/viewer/api/IPluginHooksOpenPCL.java	2007-10-30 22:47:39 UTC (rev 182)
+++ openpcl/src/com/openpcl/viewer/api/IPluginHooksOpenPCL.java	2007-11-05 19:39:46 UTC (rev 183)
@@ -11,18 +11,21 @@
 
 /** 
  * The methods in this interface are designed to be overridden by a subclass of OpenPCLViewer 
- * that is a plugin that adds additional features. Examples of additional features that can be added are:
+ * that is a plugin that adds additional features. Examples of additional features that can be added are:<br>
  * 
  * 1. To specify a different name, description, version number for the app that shows in the title bar, status bar, 
- * help about, license text.
- * 2. To add icons to the toolbar and to specify the code to execute when the user clicks the new icons.
- * 3. To open and view and print compound documents that have several PCL files in one file.
- * The binary file format of this compound document is of your own design and is not specified in OpenPCLViewer.
+ * help about, license text.<br>
+ * 2. To add icons to the toolbar and to specify the code to execute when the user clicks the new icons.<br>
+ * 3. To open and view and print compound documents that have several PCL files in one file.<br>
+ * The binary file format of this compound document is of your own design and is not specified in OpenPCLViewer.<br>
  * 4. To create and show on the screen a many levels deep tree structure of the compound document in #3 above 
- * that organizes the several PCL files so the user can select which pages in which PCL file to view and/or print. 
+ * that organizes the several PCL files so the user can select which pages in which PCL file to view and/or print. <br>
+ * 5. The Save As button in the toolbar in OpenPCLViewer just calls the method to save the current viewed page only
+ * to a PCL file, but subclass plugins can override the actionSaveAs() method to prompt the user for which of many
+ * different output formats to Save As, like save all pages to a .ZIP file or other developer designed output format.<br>
  *  
  * Therefore, it is mandatory to not delete or rename these methods or else you'll break the plugin support
- * that adds additional features. 
+ * that adds additional features.<br>
  * 
  * @author DocMagic, Document Systems Inc, Howard. 11/20/06
  */
@@ -93,4 +96,8 @@
   
   /** Get the hidden tag base String */
   public String getHiddenTagBaseString(int pTagIndex);
+  
+  /** This gets executed when the user clicks the Save As icon on the toolbar. */
+  public void actionSaveAs();
+
 }


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.