org.opencms.workplace.explorer
Class CmsExplorerContextMenu

java.lang.Object
  extended byorg.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. The sort order is specified in an attribute of the context menu subnodes in the OpenCms configuration.

Since:
6.0.0
Version:
$Revision: 1.12 $
Author:
Andreas Zahner

Constructor Summary
CmsExplorerContextMenu()
          Default constructor.
 
Method Summary
 void addEntries(java.util.List entries)
          Adds a list of CmsContextMenuItem objects to the context menu list.
 java.lang.Object clone()
           
 java.util.List getAllEntries()
          Returns all entries of the context menu.
 java.lang.String getJSEntries(CmsObject cms, CmsExplorerTypeSettings settings, int resTypeId, java.util.Locale locale)
          Builds the Javascript to create the context menu.
 boolean isEmpty()
          Tests if the context menu is empty.
 void setAllEntries(java.util.List entries)
          Sets all entries of the context menu.
 void sortEntries()
          Sorts the list of entries according to the value of the "order" attribute in the configuration.
 
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

addEntries

public void addEntries(java.util.List 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()
See Also:
Object.clone()

getAllEntries

public java.util.List getAllEntries()
Returns all entries of the context menu.

Returns:
all entries of the context menu

getJSEntries

public java.lang.String getJSEntries(CmsObject cms,
                                     CmsExplorerTypeSettings settings,
                                     int resTypeId,
                                     java.util.Locale locale)
Builds the Javascript to create the context menu.

Parameters:
cms - the CmsObject
settings - the explorer type settings for which the context menu is created
resTypeId - the id of the resource type which uses the context menu
locale - the locale to generate the context menu for
Returns:
the JavaScript output to create the context menu

isEmpty

public boolean isEmpty()
Tests if the context menu is empty.

Returns:
true or false

setAllEntries

public void setAllEntries(java.util.List entries)
Sets all entries of the context menu.

The list is sorted by their order after that operation.

Parameters:
entries - all entries of the context menu

sortEntries

public void sortEntries()
Sorts the list of entries according to the value of the "order" attribute in the configuration.