org.opencms.jsp
Class CmsJspTagDecorate

java.lang.Object
  extended byjavax.servlet.jsp.tagext.TagSupport
      extended byjavax.servlet.jsp.tagext.BodyTagSupport
          extended byorg.opencms.jsp.CmsJspTagDecorate
All Implemented Interfaces:
javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class CmsJspTagDecorate
extends javax.servlet.jsp.tagext.BodyTagSupport

Implements the <cms:decorate></cms:decorate> tag to decorate HTML content with configurated decoration maps.

Since:
6.1.3
Version:
$Revision: 1.8 $
Author:
Michael Emmerich
See Also:
Serialized Form

Field Summary
 
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
CmsJspTagDecorate()
           
 
Method Summary
 java.lang.String decorateTagAction(java.lang.String content, java.lang.String configFile, java.lang.String locale, javax.servlet.ServletRequest req)
          Internal action method.
 int doEndTag()
           
 java.lang.String getFile()
          Returns the file name.
 java.lang.String getLocale()
          Returns the locale name.
 java.lang.String getNoAutoCloseTags()
          Getter for the attribute "noAutoCloseTags" of the <cms:parse> tag.
 void setFile(java.lang.String file)
          Sets the file name.
 void setLocale(java.lang.String locale)
          Sets the locale name.
 void setNoAutoCloseTags(java.lang.String noAutoCloseTagList)
          Setter for the attribute "noAutoCloseTags" of the <cms:parse> tag.
 
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doAfterBody, doInitBody, doStartTag, getBodyContent, getPreviousOut, release, 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
 

Constructor Detail

CmsJspTagDecorate

public CmsJspTagDecorate()
Method Detail

decorateTagAction

public java.lang.String decorateTagAction(java.lang.String content,
                                          java.lang.String configFile,
                                          java.lang.String locale,
                                          javax.servlet.ServletRequest req)
Internal action method.

DEcorates a HTMl content block.

Parameters:
content - the content to be decorated
configFile - the config file
locale - the locale to use for decoration or NOLOCALE if not locale should be used
req - the current request
Returns:
the decorated content

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException
Returns:
EVAL_PAGE
Throws:
javax.servlet.jsp.JspException - in case soemthing goes wrong
See Also:
Tag.doEndTag()

getFile

public java.lang.String getFile()
Returns the file name.

Returns:
the file name

getLocale

public java.lang.String getLocale()
Returns the locale name.

Returns:
the locale name

getNoAutoCloseTags

public java.lang.String getNoAutoCloseTags()
Getter for the attribute "noAutoCloseTags" of the <cms:parse> tag.

Returns a String that consists of the comma-separated upper case tag names for which this tag will not correct missing closing tags.

Returns:
a String that consists of the comma-separated upper case tag names for which this tag will not correct missing closing tags.

setFile

public void setFile(java.lang.String file)
Sets the file name.

Parameters:
file - the file name

setLocale

public void setLocale(java.lang.String locale)
Sets the locale name.

Parameters:
locale - the locale name

setNoAutoCloseTags

public void setNoAutoCloseTags(java.lang.String noAutoCloseTagList)
Setter for the attribute "noAutoCloseTags" of the <cms:parse> tag.

Awaits a String that consists of the comma-separated upper case tag names for which this tag should not correct missing closing tags.

Parameters:
noAutoCloseTagList - a String that consists of the comma-separated upper case tag names for which this tag should not correct missing closing tags.