org.openbp.jaspira.plugin
Class OptionModule

java.lang.Object
  org.openbp.jaspira.plugin.OptionModule

Direct Known Subclasses:

DisplayObjectPlugin.RoleOptionModule, ExternalAssociationPlugin.AssociationOptionModule, ExternalOptionModule, ItemBrowserPlugin.ItemBrowserOptions, MiniViewPlugin.MiniViewOptionModule, ModelerOptionPlugin.ModelerOptions, ModelerUndoPlugin.UndoOptions, SkinPlugin.SkinOptions

public abstract class OptionModule
extends java.lang.Object

The option module defines the options of a plugin. Options are defined as inner classes (Option or some subclass of this) of the option module.

Author:

Jens Ferchland

Constructor Summary

OptionModule()

Method Summary

java.util.List	getExternalOptionClasses() Returns a list of external option classes.
void	install() Installs the option module and instantiates the option classes.
protected void	loadOptions() Instantiates the internal and external options.
void	uninstall() Uninstalls all options.

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionModule

public OptionModule()

Method Detail

install

public final void install()

Installs the option module and instantiates the option classes.

uninstall

public final void uninstall()

Uninstalls all options.

getExternalOptionClasses

public java.util.List getExternalOptionClasses()

Returns a list of external option classes. This classes will be instanciated and registered at option manager at module installation time.

Returns:

A list of Class objects or null if the module doesn't declare user options. The classes in this list must extend the Option class.

loadOptions

protected final void loadOptions()

Instantiates the internal and external options.