Package org.apache.struts.faces.component

Class LoadMessagesComponent

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIOutput

org.apache.struts.faces.component.LoadMessagesComponent

All Implemented Interfaces:

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

public class LoadMessagesComponent
extends UIOutput

Custom component to load a MessagesMap.

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

Method Summary

Modifier and Type	Method	Description
String	getFamily()	Return the component family to which this component belongs.
String	getMessages()	Gets the name of the MessageResources to expose, or null for the default MessageResources for this application module.
String	getVar()	Gets the request attribute key under which the MessagesMap will be exposed.
void	restoreState(FacesContext context, Object state)	Restore the state of this component.
Object	saveState(FacesContext context)	Save the state of this component.
void	setMessages(String messages)	Sets the name of the MessageResources to expose, or null for the default MessageResources for this application module.
void	setVar(String var)	Sets the request attribute key under which the MessagesMap will be exposed.

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

LoadMessagesComponent

public LoadMessagesComponent()

Create a new LoadMessagesComponent with default properties.

Method Details

getFamily

public String getFamily()

Return the component family to which this component belongs.

Overrides:

getFamily in class UIOutput

getMessages

public String getMessages()

Gets the name of the MessageResources to expose, or null for the default MessageResources for this application module.

Returns:

the name of the MessageResources

setMessages

public void setMessages(String messages)

Sets the name of the MessageResources to expose, or null for the default MessageResources for this application module.

Parameters:

messages - the name of the MessageResources

getVar

public String getVar()

Gets the request attribute key under which the MessagesMap will be exposed.

Returns:

the request attribute key

setVar

public void setVar(String var)

Sets the request attribute key under which the MessagesMap will be exposed.

Parameters:

var - the request attribute key

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