Package de.xima.fc.plugin.abstracts
Class APluginGenericCustomGUIBean
- java.lang.Object
-
- de.xima.fc.plugin.abstracts.APluginGenericCustomGUIBean
-
- All Implemented Interfaces:
IPluginGenericCustomGUIBean
,Serializable
- Direct Known Subclasses:
APluginClientDashboardCustomGUIBean
,APluginCustomGUIBean
public abstract class APluginGenericCustomGUIBean extends Object implements IPluginGenericCustomGUIBean, Serializable
The base class for the bean of a plugin with a custom UI.- Author:
- XIMA MEDIA GmbH
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description APluginGenericCustomGUIBean()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IPluginFileHelper
getFileHelper()
Lets you access the file helper of the plugin that provided this UI.Properties
getProperties()
Lets you access the properties of the plugin that provided this UI.IPluginResourceHelper
getResourceHelper()
Lets you access the resource helper of the plugin that provided this UI.void
initialize(IPluginInitializeBeanData initializeBeanData)
A callback method that is invoked after all beans required by theIPluginGenericCustomGUI
plugin were created.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface de.xima.fc.plugin.gui.IPluginGenericCustomGUIBean
destroy
-
-
-
-
Method Detail
-
initialize
public void initialize(IPluginInitializeBeanData initializeBeanData) throws FCPluginException
Description copied from interface:IPluginGenericCustomGUIBean
A callback method that is invoked after all beans required by theIPluginGenericCustomGUI
plugin were created. You can use this method to get access to the plugin configuration data. If you need to perform any initialization logic, do it in this method.- Specified by:
initialize
in interfaceIPluginGenericCustomGUIBean
- Parameters:
initializeBeanData
- TheIPluginInitializeBeanData
you can make use of in the initialization process.- Throws:
FCPluginException
- When the bean could not be initialized. If you do throw the exception, an error will be shown to the user. Depending on the type of custom UI, the user may instead see an error page, a default page or be redirected to another page.
-
getProperties
public Properties getProperties()
Description copied from interface:IPluginGenericCustomGUIBean
Lets you access the properties of the plugin that provided this UI.- Specified by:
getProperties
in interfaceIPluginGenericCustomGUIBean
- Returns:
Properties
The properties of the plugin.
-
getFileHelper
public IPluginFileHelper getFileHelper()
Description copied from interface:IPluginGenericCustomGUIBean
Lets you access the file helper of the plugin that provided this UI.- Specified by:
getFileHelper
in interfaceIPluginGenericCustomGUIBean
- Returns:
IPluginFileHelper
The helper class for working with the plugin files
-
getResourceHelper
public IPluginResourceHelper getResourceHelper()
Description copied from interface:IPluginGenericCustomGUIBean
Lets you access the resource helper of the plugin that provided this UI.- Specified by:
getResourceHelper
in interfaceIPluginGenericCustomGUIBean
- Returns:
IPluginResourceHelper
The helper class for working with resources
-
-