org.alfresco.web.ui.repo.component
Class UINavigator

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent
              extended by org.alfresco.web.ui.repo.component.UINavigator
All Implemented Interfaces:
javax.faces.component.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.


Nested Class Summary
static class UINavigator.NavigatorEvent
          Class representing the clicking of a tree node.
 
Field Summary
protected  java.lang.String activeArea
           
static java.lang.String COMPONENT_TYPE
           
 
Constructor Summary
UINavigator()
           
 
Method Summary
 void broadcast(javax.faces.event.FacesEvent event)
           
 void decode(javax.faces.context.FacesContext context)
           
 void encodeBegin(javax.faces.context.FacesContext context)
           
 void encodeChildren(javax.faces.context.FacesContext context)
           
 java.lang.String getActiveArea()
          Returns the active area the navigator component is showing
 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 setActiveArea(java.lang.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 java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

activeArea

protected java.lang.String activeArea
Constructor Detail

UINavigator

public UINavigator()
Method Detail

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

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)

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException
Overrides:
broadcast in class javax.faces.component.UIComponentBase
Throws:
javax.faces.event.AbortProcessingException
See Also:
UIInput.broadcast(javax.faces.event.FacesEvent)

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

getRendersChildren

public boolean getRendersChildren()
Overrides:
getRendersChildren in class javax.faces.component.UIComponentBase

getActiveArea

public java.lang.String getActiveArea()
Returns the active area the navigator component is showing

Returns:
The active area

setActiveArea

public void setActiveArea(java.lang.String activeArea)
Sets the active area for the navigator panel

Parameters:
activeArea -


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.