com.opencms.flex.jsp
Class CmsJspTagInclude

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--javax.servlet.jsp.tagext.BodyTagSupport
              |
              +--com.opencms.flex.jsp.CmsJspTagInclude

All Implemented Interfaces:

javax.servlet.jsp.tagext.BodyTag, I_CmsJspTagParamParent, javax.servlet.jsp.tagext.IterationTag, Serializable, javax.servlet.jsp.tagext.Tag

public class CmsJspTagInclude

extends javax.servlet.jsp.tagext.BodyTagSupport

implements I_CmsJspTagParamParent

Used to include another OpenCms managed resource in a JSP.

Version:

$Revision: 1.22.2.1 $

Author:

Alexander Kandzior (a.kandzior@alkacon.com)

See Also:

Serialized Form

Field Summary

static String

C_BODYLOADER_URI URI of the bodyloader XML file in the OpenCms VFS

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

void	addParameter(String name, String value) This methods adds parameters to the current request.
int	doEndTag()
int	doStartTag()
String	getAttribute() Returns the attribute.
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.
void	release()
void	setAttribute(String attribute) Sets the attribute.
void	setElement(String element) Sets the element.
void	setFile(String file) Sets the file, same aus 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

Field Detail

C_BODYLOADER_URI

public static final String C_BODYLOADER_URI

URI of the bodyloader XML file in the OpenCms VFS

See Also:

Constant Field Values

Constructor Detail

CmsJspTagInclude

public CmsJspTagInclude()

Method Detail

setPage

public void setPage(String target)

Sets the include page target.

Parameters:

target - the target to set

getPage

public String getPage()

Returns the include page target.

Returns:

the include page target

setFile

public void setFile(String file)

Sets the file, same aus using setPage()

See Also:

setPage(String)

getFile

public String getFile()

Returns the value of getPage().

Returns:

the value of getPage()

See Also:

getPage()

getProperty

public String getProperty()

Returns the property.

Returns:

the property

setProperty

public void setProperty(String property)

Sets the property.

Parameters:

property - the property to set

getAttribute

public String getAttribute()

Returns the attribute.

Returns:

the attribute

setAttribute

public void setAttribute(String attribute)

Sets the attribute.

Parameters:

attribute - the attribute to set

getSuffix

public String getSuffix()

Returns the suffix.

Returns:

the suffix

setSuffix

public void setSuffix(String suffix)

Sets the suffix.

Parameters:

suffix - the suffix to set

getElement

public String getElement()

Returns the element.

Returns:

the element

setElement

public void setElement(String element)

Sets the element.

Parameters:

element - the element to set

release

public void release()

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class javax.servlet.jsp.tagext.BodyTagSupport

See Also:

Tag.release()

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport

Returns:

EVAL_BODY_BUFFERED

javax.servlet.jsp.JspException

See Also:

Tag.doStartTag()

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport

Returns:

EVAL_PAGE

javax.servlet.jsp.JspException

See Also:

Tag.doEndTag()

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)