sos.preview
Interface PageNumberRenderer

All Known Implementing Classes:

DefaultPageNumberRenderer

public interface PageNumberRenderer

An interface that returns a component that can render the page numbers within a JPrintPreviewPane.

Note that this interface deals with page numbers, which start with 1, rather than page indices, which start with 0.

Since:

1.0

See Also:

JPrintPreviewPane, 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.

Method Detail

getPageNumberRendererComponent

public 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.

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