sos.reports
Interface JReportPane.HeaderFooterFactory

Enclosing interface:

JReportPane

public static interface JReportPane.HeaderFooterFactory

An object that specifies page headers and footers.

Since:

1.0

See Also:

JReportPane.getPageable(PageFormat,JReportPane.HeaderFooterFactory,Component,Component)

Method Summary

java.awt.Component	getFooterComponent(java.awt.print.Pageable pageable, int pageIndex) Returns the footer component for the specified page.
java.awt.Component	getHeaderComponent(java.awt.print.Pageable pageable, int pageIndex) Returns the header component for the specified page.
java.awt.Component	getPrototypeFooterComponent() Returns a prototypical sample footer component.
java.awt.Component	getPrototypeHeaderComponent() Returns a prototypical sample header component.

Method Detail

getHeaderComponent

public java.awt.Component getHeaderComponent(java.awt.print.Pageable pageable,
                                             int pageIndex)

Returns the header component for the specified page.

The returned component should implement setBounds, validate, and paint.

Parameters:

pageable - the paged report doing the rendering

pageIndex - the index of the page (starting at 0) for which the header is requested

Returns:

a component that will render the header for page pageIndex

getFooterComponent

public java.awt.Component getFooterComponent(java.awt.print.Pageable pageable,
                                             int pageIndex)

Returns the footer component for the specified page.

The returned component should implement setBounds, validate, and paint.

Parameters:

pageable - the paged report doing the rendering

pageIndex - the index of the page (starting at 0) for which the footer is requested

Returns:

a component that will render the footer for page pageIndex

getPrototypeHeaderComponent

public java.awt.Component getPrototypeHeaderComponent()

Returns a prototypical sample header component. This component should implement getPreferredSize.

Returns:

a sample header

getPrototypeFooterComponent

public java.awt.Component getPrototypeFooterComponent()

Returns a prototypical sample footer component. This component should implement getPreferredSize.

Returns:

a sample footer