org.opencms.workplace.explorer.menu
Class CmsMenuRule

java.lang.Object
  extended byorg.opencms.workplace.explorer.menu.CmsMenuRule

public class CmsMenuRule
extends java.lang.Object

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

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

Constructor Summary
CmsMenuRule()
          Constructor without parameters, needed for initialization from OpenCms configuration.
 
Method Summary
 void addMenuItemRule(I_CmsMenuItemRule menuItemRule)
          Adds a single menu item rule to the list of rules.
 void addMenuItemRuleName(java.lang.String className)
          Adds a single menu item rule to the list of rules.
 void freeze()
          Freezes the name and the items of the menu rule set.
 I_CmsMenuItemRule getMatchingRule(CmsObject cms, CmsResourceUtil[] resourceUtil)
          Returns the first matching rule for the resource to create the context menu for.
 java.util.List getMenuItemRules()
          Returns the menu item rules class instances.
 java.lang.String getName()
          Returns the name of the menu rule set.
 boolean isFrozen()
          Returns true if this menu rule set is frozen, that is read only.
 void setMenuItemRules(java.util.List menuItemRules)
          Sets the menu item rules class instances.
 void setName(java.lang.String name)
          Sets the name of the menu rule set.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CmsMenuRule

public CmsMenuRule()
Constructor without parameters, needed for initialization from OpenCms configuration.

Method Detail

addMenuItemRule

public void addMenuItemRule(I_CmsMenuItemRule menuItemRule)
Adds a single menu item rule to the list of rules.

Parameters:
menuItemRule - the menu item rule to add

addMenuItemRuleName

public void addMenuItemRuleName(java.lang.String className)
Adds a single menu item rule to the list of rules.

Parameters:
className - the class name of the menu item rule to add

freeze

public void freeze()
Freezes the name and the items of the menu rule set.

They can not be modified anymore after calling this method.


getMatchingRule

public I_CmsMenuItemRule getMatchingRule(CmsObject cms,
                                         CmsResourceUtil[] resourceUtil)
Returns the first matching rule for the resource to create the context menu for.

Parameters:
cms - the current OpenCms user context
resourceUtil - the initialized resource utilities of the resource
Returns:
the first matching rule for the resource

getMenuItemRules

public java.util.List getMenuItemRules()
Returns the menu item rules class instances.

Returns:
the menu item rules class instances

getName

public java.lang.String getName()
Returns the name of the menu rule set.

Returns:
the name of the menu rule set

isFrozen

public boolean isFrozen()
Returns true if this menu rule set is frozen, that is read only.

Returns:
true if this menu rule set is frozen, that is read only

setMenuItemRules

public void setMenuItemRules(java.util.List menuItemRules)
Sets the menu item rules class instances.

Parameters:
menuItemRules - the menu item rules class instances

setName

public void setName(java.lang.String name)
Sets the name of the menu rule set.

Parameters:
name - the name of the menu rule set