|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.workplace.explorer.CmsExplorerContextMenu
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.
Constructor Summary | |
CmsExplorerContextMenu()
Default constructor. |
Method Summary | |
void |
addEntries(java.util.List entries)
Adds a list of CmsContextMenuItem objects to the context menu list. |
void |
addEntry(CmsExplorerContextMenuItem entry)
Adds a single CmsContextMenuItem object to the context menu list. |
void |
addMenuEntry(java.lang.String key,
java.lang.String uri,
java.lang.String rules,
java.lang.String target,
java.lang.String order)
Adds a single context menu entry to the list of context menu items. |
void |
addMenuSeparator(java.lang.String order)
Adds a menu separator to the list of context menu items. |
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,
CmsMessages messages)
Builds the Javascript to create 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 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. |
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 |
public CmsExplorerContextMenu()
Method Detail |
public void addEntries(java.util.List entries)
The list is sorted by their order after that operation.
entries
- a list of initialized context menu itemspublic void addEntry(CmsExplorerContextMenuItem entry)
The list is sorted by their order after that operation.
entry
- a single context menu itempublic void addMenuEntry(java.lang.String key, java.lang.String uri, java.lang.String rules, java.lang.String target, java.lang.String order)
key
- the key of the current entryuri
- the dialog URI to call with the current entryrules
- the display rulestarget
- the frame target of the menu entryorder
- the sort order of the current entrypublic void addMenuSeparator(java.lang.String order)
order
- the sort order of the separatorpublic java.lang.Object clone()
Object.clone()
public java.util.List getAllEntries()
public java.lang.String getJSEntries(CmsObject cms, CmsExplorerTypeSettings settings, int resTypeId, CmsMessages messages)
cms
- the CmsObjectsettings
- the explorer type settings for which the context menu is createdresTypeId
- the id of the resource type which uses the context menumessages
- the messages to generate the context menu with (should be the workplace messages)
public boolean isEmpty()
public boolean isMultiMenu()
public void setAllEntries(java.util.List entries)
The list is sorted by their order after that operation.
entries
- all entries of the context menupublic void setMultiMenu(boolean multiMenu)
multiMenu
- true, if the menu is a multi context menu for more than one selected file, otherwise falsepublic void sortEntries()
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |