de.xima.fc.plugin.config

Interface IDescriptionProvidingPlugin

All Superinterfaces:

IFCPlugin, INamedUiElement, INameProviding, ITransferable, Serializable

Deprecated.

Implement IFCPlugin instead and use IFCPlugin.getDescription(java.util.Locale).

@Deprecated
public interface IDescriptionProvidingPlugin
extends IFCPlugin

Interface for plugins that can provide a human readable description that is shown on the UI.

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
String	getDescription() Deprecated. use IFCPlugin.getDescription() Eine allgemeine Beschreibung zur Funktionsweise des Plugins, welche dem Nutzer in der FORMCYCLE Oberfläche angezeigt wird. Hinweis: Um eine Formtierung des Bescheibungstextes zu ermöglichen, kann der Text mit HTML-Tags versehen werden.

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

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

Method Detail

getDescription

@Deprecated
String getDescription()

Deprecated. use IFCPlugin.getDescription() Eine allgemeine Beschreibung zur Funktionsweise des Plugins, welche dem Nutzer in der FORMCYCLE Oberfläche angezeigt wird. Hinweis: Um eine Formtierung des Bescheibungstextes zu ermöglichen, kann der Text mit HTML-Tags versehen werden.

Specified by:

getDescription in interface IFCPlugin

Returns:

eine Zeichenkette oder null