org.freehep.application
Class PrintPreview

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--org.freehep.application.PrintPreview

All Implemented Interfaces:

Accessible, HasPopupItems, ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

Application.AppPrintPreview

public class PrintPreview

extends JPanel

implements HasPopupItems

This class can be used to add print preview capabilities to an application. Originally taken from the book Swing by Matthew Robinson and Pavel Vorobiev, Ph.D.

Version:

$Id: PrintPreview.java,v 1.7 2002/10/15 22:17:19 tonyj Exp $

Author:

Tony Johnson

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

PrintPreview()
Create an empty PrintPreview

Method Summary

protected JComponent	createCloseButton() Creates the Close button
JDialog	createDialog(Component owner) Create a standard dialog that wraps the PrintPreview
JDialog	createDialog(Component owner, String title) Create a standard dialog that wraps the PrintPreview
protected JComponent	createPrintButton() Creates the Print Button
protected JComponent	createScaleChooser() Create the Scale chooser
protected JToolBar	createToolBar() Called to create the toolbar.
JPopupMenu	modifyPopupMenu(JPopupMenu menu, Component source, Point p) Allows a component to create or modify a popup menu
protected void	onError(PrinterException x)
protected boolean	onPrint(Pageable document) Called if the user chooses Print.
void	setPageable(Pageable target) Set a target Pageable.
void	setPrintable(Printable target) Set a target Printable using the default PageFormat.
void	setPrintable(Printable target, PageFormat pf) Set a target Printable.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

PrintPreview

public PrintPreview()

Create an empty PrintPreview

Method Detail

setPrintable

public void setPrintable(Printable target)
                  throws PrinterException

Set a target Printable using the default PageFormat. Printables are only suitable for printing a small number of pages, for more pages use a Pageable instead.

Parameters:

target - The Printable to preview

Throws:

PrinterException - If an exception occurs while trying to figure out how many pages are available

setPrintable

public void setPrintable(Printable target,
                         PageFormat pf)
                  throws PrinterException

Set a target Printable. Printables are only suitable for printing a small number of pages, for more pages use a Pageable instead.

Parameters:

target - The Printable to preview

pf - The PageFormat to use for the pages

Throws:

PrinterException - If an exception occurs while trying to figure out how many pages are available

setPageable

public void setPageable(Pageable target)

Set a target Pageable.

Parameters:

target - The Pageable to preview

createDialog

public JDialog createDialog(Component owner)

Create a standard dialog that wraps the PrintPreview

Parameters:

owner - The owner of the dialog

createDialog

public JDialog createDialog(Component owner,
                            String title)

Create a standard dialog that wraps the PrintPreview

Parameters:

owner - The owner of the dialog

title - The title of the dialog

onPrint

protected boolean onPrint(Pageable document)
                   throws PrinterException

Called if the user chooses Print. Override for custom printing.

Returns:

true if printing was completed, false if cancelled by user

PrinterException

onError

protected void onError(PrinterException x)

modifyPopupMenu

public JPopupMenu modifyPopupMenu(JPopupMenu menu,
                                  Component source,
                                  Point p)

Description copied from interface: HasPopupItems

Allows a component to create or modify a popup menu

Specified by:

modifyPopupMenu in interface HasPopupItems

Parameters:

menu - The menu created by the components descendents

source - The deepest component

Returns:

The modified menu

createToolBar

protected JToolBar createToolBar()

Called to create the toolbar. Override to customize the toolbar.

createCloseButton

protected JComponent createCloseButton()

Creates the Close button

createPrintButton

protected JComponent createPrintButton()

Creates the Print Button

createScaleChooser

protected JComponent createScaleChooser()

Create the Scale chooser