com.lowagie.text.rtf
Class RtfHeaderFooters

java.lang.Object
  extended bycom.lowagie.text.Rectangle
      extended bycom.lowagie.text.HeaderFooter
          extended bycom.lowagie.text.rtf.RtfHeaderFooters
All Implemented Interfaces:
Element, MarkupAttributes

public class RtfHeaderFooters
extends HeaderFooter

This HeaderFooter specialization contains some headers or footers for several pages. Is a list of headerFooters but also a sub class of header footer, to change as less as possible of the current API. ONLY FOR USE WITH THE RtfWriter NOT with the RtfWriter2. This class is based on the RtfWriter-package from Mark Hall.

Version:
$Revision: 1.20 $Date: 2004/12/14 15:14:44 $
Author:
Steffen.Stundzig@smb-tec.com, Mark.Hall@myrealbox.com

Field Summary
static int ALL_PAGES
          an attribute value
private  HeaderFooter allPages
          header or footer placeholder
static int FIRST_PAGE
          an attribute value
private  HeaderFooter firstPage
          header or footer placeholder
static int LEFT_PAGES
          an attribute value
private  HeaderFooter leftPages
          header or footer placeholder
static int RIGHT_PAGES
          an attribute value
private  HeaderFooter rightPages
          header or footer placeholder
 
Fields inherited from class com.lowagie.text.HeaderFooter
 
Fields inherited from class com.lowagie.text.Rectangle
background, border, borderColorBottom, borderColorLeft, borderColorRight, borderColorTop, borderWidth, borderWidthBottom, borderWidthLeft, borderWidthRight, borderWidthTop, BOTTOM, BOX, color, grayFill, LEFT, llx, lly, markupAttributes, NO_BORDER, RIGHT, rotation, TOP, UNDEFINED, urx, ury, useVariableBorders
 
Fields inherited from interface com.lowagie.text.Element
ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_JUSTIFIED_ALL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, ANCHOR, ANNOTATION, AUTHOR, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CELL, CHAPTER, CHUNK, CREATIONDATE, CREATOR, GRAPHIC, HEADER, IMGRAW, IMGTEMPLATE, JPEG, KEYWORDS, LIST, LISTITEM, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE
 
Constructor Summary
RtfHeaderFooters()
          Contructs a HeaderFooters object
RtfHeaderFooters(Phrase before, boolean numbered)
          Contructs a HeaderFooters object
RtfHeaderFooters(Phrase before, Phrase after)
          Contructs a HeaderFooters object
 
Method Summary
 HeaderFooter get(int type)
          Returns a type of HeaderFooter object registered in this HeaderFooters object.
 void set(int type, HeaderFooter hf)
          Adds a HeaderFooter to this HeaderFooters object
 
Methods inherited from class com.lowagie.text.HeaderFooter
alignment, getAfter, getBefore, isNumbered, paragraph, setAlignment, setPageNumber
 
Methods inherited from class com.lowagie.text.Rectangle
backgroundColor, border, borderColor, borderWidth, bottom, bottom, cloneNonPositionParameters, disableBorderSide, enableBorderSide, getBorderColorBottom, getBorderColorLeft, getBorderColorRight, getBorderColorTop, getBorderWidthBottom, getBorderWidthLeft, getBorderWidthRight, getBorderWidthTop, getChunks, getMarkupAttribute, getMarkupAttributeNames, getMarkupAttributes, getRotation, grayFill, hasBorder, hasBorders, height, isUseVariableBorders, left, left, normalize, process, rectangle, right, right, rotate, setBackgroundColor, setBorder, setBorderColor, setBorderColorBottom, setBorderColorLeft, setBorderColorRight, setBorderColorTop, setBorderWidth, setBorderWidthBottom, setBorderWidthLeft, setBorderWidthRight, setBorderWidthTop, setBottom, setGrayFill, setLeft, setMarkupAttribute, setMarkupAttributes, setRight, setTop, setUseVariableBorders, top, top, type, width
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.lowagie.text.MarkupAttributes
getMarkupAttribute, getMarkupAttributeNames, getMarkupAttributes, setMarkupAttribute, setMarkupAttributes
 
Methods inherited from interface com.lowagie.text.Element
getChunks, process, toString, type
 

Field Detail

ALL_PAGES

public static final int ALL_PAGES
an attribute value

See Also:
Constant Field Values

LEFT_PAGES

public static final int LEFT_PAGES
an attribute value

See Also:
Constant Field Values

RIGHT_PAGES

public static final int RIGHT_PAGES
an attribute value

See Also:
Constant Field Values

FIRST_PAGE

public static final int FIRST_PAGE
an attribute value

See Also:
Constant Field Values

allPages

private HeaderFooter allPages
header or footer placeholder


leftPages

private HeaderFooter leftPages
header or footer placeholder


rightPages

private HeaderFooter rightPages
header or footer placeholder


firstPage

private HeaderFooter firstPage
header or footer placeholder

Constructor Detail

RtfHeaderFooters

public RtfHeaderFooters()
Contructs a HeaderFooters object


RtfHeaderFooters

public RtfHeaderFooters(Phrase before,
                        Phrase after)
Contructs a HeaderFooters object

Parameters:
before -
after -

RtfHeaderFooters

public RtfHeaderFooters(Phrase before,
                        boolean numbered)
Contructs a HeaderFooters object

Parameters:
before -
numbered -
Method Detail

set

public void set(int type,
                HeaderFooter hf)
Adds a HeaderFooter to this HeaderFooters object

Parameters:
type -
hf -

get

public HeaderFooter get(int type)
Returns a type of HeaderFooter object registered in this HeaderFooters object.

Parameters:
type - type of the HeaderFooter object
Returns:
a HeaderFooter object