oracle.dss.dataView

Interface CustomHeaderAndFooterCallback

public interface CustomHeaderAndFooterCallback

Method that you must implement if you provide a custom callback for headers and footers. By default, view printers print the same header and footer content on all printed pages of a view. (Of course, page numbers automatically change, if you specify the display of page numbers in a header or footer.) If you want to display different content on different pages of a printout, then you must implement this interface.

To register your implementation of this interface, you call the setCustomHeaderAndFooterCallback method of the view printer. To specify the headers and footers for which the callback provides content, you call the setHeadersAndFootersUsingCallback method of the view printer.

If you want only to specify the content of the headers and footers, and you want the content to be the same on all physical pages, then you do not need to implement this interface. Instead, you get the appropriate HeaderAndFooterPainter from the view printer, and you set properties on the HeaderAndFooterPainter.

See Also:

ViewPrinter.setCustomHeaderAndFooterCallback(oracle.dss.dataView.CustomHeaderAndFooterCallback), ViewPrinter.setHeadersAndFootersUsingCallback(int), ViewPrinter.getHeaderAndFooterPainter(int)

Method Summary

Modifier and Type	Method and Description
java.lang.Object[]	getDynamicContent(int headerOrFooterID, java.lang.Object[] currentContent, int physPageNum, int[] hPos) Specifies the content for the header or footer.

Method Detail

getDynamicContent

java.lang.Object[] getDynamicContent(int headerOrFooterID,
                                     java.lang.Object[] currentContent,
                                     int physPageNum,
                                     int[] hPos)

Specifies the content for the header or footer. This method is called for each header and footer that uses this custom callback.

Parameters:

headerOrFooterID - A constant that identifies the header or footer.

physPageNum - The number of the physical page that is being printed.

hPos - The current logical page that is being printed.

Returns:

The content that the view printer should print in the header or footer. The view printer prints the array as returned. If, for example, you return an array that has an empty element, that element appears as a blank line in the header or footer.

See Also:

ViewPrinter.HEADER_LEFT, ViewPrinter.HEADER_CENTER, ViewPrinter.HEADER_RIGHT, ViewPrinter.FOOTER_LEFT, ViewPrinter.FOOTER_CENTER, ViewPrinter.FOOTER_RIGHT