org.alfresco.web.ui.repo.component.shelf

Class UIShelf

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.shelf.UIShelf

All Implemented Interfaces:

StateHolder

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

Author:

Kevin Roast

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIShelf.ShelfEvent Class representing the an action event relevant to the Shelf.

Constructor Summary

Constructors

Constructor and Description
UIShelf()

Method Summary

Modifier and Type	Method and Description
void	broadcast(FacesEvent event)
void	decode(FacesContext context)
void	encodeBegin(FacesContext context)
void	encodeChildren(FacesContext context)
void	encodeEnd(FacesContext context)
String	getFamily()
String	getGroupBgcolor()
MethodBinding	getGroupExpandedActionListener()
String	getGroupPanel()
String	getInnerGroupBgcolor()
String	getInnerGroupPanel()
boolean	getRendersChildren()
String	getSelectedGroupBgcolor()
String	getSelectedGroupPanel()
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setGroupBgcolor(String groupBgcolor)
void	setGroupExpandedActionListener(MethodBinding binding)
void	setGroupPanel(String groupPanel)
void	setInnerGroupBgcolor(String innerGroupBgcolor)
void	setInnerGroupPanel(String innerGroupPanel)
void	setSelectedGroupBgcolor(String selectedGroupBgcolor)
void	setSelectedGroupPanel(String selectedGroupPanel)

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

outputAttribute

Methods inherited from class javax.faces.component.UIComponentBase

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

UIShelf

public UIShelf()

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)

setGroupExpandedActionListener

public void setGroupExpandedActionListener(MethodBinding binding)

Parameters:

binding - The MethodBinding to call when the Group expand action is performed by the user

getGroupExpandedActionListener

public MethodBinding getGroupExpandedActionListener()

Returns:

The MethodBinding to call for the Group expand action

decode

public void decode(FacesContext context)

Overrides:

decode in class UIComponentBase

See Also:

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

broadcast

public void broadcast(FacesEvent event)
               throws AbortProcessingException

Overrides:

broadcast in class UIComponentBase

Throws:

AbortProcessingException

See Also:

UIComponentBase.broadcast(javax.faces.event.FacesEvent)

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException

See Also:

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

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)

getRendersChildren

public boolean getRendersChildren()

Overrides:

getRendersChildren in class UIComponentBase

See Also:

UIComponentBase.getRendersChildren()

getGroupPanel

public String getGroupPanel()

Returns:

Returns the group panel name.

setGroupPanel

public void setGroupPanel(String groupPanel)

Parameters:

groupPanel - The group panel name to set.

getGroupBgcolor

public String getGroupBgcolor()

Returns:

Returns the group background colour.

setGroupBgcolor

public void setGroupBgcolor(String groupBgcolor)

Parameters:

groupBgcolor - The group background colour to set.

getSelectedGroupPanel

public String getSelectedGroupPanel()

Returns:

Returns the selected group panel name.

setSelectedGroupPanel

public void setSelectedGroupPanel(String selectedGroupPanel)

Parameters:

selectedGroupPanel - The selected group panel name to set.

getSelectedGroupBgcolor

public String getSelectedGroupBgcolor()

Returns:

Returns the selected group background colour.

setSelectedGroupBgcolor

public void setSelectedGroupBgcolor(String selectedGroupBgcolor)

Parameters:

selectedGroupBgcolor - The selected group background colour to set.

getInnerGroupPanel

public String getInnerGroupPanel()

Returns:

Returns the inner group panel name.

setInnerGroupPanel

public void setInnerGroupPanel(String innerGroupPanel)

Parameters:

innerGroupPanel - The inner group panel name to set.

getInnerGroupBgcolor

public String getInnerGroupBgcolor()

Returns:

Returns the inner group background colour.

setInnerGroupBgcolor

public void setInnerGroupBgcolor(String innerGroupBgcolor)

Parameters:

innerGroupBgcolor - The inner group background colour to set.