org.opencms.util

类 CmsHtmlParser

java.lang.Object

org.htmlparser.visitors.NodeVisitor

org.opencms.util.CmsHtmlParser

所有已实现的接口:

I_CmsHtmlNodeVisitor

直接已知子类:

CmsHtml2TextConverter, CmsHtmlDecorator, CmsLinkProcessor, CmsTagReplaceParser

public class CmsHtmlParser
extends org.htmlparser.visitors.NodeVisitor
implements I_CmsHtmlNodeVisitor

Base utility class for OpenCms NodeVisitor implementations, which provides some often used utility functions.

This base implementation is only a "pass through" class, that is the content is parsed, but the generated result is exactly identical to the input.

从以下版本开始:

6.2.0

字段概要

字段

限定符和类型	字段和说明
protected boolean	m_echo Indicates if "echo" mode is on, that is all content is written to the result by default.
protected java.util.List<java.lang.String>	m_noAutoCloseTags List of upper case tag name strings of tags that should not be auto-corrected if closing divs are missing.
protected java.lang.StringBuffer	m_result The buffer to write the out to.
protected static java.lang.String[]	TAG_ARRAY The array of supported tag names.
protected static java.util.List<java.lang.String>	TAG_LIST The list of supported tag names.

构造器概要

构造器

构造器和说明
CmsHtmlParser() Creates a new instance of the html converter with echo mode set to false.
CmsHtmlParser(boolean echo) Creates a new instance of the html converter.

方法概要

方法

限定符和类型	方法和说明
protected java.lang.String	collapse(java.lang.String string) Collapse HTML whitespace in the given String.
protected org.htmlparser.PrototypicalNodeFactory	configureNoAutoCorrectionTags() Internally degrades Composite tags that do have children in the DOM tree to simple single tags.
java.lang.String	getConfiguration() Returns the configuartion String of this visitor or the empty String if was not provided before.
java.util.List<java.lang.String>	getNoAutoCloseTags() Returns a list of upper case tag names for which parsing / visiting will not correct missing closing tags.
java.lang.String	getResult() Returns the text extraction result.
java.lang.String	getTagHtml(org.htmlparser.Tag tag) Returns the HTML for the given tag itself (not the tag content).
java.lang.String	process(java.lang.String html, java.lang.String encoding) Extracts the text from the given html content, assuming the given html encoding.
void	setConfiguration(java.lang.String configuration) Set a configuartion String for this visitor.
void	setNoAutoCloseTags(java.util.List<java.lang.String> noAutoCloseTagList) Sets a list of upper case tag names for which parsing / visiting should not correct missing closing tags.
void	visitEndTag(org.htmlparser.Tag tag) Visitor method (callback) invoked when a closing Tag is encountered.
void	visitRemarkNode(org.htmlparser.Remark remark) Visitor method (callback) invoked when a remark Tag (HTML comment) is encountered.
void	visitStringNode(org.htmlparser.Text text) Visitor method (callback) invoked when a remark Tag (HTML comment) is encountered.
void	visitTag(org.htmlparser.Tag tag) Visitor method (callback) invoked when a starting Tag (HTML comment) is encountered.

从类继承的方法 org.htmlparser.visitors.NodeVisitor

beginParsing, finishedParsing, shouldRecurseChildren, shouldRecurseSelf

从类继承的方法 java.lang.Object

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

字段详细资料

m_noAutoCloseTags

protected java.util.List<java.lang.String> m_noAutoCloseTags

List of upper case tag name strings of tags that should not be auto-corrected if closing divs are missing.

TAG_ARRAY

protected static final java.lang.String[] TAG_ARRAY

The array of supported tag names.

TAG_LIST

protected static final java.util.List<java.lang.String> TAG_LIST

The list of supported tag names.

m_echo

protected boolean m_echo

Indicates if "echo" mode is on, that is all content is written to the result by default.

m_result

protected java.lang.StringBuffer m_result

The buffer to write the out to.

构造器详细资料

CmsHtmlParser

public CmsHtmlParser()

Creates a new instance of the html converter with echo mode set to false.

CmsHtmlParser

public CmsHtmlParser(boolean echo)

Creates a new instance of the html converter.

参数:

echo - indicates if "echo" mode is on, that is all content is written to the result

方法详细资料

configureNoAutoCorrectionTags

protected org.htmlparser.PrototypicalNodeFactory configureNoAutoCorrectionTags()

Internally degrades Composite tags that do have children in the DOM tree to simple single tags. This allows to avoid auto correction of unclosed HTML tags.

返回:

A node factory that will not autocorrect open tags specified via setNoAutoCloseTags(List)

getConfiguration

public java.lang.String getConfiguration()

从接口复制的说明: I_CmsHtmlNodeVisitor

Returns the configuartion String of this visitor or the empty String if was not provided before.

指定者:

getConfiguration 在接口中 I_CmsHtmlNodeVisitor

返回:

the configuartion String of this visitor - by this contract never null but an empty String if not provided.

另请参阅:

I_CmsHtmlNodeVisitor.getConfiguration()

getResult

public java.lang.String getResult()

从接口复制的说明: I_CmsHtmlNodeVisitor

Returns the text extraction result.

指定者:

getResult 在接口中 I_CmsHtmlNodeVisitor

返回:

the text extraction result

另请参阅:

I_CmsHtmlNodeVisitor.getResult()

getTagHtml

public java.lang.String getTagHtml(org.htmlparser.Tag tag)

Returns the HTML for the given tag itself (not the tag content).

参数:

tag - the tag to create the HTML for

返回:

the HTML for the given tag

process

public java.lang.String process(java.lang.String html,
                       java.lang.String encoding)
                         throws org.htmlparser.util.ParserException

从接口复制的说明: I_CmsHtmlNodeVisitor

Extracts the text from the given html content, assuming the given html encoding.

指定者:

process 在接口中 I_CmsHtmlNodeVisitor

参数:

html - the content to extract the plain text from

encoding - the encoding to use

返回:

the text extracted from the given html content

抛出:

org.htmlparser.util.ParserException - if something goes wrong

另请参阅:

I_CmsHtmlNodeVisitor.process(java.lang.String, java.lang.String)

setConfiguration

public void setConfiguration(java.lang.String configuration)

从接口复制的说明: I_CmsHtmlNodeVisitor

Set a configuartion String for this visitor.

This will most likely be done with data from an xsd, custom jsp tag, ...

指定者:

setConfiguration 在接口中 I_CmsHtmlNodeVisitor

参数:

configuration - the configuration of this visitor to set.

另请参阅:

I_CmsHtmlNodeVisitor.setConfiguration(java.lang.String)

visitEndTag

public void visitEndTag(org.htmlparser.Tag tag)

从接口复制的说明: I_CmsHtmlNodeVisitor

Visitor method (callback) invoked when a closing Tag is encountered.

指定者:

visitEndTag 在接口中 I_CmsHtmlNodeVisitor

覆盖:

visitEndTag 在类中 org.htmlparser.visitors.NodeVisitor

参数:

tag - the tag that is ended.

另请参阅:

I_CmsHtmlNodeVisitor.visitEndTag(org.htmlparser.Tag)

visitRemarkNode

public void visitRemarkNode(org.htmlparser.Remark remark)

从接口复制的说明: I_CmsHtmlNodeVisitor

Visitor method (callback) invoked when a remark Tag (HTML comment) is encountered.

指定者:

visitRemarkNode 在接口中 I_CmsHtmlNodeVisitor

覆盖:

visitRemarkNode 在类中 org.htmlparser.visitors.NodeVisitor

参数:

remark - the remark Tag to visit.

另请参阅:

I_CmsHtmlNodeVisitor.visitRemarkNode(org.htmlparser.Remark)

visitStringNode

public void visitStringNode(org.htmlparser.Text text)

从接口复制的说明: I_CmsHtmlNodeVisitor

Visitor method (callback) invoked when a remark Tag (HTML comment) is encountered.

指定者:

visitStringNode 在接口中 I_CmsHtmlNodeVisitor

覆盖:

visitStringNode 在类中 org.htmlparser.visitors.NodeVisitor

参数:

text - the text that is visited.

另请参阅:

I_CmsHtmlNodeVisitor.visitStringNode(org.htmlparser.Text)

visitTag

public void visitTag(org.htmlparser.Tag tag)

从接口复制的说明: I_CmsHtmlNodeVisitor

Visitor method (callback) invoked when a starting Tag (HTML comment) is encountered.

指定者:

visitTag 在接口中 I_CmsHtmlNodeVisitor

覆盖:

visitTag 在类中 org.htmlparser.visitors.NodeVisitor

参数:

tag - the tag that is visited.

另请参阅:

I_CmsHtmlNodeVisitor.visitTag(org.htmlparser.Tag)

collapse

protected java.lang.String collapse(java.lang.String string)

Collapse HTML whitespace in the given String.

参数:

string - the string to collapse

返回:

the input String with all HTML whitespace collapsed

getNoAutoCloseTags

public java.util.List<java.lang.String> getNoAutoCloseTags()

Returns a list of upper case tag names for which parsing / visiting will not correct missing closing tags.

返回:

a List of upper case tag names for which parsing / visiting will not correct missing closing tags

setNoAutoCloseTags

public void setNoAutoCloseTags(java.util.List<java.lang.String> noAutoCloseTagList)

Sets a list of upper case tag names for which parsing / visiting should not correct missing closing tags.

指定者:

setNoAutoCloseTags 在接口中 I_CmsHtmlNodeVisitor

参数:

noAutoCloseTagList - a list of upper case tag names for which parsing / visiting should not correct missing closing tags to set.