org.alfresco.web.ui.wcm.component

Class UIUserSandboxes

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

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

org.alfresco.web.ui.wcm.component.UIUserSandboxes

All Implemented Interfaces:

java.io.Serializable, javax.faces.component.StateHolder

public class UIUserSandboxes
extends org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent
implements java.io.Serializable

Component responsible for rendering the list of user sandboxes for a web project.

The list of users attached to the supplied Web Project noderef (must be of type wcm:avmfolder) are iterated and the various AVM services used to provide the list of modified files for each user in turn. Actions are rendering with appropriate permission evaluators next to each item. The status of workflows in progress are also checked against items when building the list of actions.

Multi-select functionality is provided for specific actions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIUserSandboxes.UserRoleWrapper Class representing a user of the website and their role.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAM_FORM_NAME

Constructor Summary

Constructors

Constructor and Description
UIUserSandboxes()

Method Summary

Methods

Modifier and Type	Method and Description
void	decode(javax.faces.context.FacesContext context)
void	encodeBegin(javax.faces.context.FacesContext context)
void	encodeChildren(javax.faces.context.FacesContext context)
java.lang.String	getFamily()
boolean	getRendersChildren()
java.util.List	getSelectedNodes(int sandbox) Get the selected nodes for a specified sandbox index
java.util.List	getSelectedNodes(java.lang.String username) Get the selected nodes for a specified sandbox user
org.alfresco.service.cmr.repository.NodeRef	getValue() Returns the NodeRef to the website to show the sandboxes for
java.lang.String	getWebapp()
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setValue(org.alfresco.service.cmr.repository.NodeRef value) Sets the NodeRef to the website to show the sandboxes for
void	setWebapp(java.lang.String webapp)

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

outputAttribute

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, 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

Field Detail

PARAM_FORM_NAME

public static final java.lang.String PARAM_FORM_NAME

See Also:

Constant Field Values

Constructor Detail

UIUserSandboxes

public UIUserSandboxes()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

See Also:

UIComponent.getFamily()

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

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

getRendersChildren

public boolean getRendersChildren()

Overrides:

getRendersChildren in class javax.faces.component.UIComponentBase

See Also:

UIComponentBase.getRendersChildren()

encodeChildren

public void encodeChildren(javax.faces.context.FacesContext context)
                    throws java.io.IOException

Overrides:

encodeChildren in class javax.faces.component.UIComponentBase

Throws:

java.io.IOException

See Also:

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

decode

public void decode(javax.faces.context.FacesContext context)

Overrides:

decode in class javax.faces.component.UIComponentBase

See Also:

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

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws java.io.IOException

Overrides:

encodeBegin in class javax.faces.component.UIComponentBase

Throws:

java.io.IOException

See Also:

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

getValue

public org.alfresco.service.cmr.repository.NodeRef getValue()

Returns the NodeRef to the website to show the sandboxes for

Returns:

The website NodeRef instance

setValue

public void setValue(org.alfresco.service.cmr.repository.NodeRef value)

Sets the NodeRef to the website to show the sandboxes for

Parameters:

value - The NodeRef to the website to show the sandboxes for

getWebapp

public java.lang.String getWebapp()

Returns:

Returns the webapp to filter file list by

setWebapp

public void setWebapp(java.lang.String webapp)

Parameters:

webapp - The webapp to filter file list by

getSelectedNodes

public java.util.List getSelectedNodes(java.lang.String username)

Get the selected nodes for a specified sandbox user

Parameters:

username - User in the user sandbox list

Returns:

List of AVMNodeDescriptor object representing the selected items

getSelectedNodes

public java.util.List getSelectedNodes(int sandbox)

Get the selected nodes for a specified sandbox index

Parameters:

sandbox - Index of sandbox in the user sandbox list

Returns:

List of AVMNodeDescriptor object representing the selected items