Package org.apache.struts.faces.component

Class MessageComponent

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIOutput

org.apache.struts.faces.component.MessageComponent

All Implemented Interfaces:

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

public class MessageComponent
extends UIOutput

Custom component that replaces the Struts <html:message> 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
MessageComponent()	Create a new MessageComponent 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	getKey()	Return the message key.
String	getStyle()	Return the CSS style(s) to be rendered for this component.
String	getStyleClass()	Return the CSS style class(es) to be rendered for this component.
boolean	isFilter()	Return a flag indicating whether filtering should take place.
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	setFilter(boolean filter)	Set the flag indicating that the output value should be filtered.
void	setKey(String key)	Set the message key.
void	setStyle(String style)	Set the CSS style(s) to be rendered for this component.
void	setStyleClass(String styleClass)	Set the CSS style class(es) to be rendered for this component.

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

MessageComponent

public MessageComponent()

Create a new MessageComponent 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

isFilter

public boolean isFilter()

Return a flag indicating whether filtering should take place.

setFilter

public void setFilter(boolean filter)

Set the flag indicating that the output value should be filtered.

Parameters:

filter - The new filter flag

getKey

public String getKey()

Return the message key.

setKey

public void setKey(String key)

Set the message key.

Parameters:

key - The new key

getStyle

public String getStyle()

Return the CSS style(s) to be rendered for this component.

setStyle

public void setStyle(String style)

Set the CSS style(s) to be rendered for this component.

Parameters:

style - The new CSS style(s)

getStyleClass

public String getStyleClass()

Return the CSS style class(es) to be rendered for this component.

setStyleClass

public void setStyleClass(String styleClass)

Set the CSS style class(es) to be rendered for this component.

Parameters:

styleClass - The new CSS style class(es)

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