Search this API

y.view
Class PrintPreviewPanel

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by y.view.PrintPreviewPanel
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class PrintPreviewPanel
extends javax.swing.JPanel

A generic print preview panel that can be used to preview printing results. To preview printed diagrams, this class is most effectively used in conjunction with the Printable implementation Graph2DPrinter.

Due to legacy reasons, the preview's Format and Print actions are executed in background threads. It is strongly recommended to use the current thread (which should be the Swing event dispatch thread) instead. This can be achieved by setting the preview's threadingEnabled property to false.

See Also:
isThreadingEnabled(), setThreadingEnabled(boolean), Serialized Form
 

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
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
static java.lang.String PAGE_FORMAT_ACTION
          Constant passed to initAction(javax.swing.Action, String) for I18n.
static java.lang.String PRINT_ACTION
          Constant passed to initAction(javax.swing.Action, String) for I18n.
static java.lang.String ZOOM_IN_ACTION
          Constant passed to initAction(javax.swing.Action, String) for I18n.
static java.lang.String ZOOM_OUT_ACTION
          Constant passed to initAction(javax.swing.Action, String) for I18n.
static java.lang.String ZOOM_TO_FIT
          Constant passed to getString(String) for I18n.
static java.lang.String ZOOM_TO_FIT_WIDTH
          Constant passed to getString(String) for I18n.
 
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
PrintPreviewPanel(java.awt.print.PrinterJob pj, java.awt.print.Printable p, int columns, int maxPages, java.awt.print.PageFormat pf)
          Creates a new instance of PrintPreviewPanel
 
Method Summary
 void addControlComponent(javax.swing.JComponent comp)
          Adds a new control component to the toolbar of this preview panel.
 java.awt.print.PageFormat getPageFormat()
          Returns the currently used PageFormat
protected  java.lang.String getString(java.lang.String s)
          Internationalization method, that translates the given string according to the currently set locale.
protected  void initAction(javax.swing.Action action, java.lang.String type)
          Initializes an action that gets triggered by one of the predefined control components.
 boolean isThreadingEnabled()
          Determines whether or not the preview panel opens the printer page dialog and prints the graph in a background thread.
 void setPageFormat(java.awt.print.PageFormat newFormat)
          Sets the new PageFormat to be used in the Preview
 void setPages(int offset, int columns, int maxPages)
          Specifies the range of pages to be previewed and the number of pages per row to be displayed.
 void setThreadingEnabled(boolean enabled)
          Specifies whether or not the preview panel opens the printer page dialog and prints the graph in a background thread.
 void zoomToFit()
          Zooms the document to make it fit the preview panel.
 void zoomToFitWidth()
          Zooms the document to make its width fit the preview panel.
 
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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, 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, 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, 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, hide, 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, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ZOOM_TO_FIT

public static final java.lang.String ZOOM_TO_FIT
Constant passed to getString(String) for I18n.

See Also:
Constant Field Values

ZOOM_TO_FIT_WIDTH

public static final java.lang.String ZOOM_TO_FIT_WIDTH
Constant passed to getString(String) for I18n.

See Also:
Constant Field Values

PAGE_FORMAT_ACTION

public static final java.lang.String PAGE_FORMAT_ACTION
Constant passed to initAction(javax.swing.Action, String) for I18n.

See Also:
Constant Field Values

PRINT_ACTION

public static final java.lang.String PRINT_ACTION
Constant passed to initAction(javax.swing.Action, String) for I18n.

See Also:
Constant Field Values

ZOOM_IN_ACTION

public static final java.lang.String ZOOM_IN_ACTION
Constant passed to initAction(javax.swing.Action, String) for I18n.

See Also:
Constant Field Values

ZOOM_OUT_ACTION

public static final java.lang.String ZOOM_OUT_ACTION
Constant passed to initAction(javax.swing.Action, String) for I18n.

See Also:
Constant Field Values
Constructor Detail

PrintPreviewPanel

public PrintPreviewPanel(java.awt.print.PrinterJob pj,
                         java.awt.print.Printable p,
                         int columns,
                         int maxPages,
                         java.awt.print.PageFormat pf)
Creates a new instance of PrintPreviewPanel

Parameters:
pj - the printer job to be used for printing
p - printable to be printed
columns - number of columns to display per row
maxPages - maximum number of pages to be displayed
pf - default page format to be used
Method Detail

isThreadingEnabled

public boolean isThreadingEnabled()
Determines whether or not the preview panel opens the printer page dialog and prints the graph in a background thread.

Threading is enabled by default for backwards compatibility.
However, It is strongly recommended to disable threading and have the the preview panel open the printer page dialog and print the graph in the thread (which should be the Swing event dispatch thread).

Returns:
true if a background thread is used; false otherwise.
See Also:
setThreadingEnabled(boolean)

setThreadingEnabled

public void setThreadingEnabled(boolean enabled)
Specifies whether or not the preview panel opens the printer page dialog and prints the graph in a background thread.

Threading is enabled by default for backwards compatibility.
However, It is strongly recommended to disable threading and have the the preview panel open the printer page dialog and print the graph in the thread (which should be the Swing event dispatch thread).

Parameters:
enabled - if true a background thread is used.

getPageFormat

public java.awt.print.PageFormat getPageFormat()
Returns the currently used PageFormat


setPageFormat

public void setPageFormat(java.awt.print.PageFormat newFormat)
Sets the new PageFormat to be used in the Preview


getString

protected java.lang.String getString(java.lang.String s)
Internationalization method, that translates the given string according to the currently set locale.

Returns:
the localized string

setPages

public void setPages(int offset,
                     int columns,
                     int maxPages)
Specifies the range of pages to be previewed and the number of pages per row to be displayed.

Parameters:
offset - number of the first page to be previewed
columns - number of pages per row to be displayed.
maxPages - maximum number of pages to displayed.

zoomToFit

public void zoomToFit()
Zooms the document to make it fit the preview panel.


zoomToFitWidth

public void zoomToFitWidth()
Zooms the document to make its width fit the preview panel.


addControlComponent

public void addControlComponent(javax.swing.JComponent comp)
Adds a new control component to the toolbar of this preview panel.


initAction

protected void initAction(javax.swing.Action action,
                          java.lang.String type)
Initializes an action that gets triggered by one of the predefined control components.

Parameters:
type - action specifier. One of the predefined constants PAGE_FORMAT_ACTION, PRINT_ACTION, ZOOM_IN_ACTION and ZOOM_OUT_ACTION.

© Copyright 2000-2021,
yWorks GmbH.
All rights reserved.