Class Document
java.lang.Object
com.gitlab.pdftk_java.com.lowagie.text.Document
- All Implemented Interfaces:
DocListener
,ElementListener
,EventListener
- Direct Known Subclasses:
PdfDocument
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:
- Once a document is created you can add some meta information.
- You can also set the headers/footers.
- You have to open the document before you can write content.
- You can only write content (no more meta-formation!) once a document is opened.
- When you change the header/footer on a certain page, this will be effective starting on the next page.
- Ater closing the document, every listener (as well as its
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
FieldsModifier and TypeFieldDescriptionprotected boolean
Has the document already been closed?static boolean
Allows the pdf documents to be produced without compression for debugging purposes.protected String
Style class in HTML body tagprivate static final String
This constant may only be changed by Paulo Soares and/or Bruno Lowagie.protected String
Content of JavaScript onLoad functionprotected String
Content of JavaScript onUnLoad functionprivate ArrayList
The DocListener.protected float
margin in y direction starting from the bottomprotected float
margin in x direction starting from the leftprotected boolean
protected float
margin in x direction starting from the rightprotected float
margin in y direction starting from the topprotected boolean
Is the document open or not?protected int
Current pagenumberprotected Rectangle
The size of the page. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Adds anElement
to theDocument
.boolean
Adds the author to a Document.boolean
Adds the current date and time to a Document.boolean
addCreator
(String creator) Adds the creator to a Document.void
addDocListener
(DocListener listener) Adds aDocListener
to theDocument
.boolean
Adds a user defined header to the document.boolean
addKeywords
(String keywords) Adds the keywords to a Document.boolean
Adds the producer to a Document.boolean
addSubject
(String subject) Adds the subject to a Document.boolean
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
Returns the bottom margin.void
Clears text wrapping around images (if applicable).void
close()
Closes the document.Gets the style class of the HTML body tagGets the JavaScript onLoad command.Gets the JavaScript onUnLoad command.int
Returns the current page number.Gets the pagesize.static final String
Gets the iText version.boolean
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
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 aDocListener
from theDocument
.void
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
Return the right margin.void
setHtmlStyleClass
(String htmlStyleClass) Adds a style class to the HTML body tagvoid
setJavaScript_onLoad
(String code) Adds a JavaScript onLoad function to the HTML body tagvoid
setJavaScript_onUnLoad
(String code) Adds a JavaScript onUnLoad function to the HTML body tagboolean
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
Returns the top margin.
-
Field Details
-
ITEXT_VERSION
This constant may only be changed by Paulo Soares and/or Bruno Lowagie.- See Also:
-
compress
public static boolean compressAllows the pdf documents to be produced without compression for debugging purposes. -
listeners
The DocListener. -
open
protected boolean openIs the document open or not? -
close
protected boolean closeHas the document already been closed? -
pageSize
The size of the page. -
marginLeft
protected float marginLeftmargin in x direction starting from the left -
marginRight
protected float marginRightmargin in x direction starting from the right -
marginTop
protected float marginTopmargin in y direction starting from the top -
marginBottom
protected float marginBottommargin in y direction starting from the bottom -
marginMirroring
protected boolean marginMirroring -
javaScript_onLoad
Content of JavaScript onLoad function -
javaScript_onUnLoad
Content of JavaScript onUnLoad function -
htmlStyleClass
Style class in HTML body tag -
pageN
protected int pageNCurrent pagenumber
-
-
Constructor Details
-
Document
public Document()Constructs a newDocument
-object. -
Document
Constructs a newDocument
-object.- Parameters:
pageSize
- the pageSize
-
Document
public Document(Rectangle pageSize, float marginLeft, float marginRight, float marginTop, float marginBottom) Constructs a newDocument
-object.- Parameters:
pageSize
- the pageSizemarginLeft
- the margin on the leftmarginRight
- the margin on the rightmarginTop
- the margin on the topmarginBottom
- the margin on the bottom
-
-
Method Details
-
addDocListener
Adds aDocListener
to theDocument
.- Parameters:
listener
- the new DocListener.
-
removeDocListener
Removes aDocListener
from theDocument
.- Parameters:
listener
- the DocListener that has to be removed.
-
add
Adds anElement
to theDocument
.- Specified by:
add
in interfaceElementListener
- Parameters:
element
- theElement
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
-
open
public void open()Opens the document.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.
- Specified by:
open
in interfaceDocListener
-
setPageSize
Sets the pagesize.- Specified by:
setPageSize
in interfaceDocListener
- Parameters:
pageSize
- the new pagesize- Returns:
- a
boolean
-
setMargins
public boolean setMargins(float marginLeft, float marginRight, float marginTop, float marginBottom) Sets the margins.- Specified by:
setMargins
in interfaceDocListener
- Parameters:
marginLeft
- the margin on the leftmarginRight
- the margin on the rightmarginTop
- the margin on the topmarginBottom
- the margin on the bottom- Returns:
- a
boolean
-
newPage
Signals that an new page has to be started.- Specified by:
newPage
in interfaceDocListener
- Returns:
true
if the page was added,false
if not.- Throws:
DocumentException
- when a document isn't open yet, or has been closed
-
resetPageCount
public void resetPageCount()Sets the page number to 0.- Specified by:
resetPageCount
in interfaceDocListener
-
setPageCount
public void setPageCount(int pageN) Sets the page number.- Specified by:
setPageCount
in interfaceDocListener
- Parameters:
pageN
- the new page number
-
getPageNumber
public int getPageNumber()Returns the current page number.- Returns:
- the current page number
-
close
public void close()Closes the document.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.
- Specified by:
close
in interfaceDocListener
-
addHeader
Adds a user defined header to the document.- Parameters:
name
- the name of the headercontent
- the content of the header- Returns:
true
if successful,false
otherwise
-
addTitle
Adds the title to a Document.- Parameters:
title
- the title- Returns:
true
if successful,false
otherwise
-
addSubject
Adds the subject to a Document.- Parameters:
subject
- the subject- Returns:
true
if successful,false
otherwise
-
addKeywords
Adds the keywords to a Document.- Parameters:
keywords
- adds the keywords to the document- Returns:
true
if successful,false
otherwise
-
addAuthor
Adds the author to a Document.- Parameters:
author
- the name of the author- Returns:
true
if successful,false
otherwise
-
addCreator
Adds the creator to a Document.- Parameters:
creator
- the name of the creator- Returns:
true
if successful,false
otherwise
-
addProducer
public boolean addProducer()Adds the producer to a Document.- Returns:
true
if successful,false
otherwise
-
addCreationDate
public boolean addCreationDate()Adds the current date and time to a Document.- Returns:
true
if successful,false
otherwise
-
leftMargin
public float leftMargin()Returns the left margin.- Returns:
- the left margin
-
rightMargin
public float rightMargin()Return the right margin.- Returns:
- the right margin
-
topMargin
public float topMargin()Returns the top margin.- Returns:
- the top margin
-
bottomMargin
public float bottomMargin()Returns the bottom margin.- Returns:
- the bottom margin
-
left
public float left()Returns the lower left x-coordinate.- Returns:
- the lower left x-coordinate
-
right
public float right()Returns the upper right x-coordinate.- Returns:
- the upper right x-coordinate
-
top
public float top()Returns the upper right y-coordinate.- Returns:
- the upper right y-coordinate
-
bottom
public float bottom()Returns the lower left y-coordinate.- Returns:
- the lower left y-coordinate
-
left
public float left(float margin) Returns the lower left x-coordinate considering a given margin.- Parameters:
margin
- a margin- Returns:
- the lower left x-coordinate
-
right
public float right(float margin) Returns the upper right x-coordinate, considering a given margin.- Parameters:
margin
- a margin- Returns:
- the upper right x-coordinate
-
top
public float top(float margin) Returns the upper right y-coordinate, considering a given margin.- Parameters:
margin
- a margin- Returns:
- the upper right y-coordinate
-
bottom
public float bottom(float margin) Returns the lower left y-coordinate, considering a given margin.- Parameters:
margin
- a margin- Returns:
- the lower left y-coordinate
-
getPageSize
Gets the pagesize.- Returns:
- the page size
-
isOpen
public boolean isOpen()Checks if the document is open.- Returns:
true
if the document is open
-
getVersion
Gets the iText version. This method may only be changed by Paulo Soares and/or Bruno Lowagie.- Returns:
- iText version
-
setJavaScript_onLoad
Adds a JavaScript onLoad function to the HTML body tag- Parameters:
code
- the JavaScript code to be executed on load of the HTML page
-
getJavaScript_onLoad
Gets the JavaScript onLoad command.- Returns:
- the JavaScript onLoad command
-
setJavaScript_onUnLoad
Adds a JavaScript onUnLoad function to the HTML body tag- Parameters:
code
- the JavaScript code to be executed on unload of the HTML page
-
getJavaScript_onUnLoad
Gets the JavaScript onUnLoad command.- Returns:
- the JavaScript onUnLoad command
-
setHtmlStyleClass
Adds a style class to the HTML body tag- Parameters:
htmlStyleClass
- the style class for the HTML body tag
-
getHtmlStyleClass
Gets the style class of the HTML body tag- Returns:
- the style class of the HTML body tag
-
clearTextWrap
Description copied from interface:DocListener
Clears text wrapping around images (if applicable). Method suggested by Pelikan Stephan- Specified by:
clearTextWrap
in interfaceDocListener
- Throws:
DocumentException
- See Also:
-
setMarginMirroring
public boolean setMarginMirroring(boolean marginMirroring) Set the margin mirroring. It will mirror margins for odd/even pages.Note: it will not work with
Table
.- Specified by:
setMarginMirroring
in interfaceDocListener
- Parameters:
marginMirroring
-true
to mirror the margins- Returns:
- always
true
-
isMarginMirroring
public boolean isMarginMirroring()Gets the margin mirroring flag.- Returns:
- the margin mirroring flag
-