com.lowagie.text.rtf: public class: RtfHeaderFooters

com.lowagie.text.rtf
public class: RtfHeaderFooters [javadoc | source]

java.lang.Object
   com.lowagie.text.Rectangle
      com.lowagie.text.HeaderFooter
         com.lowagie.text.rtf.RtfHeaderFooters

All Implemented Interfaces:
Element

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.

author: < - a href="mailto:Steffen.Stundzig@smb-tec.com">Steffen.Stundzig@smb-tec.com

author: < - a href="mailto:mhall@myrealbox.com">Mark.Hall@myrealbox.com

version: $ - Revision: 1.20 $Date: 2004/12/14 15:14:44 $

Field Summary
public static final int	ALL_PAGES	an attribute value
public static final int	LEFT_PAGES	an attribute value
public static final int	RIGHT_PAGES	an attribute value
public static final int	FIRST_PAGE	an attribute value

Fields inherited from com.lowagie.text.Rectangle:
UNDEFINED, TOP, BOTTOM, LEFT, RIGHT, NO_BORDER, BOX, llx, lly, urx, ury, rotation, border, borderWidth, borderColor, backgroundColor, useVariableBorders, borderWidthLeft, borderWidthRight, borderWidthTop, borderWidthBottom, borderColorLeft, borderColorRight, borderColorTop, borderColorBottom

Constructor:

Constructor:
public RtfHeaderFooters() { super( new Phrase(""), false ); } Contructs a HeaderFooters object
public RtfHeaderFooters(Phrase before, Phrase after) { super( before, after ); } Contructs a HeaderFooters object Parameters: `before` - `after` -
public RtfHeaderFooters(Phrase before, boolean numbered) { super( before, numbered ); } Contructs a HeaderFooters object Parameters: `before` - `numbered` -

 public RtfHeaderFooters() {
             
        super( new Phrase(""), false );
}

Contructs a HeaderFooters object

 public RtfHeaderFooters(Phrase before,
    Phrase after) {
        super( before, after );
}

Contructs a HeaderFooters object

Parameters:

before -

after -

 public RtfHeaderFooters(Phrase before,
    boolean numbered) {
        super( before, numbered );
}

Contructs a HeaderFooters object

Parameters:

before -

numbered -

Method from com.lowagie.text.rtf.RtfHeaderFooters Summary:
get, set

Methods from com.lowagie.text.HeaderFooter:
alignment, getAfter, getBefore, isNumbered, paragraph, setAlignment, setPageNumber

Methods from com.lowagie.text.Rectangle:
cloneNonPositionParameters, disableBorderSide, enableBorderSide, getBackgroundColor, getBorder, getBorderColor, getBorderColorBottom, getBorderColorLeft, getBorderColorRight, getBorderColorTop, getBorderWidth, getBorderWidthBottom, getBorderWidthLeft, getBorderWidthRight, getBorderWidthTop, getBottom, getBottom, getChunks, getGrayFill, getHeight, getLeft, getLeft, getRight, getRight, getRotation, getTop, getTop, getWidth, hasBorder, hasBorders, isContent, isNestable, isUseVariableBorders, normalize, process, rectangle, rotate, setBackgroundColor, setBorder, setBorderColor, setBorderColorBottom, setBorderColorLeft, setBorderColorRight, setBorderColorTop, setBorderWidth, setBorderWidthBottom, setBorderWidthLeft, setBorderWidthRight, setBorderWidthTop, setBottom, setGrayFill, setLeft, setRight, setTop, setUseVariableBorders, softCloneNonPositionParameters, toString, type

Methods from com.lowagie.text.Rectangle:

cloneNonPositionParameters, disableBorderSide, enableBorderSide, getBackgroundColor, getBorder, getBorderColor, getBorderColorBottom, getBorderColorLeft, getBorderColorRight, getBorderColorTop, getBorderWidth, getBorderWidthBottom, getBorderWidthLeft, getBorderWidthRight, getBorderWidthTop, getBottom, getBottom, getChunks, getGrayFill, getHeight, getLeft, getLeft, getRight, getRight, getRotation, getTop, getTop, getWidth, hasBorder, hasBorders, isContent, isNestable, isUseVariableBorders, normalize, process, rectangle, rotate, setBackgroundColor, setBorder, setBorderColor, setBorderColorBottom, setBorderColorLeft, setBorderColorRight, setBorderColorTop, setBorderWidth, setBorderWidthBottom, setBorderWidthLeft, setBorderWidthRight, setBorderWidthTop, setBottom, setGrayFill, setLeft, setRight, setTop, setUseVariableBorders, softCloneNonPositionParameters, toString, type

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from com.lowagie.text.rtf.RtfHeaderFooters Detail:
public HeaderFooter get(int type) { switch (type) { case ALL_PAGES: return allPages; case LEFT_PAGES: return leftPages; case RIGHT_PAGES: return rightPages; case FIRST_PAGE: return firstPage; default: throw new IllegalStateException( "unknown type " + type ); } } Returns a type of HeaderFooter object registered in this HeaderFooters object.
public void set(int type, HeaderFooter hf) { switch (type) { case ALL_PAGES: allPages = hf; break; case LEFT_PAGES: leftPages = hf; break; case RIGHT_PAGES: rightPages = hf; break; case FIRST_PAGE: firstPage = hf; break; default: throw new IllegalStateException( "unknown type " + type ); } } Adds a HeaderFooter to this HeaderFooters object

Method from com.lowagie.text.rtf.RtfHeaderFooters Detail:

 public HeaderFooter get(int type) {
        switch (type) {
            case ALL_PAGES:
                return allPages;
            case LEFT_PAGES:
                return leftPages;
            case RIGHT_PAGES:
                return rightPages;
            case FIRST_PAGE:
                return firstPage;
            default:
                throw new IllegalStateException( "unknown type " + type );
        }
}

Returns a type of HeaderFooter object registered in this HeaderFooters object.

 public  void set(int type,
    HeaderFooter hf) {
        switch (type) {
            case ALL_PAGES:
                allPages = hf;
                break;
            case LEFT_PAGES:
                leftPages = hf;
                break;
            case RIGHT_PAGES:
                rightPages = hf;
                break;
            case FIRST_PAGE:
                firstPage = hf;
                break;
            default:
                throw new IllegalStateException( "unknown type " + type );
        }
}

Adds a HeaderFooter to this HeaderFooters object