de.xima.fc.plugin.interfaces.backend

Interface IPluginMenuEntries

All Superinterfaces:

IFCPlugin, INamedUiElement, INameProviding, ITransferable, Serializable

public interface IPluginMenuEntries
extends IFCPlugin

Plugin for adding custom menu entries to the backend UI of FORMCYCLE. The menu entries will appear in the main menu to the left. For example, you can use this to add a link to an external page, or use this together with a portal plugin to add a custom page within FORMCYCLE.

Author:

XIMA MEDIA GmbH

Field Summary

Fields inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

CONFIG_FILENAME

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding

ATTR_NAME, COL_NAME

Fields inherited from interface de.xima.fc.interfaces.INamedUiElement

ATTR_DISPLAY_NAME

Method Summary

Modifier and Type	Method and Description
Collection<IPluginMenuEntry>	getMenuEntries(IPluginMenuEntriesParams params) This method should return the menu entries to be added to FORMCYCLE.

Methods inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

getDescription, getDescription, getDisplayName, getName, initialize, initPlugin, install, shutdown, shutdown, uninstall

Method Detail

getMenuEntries

Collection<IPluginMenuEntry> getMenuEntries(IPluginMenuEntriesParams params)

This method should return the menu entries to be added to FORMCYCLE. Note that a menu entry may have children which are shown as a submenu. In that case, you should return only the parent entries.

Parameters:

params - IPluginMenuEntriesParams Parameters this plugin may make use of, such as the current client and user.

Returns:

Collection of IPluginMenuEntrys The list of top-level (parent) menu entries to be added to FORMCYCLE.