|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.servlet.jsp.tagext.TagSupport | +--javax.faces.webapp.ConverterTag
ConverterTag is a base class for all JSP custom actions
that create and register a Converter
instance on the
ValueHolder
associated with our most immediate
surrounding instance of a tag whose implementation class is a subclass
of UIComponentTag
. To avoid creating duplicate instances when
a page is redisplayed, creation and registration of a Converter
occurs only if the corresponding UIComponent
was
created (by the owning UIComponentTag
) during the execution of the
current page.
This class may be used directly to implement a generic converter
registration tag (based on the converter-id specified by the
converterId
attribute), or as a base class for tag
instances that support specific Converter
subclasses. This
converterId
attribute must refer to one of the well
known converter-ids, or a custom converter-id as defined in a
faces-config.xml
file.
Subclasses of this class must implement the
createConverter()
method, which creates and returns a
Converter
instance. Any configuration properties that specify
behavior of this Converter
must have been set by the
createConverter()
method. Generally, this occurs
by copying corresponding attribute values on the tag instance.
This tag creates no output to the page currently being created. It
is used solely for the side effect of Converter
creation.
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 | |
ConverterTag()
|
Method Summary | |
protected javax.faces.convert.Converter |
createConverter()
Create and return a new Converter to be registered
on our surrounding UIComponent . |
int |
doStartTag()
Create a new instance of the specified Converter
class, and register it with the UIComponent instance associated
with our most immediately surrounding UIComponentTag instance, if
the UIComponent instance was created by this execution of the
containing JSP page. |
void |
release()
Release references to any acquired resources. |
void |
setConverterId(java.lang.String converterId)
Set the identifer of the Converter instance to be created. |
Methods inherited from class javax.servlet.jsp.tagext.TagSupport |
doAfterBody, doEndTag, 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 |
Constructor Detail |
public ConverterTag()
Method Detail |
public void setConverterId(java.lang.String converterId)
Set the identifer of the Converter
instance to be created.
converterId
- The identifier of the converter instance to be
created.public int doStartTag() throws javax.servlet.jsp.JspException
Create a new instance of the specified Converter
class, and register it with the UIComponent
instance associated
with our most immediately surrounding UIComponentTag
instance, if
the UIComponent
instance was created by this execution of the
containing JSP page.
doStartTag
in interface javax.servlet.jsp.tagext.Tag
doStartTag
in class javax.servlet.jsp.tagext.TagSupport
javax.servlet.jsp.JspException
- if a JSP error occurspublic void release()
Release references to any acquired resources.
release
in interface javax.servlet.jsp.tagext.Tag
release
in class javax.servlet.jsp.tagext.TagSupport
protected javax.faces.convert.Converter createConverter() throws javax.servlet.jsp.JspException
Create and return a new Converter
to be registered
on our surrounding UIComponent
.
javax.servlet.jsp.JspException
- if a new instance cannot be created
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |