com.zfqjava.swing
Class JPrintPreview

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--com.zfqjava.swing.JPrintPreview

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class JPrintPreview

extends javax.swing.JComponent

implements javax.accessibility.Accessible

JPrintPreview provides a print preview component.

Client Property:

Name	Value	Default Value
JPrintPreview.pageViewMode	SinglePage ContinuousPage	SinglePage

See Also:

Serialized Form

Inner Class Summary

protected class

JPrintPreview.AccessibleJPrintPreview This class implements accessibility support for the JPrintPreview class.

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Inner classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Inner classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent

Field Summary

static int	CLOSE_CONTROL Type used for close button on the pane.
static int	HELP_CONTROL Type used for help button on the pane.
static int	PAGE_SETUP_CONTROL Type used for page setup button on the pane.
static int	PRINT_CONTROL Type used for print button on the pane.

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

JPrintPreview()
Constructs a print preview component.

JPrintPreview(java.lang.Object printData)
Constructs a print preview component with the print data for preview.

Method Summary

void	close() Called by JPrintPreview when the user hits the Close button.
protected javax.swing.JDialog	createDialog(java.awt.Component parent, java.lang.String title) Creates a dialog for the JPrintPreview.
protected javax.swing.JFrame	createFrame(java.lang.String title) Creates a frame for the JPrintPreview.
javax.accessibility.AccessibleContext	getAccessibleContext() Gets the AccessibleContext associated with this JPrintPreview.
javax.swing.JButton	getControlButton(int controlType) Gets the control button of the type.
int	getPageCount() Returns the page count.
java.awt.print.PageFormat	getPageFormat() Returns the page format object current set.
int	getPageHeight(int index) Returns the page height.
java.awt.image.BufferedImage	getPageImage(int index) Returns the page image used for preview.
int	getPageIndex() Returns the current page index.
int	getPageWidth(int index) Returns the page width.
java.lang.Object	getPrintData() Returns the print data for current preview.
PrintPreviewUI	getUI() Returns the look and feel (L&F) object that renders this component.
java.lang.String	getUIClassID() Returns a string that specifies the name of the L&F class that renders this component.
double	getZoomFactor() Returns the current zoom factor.
void	help() Called by JPrintPreview when the user hits the Help button.
void	pageSetup() Called by JPrintPreview when the user hits the Page Setup button.
protected java.lang.String	paramString() Returns a string representation of this JPrintPreview.
void	print() Called by JPrintPreview when the user hits the Print button.
void	setPageFormat(java.awt.print.PageFormat pageFormat) Sets the page format for current preview.
void	setPageIndex(int pageIndex) Sets the page index to view.
void	setPrintData(java.lang.Object printData) Sets the print data for preview.
void	setUI(PrintPreviewUI ui) Sets the look and feel (L&F) object that renders this component.
void	setZoomFactor(double zoomFactor) Sets the zoom factor for view.
void	showDialog(java.awt.Component parent) Pops up a dialog contains the JPrintPreview with the dialog having a default title.
void	showDialog(java.awt.Component parent, java.lang.String title) Pops up a dialog contains the JPrintPreview and with the dialog having a title title.
void	showFrame() Pops up a frame contains the JPrintPreview with the frame having a default title.
void	showFrame(java.lang.String title) Pops up a frame contains the JPrintPreview and with the frame having a title title.
void	updateUI() Resets the UI property with a value from the current look and feel.

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, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

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

Field Detail

PRINT_CONTROL

public static final int PRINT_CONTROL

Type used for print button on the pane.

PAGE_SETUP_CONTROL

public static final int PAGE_SETUP_CONTROL

Type used for page setup button on the pane.

HELP_CONTROL

public static final int HELP_CONTROL

Type used for help button on the pane.

CLOSE_CONTROL

public static final int CLOSE_CONTROL

Type used for close button on the pane.

Constructor Detail

JPrintPreview

public JPrintPreview()

Constructs a print preview component.

JPrintPreview

public JPrintPreview(java.lang.Object printData)

Constructs a print preview component with the print data for preview.

Method Detail

updateUI

public void updateUI()

Resets the UI property with a value from the current look and feel.

Overrides:

updateUI in class javax.swing.JComponent

See Also:

JComponent.updateUI()

getUI

public PrintPreviewUI getUI()

Returns the look and feel (L&F) object that renders this component.

Returns:

the PrintPreviewUI object that renders this component

setUI

public void setUI(PrintPreviewUI ui)

Sets the look and feel (L&F) object that renders this component.

Parameters:

ui - the PrintPreviewUI L&F object

See Also:

UIDefaults.getUI(javax.swing.JComponent)

getUIClassID

public java.lang.String getUIClassID()

Returns a string that specifies the name of the L&F class that renders this component.

Overrides:

getUIClassID in class javax.swing.JComponent

Returns:

"PrintPreviewUI"

See Also:

JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

setPrintData

public void setPrintData(java.lang.Object printData)

Sets the print data for preview. Following type current support:

• java.awt.print.Printable
• java.awt.print.Pageable

Parameters:

printData - the print data for preview

See Also:

getPrintData()

getPrintData

public java.lang.Object getPrintData()

Returns the print data for current preview. Following type current support:

• java.awt.print.Printable
• java.awt.print.Pageable

Returns:

the print data for current preview

See Also:

setPrintData(java.lang.Object)

setPageFormat

public void setPageFormat(java.awt.print.PageFormat pageFormat)

Sets the page format for current preview. Apply the following rules: If the print data is java.awt.print.Printable or java.awt.print.Pageable, and the page format is not null, all print method in Printable pass this parameter. If the page format is null, use print data page format object, if the page format for that object is null, use the default page format object gets from default print job object.

Parameters:

pageFormat - the page format object

See Also:

getPageFormat()

getPageFormat

public java.awt.print.PageFormat getPageFormat()

Returns the page format object current set. Default is null.

Returns:

the page format object current set

See Also:

setPageFormat(java.awt.print.PageFormat)

setPageIndex

public void setPageIndex(int pageIndex)

Sets the page index to view.

Parameters:

pageIndex - the page index

See Also:

getPageIndex()

getPageIndex

public int getPageIndex()

Returns the current page index.

Returns:

the current page index

See Also:

setPageIndex(int)

getPageCount

public int getPageCount()

Returns the page count.

Returns:

the page count

getPageImage

public java.awt.image.BufferedImage getPageImage(int index)

Returns the page image used for preview.

Parameters:

index - the page index

Returns:

the page image for preview

getPageWidth

public int getPageWidth(int index)

Returns the page width. Sets the zoom factor will change the page width.

Parameters:

index - the page index

Returns:

the page width

getPageHeight

public int getPageHeight(int index)

Returns the page height. Sets the zoom factor will change the page height.

Parameters:

index - the page index

Returns:

the page height

setZoomFactor

public void setZoomFactor(double zoomFactor)

Sets the zoom factor for view.

Parameters:

zoomFactor - the zoom factor

Throws:

IllegalAugumentException - if zoomFactor <= 0

See Also:

getZoomFactor()

getZoomFactor

public double getZoomFactor()

Returns the current zoom factor.

Returns:

the current zoom factor

See Also:

setZoomFactor(double)

showDialog

public void showDialog(java.awt.Component parent)

Pops up a dialog contains the JPrintPreview with the dialog having a default title.

showDialog

public void showDialog(java.awt.Component parent,
                       java.lang.String title)

Pops up a dialog contains the JPrintPreview and with the dialog having a title title.

Parameters:

title - the title of the dialog

createDialog

protected javax.swing.JDialog createDialog(java.awt.Component parent,
                                           java.lang.String title)

Creates a dialog for the JPrintPreview.

Parameters:

parent - the parent of the dialog

title - the title of the dialog

See Also:

showDialog(Component,String), showDialog(Component)

showFrame

public void showFrame()

Pops up a frame contains the JPrintPreview with the frame having a default title.

Since:

JDataGrid 1.2

See Also:

showDialog(Component), showDialog(Component,String), showFrame(String)

showFrame

public void showFrame(java.lang.String title)

Pops up a frame contains the JPrintPreview and with the frame having a title title.

Parameters:

title - the title of the frame

Since:

JDataGrid 1.2

See Also:

showDialog(Component), showDialog(Component,String), showFrame()

createFrame

protected javax.swing.JFrame createFrame(java.lang.String title)

Creates a frame for the JPrintPreview.

Parameters:

title - the title of the frame

Since:

JDataGrid 1.2

See Also:

showFrame(), showFrame(String)

getControlButton

public javax.swing.JButton getControlButton(int controlType)

Gets the control button of the type.

Parameters:

controlType - the type of the button to be selected:

• JPrintPreview.PRINT_CONTROL
• JPrintPreview.PAGE_SETUP_CONTROL
• JPrintPreview.HELP_CONTROL
• JPrintPreview.CLOSE_CONTROL

Returns:

the button for the specify type

print

public void print()

Called by JPrintPreview when the user hits the Print button. This can also be called by the programmer.

pageSetup

public void pageSetup()

Called by JPrintPreview when the user hits the Page Setup button. This can also be called by the programmer.

help

public void help()

Called by JPrintPreview when the user hits the Help button. This can also be called by the programmer.

close

public void close()

Called by JPrintPreview when the user hits the Close button. This can also be called by the programmer.

paramString

protected java.lang.String paramString()

Returns a string representation of this JPrintPreview. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Overrides:

paramString in class javax.swing.JComponent

Returns:

a string representation of this JPrintPreview.

getAccessibleContext

public javax.accessibility.AccessibleContext getAccessibleContext()

Gets the AccessibleContext associated with this JPrintPreview. For JPrintPreviews, the AccessibleContext takes the form of an AccessibleJPrintPreview. A new AccessibleJPrintPreview instance is created if necessary.

Specified by:

getAccessibleContext in interface javax.accessibility.Accessible

Overrides:

getAccessibleContext in class javax.swing.JComponent

Returns:

an AccessibleJPrintPreview that serves as the AccessibleContext of this JPrintPreview