com.sencha.gxt.widget.core.client.form.validator

Class GroupingValidHandler

java.lang.Object

com.sencha.gxt.widget.core.client.form.validator.GroupingValidHandler

public class GroupingValidHandler
extends Object

Group field validation. This is useful with wizards validation behavior.

 final GroupingValidHandler validGroup = new GroupingValidHandler(false);
 validGroup.add(field1);
 validGroup.add(field2);
 validGroup.add(field3);
 
 final TextButton finishButton = new TextButton("Can Click if Validators are Passing");
 finishButton.setEnabled(false);

 validGroup.addInvalidChangeEventHandler(new InvalidHandler() {
    @Override
   public void onInvalid(InvalidEvent event) {
     finishButton.setEnabled(validGroup.isValid());
   }
  });

  validGroup.addValidChangeEventHandler(new ValidHandler() {
     @Override
    public void onValid(ValidEvent event) {
      finishButton.setEnabled(validGroup.isValid());
    }
  });
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	GroupingValidHandler.Valid A model to track the fields valid or invalid state.

Constructor Summary

Constructors

Constructor and Description
GroupingValidHandler() Track the invalid or valid state of a group of fields validators.
GroupingValidHandler(boolean defaultValidInvalidStateOfField) Track the invalid or valid state of a group of fields validators.

Method Summary

Modifier and Type	Method and Description
void	add(Field<?> field) Add a field to the group to observe valid and invalid state of the validators for that field.
void	add(Field<?> field, boolean defaultValidState) Add a field to the group to observe valid and invalid state of the validators for that field.
HandlerRegistration	addInvalidChangeEventHandler(InvalidEvent.InvalidHandler handler) Observe when this group of fields validators becomes invalid.
HandlerRegistration	addValidChangeEventHandler(ValidEvent.ValidHandler handler) Observe when this group of fields validators becomes valid.
List<EditorError>	getErrors() Return a list of errors for the given group of fields.
protected EventBus	getEventBus() Returns the EventBus used.
protected Map<Field<?>,GroupingValidHandler.Valid>	getValids() Returns the models that track the fields valid state.
protected boolean	isDefaultValidInvalidStateOfField() Returns the initial valid state set for fields.
boolean	isValid() Is the group valid.
boolean	isValid(Field<?> field) Is the field valid in the group?
void	remove(Field<?> field) Remove the field from the group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GroupingValidHandler

public GroupingValidHandler()

Track the invalid or valid state of a group of fields validators. The initial state of the fields will be valid.

GroupingValidHandler

public GroupingValidHandler(boolean defaultValidInvalidStateOfField)

Track the invalid or valid state of a group of fields validators.

Parameters:

defaultValidInvalidStateOfField - set the initial valid state of the field.

Method Detail

add

public void add(Field<?> field)

Add a field to the group to observe valid and invalid state of the validators for that field.

Parameters:

field - a GXT field.

add

public void add(Field<?> field,
                boolean defaultValidState)

Add a field to the group to observe valid and invalid state of the validators for that field.

Parameters:

field - a GXT field.

defaultValidState - sets the default valid state of the field.

addInvalidChangeEventHandler

public HandlerRegistration addInvalidChangeEventHandler(InvalidEvent.InvalidHandler handler)

Observe when this group of fields validators becomes invalid. Use isValid() to determine state.

Parameters:

handler - the event handler

Returns:

the handler registration

addValidChangeEventHandler

public HandlerRegistration addValidChangeEventHandler(ValidEvent.ValidHandler handler)

Observe when this group of fields validators becomes valid. Use isValid() to determine state.

Parameters:

handler - the event handler

Returns:

the handler registration

getErrors

public List<EditorError> getErrors()

Return a list of errors for the given group of fields.

Returns:

the editor errors in the group ore return an empty list.

isValid

public boolean isValid()

Is the group valid.

Returns:

false if one of the validators in the group is invalid.

isValid

public boolean isValid(Field<?> field)

Is the field valid in the group?

Parameters:

field - the field in the group.

Returns:

false if the field in the group is invalid.

remove

public void remove(Field<?> field)

Remove the field from the group.

Parameters:

field - the field in the group

getEventBus

protected EventBus getEventBus()

Returns the EventBus used.

getValids

protected Map<Field<?>,GroupingValidHandler.Valid> getValids()

Returns the models that track the fields valid state.

isDefaultValidInvalidStateOfField

protected boolean isDefaultValidInvalidStateOfField()

Returns the initial valid state set for fields.