com.sas.taglib.servlet.tbeans.util.validators
Class BaseValidatorTag

com.sas.taglib.servlet.tbeans.util.validators.BaseValidatorTag
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, javax.servlet.jsp.tagext.TryCatchFinally
Direct Known Subclasses:
DateStringValidatorTag, HexColorStringValidatorTag, IntegerInputValidatorTag, MaximumLengthValidatorTag, MaximumValueValidatorTag, MinimumValueValidatorTag, NumericInputValidatorTag, RequiredStringValidatorTag

public class BaseValidatorTag

BaseValidatorTag is the tag handler class for the sas:BaseValidator custom tag . BaseValidatorTag is invoked by the JSP page to evaluate the sas:BaseValidator custom tag during the execution of the page. Tag handler methods are called by the JSP page implementation class at various points during the evaluation of the tag. The tag handler methods in turn call methods on the underlying Transformation Bean object, BaseValidator, to execute the methods.

If you need to extend or modify the functionality of the sas:BaseValidator custom tag, you can subclass this tag handler class.

For More Information:

Visit the AppDev Studio Developer's Site to access step-by-step examples, white papers and additional usage information at http://support.sas.com/rnd/appdev/.

Refer to the Custom Tag Library Reference for usage information on the sas:BaseValidator custom tag.

Note: A snapshot of the AppDev Studio Developers Site is installed on your local Web server when you install AppDev Studio. To access the site from webAF, select Help -> Developer Site.

See Also:
JavaScriptValidator, Serialized Form

Field Summary
 
Fields inherited from class com.sas.taglib.BaseTag
APPLICATION, PAGE, RB_KEY, REQUEST, SESSION
 
Constructor Summary
BaseValidatorTag()
           
 
Method Summary
protected  void applyAttributes()
          Sets the attributes on the underlying DateStringValidator object.
 java.lang.String getClearErrorsFunctionName()
          Gets the name of the clear errors function.
 java.lang.String getErrorHandlerFunctionName()
          Gets the name of the error handler function.
 java.lang.String getErrorMessage()
          Gets the the error message that will be displayed when validation fails.
 java.lang.String getValidationFunctionName()
          Gets the name of the validation function.
protected  void initialize(boolean includeAttributes)
          Initializes attributes and variables for this tag handler.
 void setClearErrorsFunctionName(java.lang.String name)
          Sets the name of the clear errors JavaScript function to call to clear all validations that have failed.
 void setErrorHandlerFunctionName(java.lang.String name)
          Sets the name of the error handler function to call if validation fails.
 void setErrorMessage(java.lang.String message)
          Sets the error message that will be displayed when validation fails.
 void setValidationFunctionName(java.lang.String name)
          Sets the name of the JavaScript validation function to call for validation.
 
Methods inherited from class com.sas.taglib.BaseTag
convertScope, doCatch, doFinally, doStartTag, getApplyAttributes, getComponentFromParentComposite, getCompositeComponentKey, getInstantiate, getLocale, getPageContext, getRef, getScope, getTagScope, getWrappedClassName, getWrappedObject, getWrappedObject, loadBeanInstance, newInstance, release, removeFromScope, searchContext, setApplyAttributes, setComponentOnParentComposite, setCompositeComponentKey, setInstantiate, setLocale, setRef, setScope, setTagScope, setVariableWithinScope, setWrappedClassName, setWrappedObject, validate
 

Constructor Detail

BaseValidatorTag

public BaseValidatorTag()
Method Detail

initialize

protected void initialize(boolean includeAttributes)
Initializes attributes and variables for this tag handler.

Overrides:
initialize in class BaseTag
Parameters:
includeAttributes - Set to true if attributes are to be set to default values.

setValidationFunctionName

public void setValidationFunctionName(java.lang.String name)
Sets the name of the JavaScript validation function to call for validation.

Parameters:
name - The JavaScript validation function name

getValidationFunctionName

public java.lang.String getValidationFunctionName()
Gets the name of the validation function.

Returns:
The JavaScript validation function name

setErrorHandlerFunctionName

public void setErrorHandlerFunctionName(java.lang.String name)
Sets the name of the error handler function to call if validation fails.

Parameters:
name - The error handler function name

getErrorHandlerFunctionName

public java.lang.String getErrorHandlerFunctionName()
Gets the name of the error handler function.

Returns:
The error handler function name

setClearErrorsFunctionName

public void setClearErrorsFunctionName(java.lang.String name)
Sets the name of the clear errors JavaScript function to call to clear all validations that have failed.

Parameters:
name - The clear errors function name

getClearErrorsFunctionName

public java.lang.String getClearErrorsFunctionName()
Gets the name of the clear errors function.

Returns:
The clear errors function name

setErrorMessage

public void setErrorMessage(java.lang.String message)
Sets the error message that will be displayed when validation fails.

Parameters:
message - The validation error message

getErrorMessage

public java.lang.String getErrorMessage()
Gets the the error message that will be displayed when validation fails.

Returns:
The validation error message

applyAttributes

protected void applyAttributes()
                        throws javax.servlet.jsp.JspException
Sets the attributes on the underlying DateStringValidator object.

Overrides:
applyAttributes in class BaseTag
Throws:
javax.servlet.jsp.JspException - Thrown if some type of JSP error occurs



Copyright © 2009 SAS Institute Inc. All Rights Reserved.