NavigationBean (Alfresco 5.3.a-SNAPSHOT API)

java.lang.Object
- org.alfresco.web.bean.NavigationBean

All Implemented Interfaces:

Serializable
```
public class NavigationBean
extends Object
implements Serializable
```
Bean providing access and management of the various global navigation mechanisms such as the My Home, Company Home, Guest Home toolbar shortcuts, breadcrumb and the current node id and associated properties.

Author:

Kevin Roast

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class NavigationBean.NavigationBreadcrumbHandler
Class to handle breadcrumb interaction for top-level navigation pages

Nested Classes
Modifier and Type	Class and Description
`class`	`NavigationBean.NavigationBreadcrumbHandler` Class to handle breadcrumb interaction for top-level navigation pages

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BEAN_NAME` Public JSF Bean name
`protected ClientConfigElement`	`clientConfig` Client configuration object
`protected ContentDiskInterface`	`contentDiskDriver` CIFS content disk driver bean reference
`static String`	`LOCATION_COMPANY` constant values used by the toolbar location modelist control
`static String`	`LOCATION_GUEST`
`static String`	`LOCATION_HOME`
`static String`	`LOCATION_MYALFRESCO`
`static String`	`MSG_COMPANYHOME`
`static String`	`MSG_GUESTHOME`
`static String`	`MSG_MYALFRESCO` constant value representing the display lables for toolbar locations
`static String`	`MSG_MYHOME`

Constructor Summary

Constructors
Constructor and Description

NavigationBean()
Default constructor

Constructors
Constructor and Description
`NavigationBean()` Default constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected MutableAuthenticationService`	`getAuthService()`
`String`	`getCIFSServerPath(org.alfresco.jlan.server.filesys.DiskSharedDevice diskShare)`
`protected ClientConfigElement`	`getClientConfig()`
`Node`	`getCompanyHomeNode()`
`boolean`	`getCompanyHomeVisible()`
`Node`	`getCurrentNode()`
`String`	`getCurrentNodeId()`
`String`	`getCurrentNodeTemplate()`
`String`	`getCurrentNodeWebscript()`
`User`	`getCurrentUser()`
`Node`	`getDispatchContextNode()` Returns the node currently set in the dispatch context
`Node`	`getGuestHomeNode()`
`boolean`	`getGuestHomeVisible()`
`boolean`	`getHasCustomView()`
`boolean`	`getHasTemplateView()`
`boolean`	`getHasWebscriptView()`
`String`	`getHelpUrl()`
`boolean`	`getInPortalServer()`
`boolean`	`getIsGuest()`
`List<IBreadcrumbHandler>`	`getLocation()`
`protected org.alfresco.service.namespace.NamespaceService`	`getNamespaceService()`
`Map<String,Object>`	`getNodeProperties()`
`protected org.alfresco.service.cmr.repository.NodeService`	`getNodeService()`
`protected org.alfresco.service.cmr.security.PermissionService`	`getPermissionService()`
`RepoAdminService`	`getRepoAdminService()`
`String`	`getRSSFeedURL()`
`int`	`getRuleCount()`
`protected RuleService`	`getRuleService()`
`SearchContext`	`getSearchContext()`
`protected org.alfresco.service.cmr.search.SearchService`	`getSearchService()`
`protected org.alfresco.jlan.server.config.ServerConfigurationAccessor`	`getServerConfiguration()`
`boolean[]`	`getShelfItemExpanded()`
`Map`	`getTemplateModel()` Returns a model for use by a template on a space Dashboard page.
`String`	`getToolbarLocation()`
`String`	`getWorkAreaWidth()` Return the width of the main work area depending on the visibility of the Shelf panel
`boolean`	`isAllowUserChangePassword()`
`boolean`	`isAllowUserConfig()`
`boolean`	`isAllowUserGroupAdmin()`
`boolean`	`isCreateChildrenPermissionEnabled()`
`boolean`	`isRSSFeed()`
`boolean`	`isShelfExpanded()` Return the expanded state of the Shelf panel wrapper component
`boolean`	`isTeamMode()`
`void`	`processToolbarLocation(String location, boolean navigate)` Process the selected toolbar location.
`void`	`resetCurrentNodeProperties()` Clear state so that the current node properties cache for the next time they are requested
`void`	`resetDispatchContext()` Resets the dispatch context
`void`	`setAuthenticationService(MutableAuthenticationService authService)`
`void`	`setContentDiskDriver(ContentDiskInterface contentDiskDriver)`
`void`	`setCurrentNodeId(String currentNodeId)` Set the node Id of the current folder/space container node.
`void`	`setHelpUrl(String helpUrl)`
`void`	`setLocation(List<IBreadcrumbHandler> location)`
`void`	`setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)`
`void`	`setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)`
`void`	`setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)`
`void`	`setRepoAdminService(RepoAdminService repoAdminService)`
`void`	`setRuleService(RuleService ruleService)`
`void`	`setSearchContext(SearchContext searchContext)`
`void`	`setSearchService(org.alfresco.service.cmr.search.SearchService searchService)`
`void`	`setServerConfiguration(org.alfresco.jlan.server.config.ServerConfigurationAccessor serverConfiguration)`
`void`	`setShelfExpanded(boolean expanded)` Set the expanded state of the Shelf panel wrapper component
`void`	`setShelfItemExpanded(boolean[] shelfItemExpanded)`
`void`	`setToolbarLocation(String location)`
`void`	`setupDispatchContext(Node node)` Sets up the dispatch context so that the navigation handler knows what object is being acted upon
`void`	`setUserPreferencesBean(UserPreferencesBean preferences)`
`void`	`shelfGroupToggled(ActionEvent event)` Action handler called after a Shelf Group has had its expanded state toggled by the user
`void`	`toggleShelf(ActionEvent event)` Action handler to toggle the expanded state of the shelf.
`void`	`toolbarLocationChanged(ActionEvent event)` Action to change the toolbar location Currently this will changed the location from Company to the users Home space

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BEAN_NAME
```
public static final String BEAN_NAME
```
    Public JSF Bean name
    
    See Also:
    
    Constant Field Values
  - LOCATION_COMPANY
```
public static final String LOCATION_COMPANY
```
    constant values used by the toolbar location modelist control
    
    See Also:
    
    Constant Field Values
  - LOCATION_HOME
```
public static final String LOCATION_HOME
```
    See Also:
    
    Constant Field Values
  - LOCATION_GUEST
```
public static final String LOCATION_GUEST
```
    See Also:
    
    Constant Field Values
  - LOCATION_MYALFRESCO
```
public static final String LOCATION_MYALFRESCO
```
    See Also:
    
    Constant Field Values
  - MSG_MYALFRESCO
```
public static final String MSG_MYALFRESCO
```
    constant value representing the display lables for toolbar locations
    
    See Also:
    
    Constant Field Values
  - MSG_MYHOME
```
public static final String MSG_MYHOME
```
    See Also:
    
    Constant Field Values
  - MSG_COMPANYHOME
```
public static final String MSG_COMPANYHOME
```
    See Also:
    
    Constant Field Values
  - MSG_GUESTHOME
```
public static final String MSG_GUESTHOME
```
    See Also:
    
    Constant Field Values
  - contentDiskDriver
```
protected ContentDiskInterface contentDiskDriver
```
    CIFS content disk driver bean reference
  - clientConfig
```
protected ClientConfigElement clientConfig
```
    Client configuration object
- Constructor Detail
  - NavigationBean
```
public NavigationBean()
```
    Default constructor
- Method Detail
  - setNodeService
```
public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
```
    Parameters:
    
    nodeService - The nodeService to set.
  - getNodeService
```
protected org.alfresco.service.cmr.repository.NodeService getNodeService()
```
  - setSearchService
```
public void setSearchService(org.alfresco.service.cmr.search.SearchService searchService)
```
    Parameters:
    
    searchService - The searchService to set.
  - getSearchService
```
protected org.alfresco.service.cmr.search.SearchService getSearchService()
```
  - setNamespaceService
```
public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
```
    Parameters:
    
    namespaceService - The namespaceService to set.
  - getNamespaceService
```
protected org.alfresco.service.namespace.NamespaceService getNamespaceService()
```
  - setRepoAdminService
```
public void setRepoAdminService(RepoAdminService repoAdminService)
```
  - getRepoAdminService
```
public RepoAdminService getRepoAdminService()
```
  - setRuleService
```
public void setRuleService(RuleService ruleService)
```
    Parameters:
    
    ruleService - The ruleService to use
  - getRuleService
```
protected RuleService getRuleService()
```
  - setServerConfiguration
```
public void setServerConfiguration(org.alfresco.jlan.server.config.ServerConfigurationAccessor serverConfiguration)
```
    Parameters:
    
    serverConfiguration - The serverConfiguration to set.
  - getServerConfiguration
```
protected org.alfresco.jlan.server.config.ServerConfigurationAccessor getServerConfiguration()
```
  - setContentDiskDriver
```
public void setContentDiskDriver(ContentDiskInterface contentDiskDriver)
```
    Parameters:
    
    contentDiskDriver - The contentDiskDriver to set.
  - getClientConfig
```
protected ClientConfigElement getClientConfig()
```
  - setUserPreferencesBean
```
public void setUserPreferencesBean(UserPreferencesBean preferences)
```
    Parameters:
    
    preferences - The UserPreferencesBean to set
  - setAuthenticationService
```
public void setAuthenticationService(MutableAuthenticationService authService)
```
    Parameters:
    
    authService - The AuthenticationService to set.
  - getAuthService
```
protected MutableAuthenticationService getAuthService()
```
  - setPermissionService
```
public void setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)
```
    Parameters:
    
    permissionService - The PermissionService to set.
  - getPermissionService
```
protected org.alfresco.service.cmr.security.PermissionService getPermissionService()
```
  - getCurrentUser
```
public User getCurrentUser()
```
    Returns:
    
    the User object representing the current instance for this user
  - getInPortalServer
```
public boolean getInPortalServer()
```
    Returns:
    
    true if the system is running within a JSR-168 portal container
  - isShelfExpanded
```
public boolean isShelfExpanded()
```
    Return the expanded state of the Shelf panel wrapper component
    
    Returns:
    
    the expanded state of the Shelf panel wrapper component
  - setShelfExpanded
```
public void setShelfExpanded(boolean expanded)
```
    Set the expanded state of the Shelf panel wrapper component
    
    Parameters:
    
    expanded - true to expanded the Shelf panel area, false to hide it
  - getWorkAreaWidth
```
public String getWorkAreaWidth()
```
    Return the width of the main work area depending on the visibility of the Shelf panel
    
    Returns:
    
    width, which will either be "80%" or "100%"
  - getShelfItemExpanded
```
public boolean[] getShelfItemExpanded()
```
    Returns:
    
    Returns the array containing the expanded state of the shelf items
  - setShelfItemExpanded
```
public void setShelfItemExpanded(boolean[] shelfItemExpanded)
```
    Parameters:
    
    shelfItemExpanded - The array containing the expanded state of the shelf items
  - getToolbarLocation
```
public String getToolbarLocation()
```
    Returns:
    
    Returns the toolbar Location - initially set from the user preferences.
  - setToolbarLocation
```
public void setToolbarLocation(String location)
```
    Parameters:
    
    location - The toolbar Location to set.
  - processToolbarLocation
```
public void processToolbarLocation(String location,
                                   boolean navigate)
```
    Process the selected toolbar location. Setup the breadcrumb with initial value and setup the current node ID. This method can also perform the navigatin setup if requested.
    
    Parameters:
    
    location - Toolbar location constant
    
    navigate - True to perform navigation, false otherwise
  - getHelpUrl
```
public String getHelpUrl()
```
    Returns:
    
    Returns the helpUrl.
  - setHelpUrl
```
public void setHelpUrl(String helpUrl)
```
    Parameters:
    
    helpUrl - The helpUrl to set.
  - getRuleCount
```
public int getRuleCount()
```
    Returns:
    
    the number of rules associated with the current space
  - getSearchContext
```
public SearchContext getSearchContext()
```
    Returns:
    
    Returns the search context object if any.
  - setSearchContext
```
public void setSearchContext(SearchContext searchContext)
```
    Parameters:
    
    searchContext - The search context object to set or null to clear search.
  - getCurrentNodeId
```
public String getCurrentNodeId()
```
    Returns:
    
    Returns the currently browsing node Id.
  - setCurrentNodeId
```
public void setCurrentNodeId(String currentNodeId)
```
    Set the node Id of the current folder/space container node.
    Setting this value causes the UI to update and display the specified node as current.
    
    Parameters:
    
    currentNodeId - The currently browsing node Id.
  - getHasCustomView
```
public boolean getHasCustomView()
```
    Returns:
    
    true if the current node has a custom view available
  - getHasTemplateView
```
public boolean getHasTemplateView()
```
    Returns:
    
    true if the current node has a Template based custom view available
  - getHasWebscriptView
```
public boolean getHasWebscriptView()
```
    Returns:
    
    true if the current node has a Webscript based custom view available
  - getCurrentNodeTemplate
```
public String getCurrentNodeTemplate()
```
    Returns:
    
    the NodeRef.toString() for the current node Template custom view if it has one
  - getCurrentNodeWebscript
```
public String getCurrentNodeWebscript()
```
    Returns:
    
    the service url for the current node Webscript custom view if it has one
  - getTemplateModel
```
public Map getTemplateModel()
```
    Returns a model for use by a template on a space Dashboard page.
    
    Returns:
    
    model containing current current space info.
  - resetCurrentNodeProperties
```
public void resetCurrentNodeProperties()
```
    Clear state so that the current node properties cache for the next time they are requested
  - getNodeProperties
```
public Map<String,Object> getNodeProperties()
```
    Returns:
    
    The Map of properties for the current Node.
  - getCurrentNode
```
public Node getCurrentNode()
```
    Returns:
    
    The current Node object for UI context operations
  - isCreateChildrenPermissionEnabled
```
public boolean isCreateChildrenPermissionEnabled()
```
    Returns:
    
    Boolean value according to CREATE_CHILDREN permission on the current node.
  - getLocation
```
public List<IBreadcrumbHandler> getLocation()
```
    Returns:
    
    Returns the breadcrumb handler elements representing the location path of the UI.
  - setLocation
```
public void setLocation(List<IBreadcrumbHandler> location)
```
    Parameters:
    
    location - The UI location representation to set.
  - getIsGuest
```
public boolean getIsGuest()
```
    Returns:
    
    true if we are currently the special Guest user
  - setupDispatchContext
```
public void setupDispatchContext(Node node)
```
    Sets up the dispatch context so that the navigation handler knows what object is being acted upon
    
    Parameters:
    
    node - The node to be added to the dispatch context
  - resetDispatchContext
```
public void resetDispatchContext()
```
    Resets the dispatch context
  - getDispatchContextNode
```
public Node getDispatchContextNode()
```
    Returns the node currently set in the dispatch context
    
    Returns:
    
    The node being dispatched or null if there is no dispatch context
  - getCompanyHomeNode
```
public Node getCompanyHomeNode()
```
    Returns:
    
    Node representing the Company Home folder
  - getGuestHomeNode
```
public Node getGuestHomeNode()
```
    Returns:
    
    Node representing the Guest Home Space folder
  - getCompanyHomeVisible
```
public boolean getCompanyHomeVisible()
```
    Returns:
    
    true if the Company home node is accessible to the current user
  - getGuestHomeVisible
```
public boolean getGuestHomeVisible()
```
    Returns:
    
    true if the Guest home node is accessible to the current user
  - toggleShelf
```
public void toggleShelf(ActionEvent event)
```
    Action handler to toggle the expanded state of the shelf. The panel component wrapping the shelf area of the UI is value bound to the shelfExpanded property.
  - shelfGroupToggled
```
public void shelfGroupToggled(ActionEvent event)
```
    Action handler called after a Shelf Group has had its expanded state toggled by the user
  - toolbarLocationChanged
```
public void toolbarLocationChanged(ActionEvent event)
```
    Action to change the toolbar location Currently this will changed the location from Company to the users Home space
  - getCIFSServerPath
```
public String getCIFSServerPath(org.alfresco.jlan.server.filesys.DiskSharedDevice diskShare)
```
    Parameters:
    
    diskShare - Filesystem shared device
    
    Returns:
    
    CIFS server path as network style string label
  - isRSSFeed
```
public boolean isRSSFeed()
```
    Returns:
    
    true if the current space has an RSS feed applied
  - getRSSFeedURL
```
public String getRSSFeedURL()
```
    Returns:
    
    RSS Feed URL for the current space
  - isAllowUserGroupAdmin
```
public boolean isAllowUserGroupAdmin()
```
    Returns:
    
    true if User/Group admin is allowed by admin users
  - isAllowUserConfig
```
public boolean isAllowUserConfig()
```
    Returns:
    
    true if users can configure their own settings in the User Console
  - isAllowUserChangePassword
```
public boolean isAllowUserChangePassword()
```
    Returns:
    
    true if a users can modify the password set against their authentication
  - isTeamMode
```
public boolean isTeamMode()
```
    Returns:
    
    true if this is a team license

Class NavigationBean

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BEAN_NAME

LOCATION_COMPANY

LOCATION_HOME

LOCATION_GUEST

LOCATION_MYALFRESCO

MSG_MYALFRESCO

MSG_MYHOME

MSG_COMPANYHOME

MSG_GUESTHOME

contentDiskDriver

clientConfig

Constructor Detail

NavigationBean

Method Detail

setNodeService

getNodeService

setSearchService

getSearchService

setNamespaceService

getNamespaceService

setRepoAdminService

getRepoAdminService

setRuleService

getRuleService

setServerConfiguration

getServerConfiguration

setContentDiskDriver

getClientConfig

setUserPreferencesBean

setAuthenticationService

getAuthService

setPermissionService

getPermissionService

getCurrentUser

getInPortalServer

isShelfExpanded

setShelfExpanded

getWorkAreaWidth

getShelfItemExpanded

setShelfItemExpanded

getToolbarLocation

setToolbarLocation

processToolbarLocation

getHelpUrl

setHelpUrl

getRuleCount

getSearchContext

setSearchContext

getCurrentNodeId

setCurrentNodeId

getHasCustomView

getHasTemplateView

getHasWebscriptView

getCurrentNodeTemplate

getCurrentNodeWebscript

getTemplateModel

resetCurrentNodeProperties

getNodeProperties

getCurrentNode

isCreateChildrenPermissionEnabled

getLocation

setLocation

getIsGuest

setupDispatchContext

resetDispatchContext

getDispatchContextNode

getCompanyHomeNode

getGuestHomeNode

getCompanyHomeVisible

getGuestHomeVisible

toggleShelf

shelfGroupToggled

toolbarLocationChanged