org.omnifaces.component.output

Class Cache

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.omnifaces.component.output.Cache

All Implemented Interfaces:

EventListener, PartialStateHolder, StateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

public class Cache
extends UIComponentBase

Cache is a component that captures the mark-up rendered by its children and caches this for future requests.

Since:

1.1

Author:

Arjan Tijms

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	DEFAULT_SCOPE
static String	VALUE_SET

Fields inherited from class javax.faces.component.UIComponent

BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
Cache()

Method Summary

Methods

Modifier and Type	Method and Description
void	encodeChildren(FacesContext context)
String	getFamily() Returns COMPONENT_FAMILY.
String	getKey()
boolean	getRendersChildren() Returns true.
String	getScope()
Integer	getTime()
protected boolean	isVisitable(VisitContext visitContext)
void	setKey(String keyValue)
void	setScope(String scopeValue)
void	setTime(Integer timeValue)

Methods inherited from class javax.faces.component.UIComponentBase

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

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent, 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

VALUE_SET

public static final String VALUE_SET

See Also:

Constant Field Values

DEFAULT_SCOPE

public static final String DEFAULT_SCOPE

See Also:

Constant Field Values

Constructor Detail

Cache

public Cache()

Method Detail

getFamily

public String getFamily()

Returns COMPONENT_FAMILY.

Specified by:

getFamily in class UIComponent

getRendersChildren

public boolean getRendersChildren()

Returns true.

Overrides:

getRendersChildren in class UIComponentBase

encodeChildren

public void encodeChildren(FacesContext context)
                    throws IOException

Overrides:

encodeChildren in class UIComponentBase

Throws:

IOException

isVisitable

protected boolean isVisitable(VisitContext visitContext)

Overrides:

isVisitable in class UIComponent

getKey

public String getKey()

setKey

public void setKey(String keyValue)

getScope

public String getScope()

setScope

public void setScope(String scopeValue)

getTime

public Integer getTime()

setTime

public void setTime(Integer timeValue)