Bugzilla #36418:

Documentation update for the "reload" change in the AWT Viewer.
Submitted by: Richard Wheeldon <richardw.at.geoquip-rnd.demon.co.uk>

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@264974 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/java/org/apache/fop/render/awt/viewer/PreviewPanel.java b/src/java/org/apache/fop/render/awt/viewer/PreviewPanel.java
index 18436ac53b0043d8d5cea92df9a1006294763fba..b70723093a73b2aae847b4d100dcd3382088bf9e 100644 (file)
--- a/src/java/org/apache/fop/render/awt/viewer/PreviewPanel.java
+++ b/src/java/org/apache/fop/render/awt/viewer/PreviewPanel.java
@@ -53,9 +53,12 @@ import org.apache.fop.render.awt.AWTRenderer;
  * Fop controls.
  * </p>   
  * <p>In order to embed a PreviewPanel in your own app, create your own renderer,
- * and your own agent. Then call setPreviewDialogDisplayed(false) to hide the
- * default dialog. Finally create a preview panel with the renderer and add it
- * to your gui:
+ * and your own agent. In order to support reloads, you may also implement your
+ * own Renderable extension or the default InputHandler. Setting the Renderable
+ * to null works fine though.
+ * Then call setPreviewDialogDisplayed(false) to hide the
+ * default dialog. Finally create a preview panel with the agent, renderable and
+ * renderer and add it to your gui:
  * </p>
  * <pre>
  * AWTRenderer renderer = new AWTRenderer();
@@ -63,7 +66,7 @@ import org.apache.fop.render.awt.AWTRenderer;
  * agent.setRendererOverride(renderer);
  * renderer.setPreviewDialogDisplayed(false);
  * renderer.setUserAgent(agent);
- * previewPanel = new PreviewPanel(agent, renderer);
+ * previewPanel = new PreviewPanel(agent, null, renderer);
  * previewPanel = new PreviewPanel(ua);
  * myGui.add(previewPanel);
  * </pre>