org.mmbase.bridge.jsp.taglib
Class AbstractNodeProviderTag

org.mmbase.bridge.jsp.taglib.ContextReferrerTag
  |
  +--org.mmbase.bridge.jsp.taglib.CloudReferrerTag
        |
        +--org.mmbase.bridge.jsp.taglib.NodeReferrerTag
              |
              +--org.mmbase.bridge.jsp.taglib.AbstractNodeProviderTag

All Implemented Interfaces:

NodeProvider, TagIdentifier

public abstract class AbstractNodeProviderTag

extends NodeReferrerTag

implements NodeProvider

A base class for tags which provide a node. The general attributes for a NodeProvider are

• id: The identifier. Used as a key for the Context. If this attribute is missing, the Node variable will not be imported in the Context.
• jspvar: An identifier for a jsp variable available in the body. If this attribute is missing, no jsp-variable will be created.

Author:

Michiel Meeuwissen, Kees Jongenburger

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

contextId, PAGE_CATEGORY, pageContextTag, referid

Constructor Summary

AbstractNodeProviderTag()

Method Summary

int	doAfterBody() Does everything needed on the afterbody tag of every NodeProvider.
int	doEndTag()
abstract void	doInitBody()
protected void	fillVars() Fill the jsp vars.
Node	getNodeVar() For use by children, they can find the current 'node' belonging to this tag.
void	setJspvar(java.lang.String jv)
void	setModified()
protected void	setNodeVar(Node node) Children can also directly access the node member, but the prefered method is to treat this variable as much as possible as private, and use this.

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

findNodeProvider, findNodeProvider, getNode, setNode

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

findCloudProvider, getCloud, getCloudContext, getNode, setCloud

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

findParentTag, findParentTag, getAttributeBoolean, getAttributeInteger, getAttributeInteger, getAttributeValue, getContextTag, getObject, getReferid, getString, release, setContext, setPageContext, setReferid

Methods inherited from interface org.mmbase.bridge.jsp.taglib.TagIdentifier

getId

Constructor Detail

AbstractNodeProviderTag

public AbstractNodeProviderTag()

Method Detail

setJspvar

public void setJspvar(java.lang.String jv)

Specified by:

setJspvar in interface NodeProvider

getNodeVar

public Node getNodeVar()

For use by children, they can find the current 'node' belonging to this tag.

Specified by:

getNodeVar in interface NodeProvider

Following copied from interface: org.mmbase.bridge.jsp.taglib.NodeProvider

Returns:

the node contained in the tag NOTE: we have decided to call this methid getNodeVar because we use tag attributes with name "node" and type String

setNodeVar

protected void setNodeVar(Node node)

Children can also directly access the node member, but the prefered method is to treat this variable as much as possible as private, and use this.

doInitBody

public abstract void doInitBody()
                         throws javax.servlet.jsp.JspTagException

fillVars

protected void fillVars()
                 throws javax.servlet.jsp.JspTagException

Fill the jsp vars.

setModified

public void setModified()

Specified by:

setModified in interface NodeProvider

doAfterBody

public int doAfterBody()
                throws javax.servlet.jsp.JspTagException

Does everything needed on the afterbody tag of every NodeProvider. Normally this function will be overrided with one that has to call super.doAfterBody().

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspTagException