org.alfresco.web.ui.repo.component

Class UINavigator

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

All Implemented Interfaces:

StateHolder

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

Navigator component that consists of 4 panels representing the main areas of the repository i.e. company home, my home, guest home and my alfresco.

Each panel (apart from my alfresco) uses the tree component to allow navigation around that area of the repository.

Author:

gavinc

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UINavigator.NavigatorEvent Class representing the clicking of a tree node.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
UINavigator()

Method Summary

Modifier and Type	Method and Description
void	broadcast(FacesEvent event)
void	decode(FacesContext context)
void	encodeBegin(FacesContext context)
void	encodeChildren(FacesContext context)
String	getActiveArea() Returns the active area the navigator component is showing
String	getFamily()
boolean	getRendersChildren()
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setActiveArea(String activeArea) Sets the active area for the navigator panel

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

outputAttribute

Methods inherited from class javax.faces.component.UIComponentBase

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

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

activeArea

protected String activeArea

Constructor Detail

UINavigator

public UINavigator()

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

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:

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

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

getRendersChildren

public boolean getRendersChildren()

Overrides:

getRendersChildren in class UIComponentBase

getActiveArea

public String getActiveArea()

Returns the active area the navigator component is showing

Returns:

The active area

setActiveArea

public void setActiveArea(String activeArea)

Sets the active area for the navigator panel

Parameters:

activeArea - String