Interface IPluginProjectMenu

All Superinterfaces:

IFCPlugin, INamedUiElement, INameProviding, IPluginGenericCustomGUI<IPluginProjectMenuGUIBean>, ITransferable, Serializable

public interface IPluginProjectMenu
extends IFCPlugin, IPluginGenericCustomGUI<IPluginProjectMenuGUIBean>

Plugin interface for providing custom menus for projects with a specified scope

Author:

XIMA MEDIA GmbH, Dresden - 13.07.2020

Field Summary

Fields inherited from interface IFCPlugin

CONFIG_FILENAME

Fields inherited from interface INamedUiElement

ATTR_DISPLAY_NAME

Fields inherited from interface INameProviding

ATTR_NAME, COL_NAME

Method Summary

Modifier and Type	Method	Description
default URL	getDialogsXhtmlView()	Returns a path to an XHTML view specifically for custom dialogs that me be part of the custom project menu.
String	getProjectScope()	All Projekts with the scope (Projekt.getScope()) given by this method will have the custom menu provided by IPluginGenericCustomGUI.getXhtmlView().

Methods inherited from interface IFCPlugin

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

Methods inherited from interface IPluginGenericCustomGUI

getUnmanagedBeans, getXhtmlView

Method Details

getProjectScope

String getProjectScope()

All Projekts with the scope (Projekt.getScope()) given by this method will have the custom menu provided by IPluginGenericCustomGUI.getXhtmlView().

Returns:

String the project scope

getDialogsXhtmlView

default URL getDialogsXhtmlView()

Returns a path to an XHTML view specifically for custom dialogs that me be part of the custom project menu. The view usually resides within the JAR.

Returns:

URL to the dialog XHTML view or null if no dialog view is provided.