Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> opencms >> flex >> [ jsp overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

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, javax.servlet.jsp.tagext.JspTag, java.io.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 $

---

Field Summary
static java.lang.String	C_BODYLOADER_URI           URI of the bodyloader XML file in the OpenCms VFS
private static boolean	DEBUG           Debugging on / off
private  java.lang.String	m_attribute
private  java.lang.String	m_element
private  java.util.HashMap	m_parameterMap           Hashmap to save paramters to the include in
private  java.lang.String	m_property
private  java.lang.String	m_suffix
private  java.lang.String	m_target

 

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
private static void	addParameter(java.util.Map parameters, java.lang.String name, java.lang.String value, boolean overwrite)           Internal method to add parameters.
void	addParameter(java.lang.String name, java.lang.String value)           This methods adds parameters to the current request.
int	doEndTag()           Default processing of the end tag returning EVAL_PAGE.
int	doStartTag()           Default processing of the start tag returning EVAL_BODY_BUFFERED.
java.lang.String	getAttribute()           Returns the attribute.
java.lang.String	getElement()           Returns the element.
java.lang.String	getFile()           Returns the value of getPage().
java.lang.String	getPage()           Returns the include page target.
java.lang.String	getProperty()           Returns the property.
java.lang.String	getSuffix()           Returns the suffix.
(package private) static void	includeTagAction(javax.servlet.jsp.PageContext context, java.lang.String target, java.lang.String element, java.util.Map paramMap, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res)           Include action method.
void	release()           Release state.
void	setAttribute(java.lang.String attribute)           Sets the attribute.
void	setElement(java.lang.String element)           Sets the element.
void	setFile(java.lang.String file)           Sets the file, same aus using setPage()
void	setPage(java.lang.String target)           Sets the include page target.
void	setProperty(java.lang.String property)           Sets the property.
void	setSuffix(java.lang.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

m_target

private java.lang.String m_target

---

m_suffix

private java.lang.String m_suffix

---

m_property

private java.lang.String m_property

---

m_attribute

private java.lang.String m_attribute

---

m_element

private java.lang.String m_element

---

m_parameterMap

private java.util.HashMap m_parameterMap

Hashmap to save paramters to the include in

---

DEBUG

private static final boolean DEBUG

Debugging on / off

See Also:

Constant Field Values

---

C_BODYLOADER_URI

public static final java.lang.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(java.lang.String target)

Sets the include page target.

---

getPage

public java.lang.String getPage()

Returns the include page target.

---

setFile

public void setFile(java.lang.String file)

Sets the file, same aus using setPage()

---

getFile

public java.lang.String getFile()

Returns the value of getPage().

---

getProperty

public java.lang.String getProperty()

Returns the property.

---

setProperty

public void setProperty(java.lang.String property)

Sets the property.

---

getAttribute

public java.lang.String getAttribute()

Returns the attribute.

---

setAttribute

public void setAttribute(java.lang.String attribute)

Sets the attribute.

---

getSuffix

public java.lang.String getSuffix()

Returns the suffix.

---

setSuffix

public void setSuffix(java.lang.String suffix)

Sets the suffix.

---

getElement

public java.lang.String getElement()

Returns the element.

---

setElement

public void setElement(java.lang.String element)

Sets the element.

---

release

public void release()

Description copied from class: javax.servlet.jsp.tagext.BodyTagSupport

Release state.

Specified by:

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

---

doStartTag

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

Description copied from class: javax.servlet.jsp.tagext.BodyTagSupport

Default processing of the start tag returning EVAL_BODY_BUFFERED.

Specified by:

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

---

doEndTag

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

Description copied from class: javax.servlet.jsp.tagext.BodyTagSupport

Default processing of the end tag returning EVAL_PAGE.

Specified by:

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

---

includeTagAction

static void includeTagAction(javax.servlet.jsp.PageContext context,
                             java.lang.String target,
                             java.lang.String element,
                             java.util.Map paramMap,
                             javax.servlet.ServletRequest req,
                             javax.servlet.ServletResponse res)
                      throws javax.servlet.jsp.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.

---

addParameter

public void addParameter(java.lang.String name,
                         java.lang.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

---

addParameter

private static void addParameter(java.util.Map parameters,
                                 java.lang.String name,
                                 java.lang.String value,
                                 boolean overwrite)

Internal method to add parameters.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> opencms >> flex >> [ jsp overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---