org.apache.shale.clay.taglib

Class ClayTag

java.lang.Object

javax.faces.webapp.UIComponentTag

javax.faces.webapp.UIComponentBodyTag

org.apache.shale.clay.taglib.ClayTag

All Implemented Interfaces:

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

public class ClayTag
extends javax.faces.webapp.UIComponentBodyTag

JSP Tag for the Clay component.

Field Summary

Fields inherited from class javax.faces.webapp.UIComponentBodyTag

bodyContent

Fields inherited from class javax.faces.webapp.UIComponentTag

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

Constructors

Constructor and Description
ClayTag()

Method Summary

Methods

Modifier and Type	Method and Description
String	getComponentType() Returns the logical component name registered in the faces config for the Clay component.
String	getJsfid() Gets the display Element identifier to be rendered.
String	getManagedBeanName() Gets the name of the managed bean that is dynamically resolved using a token replacement before binding the value expression.
String	getRendererType() Returns the render registered for the component.
String	getShapeValidator() Returns the expression literal defining the validator event method binding.
void	setJsfid(String jsfid) Sets the identifier defining component metadata.
void	setManagedBeanName(String managedBeanName) Name of the managed bean that is dynamically resolved.
protected void	setProperties(javax.faces.component.UIComponent component) This method is invoked by the super and its purpose it to push tag attributes to corresponding component property values.
void	setShapeValidator(String shapeValidator) Sets the expression literal defining the validator event method binding.

Methods inherited from class javax.faces.webapp.UIComponentBodyTag

doAfterBody, doInitBody, getBodyContent, getDoAfterBodyValue, getDoStartValue, getPreviousOut, release, setBodyContent

Methods inherited from class javax.faces.webapp.UIComponentTag

doEndTag, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getComponentInstance, getCreated, getDoEndValue, getFacesContext, getFacetName, getId, getParent, getParentUIComponentTag, isSuppressed, isValueReference, setBinding, setId, setPageContext, setParent, setRendered, setupResponseWriter

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

doEndTag, doStartTag, getParent, setPageContext, setParent

Constructor Detail

ClayTag

public ClayTag()

Method Detail

getShapeValidator

public String getShapeValidator()

Returns the expression literal defining the validator event method binding.

Returns:

method binding expression

setShapeValidator

public void setShapeValidator(String shapeValidator)

Sets the expression literal defining the validator event method binding.

Parameters:

shapeValidator - String validator binding expression

getJsfid

public String getJsfid()

Gets the display Element identifier to be rendered.

Returns:

jsfid

setJsfid

public void setJsfid(String jsfid)

Sets the identifier defining component metadata.

Parameters:

jsfid - String sets the component element to be rendered

getManagedBeanName

public String getManagedBeanName()

Gets the name of the managed bean that is dynamically resolved using a token replacement before binding the value expression. If not explicitly set, it will default to the literal UNKNOWN

Returns:

managed bean name symbol

setManagedBeanName

public void setManagedBeanName(String managedBeanName)

Name of the managed bean that is dynamically resolved. The literal string "managed-bean-name" is replaced with the value of this property.

Parameters:

managedBeanName - String

getComponentType

public String getComponentType()

Returns the logical component name registered in the faces config for the Clay component.

Specified by:

getComponentType in class javax.faces.webapp.UIComponentTag

Returns:

component type

See Also:

UIComponentTag.getComponentType()

getRendererType

public String getRendererType()

Returns the render registered for the component. The Clay component doesn't have a render because the component invokes the rendering of it's children.

Specified by:

getRendererType in class javax.faces.webapp.UIComponentTag

Returns:

null

See Also:

UIComponentTag.getRendererType()

setProperties

protected void setProperties(javax.faces.component.UIComponent component)

This method is invoked by the super and its purpose it to push tag attributes to corresponding component property values.

Overrides:

setProperties in class javax.faces.webapp.UIComponentTag

Parameters:

component - UIComponent instance of Clay