jodd.lagarto.dom

Class LagartoDOMBuilderTagVisitor

java.lang.Object

jodd.lagarto.dom.LagartoDOMBuilderTagVisitor

All Implemented Interfaces:

TagVisitor

public class LagartoDOMBuilderTagVisitor
extends java.lang.Object
implements TagVisitor

Lagarto tag visitor that builds DOM tree.

Field Summary

Fields

Modifier and Type	Field and Description
protected LagartoDOMBuilder	domBuilder
protected boolean	enabled While enabled, nodes will be added to the DOM tree.
protected HtmlImplicitClosingRules	implRules
protected Node	parentNode
protected LagartoParserContext	parserContext
protected Document	rootNode

Constructor Summary

Constructors

Constructor and Description
LagartoDOMBuilderTagVisitor(LagartoDOMBuilder domBuilder)

Method Summary

Methods

Modifier and Type	Method and Description
void	cdata(java.lang.CharSequence cdata) Invoked on CDATA sequence.
void	comment(java.lang.CharSequence comment) Invoked on comment.
void	condComment(java.lang.CharSequence expression, boolean isStartingTag, boolean isHidden, java.lang.CharSequence comment) Invoked on IE conditional comment.
protected CData	createCData(java.lang.String cdata) Creates tag.
protected Comment	createComment(java.lang.String comment) Creates Comment.
protected Comment	createConditionalComment(java.lang.String comment, boolean isStartingTag, boolean conditionalDownlevelHidden, java.lang.String additionalComment) Creates conditional Comment.
protected Document	createDocument() Creates root Document node.
protected DocumentType	createDocumentType(java.lang.String value, java.lang.String publicId, java.lang.String baseUri)
protected Element	createElement(java.lang.String name) Creates empty tag.
protected Element	createElement(java.lang.String tagName, boolean voidElement, boolean selfClosed) Creates empty Element node.
protected Element	createElement(Tag tag, boolean voidElement, boolean selfClosed) Creates Element node from a Tag.
protected Element	createElementNode(Tag tag) Creates new element with correct configuration.
protected Text	createText(java.lang.String text) Creates Text node.
protected XmlDeclaration	createXmlDeclaration(Tag tag)
void	doctype(java.lang.String name, java.lang.String publicId, java.lang.String baseUri) Invoked on DOCTYPE directive.
void	end() Invoked at the end, after all content is visited.
void	error(java.lang.String message) Warn about parsing error.
protected Node	findMatchingParentOpenTag(java.lang.String tagName) Finds matching parent open tag or null if not found.
protected void	fixUnclosedTagsUpToMatchingParent(Tag tag, Node matchingParent) Fixes all unclosed tags up to matching parent.
Document	getDocument() Returns root document node of parsed DOM tree.
protected void	removeLastChildNodeIfEmptyText(Node parentNode, boolean closedTag) Removes last child node if contains just empty text.
void	script(Tag tag, java.lang.CharSequence body) Invoked on script tag.
void	start(LagartoParserContext parserContext) Invoked on very beginning of the visiting.
void	style(Tag tag, java.lang.CharSequence body) Invoked on style tag.
void	tag(Tag tag) Invoked on tag (open, close or empty).
void	text(java.lang.CharSequence text) Invoked on text i.e. anything other than a tag.
void	xml(Tag tag) Invoked on xml declaration.
void	xmp(Tag tag, java.lang.CharSequence body) Invoked on xmp tag.

Methods inherited from class java.lang.Object

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

Field Detail

domBuilder

protected final LagartoDOMBuilder domBuilder

implRules

protected final HtmlImplicitClosingRules implRules

rootNode

protected Document rootNode

parentNode

protected Node parentNode

enabled

protected boolean enabled

While enabled, nodes will be added to the DOM tree. Useful for skipping some tags.

parserContext

protected LagartoParserContext parserContext

Constructor Detail

LagartoDOMBuilderTagVisitor

public LagartoDOMBuilderTagVisitor(LagartoDOMBuilder domBuilder)

Method Detail

getDocument

public Document getDocument()

Returns root document node of parsed DOM tree.

start

public void start(LagartoParserContext parserContext)

Description copied from interface: TagVisitor

Invoked on very beginning of the visiting. Provides parser context that gives some information during the parsing process.

Specified by:

start in interface TagVisitor

end

public void end()

Description copied from interface: TagVisitor

Invoked at the end, after all content is visited.

Specified by:

end in interface TagVisitor

createElementNode

protected Element createElementNode(Tag tag)

Creates new element with correct configuration.

tag

public void tag(Tag tag)

Description copied from interface: TagVisitor

Invoked on tag (open, close or empty).

Warning: the passed tag instance should not be kept beyond this method as the parser reuse it!

Specified by:

tag in interface TagVisitor

removeLastChildNodeIfEmptyText

protected void removeLastChildNodeIfEmptyText(Node parentNode,
                                  boolean closedTag)

Removes last child node if contains just empty text.

findMatchingParentOpenTag

protected Node findMatchingParentOpenTag(java.lang.String tagName)

Finds matching parent open tag or null if not found.

fixUnclosedTagsUpToMatchingParent

protected void fixUnclosedTagsUpToMatchingParent(Tag tag,
                                     Node matchingParent)

Fixes all unclosed tags up to matching parent. Missing end tags will be added just before parent tag is closed, making the whole inner content as its tag body.

Tags that can be closed implicitly are checked and closed.

There is optional check for detecting orphan tags inside the table or lists. If set, tags can be closed beyond the border of the table and the list and it is reported as orphan tag.

This is just a generic solutions, closest to the rules.

xmp

public void xmp(Tag tag,
       java.lang.CharSequence body)

Description copied from interface: TagVisitor

Invoked on xmp tag.

Specified by:

xmp in interface TagVisitor

style

public void style(Tag tag,
         java.lang.CharSequence body)

Description copied from interface: TagVisitor

Invoked on style tag.

Specified by:

style in interface TagVisitor

script

public void script(Tag tag,
          java.lang.CharSequence body)

Description copied from interface: TagVisitor

Invoked on script tag.

Specified by:

script in interface TagVisitor

comment

public void comment(java.lang.CharSequence comment)

Description copied from interface: TagVisitor

Invoked on comment.

Specified by:

comment in interface TagVisitor

text

public void text(java.lang.CharSequence text)

Description copied from interface: TagVisitor

Invoked on text i.e. anything other than a tag.

Specified by:

text in interface TagVisitor

cdata

public void cdata(java.lang.CharSequence cdata)

Description copied from interface: TagVisitor

Invoked on CDATA sequence.

Specified by:

cdata in interface TagVisitor

xml

public void xml(Tag tag)

Description copied from interface: TagVisitor

Invoked on xml declaration.

Specified by:

xml in interface TagVisitor

doctype

public void doctype(java.lang.String name,
           java.lang.String publicId,
           java.lang.String baseUri)

Description copied from interface: TagVisitor

Invoked on DOCTYPE directive. If publicId is null, it is a SYSTEM directive, otherwise it is PUBLIC.

Specified by:

doctype in interface TagVisitor

condComment

public void condComment(java.lang.CharSequence expression,
               boolean isStartingTag,
               boolean isHidden,
               java.lang.CharSequence comment)

Description copied from interface: TagVisitor

Invoked on IE conditional comment. The expression if unmodified expression. comment is optional additional comment and may be null.

Specified by:

condComment in interface TagVisitor

error

public void error(java.lang.String message)

Description copied from interface: TagVisitor

Warn about parsing error. Usually, parser will try to continue.

Specified by:

error in interface TagVisitor

Parameters:

message - parsing error message

createDocument

protected Document createDocument()

Creates root Document node.

createCData

protected CData createCData(java.lang.String cdata)

Creates tag.

createComment

protected Comment createComment(java.lang.String comment)

Creates Comment.

See Also:

Comment.Comment(Document, String)

createConditionalComment

protected Comment createConditionalComment(java.lang.String comment,
                               boolean isStartingTag,
                               boolean conditionalDownlevelHidden,
                               java.lang.String additionalComment)

Creates conditional Comment.

See Also:

Comment.Comment(Document, String, boolean, boolean, String)

createElement

protected Element createElement(Tag tag,
                    boolean voidElement,
                    boolean selfClosed)

Creates Element node from a Tag.

createElement

protected Element createElement(java.lang.String name)

Creates empty tag.

createElement

protected Element createElement(java.lang.String tagName,
                    boolean voidElement,
                    boolean selfClosed)

Creates empty Element node.

createText

protected Text createText(java.lang.String text)

Creates Text node.

createDocumentType

protected DocumentType createDocumentType(java.lang.String value,
                              java.lang.String publicId,
                              java.lang.String baseUri)

createXmlDeclaration

protected XmlDeclaration createXmlDeclaration(Tag tag)