|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.lowagie.text.Document
A generic Document class.
All kinds of Text-elements can be added to a HTMLDocument.
The Document signals all the listeners when an element
has been added.
Remark:
OutputStream) is closed too.
// creation of the document with a certain size and certain margins
Document document = new Document(PageSize.A4, 50, 50, 50, 50);
try {
// creation of the different writers
HtmlWriter.getInstance(document, System.out);
PdfWriter.getInstance(document, new FileOutputStream("text.pdf"));
// we add some meta information to the document
document.addAuthor("Bruno Lowagie");
document.addSubject("This is the result of a Test.");
// we define a header and a footer
HeaderFooter header = new HeaderFooter(new Phrase("This is a header."), false);
HeaderFooter footer = new HeaderFooter(new Phrase("This is page "), new Phrase("."));
footer.setAlignment(Element.ALIGN_CENTER);
document.setHeader(header);
document.setFooter(footer);
// we open the document for writing
document.open();
document.add(new Paragraph("Hello world"));
}
catch(DocumentException de) {
System.err.println(de.getMessage());
}
document.close();
| Field Summary | |
protected boolean |
close
Has the document already been closed? |
static boolean |
compress
Allows the pdf documents to be produced without compression for debugging purposes. |
protected HeaderFooter |
footer
This is the textual part of the footer |
protected HeaderFooter |
header
This is the textual part of a Page; it can contain a header |
protected String |
htmlStyleClass
Style class in HTML body tag |
private static String |
ITEXT_VERSION
This constant may only be changed by Paulo Soares and/or Bruno Lowagie. |
protected String |
javaScript_onLoad
Content of JavaScript onLoad function |
protected String |
javaScript_onUnLoad
Content of JavaScript onUnLoad function |
private ArrayList |
listeners
The DocListener. |
protected float |
marginBottom
margin in y direction starting from the bottom |
protected float |
marginLeft
margin in x direction starting from the left |
protected float |
marginRight
margin in x direction starting from the right |
protected float |
marginTop
margin in y direction starting from the top |
protected boolean |
open
Is the document open or not? |
protected int |
pageN
Current pagenumber |
protected Rectangle |
pageSize
The size of the page. |
protected Watermark |
watermark
The watermark on the pages. |
| Constructor Summary | |
Document()
Constructs a new Document-object. |
|
Document(Rectangle pageSize)
Constructs a new Document-object. |
|
Document(Rectangle pageSize,
float marginLeft,
float marginRight,
float marginTop,
float marginBottom)
Constructs a new Document-object. |
|
| Method Summary | |
boolean |
add(Element element)
Adds an Element to the Document. |
boolean |
add(Watermark watermark)
Sets the Watermark. |
boolean |
addAuthor(String author)
Adds the author to a Document. |
boolean |
addCreationDate()
Adds the current date and time to a Document. |
boolean |
addCreator(String creator)
Adds the creator to a Document. |
void |
addDocListener(DocListener listener)
Adds a DocListener to the Document. |
boolean |
addHeader(String name,
String content)
Adds a user defined header to the document. |
boolean |
addKeywords(String keywords)
Adds the keywords to a Document. |
boolean |
addProducer()
Adds the producer to a Document. |
boolean |
addSubject(String subject)
Adds the subject to a Document. |
boolean |
addTitle(String title)
Adds the title to a Document. |
float |
bottom()
Returns the lower left y-coordinate. |
float |
bottom(float margin)
Returns the lower left y-coordinate, considering a given margin. |
float |
bottomMargin()
Returns the bottom margin. |
void |
clearTextWrap()
Clears text wrapping around images (if applicable). |
void |
close()
Closes the document. |
String |
getHtmlStyleClass()
Gets the style class of the HTML body tag |
String |
getJavaScript_onLoad()
Gets the JavaScript onLoad command. |
String |
getJavaScript_onUnLoad()
Gets the JavaScript onUnLoad command. |
int |
getPageNumber()
Returns the current page number. |
Rectangle |
getPageSize()
Gets the pagesize. |
static String |
getVersion()
Gets the iText version. |
boolean |
isOpen()
Checks if the document is open. |
float |
left()
Returns the lower left x-coordinate. |
float |
left(float margin)
Returns the lower left x-coordinate considering a given margin. |
float |
leftMargin()
Returns the left margin. |
boolean |
newPage()
Signals that an new page has to be started. |
void |
open()
Opens the document. |
void |
removeDocListener(DocListener listener)
Removes a DocListener from the Document. |
void |
removeWatermark()
Removes the Watermark. |
void |
resetFooter()
Resets the footer of this document. |
void |
resetHeader()
Resets the header of this document. |
void |
resetPageCount()
Sets the page number to 0. |
float |
right()
Returns the upper right x-coordinate. |
float |
right(float margin)
Returns the upper right x-coordinate, considering a given margin. |
float |
rightMargin()
Return the right margin. |
void |
setFooter(HeaderFooter footer)
Changes the footer of this document. |
void |
setHeader(HeaderFooter header)
Changes the header of this document. |
void |
setHtmlStyleClass(String htmlStyleClass)
Adds a style class to the HTML body tag |
void |
setJavaScript_onLoad(String code)
Adds a JavaScript onLoad function to the HTML body tag |
void |
setJavaScript_onUnLoad(String code)
Adds a JavaScript onUnLoad function to the HTML body tag |
boolean |
setMargins(float marginLeft,
float marginRight,
float marginTop,
float marginBottom)
Sets the margins. |
void |
setPageCount(int pageN)
Sets the page number. |
boolean |
setPageSize(Rectangle pageSize)
Sets the pagesize. |
float |
top()
Returns the upper right y-coordinate. |
float |
top(float margin)
Returns the upper right y-coordinate, considering a given margin. |
float |
topMargin()
Returns the top margin. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
private static final String ITEXT_VERSION
public static boolean compress
private ArrayList listeners
protected boolean open
protected boolean close
protected Rectangle pageSize
protected Watermark watermark
protected float marginLeft
protected float marginRight
protected float marginTop
protected float marginBottom
protected String javaScript_onLoad
protected String javaScript_onUnLoad
protected String htmlStyleClass
protected int pageN
protected HeaderFooter header
protected HeaderFooter footer
| Constructor Detail |
public Document()
Document-object.
public Document(Rectangle pageSize)
Document-object.
pageSize - the pageSize
public Document(Rectangle pageSize,
float marginLeft,
float marginRight,
float marginTop,
float marginBottom)
Document-object.
pageSize - the pageSizemarginLeft - the margin on the leftmarginRight - the margin on the rightmarginTop - the margin on the topmarginBottom - the margin on the bottom| Method Detail |
public void addDocListener(DocListener listener)
DocListener to the Document.
listener - the new DocListener.public void removeDocListener(DocListener listener)
DocListener from the Document.
listener - the DocListener that has to be removed.
public boolean add(Element element)
throws DocumentException
Element to the Document.
add in interface ElementListenerelement - the Element to add
true if the element was added, false if not
DocumentException - when a document isn't open yet, or has been closedpublic void open()
Once the document is opened, you can't write any Header- or Meta-information anymore. You have to open the document before you can begin to add content to the body of the document.
open in interface DocListenerpublic boolean setPageSize(Rectangle pageSize)
setPageSize in interface DocListenerpageSize - the new pagesize
booleanpublic boolean add(Watermark watermark)
Watermark.
add in interface DocListenerwatermark - the watermark to add
true if the element was added, false if not.public void removeWatermark()
Watermark.
removeWatermark in interface DocListener
public boolean setMargins(float marginLeft,
float marginRight,
float marginTop,
float marginBottom)
setMargins in interface DocListenermarginLeft - the margin on the leftmarginRight - the margin on the rightmarginTop - the margin on the topmarginBottom - the margin on the bottom
boolean
public boolean newPage()
throws DocumentException
newPage in interface DocListenertrue if the page was added, false if not.
DocumentException - when a document isn't open yet, or has been closedpublic void setHeader(HeaderFooter header)
setHeader in interface DocListenerheader - the new headerpublic void resetHeader()
resetHeader in interface DocListenerpublic void setFooter(HeaderFooter footer)
setFooter in interface DocListenerfooter - the new footerpublic void resetFooter()
resetFooter in interface DocListenerpublic void resetPageCount()
resetPageCount in interface DocListenerpublic void setPageCount(int pageN)
setPageCount in interface DocListenerpageN - the new page numberpublic int getPageNumber()
public void close()
Once all the content has been written in the body, you have to close the body. After that nothing can be written to the body anymore.
close in interface DocListener
public boolean addHeader(String name,
String content)
name - the name of the headercontent - the content of the header
true if successful, false otherwisepublic boolean addTitle(String title)
title - the title
true if successful, false otherwisepublic boolean addSubject(String subject)
subject - the subject
true if successful, false otherwisepublic boolean addKeywords(String keywords)
keywords - adds the keywords to the document
true if successful, false otherwisepublic boolean addAuthor(String author)
author - the name of the author
true if successful, false otherwisepublic boolean addCreator(String creator)
creator - the name of the creator
true if successful, false otherwisepublic boolean addProducer()
true if successful, false otherwisepublic boolean addCreationDate()
true if successful, false otherwisepublic float leftMargin()
public float rightMargin()
public float topMargin()
public float bottomMargin()
public float left()
public float right()
public float top()
public float bottom()
public float left(float margin)
margin - a margin
public float right(float margin)
margin - a margin
public float top(float margin)
margin - a margin
public float bottom(float margin)
margin - a margin
public Rectangle getPageSize()
public boolean isOpen()
true if the document is openpublic static String getVersion()
public void setJavaScript_onLoad(String code)
code - the JavaScript code to be executed on load of the HTML pagepublic String getJavaScript_onLoad()
public void setJavaScript_onUnLoad(String code)
code - the JavaScript code to be executed on unload of the HTML pagepublic String getJavaScript_onUnLoad()
public void setHtmlStyleClass(String htmlStyleClass)
htmlStyleClass - the style class for the HTML body tagpublic String getHtmlStyleClass()
public void clearTextWrap()
throws DocumentException
DocListener
clearTextWrap in interface DocListenerDocumentExceptionDocListener.clearTextWrap()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||