ilog.views.util.print

Class IlvHeaderFooter

java.lang.Object

ilog.views.util.print.IlvPrintableObject

ilog.views.util.print.IlvHeaderFooter

All Implemented Interfaces:

Printable, Cloneable

Direct Known Subclasses:

IlvFooter, IlvHeader

public abstract class IlvHeaderFooter
extends IlvPrintableObject
implements Cloneable

The abstract base class for headers or footers. A header or footer is defined by three text sections. The texts will be drawn on the left, center and right area of the header. 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 header:

   new IlvHeader("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

Field Summary

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Constructor Summary

Constructors

Constructor and Description
IlvHeaderFooter(String left, String center, String right) Creates a Header or a Footer.
IlvHeaderFooter(String left, String center, String right, ULocale locale) Creates a Header or a Footer.

Method Summary

Modifier and Type	Method and Description
Object	clone() Clones the object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
static String	getAuthorKey() Returns the key for the author.
String	getCenterSection() Returns the center section of the header or footer.
Font	getCenterSectionFont() Returns the font used to print the center section.
Color	getColor() Returns the color used to print the header.
static String	getDateKey() Returns the key for the date.
static Font	getDefaultFont() Returns the default font used when creating a header or a footer.
static String	getFileKey() Returns the key for the file name.
double	getHeight() Returns the height of the header or footer.
String	getLeftSection() Returns the left section of the header or footer.
Font	getLeftSectionFont() Returns the font used to print the left section.
static String	getPageKey() Returns the key for the page number.
static String	getPagesKey() Returns the key for the number of pages in the book.
String	getRightSection() Returns the right section of the header or footer.
Font	getRightSectionFont() Returns the font used to print the right section.
static String	getTimeKey() Returns the key for the time.
int	print(Graphics dst, PageFormat format, int pageIndex) Prints the header or footer.
void	setCenterSection(String centerSection) Changes the center section of the header or footer.
void	setCenterSectionFont(Font font) Changes the font used to print the center section.
void	setColor(Color color) Changes the color used to print the header.
void	setLeftSection(String leftSection) Changes the left section of the header or footer.
void	setLeftSectionFont(Font font) Changes the font used to print the left section.
void	setRightSection(String rightSection) Changes the right section of the header or footer.
void	setRightSectionFont(Font font) Changes the font used to print the right section.
String	toString() Returns a string representation of this object.

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

IlvHeaderFooter

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

Creates a Header or 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.

IlvHeaderFooter

public IlvHeaderFooter(String left,
                       String center,
                       String right,
                       ULocale locale)

Creates a Header or 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

Method Detail

getPageKey

public static final String getPageKey()

Returns the key for the page number.

Since:

JViews 8.7

getPagesKey

public static final String getPagesKey()

Returns the key for the number of pages in the book.

Since:

JViews 8.7

getTimeKey

public static final String getTimeKey()

Returns the key for the time.

Since:

JViews 8.7

getDateKey

public static final String getDateKey()

Returns the key for the date.

Since:

JViews 8.7

See Also:

IlvPrintableDocument.setDate(java.util.Date)

getAuthorKey

public static final String getAuthorKey()

Returns the key for the author.

Since:

JViews 8.7

See Also:

IlvPrintableDocument.setAuthor(java.lang.String)

getFileKey

public static final String getFileKey()

Returns the key for the file name.

Since:

JViews 8.7

See Also:

IlvPrintableDocument.setName(java.lang.String)

getLeftSection

public String getLeftSection()

Returns the left section of the header or footer.

See Also:

setLeftSection(java.lang.String)

setLeftSection

public void setLeftSection(String leftSection)

Changes the left section of the header or footer.

See Also:

getLeftSection()

getCenterSection

public String getCenterSection()

Returns the center section of the header or footer.

See Also:

setCenterSection(java.lang.String)

setCenterSection

public void setCenterSection(String centerSection)

Changes the center section of the header or footer.

See Also:

getCenterSection()

getRightSection

public String getRightSection()

Returns the right section of the header or footer.

See Also:

setRightSection(java.lang.String)

setRightSection

public void setRightSection(String rightSection)

Changes the right section of the header or footer.

See Also:

getRightSection()

setColor

public void setColor(Color color)

Changes the color used to print the header.

See Also:

getColor()

getColor

public Color getColor()

Returns the color used to print the header.

See Also:

setColor(java.awt.Color)

getDefaultFont

public static Font getDefaultFont()

Returns the default font used when creating a header or a footer.

setLeftSectionFont

public void setLeftSectionFont(Font font)

Changes the font used to print the left section.

See Also:

getLeftSectionFont()

getLeftSectionFont

public Font getLeftSectionFont()

Returns the font used to print the left section.

See Also:

setLeftSectionFont(java.awt.Font)

setRightSectionFont

public void setRightSectionFont(Font font)

Changes the font used to print the right section.

See Also:

getRightSectionFont()

getRightSectionFont

public Font getRightSectionFont()

Returns the font used to print the right section.

See Also:

setRightSectionFont(java.awt.Font)

setCenterSectionFont

public void setCenterSectionFont(Font font)

Changes the font used to print the center section.

See Also:

getCenterSectionFont()

getCenterSectionFont

public Font getCenterSectionFont()

Returns the font used to print the center section.

See Also:

setCenterSectionFont(java.awt.Font)

getHeight

public double getHeight()

Returns the height of the header or footer.

print

public int print(Graphics dst,
                 PageFormat format,
                 int pageIndex)
          throws PrinterException

Prints the header or footer.

Specified by:

print in interface Printable

Throws:

PrinterException

equals

public boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class Object

toString

public String toString()

Returns a string representation of this object.

Overrides:

toString in class Object

clone

public Object clone()

Clones the object.

Overrides:

clone in class Object