org.jfree.report.modules.gui.base
Class PreviewDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      org.jfree.report.modules.gui.base.PreviewDialog

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, PreviewProxy, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class PreviewDialog

extends javax.swing.JDialog

implements PreviewProxy

A standard print preview dialog for any JFreeReport. Allows the user to page back and forward through the report, zoom in and out, and send the output to the printer.

You can also save the report in PDF format (thanks to the iText library).

When including this PreviewDialog in your own programs, you should override the provided createXXXAction methods to include your customized actions.

Author:

David Gilbert, Thomas Morgner

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JDialog

javax.swing.JDialog.AccessibleJDialog

Nested classes inherited from class java.awt.Dialog

java.awt.Dialog.AccessibleAWTDialog

Nested classes inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

PreviewDialog(JFreeReport report)
Creates a new preview dialog for a report.

PreviewDialog(JFreeReport report, java.awt.Dialog owner)
Creates a new preview dialog for a report.

PreviewDialog(JFreeReport report, java.awt.Dialog owner, boolean modal)
Creates a new preview dialog for a report.

PreviewDialog(JFreeReport report, java.awt.Frame owner)
Creates a new preview dialog for a report.

PreviewDialog(JFreeReport report, java.awt.Frame owner, boolean modal)
Creates a new preview dialog for a report.

Method Summary

void	close() Shuts down the preview component.
javax.swing.Action	createDefaultCloseAction() Creates the default close action.
void	dispose() Disposes the dialog.
PreviewProxyBase	getBase() Returns the preview proxy.
java.util.ResourceBundle	getResources() Retrieves the resources for this PreviewFrame.

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Dialog

addNotify, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jfree.report.modules.gui.base.PreviewProxy

addComponentListener, pack, removeComponentListener, setJMenuBar, setTitle

Constructor Detail

PreviewDialog

public PreviewDialog(JFreeReport report)
              throws ReportProcessingException

Creates a new preview dialog for a report.

Parameters:

report - the report.

Throws:

ReportProcessingException - if there is a problem processing the report.

PreviewDialog

public PreviewDialog(JFreeReport report,
                     java.awt.Frame owner)
              throws ReportProcessingException

Creates a new preview dialog for a report.

Parameters:

report - the report.

owner - the owner frame.

Throws:

ReportProcessingException - if there is a problem processing the report.

PreviewDialog

public PreviewDialog(JFreeReport report,
                     java.awt.Frame owner,
                     boolean modal)
              throws ReportProcessingException

Creates a new preview dialog for a report.

Parameters:

report - the report.

owner - the owner frame.

modal - modal or non-modal?

Throws:

ReportProcessingException - if there is a problem processing the report.

PreviewDialog

public PreviewDialog(JFreeReport report,
                     java.awt.Dialog owner)
              throws ReportProcessingException

Creates a new preview dialog for a report.

Parameters:

report - the report.

owner - the owner dialog.

Throws:

ReportProcessingException - if there is a problem processing the report.

PreviewDialog

public PreviewDialog(JFreeReport report,
                     java.awt.Dialog owner,
                     boolean modal)
              throws ReportProcessingException

Creates a new preview dialog for a report.

Parameters:

report - the report.

owner - the owner dialog.

modal - modal or non-modal?

Throws:

ReportProcessingException - if there is a problem processing the report.

Method Detail

createDefaultCloseAction

public javax.swing.Action createDefaultCloseAction()

Creates the default close action.

Specified by:

createDefaultCloseAction in interface PreviewProxy

Returns:

The action.

dispose

public void dispose()

Disposes the dialog.

Specified by:

dispose in interface PreviewProxy

close

public void close()

Shuts down the preview component. Once the component is closed, it cannot be reactivated anymore.

Specified by:

close in interface PreviewProxy

getResources

public java.util.ResourceBundle getResources()

Retrieves the resources for this PreviewFrame. If the resources are not initialized, they get loaded on the first call to this method.

Returns:

this frames ResourceBundle.

getBase

public PreviewProxyBase getBase()

Returns the preview proxy.

Specified by:

getBase in interface PreviewProxy

Returns:

The proxy.