com.lowagie.text
public class Document extends Object implements DocListener
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 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 int | chapternumber This is a chapter number in case ChapterAutoNumber is used. |
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 |
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 |
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 boolean | marginMirroring |
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. |
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 | 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 | 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 | isMarginMirroring()
Gets the margin mirroring flag.
|
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 | 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 | setMarginMirroring(boolean marginMirroring)
Set the margin mirroring. |
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.
|
Document
-object.Document
-object.
Parameters: pageSize the pageSize
Document
-object.
Parameters: pageSize the pageSize marginLeft the margin on the left marginRight the margin on the right marginTop the margin on the top marginBottom the margin on the bottom
Element
to the Document
.
Parameters: element
the Element
to add
Returns: true
if the element was added, false
if not
Throws: DocumentException when a document isn't open yet, or has been closed
Parameters: author the name of the author
Returns: true
if successful, false
otherwise
Returns: true
if successful, false
otherwise
Parameters: creator the name of the creator
Returns: true
if successful, false
otherwise
DocListener
to the Document
.
Parameters: listener the new DocListener.
Parameters: name the name of the header content the content of the header
Returns: true
if successful, false
otherwise
Parameters: keywords adds the keywords to the document
Returns: true
if successful, false
otherwise
Returns: true
if successful, false
otherwise
Parameters: subject the subject
Returns: true
if successful, false
otherwise
Parameters: title the title
Returns: true
if successful, false
otherwise
Returns: the lower left y-coordinate
Parameters: margin a margin
Returns: the lower left y-coordinate
Returns: the bottom margin
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.
Returns: the style class of the HTML body tag
Returns: the JavaScript onLoad command
Returns: the JavaScript onUnLoad command
Returns: the current page number
Returns: the page size
Returns: iText version
Returns: the margin mirroring flag
Returns: true
if the document is open
Returns: the lower left x-coordinate
Parameters: margin a margin
Returns: the lower left x-coordinate
Returns: the left margin
Returns: true
if the page was added, false
if not.
Throws: DocumentException when a document isn't open yet, or has been closed
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.
DocListener
from the Document
.
Parameters: listener the DocListener that has to be removed.
Returns: the upper right x-coordinate
Parameters: margin a margin
Returns: the upper right x-coordinate
Returns: the right margin
Parameters: footer the new footer
Parameters: header the new header
Parameters: htmlStyleClass the style class for the HTML body tag
Parameters: code the JavaScript code to be executed on load of the HTML page
Parameters: code the JavaScript code to be executed on unload of the HTML page
Note: it will not work with Table.
Parameters: marginMirroring
true
to mirror the margins
Returns: always true
Parameters: marginLeft the margin on the left marginRight the margin on the right marginTop the margin on the top marginBottom the margin on the bottom
Returns: a boolean
Parameters: pageN the new page number
Parameters: pageSize the new pagesize
Returns: a boolean
Returns: the upper right y-coordinate
Parameters: margin a margin
Returns: the upper right y-coordinate
Returns: the top margin