Side of Software
Print Preview Library 1.8.1

sos.preview
Class JPrintPreviewPage

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--sos.preview.JPrintPreviewPage
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, Scaleable, java.io.Serializable

public class JPrintPreviewPage
extends javax.swing.JComponent
implements javax.accessibility.Accessible, Scaleable

A component that represents a page in a print preview pane.

Since:
1.0
See Also:
JPrintPreviewPane

Nested Class Summary
protected  class JPrintPreviewPage.AccessibleJPrintPreviewPage
          A class that implements accessibility support for a JPrintPreviewPage.
 
Field Summary
 
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
JPrintPreviewPage(JPrintPreviewPane printPreviewPane, java.awt.print.Printable printable, java.awt.print.PageFormat pageFormat, int pageIndex)
          Creates a JPrintPreviewPage for the specified print preview pane, printable page contents, and page format, and page index.
 
Method Summary
 javax.accessibility.AccessibleContext getAccessibleContext()
          Gets the AccessibleContext associated with this JPrintPreviewPage.
 double getFixedHeight()
          Returns the height of the fixed portion of this object.
 double getFixedWidth()
          Returns the width of the fixed portion of this object.
 JPrintPreviewPane getJPrintPreviewPane()
          Returns the print preview pane for which this page is associated.
 java.awt.print.PageFormat getPageFormat()
          Returns the page format of this page.
 int getPageIndex()
          Returns the index of this page with respect to all pages in the print preview pane.
 java.awt.print.Printable getPrintable()
          Returns the object that renders the contents of this page.
 java.awt.Dimension getScaleablePreferredSize()
          Returns the preferred size of the scaleable portion of this object.
 PrintPreviewPageUI getUI()
          Returns the look and feel delegate that renders this object.
 java.lang.String getUIClassID()
          Returns the UIDefaults key used to look up the name of the swing.plaf.ComponentUI class that defines the look and feel for this component.
 void setUI(PrintPreviewPageUI newUI)
          Sets the look and feel delegate for this print preview page.
 void updateUI()
          Resets the UI property with the 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, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, 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
 
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, 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
 

Constructor Detail

JPrintPreviewPage

public JPrintPreviewPage(JPrintPreviewPane printPreviewPane,
                         java.awt.print.Printable printable,
                         java.awt.print.PageFormat pageFormat,
                         int pageIndex)
                  throws java.lang.NullPointerException,
                         java.lang.IllegalArgumentException
Creates a JPrintPreviewPage for the specified print preview pane, printable page contents, and page format, and page index.

Parameters:
printPreviewPane - print preview pane for which this page is a member
printable - object that can render the contents of the page
pageFormat - page size, layout, and margins of this page
pageIndex - index of this page with respect to all pages in the print preview pane
Throws:
java.lang.IllegalArgumentException - if pageIndex < 0
java.lang.NullPointerException - if printPreviewPane, printable, or pageFormat is null
Method Detail

getAccessibleContext

public javax.accessibility.AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this JPrintPreviewPage.

Specified by:
getAccessibleContext in interface javax.accessibility.Accessible
Overrides:
getAccessibleContext in class javax.swing.JComponent
Returns:
the AccessibleContext associated with this JPrintPreviewPage

getFixedHeight

public double getFixedHeight()
Description copied from interface: Scaleable
Returns the height of the fixed portion of this object.

Specified by:
getFixedHeight in interface Scaleable
Returns:
the height of the portion that does not scale

getFixedWidth

public double getFixedWidth()
Description copied from interface: Scaleable
Returns the width of the fixed portion of this object.

Specified by:
getFixedWidth in interface Scaleable
Returns:
the width of the portion that does not scale

getJPrintPreviewPane

public JPrintPreviewPane getJPrintPreviewPane()
Returns the print preview pane for which this page is associated.

Returns:
this page's print preview pane

getPageFormat

public java.awt.print.PageFormat getPageFormat()
Returns the page format of this page.

Returns:
this page's page format

getPrintable

public java.awt.print.Printable getPrintable()
Returns the object that renders the contents of this page.

Returns:
the object that renders the contents of this page

getPageIndex

public int getPageIndex()
Returns the index of this page with respect to all pages in the print preview pane.

Returns:
the index of this page

getScaleablePreferredSize

public java.awt.Dimension getScaleablePreferredSize()
Description copied from interface: Scaleable
Returns the preferred size of the scaleable portion of this object.

Specified by:
getScaleablePreferredSize in interface Scaleable
Returns:
the preferred size of the scaleable portion of this object

getUI

public PrintPreviewPageUI getUI()
Returns the look and feel delegate that renders this object.

Returns:
the UI for this print preview page

getUIClassID

public java.lang.String getUIClassID()
Returns the UIDefaults key used to look up the name of the swing.plaf.ComponentUI class that defines the look and feel for this component.

Overrides:
getUIClassID in class javax.swing.JComponent
Returns:
the UIDefaults key for a ComponentUI subclass

setUI

public void setUI(PrintPreviewPageUI newUI)
Sets the look and feel delegate for this print preview page.

Parameters:
newUI - the new UI delegate

updateUI

public void updateUI()
Resets the UI property with the value from the current look and feel.

Overrides:
updateUI in class javax.swing.JComponent

Side of Software
Print Preview Library 1.8.1

Copyright 2003-07 Side of Software (SOS). All rights reserved.