org.opencms.workplace.explorer.menu
Class A_CmsMenuItemRule

java.lang.Object
  extended by org.opencms.workplace.explorer.menu.A_CmsMenuItemRule
All Implemented Interfaces:
I_CmsMenuItemRule
Direct Known Subclasses:
CmsMirActiveNonDeleted, CmsMirAlwaysActive, CmsMirAlwaysInvisible, CmsMirDirectPublish, CmsMirEditControlcode, CmsMirMultiDirPublishStandard, CmsMirMultiStandard, CmsMirPrOnlineActive, CmsMirPrOnlineInactive, CmsMirPrOnlineInvisible, CmsMirPrOtherActive, CmsMirPrOtherInactive, CmsMirPrOtherInvisible, CmsMirPrSameLockedActive, CmsMirPrSameLockedActiveChangedAl, CmsMirPrSameLockedActiveDeletedAl, CmsMirPrSameLockedActiveNotDeletedAl, CmsMirPrSameLockedActiveNotDeletedAlPermW, CmsMirPrSameLockedInactiveMovedAl, CmsMirPrSameLockedInvisible, CmsMirPrSameOtherlockActive, CmsMirPrSameOtherlockActiveNoPublish, CmsMirPrSameOtherlockInvisible, CmsMirPrSameUnlockedActive, CmsMirPrSameUnlockedActiveDeletedNoAl, CmsMirPrSameUnlockedActiveNotDeletedNoAl, CmsMirPrSameUnlockedActiveUnchanged, CmsMirPrSameUnlockedInactiveNoAl, CmsMirPrSameUnlockedInactiveNotDeletedNoAl, CmsMirPrSameUnlockedInvisible, CmsMirShowSiblings, CmsMirSubStandard

public abstract class A_CmsMenuItemRule
extends java.lang.Object
implements I_CmsMenuItemRule

Base implementation of the menu item rule.

This was introduced because of the possible sub-menus. Most rules are not sub-menu aware, therefore they do not need to implement getVisibility(CmsObject, CmsResourceUtil[], I_CmsMenuItemRule[]). This default base implementation just calls the standard visibility method discarding the additional rules.

Since:
6.7.2
Version:
$Revision: 1.7 $
Author:
Andreas Zahner

Constructor Summary
A_CmsMenuItemRule()
           
 
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.opencms.workplace.explorer.menu.I_CmsMenuItemRule
matches
 

Constructor Detail

A_CmsMenuItemRule

public A_CmsMenuItemRule()
Method Detail

getVisibility

public CmsMenuItemVisibilityMode getVisibility(CmsObject cms,
                                               CmsResourceUtil[] resourceUtil)
Description copied from interface: I_CmsMenuItemRule
Returns the visibility for the menu item.

The possible visibilities are:

Specified by:
getVisibility in interface I_CmsMenuItemRule
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
See Also:
I_CmsMenuItemRule.getVisibility(org.opencms.file.CmsObject, org.opencms.workplace.explorer.CmsResourceUtil[])

getVisibility

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

Specified by:
getVisibility in interface I_CmsMenuItemRule
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
See Also:
I_CmsMenuItemRule.getVisibility(org.opencms.file.CmsObject, org.opencms.workplace.explorer.CmsResourceUtil[], org.opencms.workplace.explorer.menu.I_CmsMenuItemRule[])