com.lowagie.text.html
Class HtmlWriter

java.lang.Object
  extended bycom.lowagie.text.DocWriter
      extended bycom.lowagie.text.html.HtmlWriter
All Implemented Interfaces:
DocListener, ElementListener, EventListener

public class HtmlWriter
extends DocWriter

A 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.
static byte[] ENDCOMMENT
          This is a possible HTML-tag.
static String NBSP
          This is a possible HTML-tag.
 
Fields inherited from class com.lowagie.text.DocWriter
EQUALS, FORWARD, GT, LT, NEWLINE, QUOTE, SPACE, TAB
 
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.
 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.
 
Methods inherited from class com.lowagie.text.DocWriter
flush, getISOBytes, isCloseStream, isPaused, pause, resetFooter, resetHeader, resetPageCount, resume, setCloseStream, setMarginMirroring, setMargins, setPageCount, setPageSize
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BEGINCOMMENT

public static final byte[] BEGINCOMMENT
This is a possible HTML-tag.


ENDCOMMENT

public static final byte[] ENDCOMMENT
This is a possible HTML-tag.


NBSP

public static final String NBSP
This is a possible HTML-tag.

See Also:
Constant Field Values
Method Detail

getInstance

public static HtmlWriter getInstance(Document document,
                                     OutputStream os)
Gets an instance of the HtmlWriter.

Parameters:
document - The Document that has to be written
os - The OutputStream the writer has to write to.
Returns:
a new HtmlWriter

newPage

public boolean newPage()
Signals that an new page has to be started.

Specified by:
newPage in interface DocListener
Overrides:
newPage in class DocWriter
Returns:
true if this action succeeded, false if not.

add

public boolean add(Element element)
            throws DocumentException
Signals that an Element was added to the Document.

Specified by:
add in interface ElementListener
Overrides:
add in class DocWriter
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

open

public void open()
Signals that the Document has been opened and that Elements can be added.

The HEAD-section of the HTML-document is written.

Specified by:
open in interface DocListener
Overrides:
open in class DocWriter

close

public void close()
Signals that the Document was closed and that no other Elements will be added.

Specified by:
close in interface DocListener
Overrides:
close in class DocWriter

setStandardFont

public void setStandardFont(Font standardfont)
Changes the standardfont.

Parameters:
standardfont - The font

isOtherFont

public boolean isOtherFont(Font font)
Checks if a given font is the same as the font that was last used.

Parameters:
font - the font of an object
Returns:
true if the font differs

setImagepath

public void setImagepath(String imagepath)
Sets the basepath for images.

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

resetImagepath

public void resetImagepath()
Resets the imagepath.


setHeader

public void setHeader(HeaderFooter header)
Changes the header of this document.

Specified by:
setHeader in interface DocListener
Overrides:
setHeader in class DocWriter
Parameters:
header - the new header

setFooter

public void setFooter(HeaderFooter footer)
Changes the footer of this document.

Specified by:
setFooter in interface DocListener
Overrides:
setFooter in class DocWriter
Parameters:
footer - the new footer

add

public boolean add(String string)
Signals that a 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.


Copyright © 2011 EGIZ - E-Government Innovation Center. All Rights Reserved.