org.opencms.workplace.explorer.menu
Class CmsMirMultiStandard

java.lang.Object
  org.opencms.workplace.explorer.menu.A_CmsMenuItemRule
      org.opencms.workplace.explorer.menu.CmsMirMultiStandard

All Implemented Interfaces:

I_CmsMenuItemRule

public class CmsMirMultiStandard
extends A_CmsMenuItemRule

Defines a menu item rule for the multi context menu that sets the visibility to active in the offline projects and to inactive in the online project.

Since:

6.5.6

Field Summary

static java.lang.String

RULE_NAME The name of the standard rule set used for multi context menu entries.

Fields inherited from interface org.opencms.workplace.explorer.menu.I_CmsMenuItemRule

ATTR_CONTEXT_INFO, CONTEXT_CONTAINERPAGE, CONTEXT_EDITPROVIDER, CONTEXT_SITEMAP

Constructor Summary

CmsMirMultiStandard()

Method Summary

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

Methods inherited from class org.opencms.workplace.explorer.menu.A_CmsMenuItemRule

getVisibility, getVisibility

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RULE_NAME

public static final java.lang.String RULE_NAME

The name of the standard rule set used for multi context menu entries.

See Also:

Constant Field Values

Constructor Detail

CmsMirMultiStandard

public CmsMirMultiStandard()

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:

• CmsMenuItemVisibilityMode.VISIBILITY_ACTIVE menu item is active
• CmsMenuItemVisibilityMode.VISIBILITY_INACTIVE menu item is inactive (greyed out)
• CmsMenuItemVisibilityMode.VISIBILITY_INVISIBLE menu item is invisible

Specified by:

getVisibility in interface I_CmsMenuItemRule

Overrides:

getVisibility in class A_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, CmsResourceUtil[])

matches

public boolean matches(CmsObject cms,
                       CmsResourceUtil[] resourceUtil)

Description copied from interface: I_CmsMenuItemRule

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

See Also:

I_CmsMenuItemRule.matches(org.opencms.file.CmsObject, CmsResourceUtil[])