org.apache.struts.faces.taglib

Class AbstractFacesTag

java.lang.Object

javax.faces.webapp.UIComponentTagBase

javax.faces.webapp.UIComponentClassicTagBase

javax.faces.webapp.UIComponentTag

org.apache.struts.faces.taglib.AbstractFacesTag

All Implemented Interfaces:

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

Direct Known Subclasses:

BaseTag, CommandLinkTag, ErrorsTag, FormTag, HtmlTag, MessageTag, StylesheetTag, WriteTag

public abstract class AbstractFacesTag
extends javax.faces.webapp.UIComponentTag

Abstract base class for custom component tags for the Struts-Faces Integration Library.

Version:

$Rev: 471754 $ $Date: 2006-11-06 08:55:09 -0600 (Mon, 06 Nov 2006) $

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	bundle The servlet context attribute under which our MessageResources bundle is stored.
protected java.lang.String	style The CSS style(s) used to render this component.
protected java.lang.String	styleClass The CSS style class(es) used to render this component.
protected java.lang.String	value The literal value to be rendered.

Fields inherited from class javax.faces.webapp.UIComponentClassicTagBase

bodyContent, pageContext, UNIQUE_ID_PREFIX

Fields inherited from class javax.faces.webapp.UIComponentTagBase

log

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

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

Constructor Summary

Constructors

Constructor and Description
AbstractFacesTag()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getComponentType() Return the component type of the component to be created for this tag.
abstract java.lang.String	getRendererType() Return the rendererType to be used for rendering our component.
void	release() Release any variables allocated during use of this tag instance.
protected void	setBooleanAttribute(javax.faces.component.UIComponent component, java.lang.String name, java.lang.String value) If the specified attribute value is not null use it to either store a value binding expression for the specified attribute name, or store it as the literal value of the attribute.
void	setBundle(java.lang.String bundle)
protected void	setIntegerAttribute(javax.faces.component.UIComponent component, java.lang.String name, java.lang.String value) If the specified attribute value is not null use it to either store a value binding expression for the specified attribute name, or store it as the literal value of the attribute.
protected void	setProperties(javax.faces.component.UIComponent component) Override attributes set on this tag instance.
protected void	setStringAttribute(javax.faces.component.UIComponent component, java.lang.String name, java.lang.String value) If the specified attribute value is not null use it to either store a value binding expression for the specified attribute name, or store it as the literal value of the attribute.
void	setStyle(java.lang.String style)
void	setStyleClass(java.lang.String styleClass)
void	setValue(java.lang.String value)

Methods inherited from class javax.faces.webapp.UIComponentTag

createComponent, getParentUIComponentTag, hasBinding, isSuppressed, isValueReference, setBinding, setRendered

Methods inherited from class javax.faces.webapp.UIComponentClassicTagBase

addChild, addFacet, addVerbatimAfterComponent, addVerbatimBeforeComponent, createVerbatimComponent, createVerbatimComponentFromBodyContent, doAfterBody, doEndTag, doInitBody, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getBodyContent, getComponentInstance, getCreated, getCreatedComponents, getDoAfterBodyValue, getDoEndValue, getDoStartValue, getFacesContext, getFacesJspId, getFacetName, getId, getIndexOfNextChildTag, getJspId, getParent, getParentUIComponentClassicTagBase, getPreviousOut, setBodyContent, setId, setJspId, setPageContext, setParent, setupResponseWriter

Methods inherited from class javax.faces.webapp.UIComponentTagBase

getELContext

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

Field Detail

bundle

protected java.lang.String bundle

The servlet context attribute under which our MessageResources bundle is stored.

style

protected java.lang.String style

The CSS style(s) used to render this component.

styleClass

protected java.lang.String styleClass

The CSS style class(es) used to render this component.

value

protected java.lang.String value

The literal value to be rendered.

Constructor Detail

AbstractFacesTag

public AbstractFacesTag()

Method Detail

setBundle

public void setBundle(java.lang.String bundle)

setStyle

public void setStyle(java.lang.String style)

setStyleClass

public void setStyleClass(java.lang.String styleClass)

setValue

public void setValue(java.lang.String value)

getComponentType

public abstract java.lang.String getComponentType()

Return the component type of the component to be created for this tag.

Specified by:

getComponentType in class javax.faces.webapp.UIComponentTagBase

getRendererType

public abstract java.lang.String getRendererType()

Return the rendererType to be used for rendering our component.

Specified by:

getRendererType in class javax.faces.webapp.UIComponentTagBase

release

public void release()

Release any variables allocated during use of this tag instance.

Specified by:

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

Overrides:

release in class javax.faces.webapp.UIComponentTag

setProperties

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

Override attributes set on this tag instance.

Overrides:

setProperties in class javax.faces.webapp.UIComponentTag

Parameters:

component - Component whose attributes should be overridden

setBooleanAttribute

protected void setBooleanAttribute(javax.faces.component.UIComponent component,
                                   java.lang.String name,
                                   java.lang.String value)

If the specified attribute value is not null use it to either store a value binding expression for the specified attribute name, or store it as the literal value of the attribute.

Parameters:

component - UIComponent whose attribute is to be set

name - Attribute name

value - Attribute value (or null)

Throws:

java.lang.NumberFormatException - if the value does not contain a parsable integer

ReferenceSyntaxException - if the expression has invalid syntax

setIntegerAttribute

protected void setIntegerAttribute(javax.faces.component.UIComponent component,
                                   java.lang.String name,
                                   java.lang.String value)

If the specified attribute value is not null use it to either store a value binding expression for the specified attribute name, or store it as the literal value of the attribute.

Parameters:

component - UIComponent whose attribute is to be set

name - Attribute name

value - Attribute value (or null)

Throws:

java.lang.NumberFormatException - if the value does not contain a parsable integer

ReferenceSyntaxException - if the expression has invalid syntax

setStringAttribute

protected void setStringAttribute(javax.faces.component.UIComponent component,
                                  java.lang.String name,
                                  java.lang.String value)

If the specified attribute value is not null use it to either store a value binding expression for the specified attribute name, or store it as the literal value of the attribute.

Parameters:

component - UIComponent whose attribute is to be set

name - Attribute name

value - Attribute value (or null)

Throws:

ReferenceSyntaxException - if the expression has invalid syntax