org.alfresco.web.ui.repo.component

Class UISidebar

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.UISidebar

All Implemented Interfaces:

StateHolder

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

Component that represents the sidebar.

A sidebar consists of multiple plugins, of which only one is active at one time. All registered plugins are displayed in a drop down allowing the user to change the active plugin. An action group can also be associated with a plugin, which get rendered in the sidebar header.

Author:

gavinc

Field Summary

Fields

Modifier and Type	Field and Description
protected String	activePlugin
static String	COMPONENT_TYPE

Constructor Summary

Constructors

Constructor and Description
UISidebar()

Method Summary

Modifier and Type	Method and Description
void	encodeBegin(FacesContext context)
void	encodeChildren(FacesContext context)
void	encodeEnd(FacesContext context)
String	getActivePlugin() Returns the id of the plugin that is currently active
String	getFamily()
boolean	getRendersChildren()
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setActivePlugin(String activePlugin) Sets the active plugin the sidebar should show
protected void	setupActionGroupId(FacesContext context, UIActions actionsComponent) Sets up the corrent actions config group id on the given actions component.

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

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

activePlugin

protected String activePlugin

Constructor Detail

UISidebar

public UISidebar()

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class UIComponent

restoreState

public void restoreState(FacesContext context,
                         Object state)

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UIComponentBase

saveState

public Object saveState(FacesContext context)

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class UIComponentBase

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException

encodeChildren

public void encodeChildren(FacesContext context)
                    throws IOException

Overrides:

encodeChildren in class UIComponentBase

Throws:

IOException

encodeEnd

public void encodeEnd(FacesContext context)
               throws IOException

Overrides:

encodeEnd in class UIComponentBase

Throws:

IOException

getRendersChildren

public boolean getRendersChildren()

Overrides:

getRendersChildren in class UIComponentBase

getActivePlugin

public String getActivePlugin()

Returns the id of the plugin that is currently active

Returns:

The currently active plugin

setActivePlugin

public void setActivePlugin(String activePlugin)

Sets the active plugin the sidebar should show

Parameters:

activePlugin - Id of the plugin to make active

setupActionGroupId

protected void setupActionGroupId(FacesContext context,
                                  UIActions actionsComponent)

Sets up the corrent actions config group id on the given actions component.

Parameters:

context - Faces context

actionsComponent - The actions component to set the group id for