com.lowagie.text.html.simpleparser

Class HTMLWorker

java.lang.Object

com.lowagie.text.html.simpleparser.HTMLWorker

All Implemented Interfaces:

DocListener, ElementListener, SimpleXMLDocHandler, EventListener

public class HTMLWorker
extends Object
implements SimpleXMLDocHandler, DocListener

Field Summary

Fields

Modifier and Type	Field and Description
protected DocListener	document
protected ArrayList<Element>	objectList
static Map<String,Object>	tagsSupported
static String	tagsSupportedString

Constructor Summary

Constructors

Constructor and Description
HTMLWorker(DocListener document) Creates a new instance of HTMLWorker

Method Summary

Modifier and Type	Method and Description
boolean	add(Element element) Signals that an Element was added to the Document.
void	clearTextWrap()
void	close() Signals that the Document was closed and that no other Elements will be added.
void	endDocument() Called after the document is parsed.
void	endElement(String tag) Called when an end tag is found.
Map<String,Object>	getInterfaceProps()
StyleSheet	getStyleSheet()
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	parse(Reader reader)
static ArrayList<Element>	parseToList(Reader reader, StyleSheet style)
static ArrayList<Element>	parseToList(Reader reader, StyleSheet style, HashMap interfaceProps) Deprecated. use parseToList(Reader, StyleSheet, Map) since 1.2.22
static ArrayList<Element>	parseToList(Reader reader, StyleSheet style, Map<String,Object> interfaceProps)
void	resetFooter() Resets the footer of this document.
void	resetHeader() Resets the header of this document.
void	resetPageCount() Sets the page number to 0.
void	setFooter(HeaderFooter footer) Changes the footer of this document.
void	setHeader(HeaderFooter header) Changes the header of this document.
void	setInterfaceProps(HashMap interfaceProps) Deprecated. use HTMLWorker#setInterfaceProps(Map) since 1.2.22
void	setInterfaceProps(Map<String,Object> interfaceProps)
boolean	setMarginMirroring(boolean marginMirroring) Parameter that allows you to do left/right margin mirroring (odd/even pages)
boolean	setMarginMirroringTopBottom(boolean marginMirroring) Parameter that allows you to do top/bottom margin mirroring (odd/even pages)
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.
void	setStyleSheet(StyleSheet style)
void	startDocument() Called when the document starts to be parsed.
void	startElement(String tag, HashMap h) Deprecated. use HTMLWorker#startElement(String, Map) } since 1.2.22
void	startElement(String tag, Map<String,String> style) Called when a start tag is found.
void	text(String str) Called when a text element is found.

Methods inherited from class java.lang.Object

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

Field Detail

tagsSupportedString

public static final String tagsSupportedString

See Also:

Constant Field Values

tagsSupported

public static final Map<String,Object> tagsSupported

objectList

protected ArrayList<Element> objectList

document

protected DocListener document

Constructor Detail

HTMLWorker

public HTMLWorker(DocListener document)

Creates a new instance of HTMLWorker

Parameters:

document - A class that implements DocListener

Method Detail

parseToList

public static ArrayList<Element> parseToList(Reader reader,
                                             StyleSheet style)
                                      throws IOException

Throws:

IOException

parseToList

@Deprecated
public static ArrayList<Element> parseToList(Reader reader,
                                                          @Nullable
                                                          StyleSheet style,
                                                          HashMap interfaceProps)
                                                   throws IOException

Deprecated. use parseToList(Reader, StyleSheet, Map) since 1.2.22

Throws:

IOException

parseToList

public static ArrayList<Element> parseToList(Reader reader,
                                             @Nullable
                                             StyleSheet style,
                                             Map<String,Object> interfaceProps)
                                      throws IOException

Throws:

IOException

getStyleSheet

public StyleSheet getStyleSheet()

setStyleSheet

public void setStyleSheet(StyleSheet style)

getInterfaceProps

public Map<String,Object> getInterfaceProps()

setInterfaceProps

@Deprecated
public void setInterfaceProps(HashMap interfaceProps)

Deprecated. use HTMLWorker#setInterfaceProps(Map) since 1.2.22

setInterfaceProps

public void setInterfaceProps(Map<String,Object> interfaceProps)

parse

public void parse(Reader reader)
           throws IOException

Throws:

IOException

endDocument

public void endDocument()

Description copied from interface: SimpleXMLDocHandler

Called after the document is parsed.

Specified by:

endDocument in interface SimpleXMLDocHandler

startDocument

public void startDocument()

Description copied from interface: SimpleXMLDocHandler

Called when the document starts to be parsed.

Specified by:

startDocument in interface SimpleXMLDocHandler

startElement

@Deprecated
public void startElement(String tag,
                                      HashMap h)

Deprecated. use HTMLWorker#startElement(String, Map) } since 1.2.22

Description copied from interface: SimpleXMLDocHandler

Called when a start tag is found.

Specified by:

startElement in interface SimpleXMLDocHandler

Parameters:

tag - the tag name

h - the tag's attributes

startElement

public void startElement(String tag,
                         Map<String,String> style)

Description copied from interface: SimpleXMLDocHandler

Called when a start tag is found.

Specified by:

startElement in interface SimpleXMLDocHandler

Parameters:

tag - the tag name

style - the tag's attributes

endElement

public void endElement(String tag)

Description copied from interface: SimpleXMLDocHandler

Called when an end tag is found.

Specified by:

endElement in interface SimpleXMLDocHandler

Parameters:

tag - the tag name

text

public void text(String str)

Description copied from interface: SimpleXMLDocHandler

Called when a text element is found.

Specified by:

text in interface SimpleXMLDocHandler

Parameters:

str - the text element, probably a fragment.

add

public boolean add(Element element)
            throws DocumentException

Description copied from interface: ElementListener

Signals that an Element was added to the Document.

Specified by:

add in interface ElementListener

Parameters:

element - a high level object

Returns:

true if the element was added, false if not.

Throws:

DocumentException - when a document isn't open yet, or has been closed

clearTextWrap

public void clearTextWrap()
                   throws DocumentException

Throws:

DocumentException

close

public void close()

Description copied from interface: DocListener

Signals that the Document was closed and that no other Elements will be added.

The outputstream of every writer implementing DocListener will be closed.

Specified by:

close in interface DocListener

newPage

public boolean newPage()

Description copied from interface: DocListener

Signals that an new page has to be started.

Specified by:

newPage in interface DocListener

Returns:

true if the page was added, false if not.

open

public void open()

Description copied from interface: DocListener

Signals that the Document has been opened and that Elements can be added.

Specified by:

open in interface DocListener

resetFooter

public void resetFooter()

Description copied from interface: DocListener

Resets the footer of this document.

Specified by:

resetFooter in interface DocListener

resetHeader

public void resetHeader()

Description copied from interface: DocListener

Resets the header of this document.

Specified by:

resetHeader in interface DocListener

resetPageCount

public void resetPageCount()

Description copied from interface: DocListener

Sets the page number to 0.

Specified by:

resetPageCount in interface DocListener

setFooter

public void setFooter(HeaderFooter footer)

Description copied from interface: DocListener

Changes the footer of this document.

Specified by:

setFooter in interface DocListener

Parameters:

footer - the new footer

setHeader

public void setHeader(HeaderFooter header)

Description copied from interface: DocListener

Changes the header of this document.

Specified by:

setHeader in interface DocListener

Parameters:

header - the new header

setMarginMirroring

public boolean setMarginMirroring(boolean marginMirroring)

Description copied from interface: DocListener

Parameter that allows you to do left/right margin mirroring (odd/even pages)

Specified by:

setMarginMirroring in interface DocListener

Returns:

true if successful

setMarginMirroringTopBottom

public boolean setMarginMirroringTopBottom(boolean marginMirroring)

Description copied from interface: DocListener

Parameter that allows you to do top/bottom margin mirroring (odd/even pages)

Specified by:

setMarginMirroringTopBottom in interface DocListener

Returns:

true if successful

Since:

2.1.6

See Also:

DocListener.setMarginMirroring(boolean)

setMargins

public boolean setMargins(float marginLeft,
                          float marginRight,
                          float marginTop,
                          float marginBottom)

Description copied from interface: DocListener

Sets the margins.

Specified by:

setMargins in interface DocListener

Parameters:

marginLeft - the margin on the left

marginRight - the margin on the right

marginTop - the margin on the top

marginBottom - the margin on the bottom

Returns:

a boolean

setPageCount

public void setPageCount(int pageN)

Description copied from interface: DocListener

Sets the page number.

Specified by:

setPageCount in interface DocListener

Parameters:

pageN - the new page number

setPageSize

public boolean setPageSize(Rectangle pageSize)

Description copied from interface: DocListener

Sets the pagesize.

Specified by:

setPageSize in interface DocListener

Parameters:

pageSize - the new pagesize

Returns:

a boolean