View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.jetspeed.portalsite.menu;
18  
19  import org.apache.jetspeed.portalsite.view.SiteView;
20  
21  /***
22   * This class provides a menu definition for the standard
23   * breadcrumbs menu.
24   * 
25   * @author <a href="mailto:rwatler@apache.org">Randy Watler</a>
26   * @version $Id: StandardBreadcrumbsMenuDefinition.java 517121 2007-03-12 07:45:49Z ate $
27   */
28  public class StandardBreadcrumbsMenuDefinition extends StandardBackMenuDefinition
29  {
30      /***
31       * StandardBreadcrumbsMenuDefinition - constructor
32       */
33      public StandardBreadcrumbsMenuDefinition()
34      {
35          super();
36      }
37  
38      /***
39       * getName - get menu name
40       *
41       * @return menu name
42       */
43      public String getName()
44      {
45          return SiteView.STANDARD_BREADCRUMBS_MENU_NAME;
46      }
47  
48      /***
49       * getOptions - get comma separated menu options if not specified as elements
50       *
51       * @return option paths specification
52       */
53      public String getOptions()
54      {
55          // current page
56          return SiteView.CURRENT_PAGE_PATH;
57      }
58  
59      /***
60       * isPaths - get generate ordered path options for specified options
61       *
62       * @return paths options flag
63       */
64      public boolean isPaths()
65      {
66          return true;
67      }
68      
69      /***
70       * getTitleResourceKey - get resource key used to lookup menu titles
71       *
72       * @return resource key
73       */
74      protected String getTitleResourceKey()
75      {
76          return "menu.title.breadcrumbs";
77      }
78  }