org.mmbase.bridge.jsp.taglib.pageflow
Class IncludeTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          org.mmbase.bridge.jsp.taglib.ContextReferrerTag
              org.mmbase.bridge.jsp.taglib.CloudReferrerTag
                  org.mmbase.bridge.jsp.taglib.pageflow.UrlTag
                      org.mmbase.bridge.jsp.taglib.pageflow.IncludeTag

All Implemented Interfaces:

BodyTag, IterationTag, ParamHandler, Serializable, Tag

Direct Known Subclasses:

LeafIncludeTag, TreeIncludeTag

public class IncludeTag

extends UrlTag

Like UrlTag, but does not spit out an URL, but the page itself.

Version:

$Id: IncludeTag.java,v 1.66 2006/03/28 22:35:22 michiel Exp $

Author:

Michiel Meeuwissen, Johannes Verelst

See Also:

Serialized Form

Field Summary

protected Attribute	debugType
static String	INCLUDE_LEVEL_KEY
static String	INCLUDE_PATH_KEY
protected Attribute	notFound
protected Attribute	resource

Fields inherited from class org.mmbase.bridge.jsp.taglib.pageflow.UrlTag

encode, escapeAmps, extraParameters, page

Fields inherited from class org.mmbase.bridge.jsp.taglib.ContextReferrerTag

contextId, EVAL_BODY, helper, id, pageContextTag, referid, writerid

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

bodyContent

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

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

IncludeTag()

Method Summary

protected boolean	addContext()
protected void	doAfterBodySetValue()
int	doStartTag()
protected boolean	getCite()
protected int	getDebug()
protected String	getPage()
protected String	getThisName() Returns a name for this tag, that must appear in the debug message (in the comments)
protected void	handleResponse(int code, String result, String url)
protected void	includePage() Includes another page in the current page.
void	setAttributes(String a)
void	setCite(String c) Test whether or not the 'cite' parameter is set
void	setDebug(String p) With debug attribute you can write the urls in comments to the page, just before and after the included page.
void	setEncoding(String e)
void	setNotfound(String n)
void	setResource(String r)

Methods inherited from class org.mmbase.bridge.jsp.taglib.pageflow.UrlTag

addParameter, doAfterBody, doEndTag, doMakeRelative, getUrl, getUrl, getUrl, initDoEndTag, makeRelative, setAbsolute, setEncode, setEscapeamps, setPage, setReferids, useAbsoluteAttribute

Methods inherited from class org.mmbase.bridge.jsp.taglib.CloudReferrerTag

fillStandardParameters, findCloudProvider, findCloudProvider, getCloudContext, getCloudVar, getLocale, getNode, getNodeOrNull, setCloud

Methods inherited from class org.mmbase.bridge.jsp.taglib.ContextReferrerTag

findLoopOrQuery, findParentTag, findParentTag, findParentTag, findParentTag, findWriter, findWriter, getAttribute, getAttributeBoolean, getAttributeInteger, getAttributeInteger, getAttributeValue, getContentTag, getContextProvider, getContextTag, getDefaultLocale, getEscapedValue, getId, getObject, getObjectConditional, getPageContext, getPageContextTag, getReferid, getString, getTaglibVersion, getTimeZone, getWriterValue, haveBody, release, setContext, setEscape, setId, setJspvar, setListdelimiter, setPageContext, setReferid, setVartype, setWrite, setWriter

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

doInitBody, getBodyContent, getPreviousOut, setBodyContent

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

findAncestorWithClass, getParent, getValue, getValues, removeValue, 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, setParent

Field Detail

INCLUDE_PATH_KEY

public static final String INCLUDE_PATH_KEY

See Also:

Constant Field Values

INCLUDE_LEVEL_KEY

public static final String INCLUDE_LEVEL_KEY

See Also:

Constant Field Values

debugType

protected Attribute debugType

notFound

protected Attribute notFound

resource

protected Attribute resource

Constructor Detail

IncludeTag

public IncludeTag()

Method Detail

setCite

public void setCite(String c)
             throws JspTagException

Test whether or not the 'cite' parameter is set

Throws:

JspTagException

setEncoding

public void setEncoding(String e)
                 throws JspTagException

Throws:

JspTagException

setNotfound

public void setNotfound(String n)
                 throws JspTagException

Throws:

JspTagException

getCite

protected boolean getCite()
                   throws JspTagException

Throws:

JspTagException

setAttributes

public void setAttributes(String a)
                   throws JspTagException

Throws:

JspTagException

setResource

public void setResource(String r)
                 throws JspTagException

Throws:

JspTagException

getPage

protected String getPage()
                  throws JspTagException

Overrides:

getPage in class UrlTag

Throws:

JspTagException

doStartTag

public int doStartTag()
               throws JspTagException

Specified by:

doStartTag in interface Tag

Overrides:

doStartTag in class UrlTag

Throws:

JspTagException

doAfterBodySetValue

protected void doAfterBodySetValue()
                            throws JspTagException

Overrides:

doAfterBodySetValue in class UrlTag

Throws:

JspTagException

addContext

protected boolean addContext()

Overrides:

addContext in class UrlTag

handleResponse

protected void handleResponse(int code,
                              String result,
                              String url)
                       throws JspTagException

Throws:

JspTagException

Since:

MMBase-1.8

includePage

protected void includePage()
                    throws JspTagException

Includes another page in the current page.

Throws:

JspTagException

setDebug

public void setDebug(String p)
              throws JspTagException

With debug attribute you can write the urls in comments to the page, just before and after the included page.

Throws:

JspTagException

getDebug

protected int getDebug()
                throws JspTagException

Throws:

JspTagException

getThisName

protected String getThisName()

Returns a name for this tag, that must appear in the debug message (in the comments)