Package org.apache.struts.faces.component

Class HtmlComponent

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIOutput

org.apache.struts.faces.component.HtmlComponent

All Implemented Interfaces:

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

public class HtmlComponent
extends UIOutput

Custom component that replaces the Struts <html:html> 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
HtmlComponent()	Create a new HtmlComponent with default properties.

Method Summary

Modifier and Type	Method	Description
String	getFamily()	Return the component family to which this component belongs.
boolean	isLocale()	Return a flag indicating whether a locale should be created.
boolean	isXhtml()	Return a flag indicating whether xhtml should be created.
void	restoreState(FacesContext context, Object state)	Restore the state of this component.
Object	saveState(FacesContext context)	Save the state of this component.
void	setLocale(boolean locale)	Set the flag indicating whether a locale should be created.
void	setXhtml(boolean xhtml)	Set the flag indicating whether xhtml should be created.

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

HtmlComponent

public HtmlComponent()

Create a new HtmlComponent with default properties.

Method Details

getFamily

public String getFamily()

Return the component family to which this component belongs.

Overrides:

getFamily in class UIOutput

isLocale

public boolean isLocale()

Return a flag indicating whether a locale should be created.

setLocale

public void setLocale(boolean locale)

Set the flag indicating whether a locale should be created.

Parameters:

locale - The new flag

isXhtml

public boolean isXhtml()

Return a flag indicating whether xhtml should be created.

setXhtml

public void setXhtml(boolean xhtml)

Set the flag indicating whether xhtml should be created.

Parameters:

xhtml - The new flag

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