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

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by javax.servlet.jsp.tagext.BodyTagSupport
          extended by org.mmbase.bridge.jsp.taglib.ContextReferrerTag
              extended by org.mmbase.bridge.jsp.taglib.CloudReferrerTag
                  extended by org.mmbase.bridge.jsp.taglib.pageflow.UrlTag
                      extended by org.mmbase.bridge.jsp.taglib.pageflow.IncludeTag
All Implemented Interfaces:
Serializable, BodyTag, IterationTag, JspTag, Tag, TryCatchFinally, FrameworkParamHandler, ParamHandler
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 39412 2009-10-28 13:31:14Z michiel $
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 static int MAX_INCLUDE_LEVEL
           
protected  Attribute notFound
           
protected  Attribute omitXmlDeclaration
           
protected  Object prevIncludePath
           
protected  Attribute resource
           
protected  Attribute timeOut
           
 
Fields inherited from class org.mmbase.bridge.jsp.taglib.pageflow.UrlTag
absolute, block, escapeAmps, extraParameters, frameworkParameters, page, parameters, referids, url
 
Fields inherited from class org.mmbase.bridge.jsp.taglib.CloudReferrerTag
cloudId
 
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 org.mmbase.bridge.jsp.taglib.ParamHandler
KEY, SCOPE
 
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  void checkAttributes()
           
protected  void doAfterBodySetValue()
           
 int doEndTag()
           
 int doStartTag()
           
protected  boolean getCite()
           
protected  Debug getDebug()
           
protected  String getPage()
          Return the page.
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)
           
 void setTimeout(String t)
           
 
Methods inherited from class org.mmbase.bridge.jsp.taglib.pageflow.UrlTag
addFrameworkParameter, addParameter, doAfterBody, doMakeRelative, encode, escapeAmps, getAbsolute, getComponent, getExtraParameters, getPage, getParameters, getUrl, getUrl, initDoEndTag, initTag, makeRelative, setAbsolute, setBlock, setEncode, setEscapeamps, setInternal, setPage, setProcess, setReferids
 
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
appendMoreParameters, doCatch, doFinally, findLoopOrQuery, findParentTag, findParentTag, findWriter, findWriter, getAttribute, getAttribute, getAttributeBoolean, getAttributeInteger, getAttributeInteger, getAttributeValue, getContentTag, getContextProvider, getContextTag, getCurrentBlock, getDefaultLocale, getEscapedValue, getFormTag, getId, getLocaleFromContext, getObject, getObjectConditional, getPageContext, getPageContextTag, getQuery, getReferid, getString, getTaglibVersion, getThreadPageContext, 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

MAX_INCLUDE_LEVEL

protected static int MAX_INCLUDE_LEVEL

debugType

protected Attribute debugType

notFound

protected Attribute notFound

resource

protected Attribute resource

timeOut

protected Attribute timeOut

omitXmlDeclaration

protected Attribute omitXmlDeclaration

prevIncludePath

protected Object prevIncludePath
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

setTimeout

public void setTimeout(String t)
                throws JspTagException
Throws:
JspTagException
Since:
MMBase-1.8.5

getPage

protected String getPage()
                  throws JspTagException
Description copied from class: UrlTag
Return the page.

Overrides:
getPage in class UrlTag
Throws:
JspTagException

checkAttributes

protected void checkAttributes()
                        throws JspTagException
Throws:
JspTagException
Since:
MMBase-1.8.5

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

handleResponse

protected void handleResponse(int code,
                              String result,
                              String url)
                       throws JspTagException
Throws:
JspTagException
Since:
MMBase-1.8

includePage

protected void includePage()
                    throws JspTagException,
                           FrameworkException
Includes another page in the current page.

Throws:
JspTagException
FrameworkException

doEndTag

public int doEndTag()
             throws JspTagException
Specified by:
doEndTag in interface Tag
Overrides:
doEndTag in class UrlTag
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 Debug 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)



MMBase 2.0-SNAPSHOT - null