org.apache.shale.clay.taglib
Class SymbolTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      org.apache.shale.clay.taglib.SymbolTag

All Implemented Interfaces:

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

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

This Tag is used to add replacement symbols to the Clay component. Replacement symbols are substituted within the meta-data used to build the subtree under the Clay component. This tag is similar to the standard JSF attribute tag. The name attribute will be prepended with an '@' character. The "at" character is the symbol identifier.

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

SymbolTag()

Method Summary

int	doStartTag() Finds the parent component and adds the symbol to the Clay component's symbol table.
java.lang.String	getName() Returns the name of the symbol.
java.lang.String	getValue() Returns the value for the symbol.
void	setName(java.lang.String name) Sets the name of the symbol.
void	setValue(java.lang.String value) Sets the value for the symbol.

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

SymbolTag

public SymbolTag()

Method Detail

getName

public java.lang.String getName()

Returns the name of the symbol.

Returns:

name of the symbol

setName

public void setName(java.lang.String name)

Sets the name of the symbol.

Parameters:

name - of the symbol

getValue

public java.lang.String getValue()

Returns the value for the symbol.

Returns:

value of the symbol

setValue

public void setValue(java.lang.String value)

Sets the value for the symbol.

Parameters:

value - of the symbol

doStartTag

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

Finds the parent component and adds the symbol to the Clay component's symbol table. The parent has to be a Clay component.

Specified by:

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

Overrides:

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

Returns:

next transition

Throws:

javax.servlet.jsp.JspException - general JSP tag