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

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.jboss.seam.ui.component.UICache
              extended by org.jboss.seam.ui.component.html.HtmlCache
All Implemented Interfaces:
javax.faces.component.StateHolder

public class HtmlCache
extends UICache

Component-Type org.jboss.seam.ui.Cache Component-Family org.jboss.seam.ui.Cache Renderer-Type org.jboss.seam.ui.CacheRenderer Cache the rendered page fragment using JBoss Cache. Note that <s:cache> actually uses the instance of JBoss Cache managed by the built-in pojoCache component.


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Constructor Summary
HtmlCache()
          Constructor to init default renderers
 
Method Summary
 java.lang.String getFamily()
           
 java.lang.String getKey()
          the key to cache rendered content, often a value expression.
 java.lang.String getRegion()
          a JBoss Cache node to use (different nodes can have different expiry policies).
 boolean isEnabled()
          a value expression that determines if the cache should be used.
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setEnabled(boolean __enabled)
          a value expression that determines if the cache should be used.
 void setKey(java.lang.String __key)
          the key to cache rendered content, often a value expression.
 void setRegion(java.lang.String __region)
          a JBoss Cache node to use (different nodes can have different expiry policies).
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId, getValueExpression, setValueExpression
 
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 java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values
Constructor Detail

HtmlCache

public HtmlCache()
Constructor to init default renderers

Method Detail

setEnabled

public void setEnabled(boolean __enabled)
a value expression that determines if the cache should be used. Setter for enabled

Specified by:
setEnabled in class UICache
Parameters:
enabled - - new value

isEnabled

public boolean isEnabled()
a value expression that determines if the cache should be used. Getter for enabled

Specified by:
isEnabled in class UICache
Returns:
enabled value from local variable or value bindings

setKey

public void setKey(java.lang.String __key)
the key to cache rendered content, often a value expression. For example, if we were caching a page fragment that displays a document, we might use key="Document-#{document.id}". Setter for key

Specified by:
setKey in class UICache
Parameters:
key - - new value

getKey

public java.lang.String getKey()
the key to cache rendered content, often a value expression. For example, if we were caching a page fragment that displays a document, we might use key="Document-#{document.id}". Getter for key

Specified by:
getKey in class UICache
Returns:
key value from local variable or value bindings

setRegion

public void setRegion(java.lang.String __region)
a JBoss Cache node to use (different nodes can have different expiry policies). Setter for region

Specified by:
setRegion in class UICache
Parameters:
region - - new value

getRegion

public java.lang.String getRegion()
a JBoss Cache node to use (different nodes can have different expiry policies). Getter for region

Specified by:
getRegion in class UICache
Returns:
region value from local variable or value bindings

getFamily

public java.lang.String getFamily()
Specified by:
getFamily in class javax.faces.component.UIComponent

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class javax.faces.component.UIComponentBase

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class javax.faces.component.UIComponentBase


Copyright © 2008. All Rights Reserved.