01: /*
02: * File : $Source: /usr/local/cvs/opencms/src/org/opencms/workplace/explorer/menu/I_CmsMenuItemRule.java,v $
03: * Date : $Date: 2008-02-27 12:05:22 $
04: * Version: $Revision: 1.4 $
05: *
06: * This library is part of OpenCms -
07: * the Open Source Content Management System
08: *
09: * Copyright (c) 2002 - 2008 Alkacon Software GmbH (http://www.alkacon.com)
10: *
11: * This library is free software; you can redistribute it and/or
12: * modify it under the terms of the GNU Lesser General Public
13: * License as published by the Free Software Foundation; either
14: * version 2.1 of the License, or (at your option) any later version.
15: *
16: * This library is distributed in the hope that it will be useful,
17: * but WITHOUT ANY WARRANTY; without even the implied warranty of
18: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19: * Lesser General Public License for more details.
20: *
21: * For further information about Alkacon Software GmbH, please see the
22: * company website: http://www.alkacon.com
23: *
24: * For further information about OpenCms, please see the
25: * project website: http://www.opencms.org
26: *
27: * You should have received a copy of the GNU Lesser General Public
28: * License along with this library; if not, write to the Free Software
29: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30: */
31:
32: package org.opencms.workplace.explorer.menu;
33:
34: import org.opencms.file.CmsObject;
35: import org.opencms.workplace.explorer.CmsResourceUtil;
36:
37: /**
38: * Defines a menu item rule to check the visibility of a context menu item in the explorer view.<p>
39: *
40: * @author Andreas Zahner
41: *
42: * @version $Revision: 1.4 $
43: *
44: * @since 6.5.6
45: */
46: public interface I_CmsMenuItemRule {
47:
48: /**
49: * Returns the visibility for the menu item.<p>
50: *
51: * The possible visibilities are:
52: * <ul>
53: * <li>{@link CmsMenuItemVisibilityMode#VISIBILITY_ACTIVE} menu item is active</li>
54: * <li>{@link CmsMenuItemVisibilityMode#VISIBILITY_INACTIVE} menu item is inactive (greyed out)</li>
55: * <li>{@link CmsMenuItemVisibilityMode#VISIBILITY_INVISIBLE} menu item is invisible</li>
56: * </ul>
57: *
58: * @param cms the current OpenCms user context
59: * @param resourceUtil the initialized resource utilities for which the menu item visibility is checked
60: * @return the visibility of the menu item
61: */
62: CmsMenuItemVisibilityMode getVisibility(CmsObject cms,
63: CmsResourceUtil[] resourceUtil);
64:
65: /**
66: * Returns the visibility for the menu item, depending on the resource utilities and menu item rules.<p>
67: *
68: * @param cms the current OpenCms user context
69: * @param resourceUtil the initialized resource utilities for which the menu item visibility is checked
70: * @param rule the rules which are checked for visibility
71: * @return the visibility for the menu item
72: */
73: CmsMenuItemVisibilityMode getVisibility(CmsObject cms,
74: CmsResourceUtil[] resourceUtil, I_CmsMenuItemRule[] rule);
75:
76: /**
77: * Returns if the rule for the menu item should be applied or not.<p>
78: *
79: * @param cms the current OpenCms user context
80: * @param resourceUtil the initialized resource utilities for which the menu item rule is checked
81: * @return true if the rule for the menu item should be applied, otherwise false
82: */
83: boolean matches(CmsObject cms, CmsResourceUtil[] resourceUtil);
84:
85: }
|