org.opencms.workplace.explorer.menu
Interface I_CmsMenuItemRule

All Known Implementing Classes:
A_CmsMenuItemRule, CmsMirActiveNonDeleted, CmsMirAlwaysActive, CmsMirAlwaysInvisible, CmsMirDirectPublish, CmsMirEditControlcode, CmsMirMultiStandard, CmsMirPrOnlineActive, CmsMirPrOnlineInactive, CmsMirPrOnlineInvisible, CmsMirPrOtherActive, CmsMirPrOtherInactive, CmsMirPrOtherInvisible, CmsMirPrSameLockedActive, CmsMirPrSameLockedActiveChangedAl, CmsMirPrSameLockedActiveDeletedAl, CmsMirPrSameLockedActiveNotDeletedAl, CmsMirPrSameLockedInvisible, CmsMirPrSameOtherlockActive, CmsMirPrSameOtherlockActiveNoPublish, CmsMirPrSameOtherlockInvisible, CmsMirPrSameUnlockedActive, CmsMirPrSameUnlockedActiveDeletedNoAl, CmsMirPrSameUnlockedActiveNotDeletedNoAl, CmsMirPrSameUnlockedActiveUnchanged, CmsMirPrSameUnlockedInactiveNoAl, CmsMirPrSameUnlockedInactiveNotDeletedNoAl, CmsMirPrSameUnlockedInvisible, CmsMirShowSiblings, CmsMirSubStandard

public interface I_CmsMenuItemRule

Defines a menu item rule to check the visibility of a context menu item in the explorer view.

Since:
6.5.6
Version:
$Revision: 1.2 $
Author:
Andreas Zahner

Method Summary
 CmsMenuItemVisibilityMode getVisibility(CmsObject cms, CmsResourceUtil[] resourceUtil)
          Returns the visibility for the menu item.
 CmsMenuItemVisibilityMode getVisibility(CmsObject cms, CmsResourceUtil[] resourceUtil, I_CmsMenuItemRule[] rule)
          Returns the visibility for the menu item, depending on the resource utilities and menu item rules.
 boolean matches(CmsObject cms, CmsResourceUtil[] resourceUtil)
          Returns if the rule for the menu item should be applied or not.
 

Method Detail

getVisibility

CmsMenuItemVisibilityMode getVisibility(CmsObject cms,
                                        CmsResourceUtil[] resourceUtil)
Returns the visibility for the menu item.

The possible visibilities are:

Parameters:
cms - the current OpenCms user context
resourceUtil - the initialized resource utilities for which the menu item visibility is checked
Returns:
the visibility of the menu item

getVisibility

CmsMenuItemVisibilityMode getVisibility(CmsObject cms,
                                        CmsResourceUtil[] resourceUtil,
                                        I_CmsMenuItemRule[] rule)
Returns the visibility for the menu item, depending on the resource utilities and menu item rules.

Parameters:
cms - the current OpenCms user context
resourceUtil - the initialized resource utilities for which the menu item visibility is checked
rule - the rules which are checked for visibility
Returns:
the visibility for the menu item

matches

boolean matches(CmsObject cms,
                CmsResourceUtil[] resourceUtil)
Returns if the rule for the menu item should be applied or not.

Parameters:
cms - the current OpenCms user context
resourceUtil - the initialized resource utilities for which the menu item rule is checked
Returns:
true if the rule for the menu item should be applied, otherwise false