org.jboss.seam.ui.component.html
Class HtmlCache

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.jboss.seam.ui.component.UICache
              org.jboss.seam.ui.component.html.HtmlCache

All Implemented Interfaces:

EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

@Generated(value={"RichFaces CDK","4.2.2.Final"})
public class HtmlCache
extends UICache

Cache the rendered page fragment using the installed cache provider.

Nested Class Summary

protected static class

HtmlCache.Properties

Field Summary

static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

Fields inherited from class javax.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

HtmlCache()

Method Summary

org.jboss.seam.cache.CacheProvider	getCacheProvider()
String	getFamily()
String	getKey()
String	getRegion()
boolean	isEnabled()
void	setCacheProvider(org.jboss.seam.cache.CacheProvider cacheProvider)
void	setEnabled(boolean enabled)
void	setKey(String key)
void	setRegion(String region)

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, 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

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

HtmlCache

public HtmlCache()

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getCacheProvider

public org.jboss.seam.cache.CacheProvider getCacheProvider()

Specified by:

getCacheProvider in class UICache

setCacheProvider

public void setCacheProvider(org.jboss.seam.cache.CacheProvider cacheProvider)

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in class UICache

setEnabled

public void setEnabled(boolean enabled)

getKey

public String getKey()

Specified by:

getKey in class UICache

setKey

public void setKey(String key)

getRegion

public String getRegion()

Specified by:

getRegion in class UICache

setRegion

public void setRegion(String region)