org.opencms.workplace.explorer.menu

类 CmsMenuRule

java.lang.Object

org.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.

从以下版本开始:

6.5.6

构造器概要

构造器

构造器和说明
CmsMenuRule() Constructor without parameters, needed for initialization from OpenCms configuration.

方法概要

方法

限定符和类型	方法和说明
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<I_CmsMenuItemRule>	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<I_CmsMenuItemRule> menuItemRules) Sets the menu item rules class instances.
void	setName(java.lang.String name) Sets the name of the menu rule set.

从类继承的方法 java.lang.Object

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

构造器详细资料

CmsMenuRule

public CmsMenuRule()

Constructor without parameters, needed for initialization from OpenCms configuration.

方法详细资料

addMenuItemRule

public void addMenuItemRule(I_CmsMenuItemRule menuItemRule)

Adds a single menu item rule to the list of rules.

参数:

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.

参数:

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.

参数:

cms - the current OpenCms user context

resourceUtil - the initialized resource utilities of the resource

返回:

the first matching rule for the resource

getMenuItemRules

public java.util.List<I_CmsMenuItemRule> getMenuItemRules()

Returns the menu item rules class instances.

返回:

the menu item rules class instances

getName

public java.lang.String getName()

Returns the name of the menu rule set.

返回:

the name of the menu rule set

isFrozen

public boolean isFrozen()

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

返回:

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

setMenuItemRules

public void setMenuItemRules(java.util.List<I_CmsMenuItemRule> menuItemRules)

Sets the menu item rules class instances.

参数:

menuItemRules - the menu item rules class instances

setName

public void setName(java.lang.String name)

Sets the name of the menu rule set.

参数:

name - the name of the menu rule set