|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.workplace.explorer.menu.CmsMenuRule
Defines a named menu rule set to check the visibility of a single context menu item in the explorer view.
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 |
public CmsMenuRule()
Method Detail |
public void addMenuItemRule(I_CmsMenuItemRule menuItemRule)
menuItemRule
- the menu item rule to addpublic void addMenuItemRuleName(java.lang.String className)
className
- the class name of the menu item rule to addpublic void freeze()
They can not be modified anymore after calling this method.
public I_CmsMenuItemRule getMatchingRule(CmsObject cms, CmsResourceUtil[] resourceUtil)
cms
- the current OpenCms user contextresourceUtil
- the initialized resource utilities of the resource
public java.util.List getMenuItemRules()
public java.lang.String getName()
public boolean isFrozen()
true
if this menu rule set is frozen, that is read only.
true
if this menu rule set is frozen, that is read onlypublic void setMenuItemRules(java.util.List menuItemRules)
menuItemRules
- the menu item rules class instancespublic void setName(java.lang.String name)
name
- the name of the menu rule set
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |