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
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
-
Method Summary
Modifier and TypeMethodDescriptionReturn the component family to which this component belongs.Gets the name of theMessageResources
to expose, ornull
for the defaultMessageResources
for this application module.getVar()
Gets the request attribute key under which theMessagesMap
will be exposed.void
restoreState
(FacesContext context, Object state) Restore the state of this component.saveState
(FacesContext context) Save the state of this component.void
setMessages
(String messages) Sets the name of theMessageResources
to expose, ornull
for the defaultMessageResources
for this application module.void
Sets the request attribute key under which theMessagesMap
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
-
Constructor Details
-
LoadMessagesComponent
public LoadMessagesComponent()Create a newLoadMessagesComponent
with default properties.
-
-
Method Details
-
getFamily
Return the component family to which this component belongs. -
getMessages
Gets the name of theMessageResources
to expose, ornull
for the defaultMessageResources
for this application module.- Returns:
- the name of the
MessageResources
-
setMessages
Sets the name of theMessageResources
to expose, ornull
for the defaultMessageResources
for this application module.- Parameters:
messages
- the name of theMessageResources
-
getVar
Gets the request attribute key under which theMessagesMap
will be exposed.- Returns:
- the request attribute key
-
setVar
Sets the request attribute key under which theMessagesMap
will be exposed.- Parameters:
var
- the request attribute key
-
restoreState
Restore the state of this component.- Specified by:
restoreState
in interfaceStateHolder
- Overrides:
restoreState
in classUIOutput
- Parameters:
context
-FacesContext
for the current requeststate
- State object from which to restore our state
-
saveState
Save the state of this component.- Specified by:
saveState
in interfaceStateHolder
- Overrides:
saveState
in classUIOutput
- Parameters:
context
-FacesContext
for the current request
-