org.alfresco.web.ui.common.component.description

Class UIDescription

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.description.UIDescription

All Implemented Interfaces:

Serializable, StateHolder

public class UIDescription
extends org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent
implements Serializable

Description component that outputs a dynamic description

Author:

gavinc

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UIDescription()

Method Summary

Modifier and Type	Method and Description
String	getControlValue()
String	getFamily()
boolean	getRendersChildren()
String	getText()
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setControlValue(String controlValue)
void	setText(String text)

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

outputAttribute

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, 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

Constructor Detail

UIDescription

public UIDescription()

Method Detail

getControlValue

public String getControlValue()

Returns:

The control value the description is for

setControlValue

public void setControlValue(String controlValue)

Parameters:

controlValue - Sets the control value this description is for

getText

public String getText()

Returns:

Returns the description text

setText

public void setText(String text)

Parameters:

text - Sets the description text

getFamily

public String getFamily()

Specified by:

getFamily in class UIComponent

See Also:

UIComponent.getFamily()

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)

getRendersChildren

public boolean getRendersChildren()

Overrides:

getRendersChildren in class UIComponentBase

See Also:

UIComponent.getRendersChildren()