Class HTMLParser

java.lang.Object

com.codename1.xml.XMLParser

com.codename1.ui.html.HTMLParser

public class HTMLParser
extends XMLParser

The HTMLParser class is used to parse an XHTML-MP 1.0 document into a DOM object (Element). Unsupported tags and attributes as well as comments are dropped in the parsing process. The parser is also makes use of CSSParser for external CSS files, embedded CSS segments and CSS within the 'style' attribute.

Constructor Summary

Constructors

Constructor	Description
HTMLParser()	Constructs a new instance of HTMLParser

Method Summary

Modifier and Type	Method	Description
protected String	convertCharEntity(String charEntity)	Overrides XMLParser.convertCharEntity to add in HTML char entities
protected Element	createNewElement(String name)	Overrides XMLParser.createNewElement to return an HTMLElement instance
protected Element	createNewTextElement(String text)	Overrides XMLParser.createNewTextElement to return an HTMLElement instance
protected String	getSupportedStandardName()	{Returns a string identifying the document type this parser supports.
protected boolean	isEmptyTag(String tagName)	Checks whether the specified tag is an empty tag as defined in EMPTY_TAGS
protected boolean	isSupported(Element element)	Overrides the Element.isSupported to let the parser know which tags are supported in XHTML-MP 1.0
HTMLElement	parseHTML(InputStreamReader isr)	A convenience method that casts the returned type of the parse method to HTMLElement.
protected void	parseTagContent(Element element, Reader is)	Overrides XMLParser.parseTagContent to enable embedded CSS segments (Style tags)
protected boolean	shouldEvaluate(Element element)	Overrides the Element.shouldEvaluate method to return false on the script tag.

Methods inherited from class XMLParser

addCharEntitiesRange, addCharEntity, attribute, endTag, eventParser, isCaseSensitive, isWhiteSpace, notifyError, parse, parseCommentOrXMLDeclaration, parseTag, setCaseSensitive, setIncludeWhitespacesBetweenTags, setParserCallback, startTag, textElement

Modifier and Type	Method	Description
void	addCharEntitiesRange(String[] symbols, int startcode)	Adds the given symbols array to the user defined char entities table with the startcode provided as the code of the first string, startcode+1 for the second etc.
void	addCharEntity(String symbol, int code)	Adds the given symbol and code to the user defined char entities table http://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references
protected void	attribute(String tag, String attributeName, String value)	Invoked for every attribute value of the givne tag This callback method is invoked only on the eventParser.
protected void	endTag(String tag)	Invoked when a tag ends This callback method is invoked only on the eventParser.
void	eventParser(Reader r)	The event parser requires deriving this class and overriding callback methods to work effectively.
boolean	isCaseSensitive()	Sets the parser to be case sensitive and retain case, otherwise it will convert all data to lower case
protected boolean	isWhiteSpace(char ch)	Checks if the specified character is a white space or not.
protected void	notifyError(int errorId, String tag, String attribute, String value, String description)	A utility method used to notify an error to the ParserCallback and throw an IllegalArgumentException if parsingError returned false
Element	parse(Reader is)	This is the entry point for parsing a document and the only non-private member method in this class
protected Element	parseCommentOrXMLDeclaration(Reader is, String endTag)	This utility method is used to parse comments and XML declarations in the XML.
protected Element	parseTag(Reader is)	This method collects the tag name and all of its attributes.
void	setCaseSensitive(boolean caseSensitive)	Sets the parser to be case sensitive and retain case, otherwise it will convert all data to lower case
void	setIncludeWhitespacesBetweenTags(boolean include)
void	setParserCallback(ParserCallback parserCallback)	Sets the specified callback to serve as the callback for parsing errors
protected boolean	startTag(String tag)	Invoked when a tag is opened, this method should return true to process the tag or return false to skip the tag.
protected void	textElement(String text)	Invoked when the event parser encounters a text element.

Methods inherited from class Object

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

Modifier and Type	Method	Description
protected Object	clone()
boolean	equals(Object obj)	Indicates whether some other object is "equal to" this one.
final Class	getClass()	Returns the runtime class of an object.
int	hashCode()	Returns a hash code value for the object.
final void	notify()	Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll()	Wakes up all threads that are waiting on this object's monitor.
String	toString()	Returns a string representation of the object.
final void	wait()	Causes current thread to wait until another thread invokes the method or the method for this object.
final void	wait(long timeout)	Causes current thread to wait until either another thread invokes the method or the method for this object, or a specified amount of time has elapsed.
final void	wait(long timeout, int nanos)	Causes current thread to wait until another thread invokes the method or the method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.

Constructor Details

HTMLParser

public HTMLParser()

Constructs a new instance of HTMLParser

Method Details

parseTagContent

protected void parseTagContent(Element element,
 Reader is)
                        throws IOException

Overrides XMLParser.parseTagContent to enable embedded CSS segments (Style tags)

Parameters

• element: The current parent element

• is: The reader containing the XML

Throws

• IOException: if an I/O error in the stream is encountered

Overrides:

parseTagContent in class XMLParser

Throws:

IOException

createNewElement

protected Element createNewElement(String name)

Overrides XMLParser.createNewElement to return an HTMLElement instance

Parameters

• name: The HTMLElement's name

Returns

a new instance of the names HTMLElement

Overrides:

createNewElement in class XMLParser

createNewTextElement

protected Element createNewTextElement(String text)

Overrides XMLParser.createNewTextElement to return an HTMLElement instance

Parameters

• text: The HTMLElement's text

Returns

a new instance of the HTMLElement

Overrides:

createNewTextElement in class XMLParser

convertCharEntity

protected String convertCharEntity(String charEntity)

Overrides XMLParser.convertCharEntity to add in HTML char entities

Parameters

• charEntity: The char entity to convert

Returns

A string containing a single char, or the original char entity string (with & and ;) if the char entity couldn't be resolved

Overrides:

convertCharEntity in class XMLParser

isEmptyTag

protected boolean isEmptyTag(String tagName)

Checks whether the specified tag is an empty tag as defined in EMPTY_TAGS

Parameters

• tagName: The tag name to check

Returns

true if that tag is defined as an empty tag, false otherwise

Overrides:

isEmptyTag in class XMLParser

parseHTML

public HTMLElement parseHTML(InputStreamReader isr)

A convenience method that casts the returned type of the parse method to HTMLElement. Basically calling this method is simlar to calling parse and casting to HTMLElement.

Parameters

• isr: The input stream containing the HTML

Returns

The HTML document

getSupportedStandardName

protected String getSupportedStandardName()

{

Returns a string identifying the document type this parser supports. This should be overriden by subclassing parsers.

Returns

a string identifying the document type this parser supports.

}

Overrides:

getSupportedStandardName in class XMLParser

isSupported

protected boolean isSupported(Element element)

Overrides the Element.isSupported to let the parser know which tags are supported in XHTML-MP 1.0

Returns

true if the tag is a supported XHTML Mobile Profile 1.0 tag, false otherwise

Overrides:

isSupported in class XMLParser

shouldEvaluate

protected boolean shouldEvaluate(Element element)

Overrides the Element.shouldEvaluate method to return false on the script tag. The script tag should be skipped entirely, since it may contain characters like greater-than and lesser-than which may break the HTML All other tags are evaluated (i.e. added including all their children to the tree), even if not supported (But of course their functionality is ignored by HTMLComponent)

Returns

false if this is the SCRIPT tag, true otherwise

Overrides:

shouldEvaluate in class XMLParser