org.opencms.jsp
Class CmsJspTagInclude

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

All Implemented Interfaces:

Serializable, BodyTag, IterationTag, Tag, I_CmsJspTagParamParent

public class CmsJspTagInclude
extends BodyTagSupport
implements I_CmsJspTagParamParent

Used to include another OpenCms managed resource in a JSP.

Since:

6.0.0

Version:

$Revision: 1.35 $

Author:

Alexander Kandzior

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

CmsJspTagInclude()

Method Summary

static void	addParameter(Map parameters, String name, String value, boolean overwrite) Adds parameters to a parameter Map that can be used for a http request.
void	addParameter(String name, String value) This methods adds parameters to the current request.
int	doEndTag()
int	doStartTag()
String	getAttribute() Returns the attribute.
String	getEditable() Returns the editable flag.
String	getElement() Returns the element.
String	getFile() Returns the value of getPage().
String	getPage() Returns the include page target.
String	getProperty() Returns the property.
String	getSuffix() Returns the suffix.
static void	includeTagAction(PageContext context, String target, String element, boolean editable, Map paramMap, ServletRequest req, ServletResponse res) Include action method.
void	release()
void	setAttribute(String attribute) Sets the attribute.
void	setEditable(String editable) Sets the editable flag.
void	setElement(String element) Sets the element.
void	setFile(String file) Sets the file, same as using setPage().
void	setPage(String target) Sets the include page target.
void	setProperty(String property) Sets the property.
void	setSuffix(String suffix) Sets the suffix.

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

doAfterBody, doInitBody, 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

Constructor Detail

CmsJspTagInclude

public CmsJspTagInclude()

Method Detail

addParameter

public static void addParameter(Map parameters,
                                String name,
                                String value,
                                boolean overwrite)

Adds parameters to a parameter Map that can be used for a http request.

Parameters:

parameters - the Map to add the parameters to

name - the name to add

value - the value to add

overwrite - if true, a parameter in the map will be overwritten by a parameter with the same name, otherwise the request will have multiple parameters with the same name (which is possible in http requests)

includeTagAction

public static void includeTagAction(PageContext context,
                                    String target,
                                    String element,
                                    boolean editable,
                                    Map paramMap,
                                    ServletRequest req,
                                    ServletResponse res)
                             throws JspException

Include action method.

The logic in this mehod is more complex than it should be. This is because of the XMLTemplate integration, which requires some settings to the parameters understandable only to XMLTemplate gurus. By putting this logic here it is not required to care about these issues on JSP pages, and you end up with considerable less JSP code. Also JSP developers need not to know the intrinsics of XMLTemplates this way.

Parameters:

context - the current JSP page context

target - the target for the include, might be null

element - the element to select form the target might be null

editable - the flag to indicate if the target is editable

paramMap - a map of parameters for the include, will be merged with the request parameters, might be null

req - the current request

res - the current response

Throws:

JspException - in case something goes wrong

addParameter

public void addParameter(String name,
                         String value)

This methods adds parameters to the current request. Parameters added here will be treated like parameters from the HttpRequest on included pages.

Remember that the value for a parameter in a HttpRequest is a String array, not just a simple String. If a parameter added here does not already exist in the HttpRequest, it will be added. If a parameter exists, another value will be added to the array of values. If the value already exists for the parameter, nothing will be added, since a value can appear only once per parameter.

Specified by:

addParameter in interface I_CmsJspTagParamParent

Parameters:

name - the name to add

value - the value to add

See Also:

I_CmsJspTagParamParent.addParameter(String, String)

doEndTag

public int doEndTag()
             throws JspException

Specified by:

doEndTag in interface Tag

Overrides:

doEndTag in class BodyTagSupport

Returns:

EVAL_PAGE

Throws:

JspException - by interface default

See Also:

Tag.doEndTag()

doStartTag

public int doStartTag()

Specified by:

doStartTag in interface Tag

Overrides:

doStartTag in class BodyTagSupport

Returns:

EVAL_BODY_BUFFERED

See Also:

Tag.doStartTag()

getAttribute

public String getAttribute()

Returns the attribute.

Returns:

the attribute

getEditable

public String getEditable()

Returns the editable flag.

Returns:

the editable flag

getElement

public String getElement()

Returns the element.

Returns:

the element

getFile

public String getFile()

Returns the value of getPage().

Returns:

the value of getPage()

See Also:

getPage()

getPage

public String getPage()

Returns the include page target.

Returns:

the include page target

getProperty

public String getProperty()

Returns the property.

Returns:

the property

getSuffix

public String getSuffix()

Returns the suffix.

Returns:

the suffix

release

public void release()

Specified by:

release in interface Tag

Overrides:

release in class BodyTagSupport

See Also:

Tag.release()

setAttribute

public void setAttribute(String attribute)

Sets the attribute.

Parameters:

attribute - the attribute to set

setEditable

public void setEditable(String editable)

Sets the editable flag.

Parameters:

editable - the flag to set

setElement

public void setElement(String element)

Sets the element.

Parameters:

element - the element to set

setFile

public void setFile(String file)

Sets the file, same as using setPage().

Parameters:

file - the file to set

See Also:

setPage(String)

setPage

public void setPage(String target)

Sets the include page target.

Parameters:

target - the target to set

setProperty

public void setProperty(String property)

Sets the property.

Parameters:

property - the property to set

setSuffix

public void setSuffix(String suffix)

Sets the suffix.

Parameters:

suffix - the suffix to set