org.sf.bluprints
Class IncludeTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      org.sf.bluprints.IncludeTag

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class IncludeTag
extends javax.servlet.jsp.tagext.TagSupport

This tag is used to include a Bluprint definition on the page. This is only necessary because Bluprints can be nested and therefore this tag is responsible for maintaining a stack of Bluprints so that the page being rendered always has the correct Bluprint object in the request under the key bluprint.

Author:

Brian Pontarelli

See Also:

Serialized Form

Field Summary

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

id, pageContext

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

int	doStartTag() Renders the include.
String	getContent() Gets the content that was passed from the page.
boolean	isFlush() Determines if the buffered is flushed to the client after the Bluprint is included using the PageContext.
boolean	isIgnore() Determines if exceptions are ignored by this taglib.
void	setContent(String content) Sets the content that was passed from the page.
void	setFlush(boolean flush) Determines if the buffered is flushed to the client after the Bluprint is included using the PageContext.
void	setIgnore(boolean ignore) Determines if exceptions are ignored by this taglib.

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

doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

IncludeTag

public IncludeTag()

Method Detail

getContent

public String getContent()

Gets the content that was passed from the page. This is the name that is used to locate the Bluprint definition from the XML configuration file.

Returns:

The content name.

setContent

public void setContent(String content)

Sets the content that was passed from the page. This is the name that is used to locate the Bluprint definition from the XML configuration file.

Parameters:

content - The content name which is the name of the bluprint to fetch.

isIgnore

public boolean isIgnore()

Determines if exceptions are ignored by this taglib.

setIgnore

public void setIgnore(boolean ignore)

Determines if exceptions are ignored by this taglib.

isFlush

public boolean isFlush()

Determines if the buffered is flushed to the client after the Bluprint is included using the PageContext.

setFlush

public void setFlush(boolean flush)

Determines if the buffered is flushed to the client after the Bluprint is included using the PageContext.

doStartTag

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

Renders the include.

Specified by:

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

Overrides:

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

Throws:

javax.servlet.jsp.JspException