ilog.views.util.print

Class IlvFooter

java.lang.Object

ilog.views.util.print.IlvPrintableObject

ilog.views.util.print.IlvHeaderFooter

ilog.views.util.print.IlvFooter

All Implemented Interfaces:

Printable, Cloneable

public class IlvFooter
extends IlvHeaderFooter

This class defines a footer to be printed at the bottom of a page. A footer is defined by three text sections. The texts will be drawn on the left, center and right area of the footer. Each text can have several lines and may contain some predefined keys that will be translated to values of the document that is printed. For example, the following footer:

   new IlvFooter("Page " + IlvHeaderFooter.PageKey, null, null);
 

will print 'Page 1' on the left section of the first page.
Such keys exist for the page number, the number of pages in the book, the file name, the author, the date and time.

Since:

JViews 5.5

See Also:

IlvHeader

Field Summary

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Constructor Summary

Constructors

Constructor and Description
IlvFooter(String left, String center, String right) Creates a footer.
IlvFooter(String left, String center, String right, com.ibm.icu.util.ULocale locale) Creates a footer.

Method Summary

Methods inherited from class ilog.views.util.print.IlvHeaderFooter

clone, equals, getAuthorKey, getCenterSection, getCenterSectionFont, getColor, getDateKey, getDefaultFont, getFileKey, getHeight, getLeftSection, getLeftSectionFont, getPageKey, getPagesKey, getRightSection, getRightSectionFont, getTimeKey, print, setCenterSection, setCenterSectionFont, setColor, setLeftSection, setLeftSectionFont, setRightSection, setRightSectionFont, toString

Methods inherited from class ilog.views.util.print.IlvPrintableObject

getPage

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IlvFooter

public IlvFooter(String left,
                 String center,
                 String right)

Creates a footer.

Parameters:

left - The text to be printed on the left.

center - The text to be printed in the center.

right - The text to be printed on the right.

IlvFooter

public IlvFooter(String left,
                 String center,
                 String right,
                 com.ibm.icu.util.ULocale locale)

Creates a footer.

Parameters:

left - The text to be printed on the left.

center - The text to be printed in the center.

right - The text to be printed on the right.

locale - The locale to be used to format numbers and dates.

Since:

JViews 8.8