J2TablePrinter

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.wildcrest.j2printerworks
Class J2TablePrinter

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              com.wildcrest.j2printerworks.J2Pageable
                  com.wildcrest.j2printerworks.J2TablePrinter

All Implemented Interfaces:: Flowable, java.awt.image.ImageObserver, java.awt.MenuContainer, java.awt.print.Pageable, java.io.Serializable

public class J2TablePrinter
extends J2Pageable

A Java 2 component for multi-page printing of any JTable or JTable subclass as either a Pageable or a Flowable, breaking pages on table row and column boundaries (or, optionally, on a specified color such as table.getGridColor()).

The JTable can have variable row heights and/or column widths. Column and/or row headers can be printed replicated at the top/left of each page, or only on the top/left pages, or not at all. You can also specify the print area (row/column subset) to be printed. The JTable will be printed "WYSIWYG", including any fonts, colors, intercell spacing, gridline values, and/or custom cell renderers you have specified. The table can be left, right, or center justified horizontally, or top, bottom, or center justified vertically on the page.

There is separate control of horizontal and vertical pagination, with several modes of pagination are supported for each. The BREAK_ON_ROWS and BREAK_ON_COLUMNS modes will calculate exact row heights (or column widths) to determine table break boundaries. BREAK_ON_COLOR mode is an alternative that will find table boundaries whose pixel values most closely approximate a specified horizontal break color (or vertical break color). Specifying a color such as table.getGridColor() will break on row (column) boundaries and will work in certain cases where BREAK_ON_ROWS or BREAK_ON_COLUMNS does not, such as nested JTables. BREAK_ON_COLOR can be slow for large tables, but there are methods (see setAutomaticRecalculation and setBreakOnColorIncrement) which can be used to optimize the process. Finally, SHRINK_TO_FIT mode will shrink the table to fit the width (or height) of a page.

In addition, all the standard J2Pageable features are also available when printing J2TablePrinter as a Pageable, including control of headers, footers, margins, orientation, and scale.

(C) Copyright 2009, Wildcrest Associates (http://www.wildcrest.com). All rights reserved.

See Also:: Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

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
`static int`	`ALL_PAGES` Specifies that column or row headers are to be printed on all pages.
`static int`	`BREAK_ON_COLOR` Used in setHorizontalPageRule and setVerticalPageRule to indicate break-on-color mode
`static int`	`BREAK_ON_COLUMNS` Used in setHorizontalPageRule to indicate break-on-columns mode
`static int`	`BREAK_ON_ROWS` Used in setVerticalPageRule to indicate break-on-rows mode
`static int`	`LEFT_PAGES` Specifies that row headers are to be printed on the left page(s) only.
`static int`	`NO_PAGES` Specifies that no column or row headers are to be printed.
`static int`	`SHRINK_TO_FIT` Used in setHorizontalPageRule and setVerticalPageRule to indicate shrink-to-fit mode
`static int`	`TOP_PAGES` Specifies that column headers are to be printed on the top page(s) only.

Fields inherited from class com.wildcrest.j2printerworks.J2Pageable

BOTTOM, BOX, CENTER, FIRST, GLOBAL, LANDSCAPE, LEFT, LINE, NONE, PORTRAIT, PPI72, REST, REVERSE_LANDSCAPE, RIGHT, TOP

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.print.Pageable

UNKNOWN_NUMBER_OF_PAGES

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary
`J2TablePrinter()` Construct a JTablePageable object (no JTable specified)
`J2TablePrinter(javax.swing.JTable table)` Construct a JTablePageable object for a given JTable

Method Summary
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener l)` Add a PropertyChangeListener for this component
`void`	`dispose()` Release all heap objects held by this J2TablePrinter object, must not call until printing completes.
`boolean`	`doneX()` Returns whether there is no more of this Flowable object to print horizontally.
`boolean`	`doneY()` Returns whether there is no more of this Flowable object to print vertically.
`int`	`getBreakOnColorIncrement()` Returns the evaluation increment in pixels for BREAK_ON_COLOR mode.
`int`	`getColumnHeaderPrinting()` Returns current value of columnHeaderPrinting property.
`int`	`getHorizontalAlignment()` Returns horizontal alignment (LEFT, CENTER, RIGHT) of this JTable on page.
`java.awt.Color`	`getHorizontalBreakColor()` Returns the Color used as break color for BREAK_ON_COLOR pagination mode when breaking horizontally.
`int`	`getHorizontalPageRule()` Returns current value of pageRule property (SHRINK_TO_FIT, BREAK_ON_COLUMNS, or BREAK_ON_COLOR).
`double`	`getMaximumPaginationGap()` Returns largest acceptable pagination gap as a percentage of the full body height/width.
`java.awt.Rectangle`	`getPrintArea()` Get the print area values set in the most recent setPrintArea call
`int`	`getRowHeaderPrinting()` Returns current value of rowHeaderPrinting property.
`javax.swing.JTable`	`getTable()` Returns the JTable containing the document that will be printed.
`int`	`getVerticalAlignment()` Returns vertical alignment (TOP, CENTER, BOTTOM) of this JTable on page.
`java.awt.Color`	`getVerticalBreakColor()` Returns the Color used as break color for BREAK_ON_COLOR pagination mode when breaking vertically.
`int`	`getVerticalPageRule()` Returns current value of pageRule property (SHRINK_TO_FIT, BREAK_ON_ROWS, or BREAK_ON_COLOR).
`boolean`	`isAutomaticRecalculation()` Returns whether BREAK_ON_ROWS (or COLUMNS) and BREAK_ON_COLOR internal data tables recompute automatically every time you print or print preview this JTable.
`boolean`	`isOutsideLines()` Returns whether to print outside gridlines around the JTable.
`boolean`	`isOverlap()` Returns whether to repeat the last pixel row and column again on the next page when paginating, which ensures that gridlines are drawn on all sides of the JTable rows and columns printed on each page.
`void`	`prepareRenderer()` Utility method that calls prepareRenderer method for all cells in the current JTable.
`void`	`printFlowable(java.awt.Graphics g, int availableWidth, int availableHeight, int nextFullPageWidth, int nextFullPageHeight)` Print the next sequential section of this Flowable object that fits into the next incremental area.
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener l)` Remove a PropertyChangeListener for this component
`void`	`resetFlowable()` Reset the Flowable object so that it starts printing from the beginning.
`void`	`setAutomaticRecalculation(boolean automaticRecalculation)` Sets whether the BREAK_ON_ROWS (and BREAK_ON_COLUMNS) or BREAK_ON_COLOR internal data tables recompute automatically every time you print or print preview this JTable.
`void`	`setBreakOnColorIncrement(int breakOnColorIncrement)` Sets the evaluation increment in pixels for BREAK_ON_COLOR mode.
`void`	`setColumnHeaderPrinting(int columnHeaderPrinting)` Sets whether column headers printed on all pages, top pages, or no pages.
`void`	`setHorizontalAlignment(int horizontalAlignment)` Sets the horizontal alignment (LEFT, CENTER, RIGHT) for printing the JTable on the page.
`void`	`setHorizontalBreakColor(java.awt.Color horizontalBreakColor)` Sets the break color to be used for BREAK_ON_COLOR pagination mode when breaking horizontally.
`void`	`setHorizontalPageRule(int horizontalPageRule)` Sets the page rule for paginating the JTable horizontally, either SHRINK_TO_FIT, BREAK_ON_COLUMNS (default), or BREAK_ON_COLOR.
`void`	`setMaximumPaginationGap(double maximumPaginationGap)` Sets the largest acceptable pagination gap as a percentage of the full body height/width.
`void`	`setOutsideLines(boolean showOutsideLines)` Sets whether to print outside gridlines around the JTable.
`void`	`setOverlap(boolean overlapEnabled)` Sets whether to repeat the last pixel row and column again on the next page when paginating.
`void`	`setPrintArea(int startColumnIndex, int startRowIndex, int numberOfPrintColumns, int numberOfPrintRows)` Set the print area to be printed.
`void`	`setPrintArea(java.awt.Rectangle rect)` Set the print area to be printed using a Rectangle.
`void`	`setRowHeaderPrinting(int rowHeaderPrinting)` Sets whether row headers printed on all pages, left pages, or no pages.
`void`	`setTable(javax.swing.JTable table)` Specifies the JTable that will be printed.
`void`	`setVerticalAlignment(int verticalAlignment)` Sets the vertical alignment (TOP, CENTER, BOTTOM) for printing the JTable on the page.
`void`	`setVerticalBreakColor(java.awt.Color verticalBreakColor)` Sets the break color to be used for BREAK_ON_COLOR pagination mode when breaking vertically.
`void`	`setVerticalPageRule(int verticalPageRule)` Sets the page rule for paginating the JTable vertically, either SHRINK_TO_FIT, BREAK_ON_ROWS (default), or BREAK_ON_COLOR.
`int`	`usedX()` Returns the amount this Flowable object was able to advance horizontally in the last printFlowable call.
`int`	`usedY()` Returns the amount this Flowable object was able to advance vertically in the last printFlowable call.

Methods inherited from class com.wildcrest.j2printerworks.J2Pageable

clearFooters, clearFooters, clearHeaders, clearHeaders, getBodyHeight, getBodyWidth, getBottomMargin, getCenterFooter, getCenterFooter, getCenterHeader, getCenterHeader, getFooterFont, getFooterFont, getFooterStyle, getFooterStyle, getGapAboveFooter, getGapBelowHeader, getHeaderFont, getHeaderFont, getHeaderStyle, getHeaderStyle, getLeftFooter, getLeftFooter, getLeftHeader, getLeftHeader, getLeftMargin, getMaximumSize, getMinimumSize, getNumberOfPages, getNumberOfPagesHigh, getNumberOfPagesWide, getOrientation, getPageFormat, getPageFormat, getPreferredSize, getPrintable, getRightFooter, getRightFooter, getRightHeader, getRightHeader, getRightMargin, getScale, getTopMargin, paint, setBottomMargin, setCenterFooter, setCenterFooter, setCenterHeader, setCenterHeader, setFooterFont, setFooterFont, setFooterStyle, setFooterStyle, setGapAboveFooter, setGapBelowHeader, setHeaderFont, setHeaderFont, setHeaderStyle, setHeaderStyle, setLeftFooter, setLeftFooter, setLeftHeader, setLeftHeader, setLeftMargin, setLocale, setMaximumPages, setOrientation, setPageFormat, setParam, setRightFooter, setRightFooter, setRightHeader, setRightHeader, setRightMargin, setScale, setTopMargin

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getNextFocusableComponent, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, 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, updateUI

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, 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

Field Detail

SHRINK_TO_FIT

public static final int SHRINK_TO_FIT

Used in setHorizontalPageRule and setVerticalPageRule to indicate shrink-to-fit mode

See Also:: Constant Field Values

BREAK_ON_ROWS

public static final int BREAK_ON_ROWS

Used in setVerticalPageRule to indicate break-on-rows mode

See Also:: Constant Field Values

BREAK_ON_COLUMNS

public static final int BREAK_ON_COLUMNS

Used in setHorizontalPageRule to indicate break-on-columns mode

See Also:: Constant Field Values

BREAK_ON_COLOR

public static final int BREAK_ON_COLOR

Used in setHorizontalPageRule and setVerticalPageRule to indicate break-on-color mode

See Also:: Constant Field Values

NO_PAGES

public static final int NO_PAGES

Specifies that no column or row headers are to be printed.

See Also:: Constant Field Values

TOP_PAGES

public static final int TOP_PAGES

Specifies that column headers are to be printed on the top page(s) only.

See Also:: Constant Field Values

LEFT_PAGES

public static final int LEFT_PAGES

Specifies that row headers are to be printed on the left page(s) only.

See Also:: Constant Field Values

ALL_PAGES

public static final int ALL_PAGES

Specifies that column or row headers are to be printed on all pages.

See Also:: Constant Field Values

Constructor Detail

J2TablePrinter

public J2TablePrinter()

Construct a JTablePageable object (no JTable specified)

J2TablePrinter

public J2TablePrinter(javax.swing.JTable table)

Construct a JTablePageable object for a given JTable

Method Detail

dispose

public void dispose()

Release all heap objects held by this J2TablePrinter object, must not call until printing completes.

Overrides:: dispose in class J2Pageable