org.omnifaces.component.validator

Class ValidateMultiple

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.omnifaces.component.validator.ValidatorFamily

org.omnifaces.component.validator.ValidateMultipleFields

org.omnifaces.component.validator.ValidateMultiple

All Implemented Interfaces:

EventListener, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, MultiFieldValidator

public class ValidateMultiple
extends ValidateMultipleFields

The <o:validateMultiple> allows the developer to validate multiple fields by either a custom validator method:

 <o:validateMultiple id="myId" components="foo bar baz" validator="#{bean.someMethod}" />
 <h:message for="myId" />
 <h:inputText id="foo" />
 <h:inputText id="bar" />
 <h:inputText id="baz" />
 

whereby the method has the following signature (method name is free to your choice):

 public boolean someMethod(FacesContext context, List<UIInput> components, List<Object> values) {
     // ...
 }
 

Or, by a managed bean instance which implements the MultiFieldValidator interface:

 <o:validateMultiple id="myId" components="foo bar baz" validator="#{validateValuesBean}" />
 <h:message for="myId" />
 <h:inputText id="foo" />
 <h:inputText id="bar" />
 <h:inputText id="baz" />
 

 @ManagedBean
 @RequestScoped
 public class ValidateValuesBean implements MultiFieldValidator {
     @Override
     public boolean validateValues(FacesContext context, List<UIInput> components, List<Object> values) {
         // ...
     }
 }
 

Design notice

Note that this validator does not throw ValidatorException, but returns a boolean! Message handling and invalidation job is up to the ValidateMultipleFields implementation who will call this method. You can customize the message by the message attribute of the tag. Refer ValidateMultipleFields documentation for general usage instructions.

Since:

1.7

Author:

Juliano Marques, Bauke Scholtz

See Also:

ValidateMultipleHandler, ValidateMultipleFields, ValidatorFamily, MultiFieldValidator

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_TYPE The standard component type.

Fields inherited from class org.omnifaces.component.validator.ValidatorFamily

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
ValidateMultiple()

Method Summary

Modifier and Type	Method and Description
MethodExpression	getValidateMethod() Returns the validator method expression.
MultiFieldValidator	getValidator() Returns the validator instance.
void	setValidateMethod(MethodExpression validateMethod) Sets the validator method expression.
void	setValidator(MultiFieldValidator validator) Sets the validator instance.
boolean	validateValues(FacesContext context, List<UIInput> components, List<Object> values) Invoke the validator and return its outcome.

Methods inherited from class org.omnifaces.component.validator.ValidateMultipleFields

collectComponents, collectValues, getComponents, getMessage, getShowMessageFor, isDisabled, isInvalidateAll, isValidationFailed, setComponents, setDisabled, setInvalidateAll, setMessage, setShowMessageFor, shouldInvalidateInput, showMessage, validateComponents, validateHierarchy

Methods inherited from class org.omnifaces.component.validator.ValidatorFamily

encodeChildren, getFamily, getRendersChildren, processDecodes, processUpdates, processValidators

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

The standard component type.

See Also:

Constant Field Values

Constructor Detail

ValidateMultiple

public ValidateMultiple()

Method Detail

validateValues

public boolean validateValues(FacesContext context,
                              List<UIInput> components,
                              List<Object> values)

Invoke the validator and return its outcome.

Parameters:

context - The faces context to work with.

components - The input components whose values are to be validated.

values - The values of the input components to be validated, in the same order as the components.

Returns:

true if validation is successful, otherwise false (and thus show the message).

getValidator

public MultiFieldValidator getValidator()

Returns the validator instance.

Returns:

The validator instance.

setValidator

public void setValidator(MultiFieldValidator validator)

Sets the validator instance.

Parameters:

validator - The validator instance.

getValidateMethod

public MethodExpression getValidateMethod()

Returns the validator method expression.

Returns:

The validator method expression.

setValidateMethod

public void setValidateMethod(MethodExpression validateMethod)

Sets the validator method expression.

Parameters:

validateMethod - The validator method expression.