edu.northwestern.at.utils.swing.printing
Class PrintJTextPane

java.lang.Object
  java.awt.Component
      edu.northwestern.at.utils.swing.printing.PrintableComponent
          edu.northwestern.at.utils.swing.printing.PrintJTextPane

All Implemented Interfaces:

PrintProgress, java.awt.image.ImageObserver, java.awt.MenuContainer, java.awt.print.Pageable, java.awt.print.Printable, java.io.Serializable

public class PrintJTextPane
extends PrintableComponent

Prints styled text from a JTextPane.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class edu.northwestern.at.utils.swing.printing.PrintableComponent

PrintableComponent.PageState

Nested classes/interfaces inherited from class java.awt.Component

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

Field Summary

protected PrintView

printView The PrintView to hold printed pages.

Fields inherited from class edu.northwestern.at.utils.swing.printing.PrintableComponent

breakCheckPercentage, component, headerAndFooter, pageCount, pageFormat, pageImage, pageState, pageStateMap, printerJob, printerPageHeight, printerPageWidth, printProgress, printProgressAllowed, scaleFactor

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.print.Pageable

UNKNOWN_NUMBER_OF_PAGES

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

PrintJTextPane(javax.swing.JTextPane textPane)
Create PrintJTextPane object.

PrintJTextPane(javax.swing.JTextPane textPane, java.awt.print.PageFormat pageFormat)
Create PrintJTextPane object.

PrintJTextPane(javax.swing.JTextPane textPane, java.awt.print.PageFormat pageFormat, PrintHeaderFooter headerFooter)
Create PrintJTextPane object.

Method Summary

int	calculatePageCount() Calculate count of printed pages.
void	doPrintContents() Print the contents of the JTextPane.
int	getNumberOfPages() Return number of pages to print.
void	initializePrintView() Initialize the print view stack.
int	print(java.awt.Graphics pg, java.awt.print.PageFormat pageFormat, int pageIndex) Print one page of text from document.

Methods inherited from class edu.northwestern.at.utils.swing.printing.PrintableComponent

closeProgress, getFooterSize, getHeaderSize, getPageFormat, getPrintable, getSliceLength, printContents, printHeaderAndFooter, printPage, setBreakCheckPercentage, setPageFormat, setPrinterJob, setProgress, updateProgress, validateLayout

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate

Methods inherited from class java.lang.Object

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

Field Detail

printView

protected PrintView printView

The PrintView to hold printed pages.

Constructor Detail

PrintJTextPane

public PrintJTextPane(javax.swing.JTextPane textPane,
                      java.awt.print.PageFormat pageFormat,
                      PrintHeaderFooter headerFooter)

Create PrintJTextPane object.

Parameters:

textPane - The text pane whose contents are to be printed.

pageFormat - The printer page format.

headerFooter - The header and footer for this page.

PrintJTextPane

public PrintJTextPane(javax.swing.JTextPane textPane,
                      java.awt.print.PageFormat pageFormat)

Create PrintJTextPane object.

Parameters:

textPane - The text pane whose contents are to be printed.

pageFormat - The printer page format.

No header, footer, or line numbers are printed.

PrintJTextPane

public PrintJTextPane(javax.swing.JTextPane textPane)

Create PrintJTextPane object.

Parameters:

textPane - The text pane whose contents are to be printed.

No header, footer, or line numbers are printed.

Method Detail

doPrintContents

public void doPrintContents()

Print the contents of the JTextPane.

You can call this method instead of printContents() if you are setting up your own printing thread.

Overrides:

doPrintContents in class PrintableComponent

print

public int print(java.awt.Graphics pg,
                 java.awt.print.PageFormat pageFormat,
                 int pageIndex)

Print one page of text from document.

Specified by:

print in interface java.awt.print.Printable

Overrides:

print in class PrintableComponent

Parameters:

pg - Graphics context into which to draw page image.

pageFormat - Contains information about page size and paper orientation.

pageIndex - Which page to print (starts at zero).

Returns:

PAGE_EXISTS if page exists NO_SUCH_PAGE if page does not exist

Implements the Printable interface for the Swing text component.

initializePrintView

public void initializePrintView()

Initialize the print view stack.

calculatePageCount

public int calculatePageCount()

Calculate count of printed pages.

Overrides:

calculatePageCount in class PrintableComponent

Returns:

Count of pages to print.

getNumberOfPages

public int getNumberOfPages()

Return number of pages to print.

Specified by:

getNumberOfPages in interface java.awt.print.Pageable

Overrides:

getNumberOfPages in class PrintableComponent

Returns:

Count of pages to print.