org.opencms.ui.contextmenu

Class CmsContextMenuItemProviderGroup

java.lang.Object

org.opencms.ui.contextmenu.CmsContextMenuItemProviderGroup

All Implemented Interfaces:

I_CmsContextMenuItemProvider

public class CmsContextMenuItemProviderGroup
extends java.lang.Object
implements I_CmsContextMenuItemProvider

Class used to manage multiple context menu item providers through a single instance.

Also keeps track of available menu entries by their global id.

Constructor Summary

Constructors

Constructor and Description
CmsContextMenuItemProviderGroup() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addProvider(java.lang.Class<? extends I_CmsContextMenuItemProvider> providerClass) Adds a new provider class.
void	addProvider(I_CmsContextMenuItemProvider instance) Adds a provider.
java.util.List<I_CmsContextMenuItem>	getMenuItems() Gets a list of available context menu items.
void	initialize() Initializes this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsContextMenuItemProviderGroup

public CmsContextMenuItemProviderGroup()

Creates a new instance.

Method Detail

addProvider

public void addProvider(java.lang.Class<? extends I_CmsContextMenuItemProvider> providerClass)

Adds a new provider class.

Parameters:

providerClass - the provider class

addProvider

public void addProvider(I_CmsContextMenuItemProvider instance)

Adds a provider.

Note that no two providers of the same exact class may be added.

Parameters:

instance - the provider instance to add

getMenuItems

public java.util.List<I_CmsContextMenuItem> getMenuItems()

Description copied from interface: I_CmsContextMenuItemProvider

Gets a list of available context menu items.

Specified by:

getMenuItems in interface I_CmsContextMenuItemProvider

Returns:

the available context menu items

See Also:

I_CmsContextMenuItemProvider.getMenuItems()

initialize

public void initialize()

Initializes this instance.

This must be called after the provider classes have been added.