Module org.omnifaces

Package org.omnifaces.component.validator

Class ValidateEqual

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

org.omnifaces.component.validator.ValidatorFamily

org.omnifaces.component.validator.ValidateMultipleFields

org.omnifaces.component.validator.ValidateEqual

All Implemented Interfaces:

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

public class ValidateEqual
extends ValidateMultipleFields

The <o:validateEqual> validates if ALL of the given UIInput components have the same value.

The default message is

{0}: Please fill out the same value for all of those fields

For general usage instructions, refer ValidateMultipleFields documentation.

Author:

Bauke Scholtz

See Also:

ValidateMultipleFields, ValidatorFamily, MultiFieldValidator

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMPONENT_TYPE	The component type, which is "org.omnifaces.component.validator.ValidateEqual".

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

COMPONENT_FAMILY

Fields inherited from class jakarta.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	Description
ValidateEqual()

Method Summary

Modifier and Type	Method	Description
boolean	validateValues(FacesContext context, List<UIInput> inputs, List<Object> values)	Validate if all values are equal.

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 jakarta.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 jakarta.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 component type, which is "org.omnifaces.component.validator.ValidateEqual".

See Also:

Constant Field Values

Constructor Detail

ValidateEqual

public ValidateEqual()

Method Detail

validateValues

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

Validate if all values are equal.

Parameters:

context - The faces context to work with.

inputs - 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).