|
|||||||||
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')}.
ISC 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(com.google.gwt.core.client.JavaScriptObject jsObj)
|
Method Summary | |
---|---|
java.lang.Boolean |
getClientOnly()
Indicates this validator runs on the client only. |
static Validator |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
|
java.lang.Boolean |
getStopIfFalse()
Normally, all validators defined for a field will be run even if one of the validators has already failed. |
void |
setClientOnly(java.lang.Boolean clientOnly)
Indicates this validator runs on the client only. |
void |
setErrorMessage(java.lang.String errorMessage)
Text to display if the value does not pass this validation check. |
void |
setStopIfFalse(java.lang.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(com.google.gwt.core.client.JavaScriptObject jsObj)
Method Detail |
---|
public static Validator getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public void setStopIfFalse(java.lang.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 java.lang.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(java.lang.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 java.lang.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 setErrorMessage(java.lang.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 |