The RtfHeaderFooterGroup holds 0 - 3 RtfHeaderFooters that create a group
of headers or footers.
| Constructor: |
public RtfHeaderFooterGroup() {
super(new Phrase(""), false);
this.mode = MODE_NONE;
}
Constructs a RtfHeaderGroup to which you add headers/footers using
via the setHeaderFooter method. |
public RtfHeaderFooterGroup(RtfDocument doc,
int type) {
super(new Phrase(""), false);
this.document = doc;
this.type = type;
}
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 to
type - The type of RtfHeaderFooterGroup to create
|
public RtfHeaderFooterGroup(RtfDocument doc,
RtfHeaderFooterGroup headerFooter,
int type) {
super(new Phrase(""), false);
this.document = doc;
this.mode = headerFooter.getMode();
this.type = type;
if(headerFooter.getHeaderAll() != null) {
this.headerAll = new RtfHeaderFooter(this.document, headerFooter.getHeaderAll(), RtfHeaderFooter.DISPLAY_ALL_PAGES);
}
if(headerFooter.getHeaderFirst() != null) {
this.headerFirst = new RtfHeaderFooter(this.document, headerFooter.getHeaderFirst(), RtfHeaderFooter.DISPLAY_FIRST_PAGE);
}
if(headerFooter.getHeaderLeft() != null) {
this.headerLeft = new RtfHeaderFooter(this.document, headerFooter.getHeaderLeft(), RtfHeaderFooter.DISPLAY_LEFT_PAGES);
}
if(headerFooter.getHeaderRight() != null) {
this.headerRight = new RtfHeaderFooter(this.document, headerFooter.getHeaderRight(), RtfHeaderFooter.DISPLAY_RIGHT_PAGES);
}
setType(this.type);
}
Constructs a RtfHeaderFooterGroup by copying the content of the original
RtfHeaderFooterGroup Parameters:
doc - The RtfDocument this RtfHeaderFooter belongs to
headerFooter - The RtfHeaderFooterGroup to copy
type - The type of RtfHeaderFooterGroup to create
|
public RtfHeaderFooterGroup(RtfDocument doc,
RtfHeaderFooter headerFooter,
int type) {
super(new Phrase(""), false);
this.document = doc;
this.type = type;
this.mode = MODE_SINGLE;
headerAll = new RtfHeaderFooter(doc, headerFooter, RtfHeaderFooter.DISPLAY_ALL_PAGES);
headerAll.setType(this.type);
}
Constructs a RtfHeaderFooterGroup for a certain RtfHeaderFooter. Parameters:
doc - The RtfDocument this RtfHeaderFooter belongs to
headerFooter - The RtfHeaderFooter to display
type - The type of RtfHeaderFooterGroup to create
|
public RtfHeaderFooterGroup(RtfDocument doc,
HeaderFooter headerFooter,
int type) {
super(new Phrase(""), false);
this.document = doc;
this.type = type;
this.mode = MODE_SINGLE;
headerAll = new RtfHeaderFooter(doc, headerFooter, type, RtfHeaderFooter.DISPLAY_ALL_PAGES);
headerAll.setType(this.type);
}
Constructs a RtfHeaderGroup for a certain HeaderFooter Parameters:
doc - The RtfDocument this RtfHeaderFooter belongs to
headerFooter - The HeaderFooter to display
type - The type of RtfHeaderFooterGroup to create
|
| Method from com.lowagie.text.rtf.headerfooter.RtfHeaderFooterGroup Detail: |
protected RtfHeaderFooter getHeaderAll() {
return headerAll;
}
Gets the RtfHeaderFooter for all pages |
protected RtfHeaderFooter getHeaderFirst() {
return headerFirst;
}
Gets the RtfHeaderFooter for the title page |
protected RtfHeaderFooter getHeaderLeft() {
return headerLeft;
}
Gets the RtfHeaderFooter for all left hand pages |
protected RtfHeaderFooter getHeaderRight() {
return headerRight;
}
Gets the RtfHeaderFooter for all right hand pages |
protected int getMode() {
return this.mode;
}
Gets the mode of this RtfHeaderFooterGroup |
public boolean hasFacingPages() {
return (headerLeft != null || headerRight != null);
}
Get whether this RtfHeaderFooterGroup has facing pages |
public boolean hasTitlePage() {
return (headerFirst != null);
}
Get whether this RtfHeaderFooterGroup has a titlepage |
public void setHasFacingPages() {
if(this.mode == MODE_SINGLE) {
this.mode = MODE_MULTIPLE;
this.headerLeft = new RtfHeaderFooter(this.document, this.headerAll, RtfHeaderFooter.DISPLAY_LEFT_PAGES);
this.headerLeft.setType(this.type);
this.headerRight = new RtfHeaderFooter(this.document, this.headerAll, RtfHeaderFooter.DISPLAY_RIGHT_PAGES);
this.headerRight.setType(this.type);
this.headerAll = null;
} else if(this.mode == MODE_MULTIPLE) {
if(this.headerLeft == null && this.headerAll != null) {
this.headerLeft = new RtfHeaderFooter(this.document, this.headerAll, RtfHeaderFooter.DISPLAY_LEFT_PAGES);
this.headerLeft.setType(this.type);
}
if(this.headerRight == null && this.headerAll != null) {
this.headerRight = new RtfHeaderFooter(this.document, this.headerAll, RtfHeaderFooter.DISPLAY_RIGHT_PAGES);
this.headerRight.setType(this.type);
}
this.headerAll = null;
}
}
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. |
public void setHasTitlePage() {
if(this.mode == MODE_SINGLE) {
this.mode = MODE_MULTIPLE;
headerFirst = new RtfHeaderFooter(this.document, headerAll, RtfHeaderFooter.DISPLAY_FIRST_PAGE);
headerFirst.setType(this.type);
}
}
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. |
public void setHeaderFooter(RtfHeaderFooter headerFooter,
int displayAt) {
this.mode = MODE_MULTIPLE;
headerFooter.setRtfDocument(this.document);
headerFooter.setType(this.type);
headerFooter.setDisplayAt(displayAt);
switch(displayAt) {
case RtfHeaderFooter.DISPLAY_ALL_PAGES:
headerAll = headerFooter;
break;
case RtfHeaderFooter.DISPLAY_FIRST_PAGE:
headerFirst = headerFooter;
break;
case RtfHeaderFooter.DISPLAY_LEFT_PAGES:
headerLeft = headerFooter;
break;
case RtfHeaderFooter.DISPLAY_RIGHT_PAGES:
headerRight = headerFooter;
break;
}
}
Set a RtfHeaderFooter to be displayed at a certain position |
public void setHeaderFooter(HeaderFooter headerFooter,
int displayAt) {
this.mode = MODE_MULTIPLE;
switch(displayAt) {
case RtfHeaderFooter.DISPLAY_ALL_PAGES:
headerAll = new RtfHeaderFooter(this.document, headerFooter, this.type, displayAt);
break;
case RtfHeaderFooter.DISPLAY_FIRST_PAGE:
headerFirst = new RtfHeaderFooter(this.document, headerFooter, this.type, displayAt);
break;
case RtfHeaderFooter.DISPLAY_LEFT_PAGES:
headerLeft = new RtfHeaderFooter(this.document, headerFooter, this.type, displayAt);
break;
case RtfHeaderFooter.DISPLAY_RIGHT_PAGES:
headerRight = new RtfHeaderFooter(this.document, headerFooter, this.type, displayAt);
break;
}
}
Set a HeaderFooter to be displayed at a certain position |
public void setInHeader(boolean inHeader) {
}
|
public void setInTable(boolean inTable) {
}
|
public void setRtfDocument(RtfDocument doc) {
this.document = doc;
if(headerAll != null) {
headerAll.setRtfDocument(this.document);
}
if(headerFirst != null) {
headerFirst.setRtfDocument(this.document);
}
if(headerLeft != null) {
headerLeft.setRtfDocument(this.document);
}
if(headerRight != null) {
headerRight.setRtfDocument(this.document);
}
}
Sets the RtfDocument this RtfElement belongs to |
public void setType(int type) {
this.type = type;
if(headerAll != null) {
headerAll.setType(this.type);
}
if(headerFirst != null) {
headerFirst.setType(this.type);
}
if(headerLeft != null) {
headerLeft.setType(this.type);
}
if(headerRight != null) {
headerRight.setType(this.type);
}
}
Set the type of this RtfHeaderFooterGroup. RtfHeaderFooter.TYPE_HEADER
or RtfHeaderFooter.TYPE_FOOTER. Also sets the type for all RtfHeaderFooters
of this RtfHeaderFooterGroup. |
public void writeContent(OutputStream result) throws IOException {
if(this.mode == MODE_SINGLE) {
headerAll.writeContent(result);
} else if(this.mode == MODE_MULTIPLE) {
if(headerFirst != null) {
headerFirst.writeContent(result);
}
if(headerLeft != null) {
headerLeft.writeContent(result);
}
if(headerRight != null) {
headerRight.writeContent(result);
}
if(headerAll != null) {
headerAll.writeContent(result);
}
}
}
Write the content of this RtfHeaderFooterGroup. |