org.kohsuke.stapler.jelly

Class IncludeTag

java.lang.Object

org.apache.commons.jelly.TagSupport

org.kohsuke.stapler.jelly.IncludeTag

All Implemented Interfaces:

org.apache.commons.jelly.Tag

public class IncludeTag
extends org.apache.commons.jelly.TagSupport

Tag that includes views of the object.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	LOGGER
static boolean	SKIP_LOGGING_CLASS_SETTER

Fields inherited from class org.apache.commons.jelly.TagSupport

body, context, parent

Constructor Summary

Constructors

Constructor and Description
IncludeTag()

Method Summary

Modifier and Type	Method and Description
void	doTag(org.apache.commons.jelly.XMLOutput output)
void	setClass(Class clazz) Deprecated.
void	setClazz(Class clazz) When loading script, load from this class.
void	setFrom(Object from) When loading the script, use the classloader from this object to locate the script.
void	setIt(Object it) Specifies the object for which JSP will be included.
void	setOptional(boolean optional) If true, not finding the page is not an error.
void	setPage(String page) Specifies the name of the JSP to be included.

Methods inherited from class org.apache.commons.jelly.TagSupport

findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, getBody, getBodyText, getBodyText, getContext, getParent, invokeBody, isEscapeText, isTrim, setBody, setContext, setEscapeText, setParent, setTrim, trimBody

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER

public static final Logger LOGGER

SKIP_LOGGING_CLASS_SETTER

public static boolean SKIP_LOGGING_CLASS_SETTER

Constructor Detail

IncludeTag

public IncludeTag()

Method Detail

setPage

@Required
public void setPage(String page)

Specifies the name of the JSP to be included.

setIt

public void setIt(Object it)

Specifies the object for which JSP will be included. Defaults to the "it" object in the current context.

setFrom

public void setFrom(Object from)

When loading the script, use the classloader from this object to locate the script. Otherwise defaults to "it" object.

setClazz

public void setClazz(Class clazz)

When loading script, load from this class. By default this is "from.getClass()". This takes precedence over the setFrom(Object) method. This used to be called setClass, but that ended up causing problems with new commons-beanutils restrictions via ConvertingWrapDynaBean use in JellyBuilder. StaplerTagLibrary uses AttributeNameRewritingTagScript to ensure attempts to set class instead set clazz, and that attempts to set clazz directly that way fail.

setClass

@Deprecated
public void setClass(Class clazz)

Deprecated.

setOptional

public void setOptional(boolean optional)

If true, not finding the page is not an error. (And in such a case, the body of the include tag is evaluated instead.)

doTag

public void doTag(org.apache.commons.jelly.XMLOutput output)
           throws org.apache.commons.jelly.JellyTagException

Throws:

org.apache.commons.jelly.JellyTagException