org.opencms.workplace.explorer
Class CmsExplorerContextMenu

java.lang.Object
  org.opencms.workplace.explorer.CmsExplorerContextMenu

public class CmsExplorerContextMenu
extends java.lang.Object

Provides methods to build a context menu for an explorer resource type.

This object stores all entries which are displayed in a context menu in a sorted list.

Since:

6.0.0

Constructor Summary

CmsExplorerContextMenu()
Default constructor.

Method Summary

void	addContextMenuEntry(CmsExplorerContextMenuItem item) Adds a menu entry to the list of context menu items.
void	addContextMenuSeparator(CmsExplorerContextMenuItem item) Adds a menu separator to the list of context menu items.
void	addEntries(java.util.List<CmsExplorerContextMenuItem> entries) Adds a list of CmsContextMenuItem objects to the context menu list.
java.lang.Object	clone()
java.util.List<CmsExplorerContextMenuItem>	getAllEntries() Returns all entries of the context menu.
boolean	isEmpty() Tests if the context menu is empty.
boolean	isMultiMenu() Returns true if the menu is a multi context menu for more than one selected file.
void	setAllEntries(java.util.List<CmsExplorerContextMenuItem> entries) Sets all entries of the context menu.
void	setMultiMenu(boolean multiMenu) Sets if the menu is a multi context menu for more than one selected file.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsExplorerContextMenu

public CmsExplorerContextMenu()

Default constructor.

Method Detail

addContextMenuEntry

public void addContextMenuEntry(CmsExplorerContextMenuItem item)

Adds a menu entry to the list of context menu items.

Parameters:

item - the entry item to add to the list

addContextMenuSeparator

public void addContextMenuSeparator(CmsExplorerContextMenuItem item)

Adds a menu separator to the list of context menu items.

Parameters:

item - the separator item to add to the list

addEntries

public void addEntries(java.util.List<CmsExplorerContextMenuItem> entries)

Adds a list of CmsContextMenuItem objects to the context menu list.

The list is sorted by their order after that operation.

Parameters:

entries - a list of initialized context menu items

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

See Also:

Object.clone()

getAllEntries

public java.util.List<CmsExplorerContextMenuItem> getAllEntries()

Returns all entries of the context menu.

Returns:

all entries of the context menu

isEmpty

public boolean isEmpty()

Tests if the context menu is empty.

Returns:

true or false

isMultiMenu

public boolean isMultiMenu()

Returns true if the menu is a multi context menu for more than one selected file.

Returns:

if the menu is a multi context menu for more than one selected file

setAllEntries

public void setAllEntries(java.util.List<CmsExplorerContextMenuItem> entries)

Sets all entries of the context menu.

Parameters:

entries - all entries of the context menu

setMultiMenu

public void setMultiMenu(boolean multiMenu)

Sets if the menu is a multi context menu for more than one selected file.

Parameters:

multiMenu - true, if the menu is a multi context menu for more than one selected file, otherwise false