org.alfresco.web.ui.repo.component

Class UIActions

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

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

org.alfresco.web.ui.repo.component.UIActions

All Implemented Interfaces:

StateHolder

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

Author:

kevinr

Field Summary

Fields

Modifier and Type	Field and Description
static Class[]	ACTION_CLASS_ARGS
static String	COMPONENT_ACTIONEVAL
static String	COMPONENT_ACTIONLINK
static String	COMPONENT_PERMISSIONEVAL
static String	RENDERER_ACTIONLINK

Constructor Summary

Constructors

Constructor and Description
UIActions()

Method Summary

Modifier and Type	Method and Description
void	encodeBegin(FacesContext context)
void	encodeChildren(FacesContext context)
void	encodeEnd(FacesContext context)
Object	getContext() Get the object that forms the context for this group of actions
String	getFamily()
boolean	getRendersChildren()
boolean	getShowLink() Get whether to show the link as well as the image if specified
String	getValue() Get the value (for this component the value is the ID of an Action Group config block)
int	getVerticalSpacing()
void	reset() Resets the component to force a re-initialisation.
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setContext(Object context) Set the the object that forms the context for this group of actions
void	setShowLink(boolean showLink) Set whether to show the link as well as the image if specified
void	setValue(String value) Set the value (for this component the value is the ID of an Action Group config block)
void	setVerticalSpacing(int verticalSpacing)

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

RENDERER_ACTIONLINK

public static final String RENDERER_ACTIONLINK

See Also:

Constant Field Values

COMPONENT_ACTIONLINK

public static final String COMPONENT_ACTIONLINK

See Also:

Constant Field Values

COMPONENT_PERMISSIONEVAL

public static final String COMPONENT_PERMISSIONEVAL

See Also:

Constant Field Values

COMPONENT_ACTIONEVAL

public static final String COMPONENT_ACTIONEVAL

See Also:

Constant Field Values

ACTION_CLASS_ARGS

public static final Class[] ACTION_CLASS_ARGS

Constructor Detail

UIActions

public UIActions()

Method Detail

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)

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException

See Also:

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

getRendersChildren

public boolean getRendersChildren()

Overrides:

getRendersChildren in class UIComponentBase

See Also:

UIComponentBase.getRendersChildren()

encodeChildren

public void encodeChildren(FacesContext context)
                    throws IOException

Overrides:

encodeChildren in class UIComponentBase

Throws:

IOException

See Also:

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

encodeEnd

public void encodeEnd(FacesContext context)
               throws IOException

Overrides:

encodeEnd in class UIComponentBase

Throws:

IOException

See Also:

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

getValue

public String getValue()

Get the value (for this component the value is the ID of an Action Group config block)

Returns:

the value

setValue

public void setValue(String value)

Set the value (for this component the value is the ID of an Action Group config block)

Parameters:

value - the value

getContext

public Object getContext()

Get the object that forms the context for this group of actions

Returns:

the context

setContext

public void setContext(Object context)

Set the the object that forms the context for this group of actions

Parameters:

context - the context

getShowLink

public boolean getShowLink()

Get whether to show the link as well as the image if specified

Returns:

true to show the link as well as the image if specified

setShowLink

public void setShowLink(boolean showLink)

Set whether to show the link as well as the image if specified

Parameters:

showLink - Whether to show the link as well as the image if specified

getVerticalSpacing

public int getVerticalSpacing()

Returns:

Returns the vertical spacing value in pixels or zero if not set.

setVerticalSpacing

public void setVerticalSpacing(int verticalSpacing)

Parameters:

verticalSpacing - The verticalSpacing to set.

reset

public void reset()

Resets the component to force a re-initialisation.