ilog.views.util.print
Class IlvHeader

java.lang.Object
  ilog.views.util.print.IlvPrintableObject
      ilog.views.util.print.IlvHeaderFooter
          ilog.views.util.print.IlvHeader

All Implemented Interfaces:

Printable, Cloneable

public class IlvHeader
extends IlvHeaderFooter

This class defines a header to be printed at the top of a page. A header 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

See Also:

IlvFooter

Field Summary

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

AuthorKey, DateKey, FileKey, PageKey, PagesKey, TimeKey

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Constructor Summary

IlvHeader(String left, String center, String right)
Creates a header.

Method Summary

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

clone, equals, getCenterSection, getCenterSectionFont, getColor, getDefaultFont, getHeight, getLeftSection, getLeftSectionFont, getRightSection, getRightSectionFont, 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

IlvHeader

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

Creates a header.

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.