com.portal.common

Class PrintPreview

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.portal.common.PrintPreview

All Implemented Interfaces:

ImageObserver, MenuContainer, Printable, Serializable, Accessible

public class PrintPreview
extends JPanel
implements Printable

Presents the preview of the specified printable component.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

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

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

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

Constructors

Constructor and Description
PrintPreview(JComponent sub, HFPageFormat pf, int pi) Creates an object of print preview.

Method Summary

Modifier and Type	Method and Description
String	getDateAndTime() Retrieves the date and time of the current locale.
int	getFormattedTableHeight(HFPageFormat pf) Retrieves the formatted imageable height used for clipping tables that does not allow splitting of any row along the bottom margin of the imageable area.
void	paint(Graphics g) Overridden paint method that carries out the rendering of various graphics primitives including the component specified for printing.
int	print(Graphics g, PageFormat pf, int pageIndex) This method implements the Printable interface.
protected void	renderComponent(Graphics2D g2d, int scaledPageH, int UP_SHIFT, double scale) This method renders the specified widget of type JComponent Override this method for any customized rendering purpose.
protected void	renderDateAndTime(Graphics2D g, int imgX, int imgY, int imgW, int imgH, int pOffSet) This method renders the date and time
protected void	renderPageHeader(Graphics g) Draw the header of each page.
protected void	renderPageHeaderFooter(Graphics g) Draw the header of each page.
protected void	renderPageNumbers(Graphics g, int imgX, int imgY, int imgW, int imgH, int pOffSet) This method renders the page numbers.
protected void	renderTableHeader(Graphics2D g2, int imgX, int imgY, int imgW, int imgH) This method renders the header portion of a table widget.
void	setLeftHeaderText(String header) The header will be printed at north west corner of each page.
void	setRightHeaderText(String header) The header will be printed at north east corner of each page.
void	showDateAndTime(boolean b) Displays date and time on the printable page.
void	showPageNumbers(boolean b) Displays page numbers on the printable page.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, 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, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

PrintPreview

public PrintPreview(JComponent sub,
                    HFPageFormat pf,
                    int pi)

Creates an object of print preview.

Method Detail

setLeftHeaderText

public void setLeftHeaderText(String header)

The header will be printed at north west corner of each page. By default, the header will not be printed. Call setLeftHeaderText(null) to suppress the printing of the header.

Parameters:

header - the text to print.

setRightHeaderText

public void setRightHeaderText(String header)

The header will be printed at north east corner of each page. By default, the header will not be printed. Call setRightHeaderText(null) to suppress the printing of the header.

Parameters:

header - the text to print.

showDateAndTime

public void showDateAndTime(boolean b)

Displays date and time on the printable page.

showPageNumbers

public void showPageNumbers(boolean b)

Displays page numbers on the printable page.

getDateAndTime

public String getDateAndTime()

Retrieves the date and time of the current locale.

getFormattedTableHeight

public int getFormattedTableHeight(HFPageFormat pf)

Retrieves the formatted imageable height used for clipping tables that does not allow splitting of any row along the bottom margin of the imageable area. Used only by tables (not for other components!).

renderComponent

protected void renderComponent(Graphics2D g2d,
                               int scaledPageH,
                               int UP_SHIFT,
                               double scale)

This method renders the specified widget of type JComponent Override this method for any customized rendering purpose.

renderTableHeader

protected void renderTableHeader(Graphics2D g2,
                                 int imgX,
                                 int imgY,
                                 int imgW,
                                 int imgH)

This method renders the header portion of a table widget. Override this method for any customized rendering of the header.

renderDateAndTime

protected void renderDateAndTime(Graphics2D g,
                                 int imgX,
                                 int imgY,
                                 int imgW,
                                 int imgH,
                                 int pOffSet)

This method renders the date and time

renderPageNumbers

protected void renderPageNumbers(Graphics g,
                                 int imgX,
                                 int imgY,
                                 int imgW,
                                 int imgH,
                                 int pOffSet)

This method renders the page numbers.

renderPageHeader

protected void renderPageHeader(Graphics g)

Draw the header of each page.

Parameters:

g - the Graphics.

renderPageHeaderFooter

protected void renderPageHeaderFooter(Graphics g)

Draw the header of each page.

Parameters:

g - the Graphics.

paint

public void paint(Graphics g)

Overridden paint method that carries out the rendering of various graphics primitives including the component specified for printing.

Overrides:

paint in class JComponent

print

public int print(Graphics g,
                 PageFormat pf,
                 int pageIndex)
          throws PrinterException

This method implements the Printable interface. Used exclusively for printing.

Specified by:

print in interface Printable

Throws:

PrinterException