|
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.lowagie.text.Rectangle
com.lowagie.text.HeaderFooter
com.lowagie.text.rtf.headerfooter.RtfHeaderFooterGroup
public class RtfHeaderFooterGroup
The RtfHeaderFooterGroup holds 0 - 3 RtfHeaderFooters that create a group of headers or footers.
| Field Summary | |
|---|---|
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. |
| 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, RIGHT, rotation, TOP, UNDEFINED, urx, ury, useVariableBorders |
| Fields inherited from interface com.lowagie.text.rtf.RtfBasicElement |
|---|
CLOSE_GROUP, COMMA_DELIMITER, DELIMITER, OPEN_GROUP, TWIPS_FACTOR |
| 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, HEADER, IMGRAW, IMGTEMPLATE, JPEG, JPEG2000, KEYWORDS, LIST, LISTITEM, MARKED, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE |
| Constructor Summary | |
|---|---|
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. |
|
| Method Summary | |
|---|---|
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. |
byte[] |
write()
Deprecated. As of iText 2.0.6 or earlier, replaced by writeContent(OutputStream), scheduled for removal at or after 2.1.0 |
void |
writeContent(OutputStream result)
Write the content of this RtfHeaderFooterGroup. |
| Methods inherited from class com.lowagie.text.HeaderFooter |
|---|
alignment, getAfter, getBefore, isNumbered, paragraph, setAlignment, setPageNumber |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
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
| Constructor Detail |
|---|
public RtfHeaderFooterGroup()
public RtfHeaderFooterGroup(RtfDocument doc,
int type)
doc - The RtfDocument this RtfHeaderFooter belongs totype - The type of RtfHeaderFooterGroup to create
public RtfHeaderFooterGroup(RtfDocument doc,
RtfHeaderFooterGroup headerFooter,
int type)
doc - The RtfDocument this RtfHeaderFooter belongs toheaderFooter - The RtfHeaderFooterGroup to copytype - The type of RtfHeaderFooterGroup to create
public RtfHeaderFooterGroup(RtfDocument doc,
RtfHeaderFooter headerFooter,
int type)
doc - The RtfDocument this RtfHeaderFooter belongs toheaderFooter - The RtfHeaderFooter to displaytype - The typ of RtfHeaderFooterGroup to create
public RtfHeaderFooterGroup(RtfDocument doc,
HeaderFooter headerFooter,
int type)
doc - The RtfDocument this RtfHeaderFooter belongs toheaderFooter - The HeaderFooter to displaytype - The typ of RtfHeaderFooterGroup to create| Method Detail |
|---|
public void setRtfDocument(RtfDocument doc)
setRtfDocument in interface RtfBasicElementdoc - The RtfDocument to usepublic byte[] write()
writeContent(OutputStream), scheduled for removal at or after 2.1.0
write in interface RtfBasicElement
public void writeContent(OutputStream result)
throws IOException
writeContent in interface RtfBasicElementIOException
public void setHeaderFooter(RtfHeaderFooter headerFooter,
int displayAt)
headerFooter - The RtfHeaderFooter to displaydisplayAt - The display location to use
public 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 RtfBasicElementinTable - public void setInHeader(boolean inHeader)
setInHeader in interface RtfBasicElementinHeader - public void setType(int type)
type - The type to useprotected int getMode()
protected RtfHeaderFooter getHeaderAll()
protected RtfHeaderFooter getHeaderFirst()
protected RtfHeaderFooter getHeaderLeft()
protected RtfHeaderFooter getHeaderRight()
|
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||