|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.workplace.explorer.CmsExplorerContextMenuItem
public class CmsExplorerContextMenuItem
Provides information about a single context menu item for a resource type in the OpenCms explorer view.
An item can be a context menu entry or a separator line.
Field Summary | |
---|---|
static java.lang.String |
TYPE_ENTRY
The name for an entry type. |
static java.lang.String |
TYPE_SEPARATOR
The name for a separator type. |
Constructor Summary | |
---|---|
CmsExplorerContextMenuItem()
Empty constructor that creates a single context menu entry. |
Method Summary | |
---|---|
void |
addContextMenuEntry(CmsExplorerContextMenuItem item)
Adds a menu sub entry to this context menu item. |
void |
addContextMenuSeparator(CmsExplorerContextMenuItem item)
Adds a menu separator to this context menu item. |
protected void |
addSubItem(CmsExplorerContextMenuItem item,
java.lang.String type)
Adds a sub item entry to this context menu item. |
java.lang.String |
getKey()
Returns the key for localization. |
CmsExplorerContextMenuItem |
getParent()
Returns the parent context menu entry item of a sub menu item. |
java.lang.String |
getRule()
Returns the name of the menu rule set. |
java.lang.String |
getRules()
Returns the set of display rules. |
java.util.List |
getSubItems()
Returns the sub item entries of this context menu item. |
java.lang.String |
getTarget()
Returns the frame target of the current item. |
java.lang.String |
getType()
Returns the type of the current item. |
java.lang.String |
getUri()
Returns the dialog URI of the current item. |
boolean |
isParentItem()
Returns if the item is a main item with configured sub items. |
boolean |
isSubItem()
Returns if the item is a sub item. |
void |
setKey(java.lang.String key)
Sets the key for localization. |
protected void |
setParent(CmsExplorerContextMenuItem parent)
Sets the parent context menu item for sub menu items. |
void |
setRule(java.lang.String rule)
Sets the name of the menu rule set. |
void |
setRules(java.lang.String rules)
Sets the set of display rules. |
void |
setTarget(java.lang.String target)
Sets the frame target of the current item. |
void |
setType(java.lang.String type)
Sets the type of the current item. |
void |
setUri(java.lang.String uri)
Sets the dialog URI of the current item. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String TYPE_ENTRY
public static final java.lang.String TYPE_SEPARATOR
Constructor Detail |
---|
public CmsExplorerContextMenuItem()
Method Detail |
---|
public void addContextMenuEntry(CmsExplorerContextMenuItem item)
item
- the entry item to add to this context menu itempublic void addContextMenuSeparator(CmsExplorerContextMenuItem item)
item
- the separator item to add to this context menu itempublic java.lang.String getKey()
public CmsExplorerContextMenuItem getParent()
public java.lang.String getRule()
public java.lang.String getRules()
public java.util.List getSubItems()
public java.lang.String getTarget()
public java.lang.String getType()
public java.lang.String getUri()
public boolean isParentItem()
public boolean isSubItem()
public void setKey(java.lang.String key)
key
- the key for localizationpublic void setRule(java.lang.String rule)
rule
- the name of the menu rule setpublic void setRules(java.lang.String rules)
rules
- the set of display rulespublic void setTarget(java.lang.String target)
target
- the frame target of the current itempublic void setType(java.lang.String type)
type
- the type of the current itempublic void setUri(java.lang.String uri)
uri
- the dialog URI of the current itemprotected void addSubItem(CmsExplorerContextMenuItem item, java.lang.String type)
item
- the item to add to this context menu itemtype
- the item type to addprotected void setParent(CmsExplorerContextMenuItem parent)
parent
- the parent context menu item
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |