org.conqat.lib.commons.html

Class HTMLWriter

java.lang.Object

org.conqat.lib.commons.xml.XMLWriter<EHTMLElement,EHTMLAttribute>

org.conqat.lib.commons.html.HTMLWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class HTMLWriter
extends XMLWriter<EHTMLElement,EHTMLAttribute>

This class is used for writing HTML.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HTMLWriter.HTMLResolver The resolver used for the HTMLWriter.

Field Summary

Fields inherited from class org.conqat.lib.commons.xml.XMLWriter

xmlResolver

Constructor Summary

Constructors

Constructor and Description
HTMLWriter(java.io.File file, CSSManagerBase cssManager) Creates a new writer for HTML documents.
HTMLWriter(java.io.OutputStream stream, CSSManagerBase cssManager) Creates a new writer for HTML documents.
HTMLWriter(java.io.PrintWriter writer, CSSManagerBase cssManager) Creates a new writer for HTML documents.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(EHTMLAttribute attribute, java.lang.Object value) Adds an attribute to the currently open element but checks in addition if the attribute may be added at all.
void	addExternalJavaScript(java.lang.String scriptFilePath) Inserts a script tag that loads JavaScript from a separate file.
void	addNonBreakingSpace() Inserts a non-breaking space.
void	addRawNewLine() Adds a line separator with closing and open tag (see XMLWriter.addNewLine().
void	addRawString(java.lang.String html) Adds the given text unprocessed to the writer.
void	addStdHeader() This adds a default header for HTML files consisting of the XML header and a DOCTYPE of the xhtml frameset DTD.
void	addStdHeader(java.lang.String encoding) This adds a default header for HTML files consisting of the XML header and a DOCTYPE of the xhtml frameset DTD.
void	insertEmptyElement(EHTMLElement element, java.lang.Object... attributes) Inserts an empty element but ensures that it is not closed using the shorthand syntax (e.g.

Methods inherited from class org.conqat.lib.commons.xml.XMLWriter

addCDataSection, addClosedElement, addClosedTextElement, addComment, addExternalAttribute, addHeader, addHTML5Doctype, addNewLine, addPublicDocTypeDefintion, addText, close, closeElement, escape, flush, getCurrentElement, getWriter, openElement, openElement, setSuppressLineBreaks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HTMLWriter

public HTMLWriter(java.io.File file,
                  CSSManagerBase cssManager)
           throws java.io.IOException

Creates a new writer for HTML documents.

Parameters:

file - the file to write to.

cssManager - the CSS manager used. If this is null, the class attributes may be filled with simple strings.

Throws:

java.io.IOException

HTMLWriter

public HTMLWriter(java.io.OutputStream stream,
                  CSSManagerBase cssManager)

Creates a new writer for HTML documents.

Parameters:

stream - the stream to print to.

cssManager - the CSS manager used. If this is null, the class attributes may be filled with simple strings.

HTMLWriter

public HTMLWriter(java.io.PrintWriter writer,
                  CSSManagerBase cssManager)

Creates a new writer for HTML documents.

Parameters:

writer - the writer to print to.

Method Detail

addStdHeader

public void addStdHeader(java.lang.String encoding)

This adds a default header for HTML files consisting of the XML header and a DOCTYPE of the xhtml frameset DTD.

XML version is set to "1.0", encoding provided by a parameter, and doc type definition to XHTML 1.0 Frameset.

addStdHeader

public void addStdHeader()

This adds a default header for HTML files consisting of the XML header and a DOCTYPE of the xhtml frameset DTD.

XML version is set to "1.0", encoding to "UTF-8", and doc type definition to XHTML 1.0 Frameset.

addRawString

public void addRawString(java.lang.String html)

Adds the given text unprocessed to the writer. This is useful for adding chunks of generated XML to avoid having the brackets escaped. Made this public here.

Overrides:

addRawString in class XMLWriter<EHTMLElement,EHTMLAttribute>

addRawNewLine

public void addRawNewLine()

Adds a line separator with closing and open tag (see XMLWriter.addNewLine().

addExternalJavaScript

public void addExternalJavaScript(java.lang.String scriptFilePath)

Inserts a script tag that loads JavaScript from a separate file.

insertEmptyElement

public void insertEmptyElement(EHTMLElement element,
                               java.lang.Object... attributes)

Inserts an empty element but ensures that it is not closed using the shorthand syntax (e.g. <div />). This is useful since some browsers choke on some shorthand elements, e.g. divs or JavaScript tags.

See Also:

#openElement(EHTMLElement, Object...)

addNonBreakingSpace

public void addNonBreakingSpace()

Inserts a non-breaking space.

addAttribute

public void addAttribute(EHTMLAttribute attribute,
                         java.lang.Object value)

Adds an attribute to the currently open element but checks in addition if the attribute may be added at all.

Overrides:

addAttribute in class XMLWriter<EHTMLElement,EHTMLAttribute>

Parameters:

attribute - the attribute to create

value - its value

Throws:

HTMLWriterException - if the attribute is not allowed for the current element.