org.alfresco.web.ui.common.component.evaluator

Class BaseEvaluator

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent

org.alfresco.web.ui.common.component.evaluator.BaseEvaluator

All Implemented Interfaces:

StateHolder

Direct Known Subclasses:

ActionInstanceEvaluator, BooleanEvaluator, PermissionEvaluator, StringEqualsEvaluator, ValueSetEvaluator

public abstract class BaseEvaluator
extends org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent

Author:

kevinr

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	s_logger

Constructor Summary

Constructors

Constructor and Description
BaseEvaluator()

Method Summary

Modifier and Type	Method and Description
void	encodeBegin(FacesContext context)
void	encodeChildren(FacesContext context)
void	encodeEnd(FacesContext context)
abstract boolean	evaluate() Evaluate against the component attributes.
String	getFamily()
boolean	getRendersChildren()
Object	getValue() Get the value for this component to be evaluated against
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setValue(Object value) Set the value for this component to be evaluated against

Methods inherited from class org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent

outputAttribute

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

s_logger

protected static final org.apache.commons.logging.Log s_logger

Constructor Detail

BaseEvaluator

public BaseEvaluator()

Method Detail

getFamily

public final String getFamily()

Specified by:

getFamily in class UIComponent

See Also:

UIComponent.getFamily()

getRendersChildren

public final boolean getRendersChildren()

Overrides:

getRendersChildren in class UIComponentBase

See Also:

UIComponentBase.getRendersChildren()

encodeBegin

public final void encodeBegin(FacesContext context)
                       throws IOException

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException

See Also:

UIComponentBase.encodeBegin(javax.faces.context.FacesContext)

encodeChildren

public final void encodeChildren(FacesContext context)
                          throws IOException

Overrides:

encodeChildren in class UIComponentBase

Throws:

IOException

See Also:

UIComponentBase.encodeChildren(javax.faces.context.FacesContext)

encodeEnd

public final void encodeEnd(FacesContext context)
                     throws IOException

Overrides:

encodeEnd in class UIComponentBase

Throws:

IOException

See Also:

UIComponentBase.encodeEnd(javax.faces.context.FacesContext)

getValue

public Object getValue()

Get the value for this component to be evaluated against

Returns:

the value for this component to be evaluated against

setValue

public void setValue(Object value)

Set the value for this component to be evaluated against

Parameters:

value - the value for this component to be evaluated against

restoreState

public void restoreState(FacesContext context,
                         Object state)

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UIComponentBase

See Also:

StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)

saveState

public Object saveState(FacesContext context)

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class UIComponentBase

See Also:

StateHolder.saveState(javax.faces.context.FacesContext)

evaluate

public abstract boolean evaluate()

Evaluate against the component attributes. Return true to allow the inner components to render, false to hide them during rendering.

Returns:

true to allow rendering of child components, false otherwise