|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sourceforge.stripes.tag.StripesTagSupport
net.sourceforge.stripes.tag.HtmlTagSupport
net.sourceforge.stripes.tag.InputTagSupport
public abstract class InputTagSupport
Parent class for all input tags in stripes. Provides support methods for retrieving all the attributes that are shared across form input tags. Also provides accessors for finding the specified "override" value and for finding the enclosing support tag.
Field Summary | |
---|---|
protected TagErrorRenderer |
errorRenderer
The error renderer to be utilized for error output of this input tag |
protected List<ValidationError> |
fieldErrors
A list of the errors related to this input tag instance |
Fields inherited from class net.sourceforge.stripes.tag.StripesTagSupport |
---|
pageContext, parentTag |
Fields inherited from interface javax.servlet.jsp.tagext.Tag |
---|
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE |
Constructor Summary | |
---|---|
InputTagSupport()
|
Method Summary | |
---|---|
void |
doCatch(Throwable throwable)
Rethrows the passed in throwable in all cases. |
abstract int |
doEndInputTag()
Abstract method implemented in child classes instead of doEndTag(). |
int |
doEndTag()
Final implementation of the doEndTag() method that allows the base InputTagSupport class to insert functionality before and after the tag performs it's doEndTag equivalent method. |
void |
doFinally()
Used to ensure that the input tag is always removed from the tag stack so that there is never any confusion about tag-parent hierarchies. |
abstract int |
doStartInputTag()
Abstract method implemented in child classes instead of doStartTag(). |
int |
doStartTag()
Final implementation of the doStartTag() method that allows the base InputTagSupport class to insert functionality before and after the tag performs it's doStartTag equivalent method. |
protected String |
format(Object input)
Calls format(Object, boolean) with forOutput set to true. |
protected String |
format(Object input,
boolean forOutput)
Attempts to format an object using the Stripes formatting system. |
ActionBean |
getActionBean()
Fetches the ActionBean associated with the form if one is present. |
String |
getDisabled()
|
List<ValidationError> |
getFieldErrors()
Access for the field errors that occurred on the form input this tag represents |
String |
getFormatPattern()
Returns the value set with setFormatPattern() |
String |
getFormatType()
Returns the value set with setFormatAs() |
String |
getLocalizedFieldName()
Fetches the localized name for this field if one exists in the resource bundle. |
protected String |
getLocalizedFieldName(String name)
Attempts to fetch a "field name" resource from the localization bundle. |
String |
getName()
|
protected Object |
getOverrideValueOrValues()
Gets the value for this tag based on the current population strategy. |
FormTag |
getParentFormTag()
Locates the enclosing stripes form tag. |
String |
getReadonly()
Gets the HTML attribute of the same name. |
protected Object |
getSingleOverrideValue()
Returns a single value for the the value of this field. |
String |
getSize()
|
protected ValidationMetadata |
getValidationMetadata()
|
Object |
getValueOnPage()
Used during repopulation to query the tag for a value of values provided to the tag on the JSP. |
boolean |
hasErrors()
Returns true if one or more validation errors exist for the field represented by this input tag. |
protected boolean |
isItemSelected(Object value,
Object selected)
Utility method for determining if a String value is contained within an Object, where the object may be either a String, String[], Object, Object[] or Collection. |
protected void |
loadErrors()
Find errors that are related to the form field this input tag represents and place them in an instance variable to use during error rendering. |
protected void |
makeFocused()
Writes out a JavaScript string to set focus on the field as it is rendered. |
protected void |
registerWithParentForm()
Registers the field with the parent form within which it must be enclosed. |
void |
setDisabled(String disabled)
Checks to see if the value provided is either 'disabled' or a value that the BooleanTypeConverter believes it true. |
void |
setFocus(boolean focus)
Informs the tag that it should render JavaScript to ensure that it is focused when the page is loaded. |
void |
setFormatPattern(String formatPattern)
Sets the named format pattern, or a custom format pattern. |
void |
setFormatType(String formatType)
Sets the type of output to format, e.g. |
void |
setName(String name)
|
void |
setReadonly(String readonly)
Sets the value of the readonly attribute to "readonly" but only when the value passed in is either "readonly" itself, or is converted to true by the BooleanTypeConverter . |
void |
setSize(String size)
|
Methods inherited from class net.sourceforge.stripes.tag.HtmlTagSupport |
---|
evaluateExpression, get, getAccesskey, getAttributes, getBodyContent, getBodyContentAsString, getCssClass, getDir, getId, getLang, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getStyle, getTabindex, getTitle, release, set, setAccesskey, setBodyContent, setClass, setCssClass, setDir, setDynamicAttribute, setId, setLang, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setStyle, setTabindex, setTitle, toString, writeAttributes, writeCloseTag, writeOpenTag, writeSingletonTag |
Methods inherited from class net.sourceforge.stripes.tag.StripesTagSupport |
---|
getActionBeanType, getActionBeanUrl, getPageContext, getParent, getParentTag, getTagStack, popPageContextAttributes, pushPageContextAttributes, setPageContext, setParent |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected List<ValidationError> fieldErrors
protected TagErrorRenderer errorRenderer
Constructor Detail |
---|
public InputTagSupport()
Method Detail |
---|
public void setFormatType(String formatType)
public String getFormatType()
public void setFormatPattern(String formatPattern)
public String getFormatPattern()
protected Object getOverrideValueOrValues() throws StripesJspException
StripesJspException
- if the enclosing form tag (which is required at all times, and
necessary to perform repopulation) cannot be locatedprotected Object getSingleOverrideValue() throws StripesJspException
StripesJspException
- if the enclosing form tag (which is required at all times, and
necessary to perform repopulation) cannot be locatedpublic Object getValueOnPage()
public FormTag getParentFormTag() throws StripesJspException
Locates the enclosing stripes form tag. If no form tag can be found, because the tag was not enclosed in one on the JSP, an exception is thrown.
StripesJspException
- if an enclosing form tag cannot be foundprotected boolean isItemSelected(Object value, Object selected)
value
- the value that we are searching forselected
- a String, String[], Object, Object[] or Collection (of scalars) denoting the
selected items
public String getLocalizedFieldName() throws StripesJspException
StripesJspException
protected String getLocalizedFieldName(String name) throws StripesJspException
LocalizationUtility.getLocalizedFieldName(String, String, Class, java.util.Locale)
name
- the field name or resource to look up
StripesJspException
protected ValidationMetadata getValidationMetadata() throws StripesJspException
StripesJspException
protected String format(Object input)
format(Object, boolean)
with forOutput
set to true.
input
- The object to be formattedformat(Object, boolean)
protected String format(Object input, boolean forOutput)
input
- The object to be formattedforOutput
- If true, then the object will be formatted for output to the JSP. Currently,
that means that if encryption is enabled for the ActionBean property with the same
name as this tag then the formatted value will be encrypted before it is returned.protected void loadErrors() throws StripesJspException
StripesJspException
public List<ValidationError> getFieldErrors() throws StripesJspException
StripesJspException
public boolean hasErrors() throws StripesJspException
StripesJspException
public ActionBean getActionBean() throws StripesJspException
StripesJspException
public final int doStartTag() throws JspException
TagErrorRenderer
if appropriate.
doStartTag
in interface Tag
doStartTag
in class StripesTagSupport
JspException
protected void registerWithParentForm() throws StripesJspException
StripesJspException
- if the parent form tag is not foundpublic abstract int doStartInputTag() throws JspException
JspException
public final int doEndTag() throws JspException
doEndTag
in interface Tag
doEndTag
in class StripesTagSupport
JspException
public void doCatch(Throwable throwable) throws Throwable
doCatch
in interface TryCatchFinally
Throwable
public void doFinally()
doFinally
in interface TryCatchFinally
public void setFocus(boolean focus)
focus
- true if focus is desired, false otherwiseprotected void makeFocused() throws JspException
JspException
public abstract int doEndInputTag() throws JspException
JspException
public void setDisabled(String disabled)
BooleanTypeConverter
believes it true. If so, adds a disabled attribute
to the tag, otherwise does not.
public String getDisabled()
public void setReadonly(String readonly)
Sets the value of the readonly attribute to "readonly" but only when the value passed
in is either "readonly" itself, or is converted to true by the
BooleanTypeConverter
.
Although not all input tags support the readonly attribute, the method is located here because it is not a simple one-liner and is used by more than one tag.
public String getReadonly()
public void setName(String name)
public String getName()
public void setSize(String size)
public String getSize()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |