Class HTMLWorker
- java.lang.Object
-
- com.itextpdf.text.html.simpleparser.HTMLWorker
-
- All Implemented Interfaces:
DocListener
,ElementListener
,SimpleXMLDocHandler
,java.util.EventListener
@Deprecated public class HTMLWorker extends java.lang.Object implements SimpleXMLDocHandler, DocListener
Deprecated.since 5.5.2; please switch to XML Worker instead (this is a separate project)Old iText class that allows you to convert HTML to PDF. We've completely rewritten HTML to PDF conversion and we made it a separate project named XML Worker.
-
-
Field Summary
Fields Modifier and Type Field Description private ChainedProperties
chain
Deprecated.The current hierarchy chain of tags.protected Paragraph
currentParagraph
Deprecated.Keeps the content of the current paragraphprotected DocListener
document
Deprecated.DocListener that will listen to the Elements produced by parsing the HTML.private ElementFactory
factory
Deprecated.Factory that is able to create iText Element objects.static java.lang.String
FONT_PROVIDER
Deprecated.Key used to store the font provider in the providers map.static java.lang.String
IMG_BASEURL
Deprecated.Key used to store the image baseurl provider in the providers map.static java.lang.String
IMG_PROCESSOR
Deprecated.Key used to store the image processor in the providers map.static java.lang.String
IMG_PROVIDER
Deprecated.Key used to store the image provider in the providers map.static java.lang.String
IMG_STORE
Deprecated.Key used to store the image store in the providers map.private boolean
insidePRE
Deprecated.Boolean to keep track of PRE tagsstatic java.lang.String
LINK_PROVIDER
Deprecated.Key used to store the link provider in the providers map.private static Logger
LOGGER
Deprecated.protected java.util.List<Element>
objectList
Deprecated.The resulting list of elements.private boolean
pendingLI
Deprecated.Boolean to keep track of LI tagsprivate boolean
pendingTD
Deprecated.Boolean to keep track of TD and TH tagsprivate boolean
pendingTR
Deprecated.Boolean to keep track of TR tags.private java.util.Map<java.lang.String,java.lang.Object>
providers
Deprecated.Map containing providers such as a FontProvider or ImageProvider.protected boolean
skipText
Deprecated.Indicates if text needs to be skipped.protected java.util.Stack<Element>
stack
Deprecated.Stack with the Elements that already have been processed.private StyleSheet
style
Deprecated.The object defining all the styles.private java.util.Stack<boolean[]>
tableState
Deprecated.Stack to keep track of table tags.protected java.util.Map<java.lang.String,HTMLTagProcessor>
tags
Deprecated.The map with all the supported tags.
-
Constructor Summary
Constructors Constructor Description HTMLWorker(DocListener document)
Deprecated.Creates a new instance of HTMLWorkerHTMLWorker(DocListener document, java.util.Map<java.lang.String,HTMLTagProcessor> tags, StyleSheet style)
Deprecated.Creates a new instance of HTMLWorker
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
add(Element element)
Deprecated.Signals that anElement
was added to theDocument
.void
carriageReturn()
Deprecated.Flushes the current paragraph, indicating that we're starting a new block.void
close()
Deprecated.Signals that theDocument
was closed and that no otherElements
will be added.CellWrapper
createCell(java.lang.String tag)
Deprecated.Creates a Cell.Chunk
createChunk(java.lang.String content)
Deprecated.Creates a Chunk using the factory.Image
createImage(java.util.Map<java.lang.String,java.lang.String> attrs)
Deprecated.Creates an Image object.LineSeparator
createLineSeparator(java.util.Map<java.lang.String,java.lang.String> attrs)
Deprecated.Creates a LineSeparator object.List
createList(java.lang.String tag)
Deprecated.Creates a List object.ListItem
createListItem()
Deprecated.Creates a ListItem object.Paragraph
createParagraph()
Deprecated.Creates a Paragraph using the factory.void
endDocument()
Deprecated.Called after the document is parsed.void
endElement(java.lang.String tag)
Deprecated.Called when an end tag is found.void
flushContent()
Deprecated.Stacks the current paragraph, indicating that we're starting a new span.java.util.Map<java.lang.String,java.lang.Object>
getInterfaceProps()
Deprecated.use getProviders() insteadboolean
isInsidePRE()
Deprecated.boolean
isPendingLI()
Deprecated.boolean
isPendingTD()
Deprecated.boolean
isPendingTR()
Deprecated.boolean
isSkipText()
Deprecated.void
newLine()
Deprecated.Adds a new line to the currentParagraph.boolean
newPage()
Deprecated.Signals that an new page has to be started.void
open()
Deprecated.Signals that theDocument
has been opened and thatElements
can be added.void
parse(java.io.Reader reader)
Deprecated.Parses content read from a java.io.Reader object.static java.util.List<Element>
parseToList(java.io.Reader reader, StyleSheet style)
Deprecated.Parses an HTML source to a List of Element objectsstatic java.util.List<Element>
parseToList(java.io.Reader reader, StyleSheet style, java.util.HashMap<java.lang.String,java.lang.Object> providers)
Deprecated.Parses an HTML source to a List of Element objectsstatic java.util.List<Element>
parseToList(java.io.Reader reader, StyleSheet style, java.util.Map<java.lang.String,HTMLTagProcessor> tags, java.util.HashMap<java.lang.String,java.lang.Object> providers)
Deprecated.Parses an HTML source to a List of Element objectsvoid
popTableState()
Deprecated.Pops the values of pendingTR and pendingTD from a state stack.void
processImage(Image img, java.util.Map<java.lang.String,java.lang.String> attrs)
Deprecated.Processes an Image.void
processLink()
Deprecated.Adds a link to the current paragraph.void
processList()
Deprecated.Fetches the List from the Stack and adds it to the TextElementArray on top of the Stack, or to the Document if the Stack is empty.void
processListItem()
Deprecated.Looks for the List object on the Stack, and adds the ListItem to the List.void
processRow()
Deprecated.Gets the TableWrapper from the Stack and adds a new row.void
processTable()
Deprecated.Processes the Table.void
pushTableState()
Deprecated.Pushes the values of pendingTR and pendingTD to a state stack.void
pushToStack(Element element)
Deprecated.Pushes an element to the Stack.void
resetPageCount()
Deprecated.Sets the page number to 0.void
setInsidePRE(boolean insidePRE)
Deprecated.void
setInterfaceProps(java.util.HashMap<java.lang.String,java.lang.Object> providers)
Deprecated.use setProviders() insteadboolean
setMarginMirroring(boolean marginMirroring)
Deprecated.Parameter that allows you to do left/right margin mirroring (odd/even pages)boolean
setMarginMirroringTopBottom(boolean marginMirroring)
Deprecated.Parameter that allows you to do top/bottom margin mirroring (odd/even pages)boolean
setMargins(float marginLeft, float marginRight, float marginTop, float marginBottom)
Deprecated.Sets the margins.void
setPageCount(int pageN)
Deprecated.Sets the page number.boolean
setPageSize(Rectangle pageSize)
Deprecated.Sets the pagesize.void
setPendingLI(boolean pendingLI)
Deprecated.void
setPendingTD(boolean pendingTD)
Deprecated.void
setPendingTR(boolean pendingTR)
Deprecated.void
setProviders(java.util.Map<java.lang.String,java.lang.Object> providers)
Deprecated.Setter for the providers.void
setSkipText(boolean skipText)
Deprecated.void
setStyleSheet(StyleSheet style)
Deprecated.Setter for the StyleSheetvoid
setSupportedTags(java.util.Map<java.lang.String,HTMLTagProcessor> tags)
Deprecated.Sets the map with supported tags.void
startDocument()
Deprecated.Called when the document starts to be parsed.void
startElement(java.lang.String tag, java.util.Map<java.lang.String,java.lang.String> attrs)
Deprecated.Called when a start tag is found.void
text(java.lang.String content)
Deprecated.Called when a text element is found.void
updateChain(java.lang.String tag)
Deprecated.Updates the chain by removing a tag.void
updateChain(java.lang.String tag, java.util.Map<java.lang.String,java.lang.String> attrs)
Deprecated.Updates the chain with a new tag and new attributes.
-
-
-
Field Detail
-
LOGGER
private static Logger LOGGER
Deprecated.
-
document
protected DocListener document
Deprecated.DocListener that will listen to the Elements produced by parsing the HTML. This can be a com.lowagie.text.Document adding the elements to a Document directly, or an HTMLWorker instance strong the objects in a List
-
tags
protected java.util.Map<java.lang.String,HTMLTagProcessor> tags
Deprecated.The map with all the supported tags.- Since:
- 5.0.6
-
style
private StyleSheet style
Deprecated.The object defining all the styles.
-
stack
protected java.util.Stack<Element> stack
Deprecated.Stack with the Elements that already have been processed.- Since:
- iText 5.0.6 (private => protected)
-
currentParagraph
protected Paragraph currentParagraph
Deprecated.Keeps the content of the current paragraph- Since:
- iText 5.0.6 (private => protected)
-
chain
private final ChainedProperties chain
Deprecated.The current hierarchy chain of tags.- Since:
- 5.0.6
-
IMG_PROVIDER
public static final java.lang.String IMG_PROVIDER
Deprecated.Key used to store the image provider in the providers map.- Since:
- 5.0.6
- See Also:
- Constant Field Values
-
IMG_PROCESSOR
public static final java.lang.String IMG_PROCESSOR
Deprecated.Key used to store the image processor in the providers map.- Since:
- 5.0.6
- See Also:
- Constant Field Values
-
IMG_STORE
public static final java.lang.String IMG_STORE
Deprecated.Key used to store the image store in the providers map.- Since:
- 5.0.6
- See Also:
- Constant Field Values
-
IMG_BASEURL
public static final java.lang.String IMG_BASEURL
Deprecated.Key used to store the image baseurl provider in the providers map.- Since:
- 5.0.6
- See Also:
- Constant Field Values
-
FONT_PROVIDER
public static final java.lang.String FONT_PROVIDER
Deprecated.Key used to store the font provider in the providers map.- Since:
- 5.0.6
- See Also:
- Constant Field Values
-
LINK_PROVIDER
public static final java.lang.String LINK_PROVIDER
Deprecated.Key used to store the link provider in the providers map.- Since:
- 5.0.6
- See Also:
- Constant Field Values
-
providers
private java.util.Map<java.lang.String,java.lang.Object> providers
Deprecated.Map containing providers such as a FontProvider or ImageProvider.- Since:
- 5.0.6 (renamed from interfaceProps)
-
factory
private final ElementFactory factory
Deprecated.Factory that is able to create iText Element objects.- Since:
- 5.0.6
-
tableState
private final java.util.Stack<boolean[]> tableState
Deprecated.Stack to keep track of table tags.
-
pendingTR
private boolean pendingTR
Deprecated.Boolean to keep track of TR tags.
-
pendingTD
private boolean pendingTD
Deprecated.Boolean to keep track of TD and TH tags
-
pendingLI
private boolean pendingLI
Deprecated.Boolean to keep track of LI tags
-
insidePRE
private boolean insidePRE
Deprecated.Boolean to keep track of PRE tags- Since:
- 5.0.6 renamed from isPRE
-
skipText
protected boolean skipText
Deprecated.Indicates if text needs to be skipped.- Since:
- iText 5.0.6 (private => protected)
-
objectList
protected java.util.List<Element> objectList
Deprecated.The resulting list of elements.
-
-
Constructor Detail
-
HTMLWorker
public HTMLWorker(DocListener document)
Deprecated.Creates a new instance of HTMLWorker- Parameters:
document
- A class that implementsDocListener
-
HTMLWorker
public HTMLWorker(DocListener document, java.util.Map<java.lang.String,HTMLTagProcessor> tags, StyleSheet style)
Deprecated.Creates a new instance of HTMLWorker- Parameters:
document
- A class that implementsDocListener
tags
- A map containing the supported tagsstyle
- A StyleSheet- Since:
- 5.0.6
-
-
Method Detail
-
setSupportedTags
public void setSupportedTags(java.util.Map<java.lang.String,HTMLTagProcessor> tags)
Deprecated.Sets the map with supported tags.- Parameters:
tags
-- Since:
- 5.0.6
-
setStyleSheet
public void setStyleSheet(StyleSheet style)
Deprecated.Setter for the StyleSheet- Parameters:
style
- the StyleSheet
-
parse
public void parse(java.io.Reader reader) throws java.io.IOException
Deprecated.Parses content read from a java.io.Reader object.- Parameters:
reader
- the content- Throws:
java.io.IOException
-
startDocument
public void startDocument()
Deprecated.Description copied from interface:SimpleXMLDocHandler
Called when the document starts to be parsed.- Specified by:
startDocument
in interfaceSimpleXMLDocHandler
- See Also:
SimpleXMLDocHandler.startDocument()
-
startElement
public void startElement(java.lang.String tag, java.util.Map<java.lang.String,java.lang.String> attrs)
Deprecated.Description copied from interface:SimpleXMLDocHandler
Called when a start tag is found.- Specified by:
startElement
in interfaceSimpleXMLDocHandler
- Parameters:
tag
- the tag nameattrs
- the tag's attributes- See Also:
SimpleXMLDocHandler.startElement(java.lang.String, java.util.Map)
-
text
public void text(java.lang.String content)
Deprecated.Description copied from interface:SimpleXMLDocHandler
Called when a text element is found.- Specified by:
text
in interfaceSimpleXMLDocHandler
- Parameters:
content
- the text element, probably a fragment.- See Also:
SimpleXMLDocHandler.text(java.lang.String)
-
endElement
public void endElement(java.lang.String tag)
Deprecated.Description copied from interface:SimpleXMLDocHandler
Called when an end tag is found.- Specified by:
endElement
in interfaceSimpleXMLDocHandler
- Parameters:
tag
- the tag name- See Also:
SimpleXMLDocHandler.endElement(java.lang.String)
-
endDocument
public void endDocument()
Deprecated.Description copied from interface:SimpleXMLDocHandler
Called after the document is parsed.- Specified by:
endDocument
in interfaceSimpleXMLDocHandler
- See Also:
SimpleXMLDocHandler.endDocument()
-
newLine
public void newLine()
Deprecated.Adds a new line to the currentParagraph.- Since:
- 5.0.6
-
carriageReturn
public void carriageReturn() throws DocumentException
Deprecated.Flushes the current paragraph, indicating that we're starting a new block. If the stack is empty, the paragraph is added to the document. Otherwise the Paragraph is added to the stack.- Throws:
DocumentException
- Since:
- 5.0.6
-
flushContent
public void flushContent()
Deprecated.Stacks the current paragraph, indicating that we're starting a new span.- Since:
- 5.0.6
-
pushToStack
public void pushToStack(Element element)
Deprecated.Pushes an element to the Stack.- Parameters:
element
-- Since:
- 5.0.6
-
updateChain
public void updateChain(java.lang.String tag, java.util.Map<java.lang.String,java.lang.String> attrs)
Deprecated.Updates the chain with a new tag and new attributes.- Parameters:
tag
- the new tagattrs
- the corresponding attributes- Since:
- 5.0.6
-
updateChain
public void updateChain(java.lang.String tag)
Deprecated.Updates the chain by removing a tag.- Parameters:
tag
- the new tag- Since:
- 5.0.6
-
setProviders
public void setProviders(java.util.Map<java.lang.String,java.lang.Object> providers)
Deprecated.Setter for the providers. If a FontProvider is added, the ElementFactory is updated.- Parameters:
providers
- a Map with different providers- Since:
- 5.0.6
-
createChunk
public Chunk createChunk(java.lang.String content)
Deprecated.Creates a Chunk using the factory.- Parameters:
content
- the content of the chunk- Returns:
- a Chunk with content
- Since:
- 5.0.6
-
createParagraph
public Paragraph createParagraph()
Deprecated.Creates a Paragraph using the factory.- Returns:
- a Paragraph without any content
- Since:
- 5.0.6
-
createList
public List createList(java.lang.String tag)
Deprecated.Creates a List object.- Parameters:
tag
- should be "ol" or "ul"- Returns:
- a List object
- Since:
- 5.0.6
-
createListItem
public ListItem createListItem()
Deprecated.Creates a ListItem object.- Returns:
- a ListItem object
- Since:
- 5.0.6
-
createLineSeparator
public LineSeparator createLineSeparator(java.util.Map<java.lang.String,java.lang.String> attrs)
Deprecated.Creates a LineSeparator object.- Parameters:
attrs
- properties of the LineSeparator- Returns:
- a LineSeparator object
- Since:
- 5.0.6
-
createImage
public Image createImage(java.util.Map<java.lang.String,java.lang.String> attrs) throws DocumentException, java.io.IOException
Deprecated.Creates an Image object.- Parameters:
attrs
- properties of the Image- Returns:
- an Image object (or null if the Image couldn't be found)
- Throws:
DocumentException
java.io.IOException
- Since:
- 5.0.6
-
createCell
public CellWrapper createCell(java.lang.String tag)
Deprecated.Creates a Cell.- Parameters:
tag
- the tag- Returns:
- a CellWrapper object
- Since:
- 5.0.6
-
processLink
public void processLink()
Deprecated.Adds a link to the current paragraph.- Since:
- 5.0.6
-
processList
public void processList() throws DocumentException
Deprecated.Fetches the List from the Stack and adds it to the TextElementArray on top of the Stack, or to the Document if the Stack is empty.- Throws:
DocumentException
- Since:
- 5.0.6
-
processListItem
public void processListItem() throws DocumentException
Deprecated.Looks for the List object on the Stack, and adds the ListItem to the List.- Throws:
DocumentException
- Since:
- 5.0.6
-
processImage
public void processImage(Image img, java.util.Map<java.lang.String,java.lang.String> attrs) throws DocumentException
Deprecated.Processes an Image.- Parameters:
img
-attrs
-- Throws:
DocumentException
- Since:
- 5.0.6
-
processTable
public void processTable() throws DocumentException
Deprecated.Processes the Table.- Throws:
DocumentException
- Since:
- 5.0.6
-
processRow
public void processRow()
Deprecated.Gets the TableWrapper from the Stack and adds a new row.- Since:
- 5.0.6
-
pushTableState
public void pushTableState()
Deprecated.Pushes the values of pendingTR and pendingTD to a state stack.- Since:
- 5.0.6
-
popTableState
public void popTableState()
Deprecated.Pops the values of pendingTR and pendingTD from a state stack.- Since:
- 5.0.6
-
isPendingTR
public boolean isPendingTR()
Deprecated.- Returns:
- the pendingTR
- Since:
- 5.0.6
-
setPendingTR
public void setPendingTR(boolean pendingTR)
Deprecated.- Parameters:
pendingTR
- the pendingTR to set- Since:
- 5.0.6
-
isPendingTD
public boolean isPendingTD()
Deprecated.- Returns:
- the pendingTD
- Since:
- 5.0.6
-
setPendingTD
public void setPendingTD(boolean pendingTD)
Deprecated.- Parameters:
pendingTD
- the pendingTD to set- Since:
- 5.0.6
-
isPendingLI
public boolean isPendingLI()
Deprecated.- Returns:
- the pendingLI
- Since:
- 5.0.6
-
setPendingLI
public void setPendingLI(boolean pendingLI)
Deprecated.- Parameters:
pendingLI
- the pendingLI to set- Since:
- 5.0.6
-
isInsidePRE
public boolean isInsidePRE()
Deprecated.- Returns:
- the insidePRE
- Since:
- 5.0.6
-
setInsidePRE
public void setInsidePRE(boolean insidePRE)
Deprecated.- Parameters:
insidePRE
- the insidePRE to set- Since:
- 5.0.6
-
isSkipText
public boolean isSkipText()
Deprecated.- Returns:
- the skipText
- Since:
- 5.0.6
-
setSkipText
public void setSkipText(boolean skipText)
Deprecated.- Parameters:
skipText
- the skipText to set- Since:
- 5.0.6
-
parseToList
public static java.util.List<Element> parseToList(java.io.Reader reader, StyleSheet style) throws java.io.IOException
Deprecated.Parses an HTML source to a List of Element objects- Parameters:
reader
- the HTML sourcestyle
- a StyleSheet object- Returns:
- a List of Element objects
- Throws:
java.io.IOException
-
parseToList
public static java.util.List<Element> parseToList(java.io.Reader reader, StyleSheet style, java.util.HashMap<java.lang.String,java.lang.Object> providers) throws java.io.IOException
Deprecated.Parses an HTML source to a List of Element objects- Parameters:
reader
- the HTML sourcestyle
- a StyleSheet objectproviders
- map containing classes with extra info- Returns:
- a List of Element objects
- Throws:
java.io.IOException
-
parseToList
public static java.util.List<Element> parseToList(java.io.Reader reader, StyleSheet style, java.util.Map<java.lang.String,HTMLTagProcessor> tags, java.util.HashMap<java.lang.String,java.lang.Object> providers) throws java.io.IOException
Deprecated.Parses an HTML source to a List of Element objects- Parameters:
reader
- the HTML sourcestyle
- a StyleSheet objecttags
- a map containing supported tags and their processorsproviders
- map containing classes with extra info- Returns:
- a List of Element objects
- Throws:
java.io.IOException
- Since:
- 5.0.6
-
add
public boolean add(Element element) throws DocumentException
Deprecated.Description copied from interface:ElementListener
Signals that anElement
was added to theDocument
.- Specified by:
add
in interfaceElementListener
- 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- See Also:
ElementListener.add(com.itextpdf.text.Element)
-
close
public void close()
Deprecated.Description copied from interface:DocListener
Signals that theDocument
was closed and that no otherElements
will be added.The outputstream of every writer implementing
DocListener
will be closed.- Specified by:
close
in interfaceDocListener
- See Also:
DocListener.close()
-
newPage
public boolean newPage()
Deprecated.Description copied from interface:DocListener
Signals that an new page has to be started.- Specified by:
newPage
in interfaceDocListener
- Returns:
true
if the page was added,false
if not.- See Also:
DocListener.newPage()
-
open
public void open()
Deprecated.Description copied from interface:DocListener
Signals that theDocument
has been opened and thatElements
can be added.- Specified by:
open
in interfaceDocListener
- See Also:
DocListener.open()
-
resetPageCount
public void resetPageCount()
Deprecated.Description copied from interface:DocListener
Sets the page number to 0.- Specified by:
resetPageCount
in interfaceDocListener
- See Also:
DocListener.resetPageCount()
-
setMarginMirroring
public boolean setMarginMirroring(boolean marginMirroring)
Deprecated.Description copied from interface:DocListener
Parameter that allows you to do left/right margin mirroring (odd/even pages)- Specified by:
setMarginMirroring
in interfaceDocListener
- Returns:
- true if successful
- See Also:
DocListener.setMarginMirroring(boolean)
-
setMarginMirroringTopBottom
public boolean setMarginMirroringTopBottom(boolean marginMirroring)
Deprecated.Description copied from interface:DocListener
Parameter that allows you to do top/bottom margin mirroring (odd/even pages)- Specified by:
setMarginMirroringTopBottom
in interfaceDocListener
- 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)
Deprecated.Description copied from interface:DocListener
Sets the margins.- Specified by:
setMargins
in 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
- See Also:
DocListener.setMargins(float, float, float, float)
-
setPageCount
public void setPageCount(int pageN)
Deprecated.Description copied from interface:DocListener
Sets the page number.- Specified by:
setPageCount
in interfaceDocListener
- Parameters:
pageN
- the new page number- See Also:
DocListener.setPageCount(int)
-
setPageSize
public boolean setPageSize(Rectangle pageSize)
Deprecated.Description copied from interface:DocListener
Sets the pagesize.- Specified by:
setPageSize
in interfaceDocListener
- Parameters:
pageSize
- the new pagesize- Returns:
- a
boolean
- See Also:
DocListener.setPageSize(com.itextpdf.text.Rectangle)
-
setInterfaceProps
@Deprecated public void setInterfaceProps(java.util.HashMap<java.lang.String,java.lang.Object> providers)
Deprecated.use setProviders() insteadSets the providers.
-
getInterfaceProps
@Deprecated public java.util.Map<java.lang.String,java.lang.Object> getInterfaceProps()
Deprecated.use getProviders() insteadGets the providers
-
-