com.lowagie.text.html
public class HtmlWriter extends DocWriter
DocWriter
class for HTML.
An HtmlWriter
can be added as a DocListener
to a certain Document
by getting an instance.
Every Element
added to the original Document
will be written to the OutputStream
of this HtmlWriter
.
Example:
// creation of the document with a certain size and certain margins Document document = new Document(PageSize.A4, 50, 50, 50, 50); try { // this will write HTML to the Standard OutputStream HtmlWriter.getInstance(document, System.out); // this will write HTML to a file called text.html HtmlWriter.getInstance(document, new FileOutputStream("text.html")); // this will write HTML to for instance the OutputStream of a HttpServletResponse-object HtmlWriter.getInstance(document, response.getOutputStream()); } catch(DocumentException de) { System.err.println(de.getMessage()); } // this will close the document and all the OutputStreams listening to it document.close();
Field Summary | |
---|---|
static byte[] | BEGINCOMMENT This is a possible HTML-tag. |
protected Stack | currentfont This is the current font of the HTML. |
static byte[] | ENDCOMMENT This is a possible HTML-tag. |
protected HeaderFooter | footer This is the textual part of the footer |
protected HeaderFooter | header This is the textual part of a header |
protected String | imagepath This is a path for images. |
protected Properties | markup Store the markup properties of a MarkedObject. |
static String | NBSP This is a possible HTML-tag. |
protected int | pageN Stores the page number. |
protected Font | standardfont This is the standard font of the HTML. |
Constructor Summary | |
---|---|
protected | HtmlWriter(Document doc, OutputStream os)
Constructs a HtmlWriter .
|
Method Summary | |
---|---|
boolean | add(Element element)
Signals that an Element was added to the Document .
|
boolean | add(String string)
Signals that a String was added to the Document .
|
void | close()
Signals that the Document was closed and that no other
Elements will be added. |
static HtmlWriter | getInstance(Document document, OutputStream os)
Gets an instance of the HtmlWriter .
|
protected void | initFooter()
Adds the header to the top of the Document |
protected void | initHeader()
Adds the header to the top of the Document |
boolean | isOtherFont(Font font)
Checks if a given font is the same as the font that was last used.
|
boolean | newPage()
Signals that an new page has to be started.
|
void | open()
Signals that the Document has been opened and that
Elements can be added.
|
void | resetImagepath()
Resets the imagepath. |
void | setFooter(HeaderFooter footer)
Changes the footer of this document.
|
void | setHeader(HeaderFooter header)
Changes the header of this document.
|
void | setImagepath(String imagepath)
Sets the basepath for images.
|
void | setStandardFont(Font standardfont)
Changes the standardfont.
|
protected void | write(Element element, int indent)
Writes the HTML representation of an element.
|
protected void | write(Font font, Properties styleAttributes)
Writes the representation of a Font .
|
protected void | writeComment(String comment)
Writes some comment.
|
protected void | writeCssProperty(String prop, String value)
Writes out a CSS property. |
protected void | writeHeader(Meta meta)
Writes a Metatag in the header.
|
protected void | writeJavaScript(Header header)
Writes a JavaScript section or, if the markup attribute HtmlTags.URL is set, a JavaScript reference in the header.
|
protected void | writeLink(Header header)
Writes a link in the header.
|
protected void | writeSection(Section section, int indent)
Writes the HTML representation of a section.
|
HtmlWriter
.
Parameters: doc The Document
that has to be written as HTML os The OutputStream
the writer has to write to.
Element
was added to the Document
.
Parameters: element a high level object that has to be translated to HTML
Returns: true
if the element was added, false
if not.
Throws: DocumentException when a document isn't open yet, or has been closed
String
was added to the Document
.
Parameters: string a String to add to the HTML
Returns: true
if the string was added, false
if not.
Throws: DocumentException when a document isn't open yet, or has been closed
Document
was closed and that no other
Elements
will be added.HtmlWriter
.
Parameters: document The Document
that has to be written os The OutputStream
the writer has to write to.
Returns: a new HtmlWriter
Parameters: font the font of an object
Returns: true if the font differs
Returns: true
if this action succeeded, false
if not.
Throws: DocumentException when a document isn't open yet, or has been closed
Document
has been opened and that
Elements
can be added.
The HEAD
-section of the HTML-document is written.
Parameters: footer the new footer
Parameters: header the new header
This is especially useful if you add images using a file, rather than an URL. In PDF there is no problem, since the images are added inline, but in HTML it is sometimes necessary to use a relative path or a special path to some images directory.
Parameters: imagepath the new imagepath
Parameters: standardfont The font
Parameters: element the element indent the indentation
Throws: IOException
Font
.
Parameters: font a Font
styleAttributes the style of the font
Throws: IOException
This method writes some comment.
Parameters: comment the comment that has to be written
Throws: IOException
Parameters: prop a CSS property value the value of the CSS property
Throws: IOException
Parameters: meta the element that has to be written
Throws: IOException
Parameters: header the element that has to be written
Throws: IOException
Parameters: header the element that has to be written
Throws: IOException
Parameters: section the section to write indent the indentation
Throws: IOException