|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.faces.component.UIComponent javax.faces.component.UIComponentBase org.omnifaces.component.output.OutputFamily org.omnifaces.component.output.Cache
public class Cache
Cache is a component that captures the mark-up rendered by its children and caches this for future requests.
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
DEFAULT_SCOPE
|
static java.lang.String |
END_CONTENT_MARKER
|
static java.lang.String |
START_CONTENT_MARKER
|
static java.lang.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 | |
---|---|
Cache()
|
Method Summary | |
---|---|
void |
encodeChildren(javax.faces.context.FacesContext context)
|
java.lang.Object |
getCacheAttribute(javax.faces.context.FacesContext context,
java.lang.String name)
Gets a named attribute associated with the main cache entry this component is using to store the rendering of its child components. |
java.lang.String |
getKey()
|
java.lang.String |
getScope()
|
java.lang.Integer |
getTime()
|
java.lang.Boolean |
isUseBuffer()
|
protected boolean |
isVisitable(javax.faces.component.visit.VisitContext visitContext)
|
void |
setCacheAttribute(javax.faces.context.FacesContext context,
java.lang.String name,
java.lang.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(java.lang.String keyValue)
|
void |
setScope(java.lang.String scopeValue)
|
void |
setTime(java.lang.Integer timeValue)
|
void |
setUseBuffer(java.lang.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 |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String VALUE_SET
public static final java.lang.String DEFAULT_SCOPE
public static final java.lang.String START_CONTENT_MARKER
public static final java.lang.String END_CONTENT_MARKER
Constructor Detail |
---|
public Cache()
Method Detail |
---|
public void encodeChildren(javax.faces.context.FacesContext context) throws java.io.IOException
encodeChildren
in class javax.faces.component.UIComponentBase
java.io.IOException
public java.lang.Object getCacheAttribute(javax.faces.context.FacesContext context, java.lang.String name)
context
- the current FacesContextname
- name of the attribute to retrieve a value for
public void setCacheAttribute(javax.faces.context.FacesContext context, java.lang.String name, java.lang.Object value)
context
- the current FacesContextname
- name of the attribute under which the value is storedvalue
- the value that is to be storedprotected boolean isVisitable(javax.faces.component.visit.VisitContext visitContext)
isVisitable
in class javax.faces.component.UIComponent
public java.lang.String getKey()
public void setKey(java.lang.String keyValue)
public java.lang.String getScope()
public void setScope(java.lang.String scopeValue)
public java.lang.Integer getTime()
public void setTime(java.lang.Integer timeValue)
public java.lang.Boolean isUseBuffer()
public void setUseBuffer(java.lang.Boolean useBufferValue)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |