Package org.apache.struts.faces.component

Class ErrorsComponent

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIOutput

org.apache.struts.faces.component.ErrorsComponent

All Implemented Interfaces:

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

public class ErrorsComponent
extends UIOutput

Custom component that replaces the Struts <html:errors> tag.

Field Summary

Fields inherited from class jakarta.faces.component.UIOutput

COMPONENT_FAMILY, COMPONENT_TYPE

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
ErrorsComponent()	Create a new ErrorsComponent with default properties.

Method Summary

Modifier and Type	Method	Description
String	getBundle()	Return the MessageResources key.
String	getFamily()	Return the component family to which this component belongs.
String	getProperty()	Return the property name for which to report errors.
void	restoreState(FacesContext context, Object state)	Restore the state of this component.
Object	saveState(FacesContext context)	Save the state of this component.
void	setBundle(String bundle)	Set the MessageResources key.
void	setProperty(String property)	Set the property name for which to report errors.

Methods inherited from class jakarta.faces.component.UIOutput

clearInitialState, getConverter, getLocalValue, getValue, markInitialState, resetValue, setConverter, setValue

Methods inherited from class jakarta.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, 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

Constructor Details

ErrorsComponent

public ErrorsComponent()

Create a new ErrorsComponent with default properties.

Method Details

getBundle

public String getBundle()

Return the MessageResources key.

setBundle

public void setBundle(String bundle)

Set the MessageResources key.

Parameters:

bundle - The new key

getFamily

public String getFamily()

Return the component family to which this component belongs.

Overrides:

getFamily in class UIOutput

getProperty

public String getProperty()

Return the property name for which to report errors.

setProperty

public void setProperty(String property)

Set the property name for which to report errors.

Parameters:

property - The new property name

restoreState

public void restoreState(FacesContext context,
 Object state)

Restore the state of this component.

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UIOutput

Parameters:

context - FacesContext for the current request

state - State object from which to restore our state

saveState

public Object saveState(FacesContext context)

Save the state of this component.

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class UIOutput

Parameters:

context - FacesContext for the current request