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:
- javax.faces.component.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.
Method Summary |
void |
encodeBegin(javax.faces.context.FacesContext context)
|
void |
encodeChildren(javax.faces.context.FacesContext context)
|
void |
encodeEnd(javax.faces.context.FacesContext context)
|
java.lang.String |
getActivePlugin()
Returns the id of the plugin that is currently active |
java.lang.String |
getFamily()
|
boolean |
getRendersChildren()
|
void |
restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
|
java.lang.Object |
saveState(javax.faces.context.FacesContext context)
|
void |
setActivePlugin(java.lang.String activePlugin)
Sets the active plugin the sidebar should show |
protected void |
setupActionGroupId(javax.faces.context.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 |
COMPONENT_TYPE
public static final java.lang.String COMPONENT_TYPE
- See Also:
- Constant Field Values
activePlugin
protected java.lang.String activePlugin
UISidebar
public UISidebar()
getFamily
public java.lang.String getFamily()
- Specified by:
getFamily
in class javax.faces.component.UIComponent
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
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
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
encodeEnd
public void encodeEnd(javax.faces.context.FacesContext context)
throws java.io.IOException
- Overrides:
encodeEnd
in class javax.faces.component.UIComponentBase
- Throws:
java.io.IOException
getRendersChildren
public boolean getRendersChildren()
- Overrides:
getRendersChildren
in class javax.faces.component.UIComponentBase
getActivePlugin
public java.lang.String getActivePlugin()
- Returns the id of the plugin that is currently active
- Returns:
- The currently active plugin
setActivePlugin
public void setActivePlugin(java.lang.String activePlugin)
- Sets the active plugin the sidebar should show
- Parameters:
activePlugin
- Id of the plugin to make active
setupActionGroupId
protected void setupActionGroupId(javax.faces.context.FacesContext context,
UIActions actionsComponent)
- Sets up the corrent actions config group id on the given actions
component.
- Parameters:
context
- Faces contextactionsComponent
- The actions component to set the group id for
Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.