sos.preview
Class DefaultPageNumberRenderer

java.lang.Object
  |
  +--sos.preview.DefaultPageNumberRenderer

All Implemented Interfaces:

PageNumberRenderer, java.io.Serializable

public class DefaultPageNumberRenderer

extends java.lang.Object

implements PageNumberRenderer, java.io.Serializable

A page number renderer that centers page numbers with a JLabel initialized with the font and colors of the JPrintPreviewPane. This is the default page number renderer used by JPrintPreviewPane.

Programmers may subclass this class in order to alter the JLabel that renders the page numbers. To change the text, override pageNumberToString and define the mapping from page numbers to strings. To change the look of the label, override prepareLabel, call this class's prepareLabel to pick up the default behavior, and then alter the label as desired.

Since:

1.0

See Also:

PageNumberRenderer, JPrintPreviewPane

Constructor Summary

DefaultPageNumberRenderer()
Creates a new instance of DefaultPageNumberRenderer.

Method Summary

java.awt.Component	getPageNumberRendererComponent(JPrintPreviewPane printPreviewPane, int pageNumber, boolean isSelected, boolean pageHasFocus) Returns a graphical component that can render the page number within the specified print preview pane.
protected java.lang.String	pageNumberToString(int pageNumber) Converts the specified page number to a string.
protected void	prepareLabel(javax.swing.JLabel label, JPrintPreviewPane printPreviewPane, int pageNumber, boolean isSelected, boolean pageHasFocus) Prepares a label component before rendering a page number.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPageNumberRenderer

public DefaultPageNumberRenderer()

Creates a new instance of DefaultPageNumberRenderer.

Method Detail

getPageNumberRendererComponent

public java.awt.Component getPageNumberRendererComponent(JPrintPreviewPane printPreviewPane,
                                                         int pageNumber,
                                                         boolean isSelected,
                                                         boolean pageHasFocus)

Description copied from interface: PageNumberRenderer

Returns a graphical component that can render the page number within the specified print preview pane.

Specified by:

getPageNumberRendererComponent in interface PageNumberRenderer

Parameters:

printPreviewPane - print preview pane for which the page numbers will be rendererd

pageNumber - page number to render (starts at 1)

isSelected - true if the page corresponding to pageNumber is selected

pageHasFocus - true if the page corresponding to pageNumber has focus

Returns:

an AWT component that is prepared to paint the page number

pageNumberToString

protected java.lang.String pageNumberToString(int pageNumber)

Converts the specified page number to a string. This is a hook method. Subclasses may override this method to customize the conversion.

This implementation formats the page number using a locale-sensitive number formatter.

Parameters:

pageNumber - page number to convert to a string

Returns:

a string representation of the page number

prepareLabel

protected void prepareLabel(javax.swing.JLabel label,
                            JPrintPreviewPane printPreviewPane,
                            int pageNumber,
                            boolean isSelected,
                            boolean pageHasFocus)

Prepares a label component before rendering a page number. This is a hook method. Subclasses may override this method to customize the look of the label. Generally, subclasses should invoke this method first in order to start with the default preparation.

Parameters:

label - label component that will render the page number

printPreviewPane - print preview pane for which the page numbers will be rendererd

pageNumber - page number to render

isSelected - true if the page corresponding to pageNumber is selected

pageHasFocus - true if the page corresponding to pageNumber has focus