01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. The ASF licenses this file to You
04: * under the Apache License, Version 2.0 (the "License"); you may not
05: * use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License. For additional information regarding
15: * copyright in this work, please see the NOTICE file in the top level
16: * directory of this distribution.
17: */
18:
19: package org.apache.roller.ui.core.tags.menu;
20:
21: import javax.servlet.http.HttpServletRequest;
22:
23: import org.apache.roller.RollerException;
24:
25: /** An individual menu which contains MenuItems */
26: public interface Menu {
27:
28: /** Name of Menu */
29: public String getName();
30:
31: /** Collection of MenuItem objects contained in this menu */
32: public java.util.Vector getMenuItems();
33:
34: /** Determine if this menu is selected based on request */
35: public boolean isSelected(HttpServletRequest req)
36: throws RollerException;
37:
38: /** Get currently selected menu item in this menu */
39: public MenuItem getSelectedMenuItem(HttpServletRequest req)
40: throws RollerException;
41:
42: /** Url to be displayed in menu */
43: public String getUrl(javax.servlet.jsp.PageContext pctx);
44:
45: /** Is user principal permitted to use this menu? */
46: public boolean isPermitted(HttpServletRequest req)
47: throws RollerException;
48:
49: /** Set roles allowed to use this menu (comma separated list). */
50: public void setRoles(String roles);
51:
52: /** Name of true/false configuration property that enables this menu */
53: public void setEnabledProperty(String enabledProperty);
54:
55: /** Name of true/false configuration property that disables this menu */
56: public void setDisabledProperty(String disabledProperty);
57: }
|