CmsExplorerContextMenuItem

java.lang.Object
- org.opencms.workplace.explorer.CmsExplorerContextMenuItem

```
public class CmsExplorerContextMenuItem
extends java.lang.Object
```
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.

从以下版本开始:

6.0.0

字段概要

字段
限定符和类型字段和说明

static java.lang.String TYPE_ENTRY
The name for an entry type.

static java.lang.String TYPE_SEPARATOR
The name for a separator type.

字段
限定符和类型	字段和说明
`static java.lang.String`	`TYPE_ENTRY` The name for an entry type.
`static java.lang.String`	`TYPE_SEPARATOR` The name for a separator type.

构造器概要

构造器
构造器和说明

CmsExplorerContextMenuItem()
Empty constructor that creates a single context menu entry.

构造器
构造器和说明
`CmsExplorerContextMenuItem()` Empty constructor that creates a single context menu entry.

方法概要

方法
限定符和类型	方法和说明
`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`	`getIcon()` Returns the icon.
`java.lang.String`	`getKey()` Returns the key for localization.
`java.lang.String`	`getName()` Returns the name.
`java.lang.String`	`getParams()` Gets the parameters for the context menu command.
`java.util.Map<java.lang.String,java.lang.String>`	`getParamsMap()` Gets the parameters as a map of strings.
`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<CmsExplorerContextMenuItem>`	`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`	`setIcon(java.lang.String iconPath)` Sets the icon path.
`void`	`setKey(java.lang.String key)` Sets the key for localization.
`void`	`setName(java.lang.String name)` Sets the name.
`void`	`setParams(java.lang.String params)` Sets the parameter string for the context menu command.
`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.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - TYPE_ENTRY
```
public static final java.lang.String TYPE_ENTRY
```
    The name for an entry type.
    
    另请参阅:
    常量字段值
  - TYPE_SEPARATOR
```
public static final java.lang.String TYPE_SEPARATOR
```
    The name for a separator type.
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - CmsExplorerContextMenuItem
```
public CmsExplorerContextMenuItem()
```
    Empty constructor that creates a single context menu entry.
- 方法详细资料
  - addContextMenuEntry
```
public void addContextMenuEntry(CmsExplorerContextMenuItem item)
```
    Adds a menu sub entry to this context menu item.
    
    参数:
    item - the entry item to add to this context menu item
  - addContextMenuSeparator
```
public void addContextMenuSeparator(CmsExplorerContextMenuItem item)
```
    Adds a menu separator to this context menu item.
    
    参数:
    item - the separator item to add to this context menu item
  - getIcon
```
public java.lang.String getIcon()
```
    Returns the icon.
    
    返回:
    the icon
  - getKey
```
public java.lang.String getKey()
```
    Returns the key for localization.
    
    返回:
    the key for localization
  - getName
```
public java.lang.String getName()
```
    Returns the name.
    
    返回:
    the name
  - getParams
```
public java.lang.String getParams()
```
    Gets the parameters for the context menu command.
    
    返回:
    the parameter string for the context menu command
  - getParamsMap
```
public java.util.Map<java.lang.String,java.lang.String> getParamsMap()
```
    Gets the parameters as a map of strings.
    
    返回:
    the parameters as a map of strings
  - getParent
```
public CmsExplorerContextMenuItem getParent()
```
    Returns the parent context menu entry item of a sub menu item.
    
    返回:
    the parent context menu entry item
  - getRule
```
public java.lang.String getRule()
```
    Returns the name of the menu rule set.
    
    返回:
    the name of the menu rule set
  - getRules
```
public java.lang.String getRules()
```
    Returns the set of display rules.
    
    返回:
    the set of display rules
  - getSubItems
```
public java.util.List<CmsExplorerContextMenuItem> getSubItems()
```
    Returns the sub item entries of this context menu item.
    
    返回:
    the sub item entries of this context menu item
  - getTarget
```
public java.lang.String getTarget()
```
    Returns the frame target of the current item.
    
    返回:
    the frame target of the current item
  - getType
```
public java.lang.String getType()
```
    Returns the type of the current item.
    
    返回:
    the type of the current item
  - getUri
```
public java.lang.String getUri()
```
    Returns the dialog URI of the current item.
    
    返回:
    the dialog URI of the current item
  - isParentItem
```
public boolean isParentItem()
```
    Returns if the item is a main item with configured sub items.
    
    返回:
    true if the item is a main entry item with configured sub items, otherwise false
  - isSubItem
```
public boolean isSubItem()
```
    Returns if the item is a sub item.
    
    返回:
    true if the item is a sub entry item, otherwise false
  - setIcon
```
public void setIcon(java.lang.String iconPath)
```
    Sets the icon path.
    
    参数:
    iconPath - the icon path for a menu entry
  - setKey
```
public void setKey(java.lang.String key)
```
    Sets the key for localization.
    
    参数:
    key - the key for localization
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name.
    
    参数:
    name - the name to set
  - setParams
```
public void setParams(java.lang.String params)
```
    Sets the parameter string for the context menu command.
    
    参数:
    params - the parameter string for the context menu command
  - setRule
```
public void setRule(java.lang.String rule)
```
    Sets the name of the menu rule set.
    
    参数:
    rule - the name of the menu rule set
  - setRules
```
public void setRules(java.lang.String rules)
```
    Sets the set of display rules.
    
    参数:
    rules - the set of display rules
  - setTarget
```
public void setTarget(java.lang.String target)
```
    Sets the frame target of the current item.
    
    参数:
    target - the frame target of the current item
  - setType
```
public void setType(java.lang.String type)
```
    Sets the type of the current item.
    
    参数:
    type - the type of the current item
  - setUri
```
public void setUri(java.lang.String uri)
```
    Sets the dialog URI of the current item.
    
    参数:
    uri - the dialog URI of the current item
  - addSubItem
```
protected void addSubItem(CmsExplorerContextMenuItem item,
              java.lang.String type)
```
    Adds a sub item entry to this context menu item.
    
    参数:
    item - the item to add to this context menu item
    type - the item type to add
  - setParent
```
protected void setParent(CmsExplorerContextMenuItem parent)
```
    Sets the parent context menu item for sub menu items.
    
    参数:
    parent - the parent context menu item

类 CmsExplorerContextMenuItem

字段概要

构造器概要

方法概要

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

字段详细资料

TYPE_ENTRY

TYPE_SEPARATOR

构造器详细资料

CmsExplorerContextMenuItem

方法详细资料

addContextMenuEntry

addContextMenuSeparator

getIcon

getKey

getName

getParams

getParamsMap

getParent

getRule

getRules

getSubItems

getTarget

getType

getUri

isParentItem

isSubItem

setIcon

setKey

setName

setParams

setRule

setRules

setTarget

setType

setUri

addSubItem

setParent