Moving to root below branch label

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@2005 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/web/bean/RecentSpacesBean.java

@@ -0,0 +1,204 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.web.bean;
+
+import java.text.MessageFormat;
+import java.util.LinkedList;
+import java.util.List;
+
+import javax.faces.context.FacesContext;
+import javax.faces.event.ActionEvent;
+
+import org.alfresco.config.ConfigService;
+import org.alfresco.service.cmr.repository.InvalidNodeRefException;
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.web.app.Application;
+import org.alfresco.web.app.context.IContextListener;
+import org.alfresco.web.app.context.UIContextService;
+import org.alfresco.web.bean.repository.Node;
+import org.alfresco.web.bean.repository.Repository;
+import org.alfresco.web.config.ClientConfigElement;
+import org.alfresco.web.ui.common.Utils;
+import org.alfresco.web.ui.repo.component.shelf.UIRecentSpacesShelfItem;
+import org.apache.log4j.Logger;
+
+/**
+ * This bean manages the real-time updated list of Recent Spaces in the Shelf component.
+ * <p>
+ * Registers itself as a UI Context Listener so it is informed as to when the current Node ID
+ * has changed in the NavigationBeans. This is used to keep the list of spaces up-to-date. 
+ * 
+ * @author Kevin Roast
+ */
+public class RecentSpacesBean implements IContextListener
+{
+   private static Logger logger = Logger.getLogger(RecentSpacesBean.class);
+   
+   /** The NavigationBean reference */
+   private NavigationBean navigator;
+   
+   /** The BrowseBean reference */
+   private BrowseBean browseBean;
+   
+   /** ConfigService bean reference */
+   private ConfigService configService;
+   
+   /** Maximum number of recent spaces to show */
+   private Integer maxRecentSpaces = null;
+   
+   /** List of recent space nodes */
+   private List<Node> recentSpaces = new LinkedList<Node>();
+   
+   
+   // ------------------------------------------------------------------------------
+   // Construction 
+   
+   /**
+    * Default Constructor
+    */
+   public RecentSpacesBean()
+   {
+      UIContextService.getInstance(FacesContext.getCurrentInstance()).registerBean(this);
+   }
+
+
+   // ------------------------------------------------------------------------------
+   // Bean property getters and setters 
+   
+   /**
+    * @param navigator The NavigationBean to set.
+    */
+   public void setNavigator(NavigationBean navigator)
+   {
+      this.navigator = navigator;
+   }
+
+   /**
+    * @param browseBean The BrowseBean to set.
+    */
+   public void setBrowseBean(BrowseBean browseBean)
+   {
+      this.browseBean = browseBean;
+   }
+   
+   /**
+    * @param configService The ConfigService to set.
+    */
+   public void setConfigService(ConfigService configService)
+   {
+      this.configService = configService;
+   }
+   
+   /**
+    * @return the List of recent spaces
+    */
+   public List<Node> getRecentSpaces()
+   {
+      return this.recentSpaces;
+   }
+   
+   /**
+    * @param spaces     List of Nodes
+    */
+   public void setRecentSpaces(List<Node> spaces)
+   {
+      this.recentSpaces = spaces;
+   }
+   
+   
+   // ------------------------------------------------------------------------------
+   // Action method handlers
+   
+   /**
+    * Action handler bound to the recent spaces Shelf component called when a Space is clicked
+    */
+   public void navigate(ActionEvent event)
+   {
+      // work out which node was clicked from the event data
+      UIRecentSpacesShelfItem.RecentSpacesEvent spaceEvent = (UIRecentSpacesShelfItem.RecentSpacesEvent)event;
+      Node selectedNode = this.recentSpaces.get(spaceEvent.Index);
+      NodeRef nodeRef = selectedNode.getNodeRef();
+      try
+      {
+         // then navigate to the appropriate node in UI
+         // use browse bean functionality for this as it will update the breadcrumb for us
+         this.browseBean.updateUILocation(nodeRef);
+      }
+      catch (InvalidNodeRefException refErr)
+      {
+         Utils.addErrorMessage(MessageFormat.format(Application.getMessage(
+               FacesContext.getCurrentInstance(), Repository.ERROR_NODEREF), new Object[] {nodeRef.getId()}) );
+         
+         // remove invalid node from recent spaces list
+         this.recentSpaces.remove(spaceEvent.Index);
+      }
+   }
+   
+   
+   // ------------------------------------------------------------------------------
+   // IContextListener implementation
+   
+   /**
+    * @see org.alfresco.web.app.context.IContextListener#contextUpdated()
+    */
+   public void contextUpdated()
+   {
+      // We use this listener handler to refresh the recent spaces list. At the point
+      // where this method is called, the current node Id in UI will probably have changed.
+      Node node = this.navigator.getCurrentNode();
+      
+      // search for this node - if it's already in the list remove it so
+      // that it appears at the top for us
+      for (int i=0; i<this.recentSpaces.size(); i++)
+      {
+         if (node.getId().equals(this.recentSpaces.get(i).getId()))
+         {
+            // found same node already in the list - remove it
+            this.recentSpaces.remove(i);
+            break;
+         }
+      }
+      
+      // remove an item if the list is at the maximum length
+      int maxItems = getMaxRecentSpaces();
+      if (this.recentSpaces.size() == maxItems)
+      {
+         this.recentSpaces.remove(maxItems - 1);
+      }
+      
+      if (logger.isDebugEnabled())
+         logger.debug("Inserting node: " + node.getName() + " at top of recent spaces list.");
+      
+      // insert our Node at the top of the list so it's most relevent
+      this.recentSpaces.add(0, node);
+   }
+   
+   /**
+    * @return the max number of recent spaces to show, retrieved from client config
+    */
+   private int getMaxRecentSpaces()
+   {
+      if (maxRecentSpaces == null)
+      {
+         ClientConfigElement config = (ClientConfigElement)this.configService.getGlobalConfig().getConfigElement(
+               ClientConfigElement.CONFIG_ELEMENT_ID);
+         maxRecentSpaces = Integer.valueOf(config.getRecentSpacesItems());
+      }
+      
+      return maxRecentSpaces.intValue();
+   }
+}