com.lowagie.text.rtf.headerfooter
public class RtfHeaderFooterGroup extends HeaderFooter implements RtfBasicElement
Modifier and Type | Field and Description |
---|---|
private RtfDocument |
document
The RtfDocument this RtfHeaderFooterGroup belongs to
|
private RtfHeaderFooter |
headerAll
The RtfHeaderFooter for all pages
|
private RtfHeaderFooter |
headerFirst
The RtfHeaderFooter for the first page
|
private RtfHeaderFooter |
headerLeft
The RtfHeaderFooter for the left hand pages
|
private RtfHeaderFooter |
headerRight
The RtfHeaderFooter for the right hand pages
|
private int |
mode
The current mode of this RtfHeaderFooterGroup.
|
private static int |
MODE_MULTIPLE
This RtfHeaderFooterGroup contains two or three RtfHeaderFooter objects
|
private static int |
MODE_NONE
This RtfHeaderFooterGroup contains no RtfHeaderFooter objects
|
private static int |
MODE_SINGLE
This RtfHeaderFooterGroup contains one RtfHeaderFooter object
|
private int |
type
The current type of this RtfHeaderFooterGroup.
|
backgroundColor, border, borderColor, borderColorBottom, borderColorLeft, borderColorRight, borderColorTop, borderWidth, borderWidthBottom, borderWidthLeft, borderWidthRight, borderWidthTop, BOTTOM, BOX, LEFT, llx, lly, NO_BORDER, RIGHT, rotation, TOP, UNDEFINED, urx, ury, useVariableBorders
CLOSE_GROUP, COMMA_DELIMITER, DELIMITER, OPEN_GROUP, TWIPS_FACTOR
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, HEADER, IMGRAW, IMGTEMPLATE, JBIG2, JPEG, JPEG2000, KEYWORDS, LIST, LISTITEM, MARKED, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE, YMARK
Constructor and Description |
---|
RtfHeaderFooterGroup()
Constructs a RtfHeaderGroup to which you add headers/footers using
via the setHeaderFooter method.
|
RtfHeaderFooterGroup(RtfDocument doc,
HeaderFooter headerFooter,
int type)
Constructs a RtfHeaderGroup for a certain HeaderFooter
|
RtfHeaderFooterGroup(RtfDocument doc,
int type)
Constructs a certain type of RtfHeaderFooterGroup.
|
RtfHeaderFooterGroup(RtfDocument doc,
RtfHeaderFooterGroup headerFooter,
int type)
Constructs a RtfHeaderFooterGroup by copying the content of the original
RtfHeaderFooterGroup
|
RtfHeaderFooterGroup(RtfDocument doc,
RtfHeaderFooter headerFooter,
int type)
Constructs a RtfHeaderFooterGroup for a certain RtfHeaderFooter.
|
Modifier and Type | Method and Description |
---|---|
protected RtfHeaderFooter |
getHeaderAll()
Gets the RtfHeaderFooter for all pages
|
protected RtfHeaderFooter |
getHeaderFirst()
Gets the RtfHeaderFooter for the title page
|
protected RtfHeaderFooter |
getHeaderLeft()
Gets the RtfHeaderFooter for all left hand pages
|
protected RtfHeaderFooter |
getHeaderRight()
Gets the RtfHeaderFooter for all right hand pages
|
protected int |
getMode()
Gets the mode of this RtfHeaderFooterGroup
|
boolean |
hasFacingPages()
Get whether this RtfHeaderFooterGroup has facing pages
|
boolean |
hasTitlePage()
Get whether this RtfHeaderFooterGroup has a titlepage
|
void |
setHasFacingPages()
Set that this RtfHeaderFooterGroup should have facing pages.
|
void |
setHasTitlePage()
Set that this RtfHeaderFooterGroup should have a title page.
|
void |
setHeaderFooter(HeaderFooter headerFooter,
int displayAt)
Set a HeaderFooter to be displayed at a certain position
|
void |
setHeaderFooter(RtfHeaderFooter headerFooter,
int displayAt)
Set a RtfHeaderFooter to be displayed at a certain position
|
void |
setInHeader(boolean inHeader)
Unused
|
void |
setInTable(boolean inTable)
Unused
|
void |
setRtfDocument(RtfDocument doc)
Sets the RtfDocument this RtfElement belongs to
|
void |
setType(int type)
Set the type of this RtfHeaderFooterGroup.
|
void |
writeContent(OutputStream result)
Write the content of this RtfHeaderFooterGroup.
|
alignment, getAfter, getBefore, isNumbered, paragraph, setAlignment, setPageNumber
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
private static final int MODE_NONE
private static final int MODE_SINGLE
private static final int MODE_MULTIPLE
private int mode
private int type
private RtfHeaderFooter headerAll
private RtfHeaderFooter headerFirst
private RtfHeaderFooter headerLeft
private RtfHeaderFooter headerRight
private RtfDocument document
public RtfHeaderFooterGroup()
public RtfHeaderFooterGroup(RtfDocument doc, int type)
doc
- The RtfDocument this RtfHeaderFooter belongs totype
- The type of RtfHeaderFooterGroup to createpublic RtfHeaderFooterGroup(RtfDocument doc, RtfHeaderFooterGroup headerFooter, int type)
doc
- The RtfDocument this RtfHeaderFooter belongs toheaderFooter
- The RtfHeaderFooterGroup to copytype
- The type of RtfHeaderFooterGroup to createpublic RtfHeaderFooterGroup(RtfDocument doc, RtfHeaderFooter headerFooter, int type)
doc
- The RtfDocument this RtfHeaderFooter belongs toheaderFooter
- The RtfHeaderFooter to displaytype
- The type of RtfHeaderFooterGroup to createpublic RtfHeaderFooterGroup(RtfDocument doc, HeaderFooter headerFooter, int type)
doc
- The RtfDocument this RtfHeaderFooter belongs toheaderFooter
- The HeaderFooter to displaytype
- The type of RtfHeaderFooterGroup to createpublic void setRtfDocument(RtfDocument doc)
setRtfDocument
in interface RtfBasicElement
doc
- The RtfDocument to usepublic void writeContent(OutputStream result) throws IOException
writeContent
in interface RtfBasicElement
result
- The OutputStream
to write the content toIOException
public void setHeaderFooter(RtfHeaderFooter headerFooter, int displayAt)
headerFooter
- The RtfHeaderFooter to displaydisplayAt
- The display location to usepublic void setHeaderFooter(HeaderFooter headerFooter, int displayAt)
headerFooter
- The HeaderFooter to setdisplayAt
- The display location to usepublic void setHasTitlePage()
public void setHasFacingPages()
public boolean hasTitlePage()
public boolean hasFacingPages()
public void setInTable(boolean inTable)
setInTable
in interface RtfBasicElement
inTable
- public void setInHeader(boolean inHeader)
setInHeader
in interface RtfBasicElement
inHeader
- public void setType(int type)
type
- The type to useprotected int getMode()
protected RtfHeaderFooter getHeaderAll()
protected RtfHeaderFooter getHeaderFirst()
protected RtfHeaderFooter getHeaderLeft()
protected RtfHeaderFooter getHeaderRight()