info.magnolia.cms.taglibs
Class Include

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          info.magnolia.cms.taglibs.Include

All Implemented Interfaces:

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

public class Include
extends javax.servlet.jsp.tagext.BodyTagSupport

Delegates to an appropriate ParagraphRenderer, or include a JSP. This is typically used to render a paragraph. Within contentNodeIterator, parameters are provided automatically by the loop.

Version:

$Revision: 41137 $ ($Author: gjoseph $)

Author:

marcel Salathe, Sameer Charles, Fabrizio Giustina

See Also:

Serialized Form

Field Summary

protected RenderingEngine

renderingEngine

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

Include()

Method Summary

int	doAfterBody()
int	doEndTag()
void	release()
void	setAttribute(String name, Object value)
void	setContainer(Content contentNode) Deprecated. use the contentNode attribute instead
void	setContentNode(Content contentNode)
void	setContentNodeName(String contentNodeName) The name of the contentNode (i.e.
void	setNoEditBars(boolean noEditBars) Set to true if the content should not be rendered in edit mode (edit bars, ...).
void	setPath(String path) Deprecated. file to be included (e.g. "/templates/jsp/x.jsp"). Just use basic jsp tags (i.e. ) if you need to include a jsp in your templates.

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

doInitBody, doStartTag, 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

renderingEngine

protected RenderingEngine renderingEngine

Constructor Detail

Include

public Include()

Method Detail

setContainer

public void setContainer(Content contentNode)

Deprecated. use the contentNode attribute instead

See Also:

setContentNode(Content)

setContentNode

public void setContentNode(Content contentNode)

Parameters:

contentNode - the instance contentNode (i.e. paragraph) you wish to show

setPath

public void setPath(String path)

Deprecated. file to be included (e.g. "/templates/jsp/x.jsp"). Just use basic jsp tags (i.e. ) if you need to include a jsp in your templates.

setContentNodeName

public void setContentNodeName(String contentNodeName)

The name of the contentNode (i.e. paragraph) you wish to show.

setAttribute

public void setAttribute(String name,
                         Object value)

Parameters:

name - name of attribute to pass with the include

value - value of attribute to pass with the include

setNoEditBars

public void setNoEditBars(boolean noEditBars)

Set to true if the content should not be rendered in edit mode (edit bars, ...).

doAfterBody

public int doAfterBody()

Specified by:

doAfterBody in interface javax.servlet.jsp.tagext.IterationTag

Overrides:

doAfterBody in class javax.servlet.jsp.tagext.BodyTagSupport

doEndTag

public int doEndTag()

Specified by:

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

Overrides:

doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport

release

public void release()

Specified by:

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

Overrides:

release in class javax.servlet.jsp.tagext.BodyTagSupport