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.om.folder.impl.StandardMenuDefinitionImpl;
20  
21  /***
22   * This class provides a menu definition for default menus
23   * constructed from folders within menus with depth expansion
24   * specified.
25   * 
26   * @author <a href="mailto:rwatler@apache.org">Randy Watler</a>
27   * @version $Id: DefaultMenuDefinition.java 516448 2007-03-09 16:25:47Z ate $
28   */
29  public class DefaultMenuDefinition extends StandardMenuDefinitionImpl
30  {
31      /***
32       * options - options path specification for menu
33       */
34      private String options;
35  
36      /***
37       * depth - inclusion depth for menu
38       */
39      private int depth;
40  
41      /***
42       * profile - profile locator for menu and its elements
43       */
44      private String profile;
45  
46      /***
47       * DefaultMenuDefinition - constructor
48       */
49      public DefaultMenuDefinition(String options, int depth, String locatorName)
50      {
51          super();
52          this.options = options;
53          this.depth = depth;
54          this.profile = locatorName;
55      }
56  
57      /***
58       * getOptions - get comma separated menu options if not specified as elements
59       *
60       * @return option paths specification
61       */
62      public String getOptions()
63      {
64          return options;
65      }
66  
67      /***
68       * getDepth - get depth of inclusion for folder menu options
69       *
70       * @return inclusion depth
71       */
72      public int getDepth()
73      {
74          return depth;
75      }
76  
77      /***
78       * getProfile - get profile locator used to filter specified options
79       *
80       * @return profile locator name
81       */
82      public String getProfile()
83      {
84          return profile;
85      }
86  }