Class RtfHeaderFooterGroup
java.lang.Object
com.lowagie.text.Rectangle
com.lowagie.text.HeaderFooter
com.lowagie.text.rtf.headerfooter.RtfHeaderFooterGroup
- All Implemented Interfaces:
com.lowagie.text.Element
,RtfBasicElement
,com.lowagie.text.RtfElementInterface
The RtfHeaderFooterGroup holds 0 - 3 RtfHeaderFooters that create a group
of headers or footers.
- Version:
- $Id: RtfHeaderFooterGroup.java 3373 2008-05-12 16:21:24Z xlv $
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate RtfDocument
The RtfDocument this RtfHeaderFooterGroup belongs toprivate RtfHeaderFooter
The RtfHeaderFooter for all pagesprivate RtfHeaderFooter
The RtfHeaderFooter for the first pageprivate RtfHeaderFooter
The RtfHeaderFooter for the left hand pagesprivate RtfHeaderFooter
The RtfHeaderFooter for the right hand pagesprivate int
The current mode of this RtfHeaderFooterGroup.private static final int
This RtfHeaderFooterGroup contains two or three RtfHeaderFooter objectsprivate static final int
This RtfHeaderFooterGroup contains no RtfHeaderFooter objectsprivate static final int
This RtfHeaderFooterGroup contains one RtfHeaderFooter objectprivate int
The current type of this RtfHeaderFooterGroup.Fields inherited from class com.lowagie.text.Rectangle
backgroundColor, border, borderColor, borderColorBottom, borderColorLeft, borderColorRight, borderColorTop, borderWidth, borderWidthBottom, borderWidthLeft, borderWidthRight, borderWidthTop, BOTTOM, BOX, LEFT, llx, lly, NO_BORDER, offsetToTop, 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, FOOTNOTE, HEADER, IMGRAW, IMGTEMPLATE, JBIG2, JPEG, JPEG2000, KEYWORDS, LIST, LISTITEM, MARKED, MODIFICATIONDATE, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE, YMARK
Fields inherited from interface com.lowagie.text.rtf.RtfBasicElement
CLOSE_GROUP, COMMA_DELIMITER, DELIMITER, OPEN_GROUP, TWIPS_FACTOR
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a RtfHeaderGroup to which you add headers/footers using via the setHeaderFooter method.RtfHeaderFooterGroup
(RtfDocument doc, int type) Constructs a certain type of RtfHeaderFooterGroup.RtfHeaderFooterGroup
(RtfDocument doc, com.lowagie.text.HeaderFooter headerFooter, int type) Constructs a RtfHeaderGroup for a certain HeaderFooterRtfHeaderFooterGroup
(RtfDocument doc, RtfHeaderFooterGroup headerFooter, int type) Constructs a RtfHeaderFooterGroup by copying the content of the original RtfHeaderFooterGroupRtfHeaderFooterGroup
(RtfDocument doc, RtfHeaderFooter headerFooter, int type) Constructs a RtfHeaderFooterGroup for a certain RtfHeaderFooter. -
Method Summary
Modifier and TypeMethodDescriptionprotected RtfHeaderFooter
Gets the RtfHeaderFooter for all pagesprotected RtfHeaderFooter
Gets the RtfHeaderFooter for the title pageprotected RtfHeaderFooter
Gets the RtfHeaderFooter for all left hand pagesprotected RtfHeaderFooter
Gets the RtfHeaderFooter for all right hand pagesprotected int
getMode()
Gets the mode of this RtfHeaderFooterGroupboolean
Get whether this RtfHeaderFooterGroup has facing pagesboolean
Get whether this RtfHeaderFooterGroup has a titlepagevoid
Set that this RtfHeaderFooterGroup should have facing pages.void
Set that this RtfHeaderFooterGroup should have a title page.void
setHeaderFooter
(com.lowagie.text.HeaderFooter headerFooter, int displayAt) Set a HeaderFooter to be displayed at a certain positionvoid
setHeaderFooter
(RtfHeaderFooter headerFooter, int displayAt) Set a RtfHeaderFooter to be displayed at a certain positionvoid
setInHeader
(boolean inHeader) Unusedvoid
setInTable
(boolean inTable) Unusedvoid
Sets the RtfDocument this RtfElement belongs tovoid
setType
(int type) Set the type of this RtfHeaderFooterGroup.void
writeContent
(OutputStream result) Write the content of this RtfHeaderFooterGroup.Methods inherited from class com.lowagie.text.HeaderFooter
addPadding, addSpecialContent, alignment, getAfter, getBefore, getPadding, getSpecialContent, isNumbered, paragraph, setAlignment, setPadding, setPageNumber
Methods inherited from class 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, getRelativeTop, 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, setRelativeTop, setRight, setRotation, setTop, setUseVariableBorders, softCloneNonPositionParameters, toString, type
-
Field Details
-
MODE_NONE
private static final int MODE_NONEThis RtfHeaderFooterGroup contains no RtfHeaderFooter objects- See Also:
-
MODE_SINGLE
private static final int MODE_SINGLEThis RtfHeaderFooterGroup contains one RtfHeaderFooter object- See Also:
-
MODE_MULTIPLE
private static final int MODE_MULTIPLEThis RtfHeaderFooterGroup contains two or three RtfHeaderFooter objects- See Also:
-
mode
private int modeThe current mode of this RtfHeaderFooterGroup. Defaults to MODE_NONE -
type
private int typeThe current type of this RtfHeaderFooterGroup. Defaults to RtfHeaderFooter.TYPE_HEADER -
headerAll
The RtfHeaderFooter for all pages -
headerFirst
The RtfHeaderFooter for the first page -
headerLeft
The RtfHeaderFooter for the left hand pages -
headerRight
The RtfHeaderFooter for the right hand pages -
document
The RtfDocument this RtfHeaderFooterGroup belongs to
-
-
Constructor Details
-
RtfHeaderFooterGroup
public RtfHeaderFooterGroup()Constructs a RtfHeaderGroup to which you add headers/footers using via the setHeaderFooter method. -
RtfHeaderFooterGroup
Constructs a certain type of RtfHeaderFooterGroup. RtfHeaderFooter.TYPE_HEADER and RtfHeaderFooter.TYPE_FOOTER are valid values for type.- Parameters:
doc
- The RtfDocument this RtfHeaderFooter belongs totype
- The type of RtfHeaderFooterGroup to create
-
-
Method Details
-
setRtfDocument
Sets the RtfDocument this RtfElement belongs to- Specified by:
setRtfDocument
in interfaceRtfBasicElement
- Parameters:
doc
- The RtfDocument to use
-
writeContent
Write the content of this RtfHeaderFooterGroup.- Specified by:
writeContent
in interfaceRtfBasicElement
- Parameters:
result
- TheOutputStream
to write the content to- Throws:
IOException
-
setHasTitlePage
public void setHasTitlePage()Set that this RtfHeaderFooterGroup should have a title page. If only a header / footer for all pages exists, then it will be copied to the first page as well. -
setHasFacingPages
public void setHasFacingPages()Set that this RtfHeaderFooterGroup should have facing pages. If only a header / footer for all pages exists, then it will be copied to the left and right pages as well. -
hasTitlePage
public boolean hasTitlePage()Get whether this RtfHeaderFooterGroup has a titlepage- Returns:
- Whether this RtfHeaderFooterGroup has a titlepage
-
hasFacingPages
public boolean hasFacingPages()Get whether this RtfHeaderFooterGroup has facing pages- Returns:
- Whether this RtfHeaderFooterGroup has facing pages
-
setInTable
public void setInTable(boolean inTable) Unused- Specified by:
setInTable
in interfaceRtfBasicElement
- Parameters:
inTable
-
-
setInHeader
public void setInHeader(boolean inHeader) Unused- Specified by:
setInHeader
in interfaceRtfBasicElement
- Parameters:
inHeader
-
-
setType
public void setType(int type) Set the type of this RtfHeaderFooterGroup. RtfHeaderFooter.TYPE_HEADER or RtfHeaderFooter.TYPE_FOOTER. Also sets the type for all RtfHeaderFooters of this RtfHeaderFooterGroup.- Parameters:
type
- The type to use
-
getMode
protected int getMode()Gets the mode of this RtfHeaderFooterGroup- Returns:
- The mode of this RtfHeaderFooterGroup
-
getHeaderAll
Gets the RtfHeaderFooter for all pages- Returns:
- The RtfHeaderFooter for all pages
-
getHeaderFirst
Gets the RtfHeaderFooter for the title page- Returns:
- The RtfHeaderFooter for the title page
-
getHeaderLeft
Gets the RtfHeaderFooter for all left hand pages- Returns:
- The RtfHeaderFooter for all left hand pages
-
getHeaderRight
Gets the RtfHeaderFooter for all right hand pages- Returns:
- The RtfHeaderFooter for all right hand pages
-