org.opencms.jsp
Class CmsJspTagParse

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          org.opencms.jsp.CmsJspTagParse

All Implemented Interfaces:

Serializable, BodyTag, IterationTag, Tag

public class CmsJspTagParse
extends BodyTagSupport

Implements the <cms:parse></cms:parse> tag to allow parsing of nested HTML with the A_CmsConfiguredHtmlParser} implementation specified by the "parserClass" attribute.

Since:

6.1.3

Version:

$Revision: 1.2 $

Author:

Achim Westermann

See Also:

Serialized Form

Field Summary

static String	ATT_VISITOR_CLASS The name of the mandatory Tag attribute for the visitor class an instance of will be guided throught the body content.
static String	TAG_NAME Tag name constant for log output.

Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

bodyContent

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

CmsJspTagParse()

Method Summary

int	doEndTag()
String	getParam() Returns the param.
String	getParserClass() Returns the fully qualified class name of the A_CmsConfiguredHtmlParser class to use for parsing.
static String	parseTagAction(String content, PageContext context, A_CmsConfiguredHtmlParser parser) Internal action method.
void	release()
void	setParam(String param) Sets the param.
void	setParserClass(String parserClass) Sets the fully qualified class name of the A_CmsConfiguredHtmlParser class to use for parsing.

Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

doAfterBody, doInitBody, doStartTag, getBodyContent, getPreviousOut, setBodyContent

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Field Detail

ATT_VISITOR_CLASS

public static final String ATT_VISITOR_CLASS

The name of the mandatory Tag attribute for the visitor class an instance of will be guided throught the body content.

See Also:

Constant Field Values

TAG_NAME

public static final String TAG_NAME

Tag name constant for log output.

See Also:

Constant Field Values

Constructor Detail

CmsJspTagParse

public CmsJspTagParse()

Method Detail

parseTagAction

public static String parseTagAction(String content,
                                    PageContext context,
                                    A_CmsConfiguredHtmlParser parser)

Internal action method.

Parses (and potentially transforms) a HTMl content block.

Parameters:

content - the content to be parsed / transformed.

context - needed for getting the encoding / the locale.

parser - the visitor / parser to use.

Returns:

the transformed content.

doEndTag

public int doEndTag()
             throws JspException

Specified by:

doEndTag in interface Tag

Overrides:

doEndTag in class BodyTagSupport

Returns:

EVAL_PAGE

Throws:

JspException - in case soemthing goes wrong

See Also:

Tag.doEndTag()

getParam

public String getParam()

Returns the param.

Returns:

the param

getParserClass

public String getParserClass()

Returns the fully qualified class name of the A_CmsConfiguredHtmlParser class to use for parsing.

Returns:

the parserrClass

release

public void release()

Specified by:

release in interface Tag

Overrides:

release in class BodyTagSupport

See Also:

Tag.release()

setParam

public void setParam(String param)

Sets the param.

Parameters:

param - the param to set

setParserClass

public void setParserClass(String parserClass)

Sets the fully qualified class name of the A_CmsConfiguredHtmlParser class to use for parsing.

Parameters:

parserClass - the fully qualified class name of the A_CmsConfiguredHtmlParser class to use for parsing.