|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.smartgwt.client.core.JsObject
com.smartgwt.client.core.DataClass
com.smartgwt.client.widgets.form.validator.Validator
public class Validator
A validator describes a check that should be performed on a value the user is trying to save.
Validators are
specified for DataSource fields via the validators
property. Validators that need not be run on the server can also be specified for a specific FormItem
or ${isc.DocUtils.linkForRef('object:ListGridField')}.
Smart GWT
supports a powerful library of com.smartgwt.client..ValidatorTypes
which have identical behavior on both the
client and the server.
Beyond this, custom validators can be defined on the client and custom validation logic
added on the server. Note that the regexp
and mask
validator types are very flexible and can
be used to perform virtually any kind of formatting check that doesn't involve some large external dataset.
Custom
validators can be reused on the client by adding them to the global validator list, via the com.smartgwt.client.widgets.form.validator.Validator#addValidator
method.
Field Summary |
---|
Fields inherited from class com.smartgwt.client.core.JsObject |
---|
jsObj |
Constructor Summary | |
---|---|
Validator()
|
|
Validator(JavaScriptObject jsObj)
|
Method Summary | |
---|---|
Boolean |
getClientOnly()
Indicates this validator runs on the client only. |
static Validator |
getOrCreateRef(JavaScriptObject jsObj)
|
String |
getServerCondition()
An expression in the Velocity Template Language that will run on the server. |
Boolean |
getServerOnly()
Indicates this validator runs on the server only. |
Boolean |
getStopIfFalse()
Normally, all validators defined for a field will be run even if one of the validators has already failed. |
void |
setClientOnly(Boolean clientOnly)
Indicates this validator runs on the client only. |
void |
setErrorMessage(String errorMessage)
Text to display if the value does not pass this validation check. |
void |
setServerCondition(String serverCondition)
An expression in the Velocity Template Language that will run on the server. |
void |
setServerOnly(Boolean serverOnly)
Indicates this validator runs on the server only. |
void |
setStopIfFalse(Boolean stopIfFalse)
Normally, all validators defined for a field will be run even if one of the validators has already failed. |
Methods inherited from class com.smartgwt.client.core.JsObject |
---|
isCreated, setJsObj |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Validator()
public Validator(JavaScriptObject jsObj)
Method Detail |
---|
public static Validator getOrCreateRef(JavaScriptObject jsObj)
public void setStopIfFalse(Boolean stopIfFalse)
stopIfFalse
is set, validation will not proceed beyond this validator if the check fails. This is useful to prevent expensive validators from being run unnecessarily, or to allow custom validators that don't need to be robust about handling every conceivable type of value.
stopIfFalse
- stopIfFalse Default value is falsepublic Boolean getStopIfFalse()
stopIfFalse
is set, validation will not proceed beyond this validator if the check fails. This is useful to prevent expensive validators from being run unnecessarily, or to allow custom validators that don't need to be robust about handling every conceivable type of value.
public void setClientOnly(Boolean clientOnly)
Normally, if the server is trying to run validators and finds a validator that it can't execute, for safety reasons validation is considered to have failed. Use this flag to explicitly mark a validator that only needs to run on the client.
clientOnly
- clientOnly Default value is falsepublic Boolean getClientOnly()
Normally, if the server is trying to run validators and finds a validator that it can't execute, for safety reasons validation is considered to have failed. Use this flag to explicitly mark a validator that only needs to run on the client.
public void setServerOnly(Boolean serverOnly)
serverOnly
- serverOnly Default value is nullpublic Boolean getServerOnly()
public void setServerCondition(String serverCondition)
HttpSession
or a
DSRequest
. Server-side custom validators only have the following variables
available:
$dataSources.supplyItem
refers to the supplyItem
DataSource
object).Map
DSField
object)DataTools
object, giving you access to all of that
class's useful helper functions
serverCondition
- Velocity Expression serverCondition Default value is nullpublic String getServerCondition()
HttpSession
or a
DSRequest
. Server-side custom validators only have the following variables
available:
$dataSources.supplyItem
refers to the supplyItem
DataSource
object).Map
DSField
object)DataTools
object, giving you access to all of that
class's useful helper functions
public void setErrorMessage(String errorMessage)
If unspecified, default error messages exist for all built-in validators, and a generic message will be used for a custom validator that is not passed.
errorMessage
- errorMessage Default value is null
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |