Package org.apache.fop.render.awt.viewer

Class PreviewPanel

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
org.apache.fop.render.awt.viewer.PreviewPanel
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible
public class PreviewPanel extends JPanel

Holds a scrollpane with the rendered page(s) and handles actions performed to alter the display of the page.

Use PreviewPanel when you want to embed a preview in your own application with your own controls. Use PreviewDialog when you want to use the standard Fop controls.

In order to embed a PreviewPanel in your own app, create your own renderer, 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: 

 FopFactory fopFactory = FopFactory.newInstance();
 FOUserAgent agent = fopFactory.newFOUserAgent();
 AWTRenderer renderer = new AWTRenderer(agent);
 agent.setRendererOverride(renderer);
 previewPanel = new PreviewPanel(agent, null, renderer);
 previewPanel = new PreviewPanel(ua);
 myGui.add(previewPanel);
In order to set options and display a page do: 
 renderer.clearViewportList();
 // build report xml here
 reload(); // optional if setting changed
If you wan't to change settings, don't call reload. A good example is to set the page to fill the screen and set the scrolling mode: 
 double scale = previewPanel.getScaleToFitWindow();
 previewPanel.setScaleFactor(scale);
 previewPanel.setDisplayMode(PreviewPanel.CONTINUOUS);
See Also:

  • Field Details

    • SINGLE

      public static final int SINGLE
      Constant for setting single page display.
      See Also:

    • CONTINUOUS

      public static final int CONTINUOUS
      Constant for setting continuous page display.
      See Also:

    • CONT_FACING

      public static final int CONT_FACING
      Constant for displaying even/odd pages side by side in continuous form.
      See Also:

    • foUserAgent

      protected FOUserAgent foUserAgent
      The FOUserAgent associated with this panel - often shared with PreviewDialog

    • renderable

      protected Renderable renderable
      Renderable instance that can be used to reload and re-render a document after modifications.

  • Constructor Details

    • PreviewPanel

      public PreviewPanel(FOUserAgent foUserAgent, Renderable renderable, AWTRenderer renderer)
      Creates a new PreviewPanel instance.
      Parameters:
      foUserAgent - the user agent
      renderable - the Renderable instance that is used to reload/re-render a document after modifications.
      renderer - the AWT Renderer instance to paint with

  • Method Details

    • getPage

      public int getPage()
      Returns:
      the currently visible page

    • setPage

      public void setPage(int number)
      Selects the given page, displays it on screen and notifies listeners about the change in selection.
      Parameters:
      number - the page number

    • setDisplayMode

      public void setDisplayMode(int mode)
      Sets the display mode.
      Parameters:
      mode - One of SINGLE, CONTINUOUS or CONT_FACING.

    • getDisplayMode

      public int getDisplayMode()
      Returns the display mode.
      Returns:
      mode One of SINGLE, CONTINUOUS or CONT_FACING.

    • reload

      public void reload()
      Reloads and reformats document.

    • addPageChangeListener

      public void addPageChangeListener(PageChangeListener l)
      Add a listener to receive notification of page change events. Events will be fired whenever the currentPage value is changed. The values recorded are 0-based.
      Parameters:
      l - the page change listener to add

    • removePageChangeListener

      public void removePageChangeListener(PageChangeListener l)
      Removes a page change listener.
      Parameters:
      l - the page change listener to remove

    • firePageChange

      protected void firePageChange(int oldPage, int newPage)
      Notify all registered listeners of a page change event.
      Parameters:
      oldPage - the old page
      newPage - the new page

    • setScaleFactor

      public void setScaleFactor(double scale)
      Scales page image
      Parameters:
      scale - [0;1]

    • getScaleToFitWindow

      public double getScaleToFitWindow() throws FOPException
      Returns the scale factor required in order to fit either the current page within the current window or to fit two adjacent pages within the display if the displaymode is continuous.
      Returns:
      the requested scale factor
      Throws:
      FOPException - in case of an error while fetching the PageViewport

    • getScaleToFitWidth

      public double getScaleToFitWidth() throws FOPException
      As getScaleToFitWindow, but ignoring the Y axis.
      Returns:
      the requested scale factor
      Throws:
      FOPException - in case of an error while fetching the PageViewport

    • getScaleToFit

      public double getScaleToFit(double viewWidth, double viewHeight) throws FOPException
      Returns the scale factor required in order to fit either the current page or two adjacent pages within a window of the given height and width, depending on the display mode. In order to ignore either dimension, just specify it as Double.MAX_VALUE.
      Parameters:
      viewWidth - width of the view
      viewHeight - height of the view
      Returns:
      the requested scale factor
      Throws:
      FOPException - in case of an error while fetching the PageViewport

    • showPage

      public void showPage()
      Starts rendering process and shows the current page.