org.opencms.jsp.decorator
Class CmsHtmlDecorator

java.lang.Object
  org.htmlparser.visitors.NodeVisitor
      org.opencms.util.CmsHtmlParser
          org.opencms.jsp.decorator.CmsHtmlDecorator

All Implemented Interfaces:

I_CmsHtmlNodeVisitor

public class CmsHtmlDecorator
extends CmsHtmlParser

The CmsHtmlDecorator is the main object for processing the text decorations.

It uses the information of a CmsDecoratorConfiguration to process the text decorations.

Since:

6.1.3

Version:

$Revision: 1.2 $

Author:

Michael Emmerich

Field Summary

Fields inherited from class org.opencms.util.CmsHtmlParser

m_echo, m_result, TAG_ARRAY, TAG_LIST

Constructor Summary

CmsHtmlDecorator(CmsDecoratorConfiguration config)
Constructor, creates a new CmsHtmlDecorator with a given configuration.

CmsHtmlDecorator(CmsObject cms)
Constructor, creates a new, empty CmsHtmlDecorator.

Method Summary

static String	doDecoration(String html, CmsDecoratorConfiguration config, String encoding) Processes a HTML string and adds text decorations according to the decoration configuration.
static String	doDecoration(String html, CmsHtmlDecorator processor, String encoding) Processes a HTML string and adds text decorations according to the decoration configuration.
void	resetDecorationDefinitions() Resets the first occurance flags of all decoration objects.
static List	splitAsList(String source, String[] delimiters, boolean trim, boolean includeDelimiters) Splits a String into substrings along the provided delimiter list and returns the result as a List of Substrings.
void	visitStringNode(Text text) Visitor method (callback) invoked when a remark Tag (HTML comment) is encountered.

Methods inherited from class org.opencms.util.CmsHtmlParser

collapse, getConfiguration, getResult, getTagHtml, process, process, setConfiguration, visitEndTag, visitRemarkNode, visitTag

Methods inherited from class org.htmlparser.visitors.NodeVisitor

beginParsing, finishedParsing, shouldRecurseChildren, shouldRecurseSelf

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsHtmlDecorator

public CmsHtmlDecorator(CmsDecoratorConfiguration config)

Constructor, creates a new CmsHtmlDecorator with a given configuration.

Parameters:

config - the configuration to be used

CmsHtmlDecorator

public CmsHtmlDecorator(CmsObject cms)

Constructor, creates a new, empty CmsHtmlDecorator.

Parameters:

cms - the CmsObject

Method Detail

doDecoration

public static String doDecoration(String html,
                                  CmsDecoratorConfiguration config,
                                  String encoding)
                           throws Exception

Processes a HTML string and adds text decorations according to the decoration configuration.

Parameters:

html - a string holding the HTML code that should be added with text decorations

config - the decoration configuration

encoding - the encoding to be used

Returns:

a HTML string with the decorations added.

Throws:

Exception - if something goes wrong

doDecoration

public static String doDecoration(String html,
                                  CmsHtmlDecorator processor,
                                  String encoding)
                           throws Exception

Processes a HTML string and adds text decorations according to the decoration configuration.

Parameters:

html - a string holding the HTML code that should be added with text decorations

processor - an already configured

encoding - the encoding to be used

Returns:

a HTML string with the decorations added.

Throws:

Exception - if something goes wrong

splitAsList

public static List splitAsList(String source,
                               String[] delimiters,
                               boolean trim,
                               boolean includeDelimiters)

Splits a String into substrings along the provided delimiter list and returns the result as a List of Substrings.

Parameters:

source - the String to split

delimiters - the delimiters to split at

trim - flag to indicate if leading and trailing whitespaces should be omitted

includeDelimiters - flag to indicate if the delimiters should be included as well

Returns:

the List of splitted Substrings

resetDecorationDefinitions

public void resetDecorationDefinitions()

Resets the first occurance flags of all decoration objects.

This is nescessary if decoration objects should be used for processing more than once. *

visitStringNode

public void visitStringNode(Text text)

Description copied from interface: I_CmsHtmlNodeVisitor

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

Specified by:

visitStringNode in interface I_CmsHtmlNodeVisitor

Overrides:

visitStringNode in class CmsHtmlParser

Parameters:

text - the text that is visited.

See Also:

NodeVisitor.visitStringNode(org.htmlparser.Text)