- All Implemented Interfaces:
DocListener,ElementListener,AutoCloseable,EventListener
- Direct Known Subclasses:
PdfDocument
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.
- After 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 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 intDeprecated.This is a chapter number in case ChapterAutoNumber is used.protected booleanDeprecated.Has the document already been closed?static booleanDeprecated.Allows the pdf documents to be produced without compression for debugging purposes.protected HeaderFooterDeprecated.This is the textual part of the footerprotected HeaderFooterDeprecated.This is the textual part of a Page; it can contain a headerprotected StringDeprecated.Style class in HTML body tagprotected StringDeprecated.Content of JavaScript onLoad functionprotected StringDeprecated.Content of JavaScript onUnLoad functionprotected floatDeprecated.margin in y direction starting from the bottomprotected floatDeprecated.margin in x direction starting from the leftprotected booleanDeprecated.mirroring of the left/right marginsprotected booleanDeprecated.mirroring of the top/bottom marginsprotected floatDeprecated.margin in x direction starting from the rightprotected floatDeprecated.margin in y direction starting from the topprotected booleanDeprecated.Is the document open or not?protected intDeprecated.Current pagenumberprotected RectangleDeprecated.The size of the page.static booleanDeprecated.When true the file access is not done through a memory mapped file.static floatDeprecated.Scales the WMF font size. -
Constructor Summary
ConstructorsConstructorDescriptionDocument()Deprecated.Constructs a newDocument-object with the default page size asPageSize.A4.Deprecated.Constructs a newDocument-object using the given rectangle as page size and default margin of 36.Document(Rectangle pageSize, float marginLeft, float marginRight, float marginTop, float marginBottom) Deprecated.Constructs a newDocument-object. -
Method Summary
Modifier and TypeMethodDescriptionbooleanDeprecated.Adds anElementto theDocument.booleanDeprecated.Adds the author to a Document.booleanDeprecated.Adds the current date and time to a Document.booleanaddCreationDate(PdfDate date) Deprecated.Adds the current date and time to a Document.booleanaddCreator(String creator) Deprecated.Adds the creator to a Document.voidaddDocListener(DocListener listener) Deprecated.Adds aDocListenerto theDocument.booleanDeprecated.Adds a user defined header to the document.booleanaddKeywords(String keywords) Deprecated.Adds the keywords to a Document.booleanDeprecated.Adds the current date and time to a Document.booleanaddModificationDate(PdfDate date) Deprecated.Adds the current date and time to a Document.booleanDeprecated.Adds the producer to a Document.booleanaddProducer(String producer) Deprecated.Adds the provided value as the producer to a Document.booleanaddSubject(String subject) Deprecated.Adds the subject to a Document.booleanDeprecated.Adds the title to a Document.floatbottom()Deprecated.Returns the lower left y-coordinate.floatbottom(float margin) Deprecated.Returns the lower left y-coordinate, considering a given margin.floatDeprecated.Returns the bottom margin.voidclose()Deprecated.Closes the document.Deprecated.The default language of the document.Deprecated.Gets the style class of the HTML body tagDeprecated.Gets the JavaScript onLoad command.Deprecated.Gets the JavaScript onUnLoad command.intDeprecated.Returns the current page number.Deprecated.Gets the pagesize.static StringDeprecated.Gets the product name.static StringDeprecated.Gets the release number.Deprecated.Gets the text rendering options.static StringDeprecated.Gets the iText version.booleanDeprecated.Returns the glyph substitution enabled flag.booleanDeprecated.Gets the margin mirroring flag.booleanisOpen()Deprecated.Checks if the document is open.floatleft()Deprecated.Returns the lower left x-coordinate.floatleft(float margin) Deprecated.Returns the lower left x-coordinate considering a given margin.floatDeprecated.Returns the left margin.booleannewPage()Deprecated.Signals to all listeners, that a new page has to be started.voidopen()Deprecated.Opens the document.voidremoveDocListener(DocListener listener) Deprecated.Removes aDocListenerfrom theDocument.voidDeprecated.Resets the footer of this document.voidDeprecated.Resets the header of this document.voidDeprecated.Sets the page number to 0.floatright()Deprecated.Returns the upper right x-coordinate.floatright(float margin) Deprecated.Returns the upper right x-coordinate, considering a given margin.floatDeprecated.Return the right margin.voidsetDocumentLanguage(String documentLanguage) Deprecated.The new document language.voidsetFooter(HeaderFooter footer) Deprecated.Changes the footer of this document.voidsetGlyphSubstitutionEnabled(boolean glyphSubstitutionEnabled) Deprecated.Set a flag that determine whether glyph substion is enabled when FOP is available.voidsetHeader(HeaderFooter header) Deprecated.Changes the header of this document.voidsetHtmlStyleClass(String htmlStyleClass) Deprecated.Adds a style class to the HTML body tagvoidsetJavaScript_onLoad(String code) Deprecated.Adds a JavaScript onLoad function to the HTML body tagvoidsetJavaScript_onUnLoad(String code) Deprecated.Adds a JavaScript onUnLoad function to the HTML body tagbooleansetMarginMirroring(boolean marginMirroring) Deprecated.Set the margin mirroring.booleansetMarginMirroringTopBottom(boolean marginMirroringTopBottom) Deprecated.Set the margin mirroring.booleansetMargins(float marginLeft, float marginRight, float marginTop, float marginBottom) Deprecated.Sets the margins.voidsetPageCount(int pageN) Deprecated.Sets the page number.booleansetPageSize(Rectangle pageSize) Deprecated.Sets the pagesize.voidsetTextRenderingOptions(TextRenderingOptions textRenderingOptions) Deprecated.Sets the text rendering options.floattop()Deprecated.Returns the upper right y-coordinate.floattop(float margin) Deprecated.Returns the upper right y-coordinate, considering a given margin.floatDeprecated.Returns the top margin.
-
Field Details
-
compress
public static boolean compressDeprecated.Allows the pdf documents to be produced without compression for debugging purposes. -
plainRandomAccess
public static boolean plainRandomAccessDeprecated.When true the file access is not done through a memory mapped file. Use it if the file is too big to be mapped in your address space. -
wmfFontCorrection
public static float wmfFontCorrectionDeprecated.Scales the WMF font size. The default value is 0.86. -
open
protected boolean openDeprecated.Is the document open or not? -
close
protected boolean closeDeprecated.Has the document already been closed? -
pageSize
Deprecated.The size of the page. -
marginLeft
protected float marginLeftDeprecated.margin in x direction starting from the left -
marginRight
protected float marginRightDeprecated.margin in x direction starting from the right -
marginTop
protected float marginTopDeprecated.margin in y direction starting from the top -
marginBottom
protected float marginBottomDeprecated.margin in y direction starting from the bottom -
marginMirroring
protected boolean marginMirroringDeprecated.mirroring of the left/right margins -
marginMirroringTopBottom
protected boolean marginMirroringTopBottomDeprecated.mirroring of the top/bottom margins- Since:
- 2.1.6
-
javaScript_onLoad
Deprecated.Content of JavaScript onLoad function -
javaScript_onUnLoad
Deprecated.Content of JavaScript onUnLoad function -
htmlStyleClass
Deprecated.Style class in HTML body tag -
pageN
protected int pageNDeprecated.Current pagenumber -
header
Deprecated.This is the textual part of a Page; it can contain a header -
chapternumber
protected int chapternumberDeprecated.This is a chapter number in case ChapterAutoNumber is used.
-
-
Constructor Details
-
Document
public Document()Deprecated.Constructs a newDocument-object with the default page size asPageSize.A4. -
Document
Deprecated.Constructs a newDocument-object using the given rectangle as page size and default margin of 36.- Parameters:
pageSize- the pageSize
-
Document
public Document(Rectangle pageSize, float marginLeft, float marginRight, float marginTop, float marginBottom) Deprecated.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
-
getProduct
Deprecated.Gets the product name.- Returns:
- the product name
- Since:
- 2.1.6
-
getRelease
Deprecated.Gets the release number.- Returns:
- the product name
- Since:
- 2.1.6
-
getVersion
Deprecated.Gets the iText version.- Returns:
- iText version
-
addDocListener
Deprecated.Adds aDocListenerto theDocument.- Parameters:
listener- the new DocListener.
-
removeDocListener
Deprecated.Removes aDocListenerfrom theDocument.- Parameters:
listener- the DocListener that has to be removed.
-
add
Deprecated.Adds anElementto theDocument.- Specified by:
addin interfaceElementListener- Parameters:
element- theElementto add- Returns:
trueif the element was added,falseif not- Throws:
DocumentException- when a document isn't open yet, or has been closed
-
open
public void open()Deprecated.Opens the document.Once the document is opened, you can't write any meta-information anymore. If you change the header/footer after opening the document, the change will be effective starting from the second page. You have to open the document before you can begin to add content to the body of the document.
- Specified by:
openin interfaceDocListener
-
setPageSize
Deprecated.Sets the pagesize.This change will be effective starting from the next page. If you want to change the page size of the first page, you need to set it before opening the document.
- Specified by:
setPageSizein interfaceDocListener- Parameters:
pageSize- the new pagesize- Returns:
- a
boolean
-
setMargins
public boolean setMargins(float marginLeft, float marginRight, float marginTop, float marginBottom) Deprecated.Sets the margins.This change will be effective starting from the next page. If you want to change margins on the first page, you need to set it before opening the document.
A new page is created when you call:
- Document.open()
- Document.newPage(), only if the current page has some content, otherwise no new page will be created
- Specified by:
setMarginsin 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
public boolean newPage()Deprecated.Signals to all listeners, that a new page has to be started. New pages can only be added on already opened and not yet closed documents.- Specified by:
newPagein interfaceDocListener- Returns:
trueif the page was added,falseif not.
-
resetHeader
public void resetHeader()Deprecated.Resets the header of this document.This change will be effective starting from the next page.
- Specified by:
resetHeaderin interfaceDocListener
-
resetPageCount
public void resetPageCount()Deprecated.Sets the page number to 0.This change will be effective starting from the next page.
- Specified by:
resetPageCountin interfaceDocListener
-
setPageCount
public void setPageCount(int pageN) Deprecated.Sets the page number.This change will be effective starting from the next page.
The page number of the next new page will be:
pageN + 1- Specified by:
setPageCountin interfaceDocListener- Parameters:
pageN- the new page number
-
getPageNumber
public int getPageNumber()Deprecated.Returns the current page number.- Returns:
- the current page number
-
close
public void close()Deprecated.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:
closein interfaceAutoCloseable- Specified by:
closein interfaceDocListener
-
addHeader
Deprecated.Adds a user defined header to the document. Shortcut method to call:add(new Header(name, content))- Parameters:
name- the name of the headercontent- the content of the header- Returns:
trueif successful,falseotherwise
-
addTitle
Deprecated.Adds the title to a Document. In case of a PDF this will be visible in the document properties panel. In case of a HTML file this will be visible as thetitlemetatag in theHEADpart of the file. Shortcut method to call:add(new Meta(Element.TITLE, title))- Parameters:
title- the title- Returns:
trueif successful,falseotherwise
-
addSubject
Deprecated.Adds the subject to a Document. In case of a PDF this will be visible in the document properties panel. In case of a HTML file this will be visible as thesubjectmetatag in theHEADpart of the file.- Parameters:
subject- the subject- Returns:
trueif successful,falseotherwise
-
addKeywords
Deprecated.Adds the keywords to a Document. In case of a PDF this will be visible in the document properties panel. In case of a HTML file this will be visible as thekeywordsmetatag in theHEADpart of the file.- Parameters:
keywords- adds the keywords to the document- Returns:
trueif successful,falseotherwise
-
addAuthor
Deprecated.Adds the author to a Document. In case of a PDF this will be visible in the document properties panel. In case of a HTML file this will be visible as theauthormetatag in theHEADpart of the file.- Parameters:
author- the name of the author- Returns:
trueif successful,falseotherwise
-
addCreator
Deprecated.Adds the creator to a Document. In case of a PDF this will be visible in the document properties panel. In case of a HTML file this will be visible as comment in theHEADpart of the file.- Parameters:
creator- the name of the creator- Returns:
trueif successful,falseotherwise
-
addProducer
public boolean addProducer()Deprecated.Adds the producer to a Document. In case of a PDF this will be visible in the document properties panel. In case of a HTML file this will be visible as comment in theHEADpart of the file.- Returns:
trueif successful,falseotherwise
-
addProducer
Deprecated.Adds the provided value as the producer to a Document. The default producer isOpenPDF XX.YY.ZZwhereXX.YY.ZZis the version of the OpenPDF library used to produce the document In case of a PDF this will be visible in the document properties panel. In case of a HTML file this will be visible as comment in theHEADpart of the file.- Parameters:
producer- new producer line value- Returns:
trueif successful,falseotherwise
-
addCreationDate
public boolean addCreationDate()Deprecated.Adds the current date and time to a Document. In case of a PDF this will be visible in the document properties panel. In case of a HTML file this will be visible as comment in theHEADpart of the file.- Returns:
trueif successful,falseotherwise
-
addCreationDate
Deprecated.Adds the current date and time to a Document.- Returns:
trueif successful,falseotherwise
-
addModificationDate
public boolean addModificationDate()Deprecated.Adds the current date and time to a Document.- Returns:
trueif successful,falseotherwise
-
addModificationDate
Deprecated.Adds the current date and time to a Document.- Returns:
trueif successful,falseotherwise
-
leftMargin
public float leftMargin()Deprecated.Returns the left margin.- Returns:
- the left margin
-
rightMargin
public float rightMargin()Deprecated.Return the right margin.- Returns:
- the right margin
-
topMargin
public float topMargin()Deprecated.Returns the top margin.- Returns:
- the top margin
-
bottomMargin
public float bottomMargin()Deprecated.Returns the bottom margin.- Returns:
- the bottom margin
-
left
public float left()Deprecated.Returns the lower left x-coordinate.- Returns:
- the lower left x-coordinate
-
right
public float right()Deprecated.Returns the upper right x-coordinate.- Returns:
- the upper right x-coordinate
-
top
public float top()Deprecated.Returns the upper right y-coordinate.- Returns:
- the upper right y-coordinate
-
bottom
public float bottom()Deprecated.Returns the lower left y-coordinate.- Returns:
- the lower left y-coordinate
-
left
public float left(float margin) Deprecated.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) Deprecated.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) Deprecated.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) Deprecated.Returns the lower left y-coordinate, considering a given margin.- Parameters:
margin- a margin- Returns:
- the lower left y-coordinate
-
getPageSize
Deprecated.Gets the pagesize.- Returns:
- the page size
-
isOpen
public boolean isOpen()Deprecated.Checks if the document is open.- Returns:
trueif the document is open
-
getJavaScript_onLoad
Deprecated.Gets the JavaScript onLoad command.- Returns:
- the JavaScript onLoad command
-
setJavaScript_onLoad
Deprecated.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_onUnLoad
Deprecated.Gets the JavaScript onUnLoad command.- Returns:
- the JavaScript onUnLoad command
-
setJavaScript_onUnLoad
Deprecated.Adds a JavaScript onUnLoad function to the HTML body tag- Parameters:
code- the JavaScript code to be executed on unload of the HTML page
-
getHtmlStyleClass
Deprecated.Gets the style class of the HTML body tag- Returns:
- the style class of the HTML body tag
-
setHtmlStyleClass
Deprecated.Adds a style class to the HTML body tag- Parameters:
htmlStyleClass- the style class for the HTML body tag
-
setMarginMirroring
public boolean setMarginMirroring(boolean marginMirroring) Deprecated.Set the margin mirroring. It will mirror right/left margins for odd/even pages.Note: it will not work with
Table.- Specified by:
setMarginMirroringin interfaceDocListener- Parameters:
marginMirroring-trueto mirror the margins- Returns:
- always
true
-
setMarginMirroringTopBottom
public boolean setMarginMirroringTopBottom(boolean marginMirroringTopBottom) Deprecated.Set the margin mirroring. It will mirror top/bottom margins for odd/even pages.Note: it will not work with
Table.- Specified by:
setMarginMirroringTopBottomin interfaceDocListener- Parameters:
marginMirroringTopBottom-trueto mirror the margins- Returns:
- always
true - Since:
- 2.1.6
-
isMarginMirroring
public boolean isMarginMirroring()Deprecated.Gets the margin mirroring flag.- Returns:
- the margin mirroring flag
-
getDocumentLanguage
Deprecated.The default language of the document. Can be set to values like "en_US". This language is used in FopGlyphProcessor to determine which glyphs are to be substituted. The default "dflt" means that all glyphs which can be replaced will be substituted.- Returns:
- the current document language
-
setDocumentLanguage
Deprecated.The new document language. This language is used in FopGlyphProcessor to determine which glyphs are to be substituted. The default "dflt" means that all glyphs which can be replaced will be substituted.- Parameters:
documentLanguage- the wanted language
-
isGlyphSubstitutionEnabled
public boolean isGlyphSubstitutionEnabled()Deprecated.Returns the glyph substitution enabled flag.- Returns:
- the glyph substitution enabled flag
- See Also:
-
setGlyphSubstitutionEnabled
public void setGlyphSubstitutionEnabled(boolean glyphSubstitutionEnabled) Deprecated.Set a flag that determine whether glyph substion is enabled when FOP is available.- Parameters:
glyphSubstitutionEnabled- the glyph substitution enabled flag- See Also:
-
getTextRenderingOptions
Deprecated.Gets the text rendering options.- Returns:
- the text rendering options
- See Also:
-
setTextRenderingOptions
Deprecated.Sets the text rendering options.- Parameters:
textRenderingOptions- the text rendering options- See Also:
-