org.omnifaces.component.output

Class Cache

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.omnifaces.component.output.OutputFamily

org.omnifaces.component.output.Cache

All Implemented Interfaces:

EventListener, PartialStateHolder, StateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

public class Cache
extends OutputFamily

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_TYPE
static String	DEFAULT_SCOPE
static String	END_CONTENT_MARKER
static String	START_CONTENT_MARKER
static String	VALUE_SET

Fields inherited from class org.omnifaces.component.output.OutputFamily

COMPONENT_FAMILY

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)
Object	getCacheAttribute(FacesContext context, String name) Gets a named attribute associated with the main cache entry this component is using to store the rendering of its child components.
String	getKey()
String	getScope()
Integer	getTime()
Boolean	isUseBuffer()
protected boolean	isVisitable(VisitContext visitContext)
void	setCacheAttribute(FacesContext context, String name, Object value) Sets a named attribute associated with the main cache entry this component is using to store the rendering of its child components.
void	setKey(String keyValue)
void	setScope(String scopeValue)
void	setTime(Integer timeValue)
void	setUseBuffer(Boolean useBufferValue)

Methods inherited from class org.omnifaces.component.output.OutputFamily

getFamily, getRendersChildren

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

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

START_CONTENT_MARKER

public static final String START_CONTENT_MARKER

See Also:

Constant Field Values

END_CONTENT_MARKER

public static final String END_CONTENT_MARKER

See Also:

Constant Field Values

Constructor Detail

Cache

public Cache()

Method Detail

encodeChildren

public void encodeChildren(FacesContext context)
                    throws IOException

Overrides:

encodeChildren in class UIComponentBase

Throws:

IOException

getCacheAttribute

public Object getCacheAttribute(FacesContext context,
                       String name)

Gets a named attribute associated with the main cache entry this component is using to store the rendering of its child components.

Parameters:

context - the current FacesContext

name - name of the attribute to retrieve a value for

Returns:

value associated with the named attribute

Since:

1.2

setCacheAttribute

public void setCacheAttribute(FacesContext context,
                     String name,
                     Object value)

Sets a named attribute associated with the main cache entry this component is using to store the rendering of its child components.

Parameters:

context - the current FacesContext

name - name of the attribute under which the value is stored

value - the value that is to be stored

Since:

1.2

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)

isUseBuffer

public Boolean isUseBuffer()

setUseBuffer

public void setUseBuffer(Boolean useBufferValue)