|
| |
|
| java.lang.Object
 org.jdesktop.j3dfly.plugins.PluginPreference
All known Subclasses: org.jdesktop.j3dfly.plugins.J3dFlyMouseBehaviorPluginPreference,
| PluginPreference | | abstract public class PluginPreference extends Object implements java.io.Serializable(Code) | | Base class for all Plugin Preferences. All the methods in PluginPreferences
which follow the Bean pattern naming convention will have their state
saved in the xml preference files.
If you don't want the state of a property saved in the preference file then
either don't use the Bean naming pattern or mark the property as transient.
Note the transient keyword has no effect on the XMLEncoder,
instead you need to set the a Property of transient=True in the
property descriptor. THis is done automatically for this class
in the PluginPreferenceControl, however if you create a subclass
that uses transient data you will have to create a BeanInfo class
and set the appropriate properties.
author:
Paul Byrne
version:
$Revision: 1.1 $ |
| FILE | | final public static int FILE(Code) | | |
| LOADER | | final public static int LOADER(Code) | | |
| SYSTEM | | final public static int SYSTEM(Code) | | |
| USER | | final public static int USER(Code) | | |
| enabled | | protected boolean enabled(Code) | | When a plugin is enabled it's gui is active and
it has an effect on the scene graph. When it's not enabled it
should have NO effect on the scene graph.
|
| installInMenu | | protected boolean installInMenu(Code) | | Should this plugin install itself in the menubar
|
| installed | | protected boolean installed(Code) | | An installed Plugin appears in the set of installed plugins and
it GUI components will be installed, unless it's enabled it will
have no effect on the scene graph
|
| installedFrom | | protected transient int installedFrom(Code) | | Indicates where this Plugin was installed from
either SYSTEM, USER or FILE
|
| plugin | | protected transient J3dFlyPlugin plugin(Code) | | The plugin instantiated from these preferences
|
| PluginPreference | | public PluginPreference()(Code) | | Creates new PluginPreference
|
| PluginPreference | | public PluginPreference(boolean enabled, boolean installed)(Code) | | |
| getDescription | | abstract public String getDescription()(Code) | | Return a description of this plugin
|
| getInstalledFrom | | public int getInstalledFrom()(Code) | | Returns where this plugin was installed from
either SYSTEM, USER or FILE
|
| getInstalledFromStr | | public String getInstalledFromStr()(Code) | | Returns where this plugin was installed from in String form
either System, Usert or File
|
| getName | | abstract public String getName()(Code) | | Return the name of the Plugin for this prefernece.
This is the name that will appear in the list of plugins
|
| getPlugin | | public J3dFlyPlugin getPlugin()(Code) | | Return the plugin instantiated from this preference
|
| instantiatePlugin | | abstract public J3dFlyPlugin instantiatePlugin()(Code) | | Instiate and return the Plugin
May return null if plugin is unavailable
|
| isEnabled | | public boolean isEnabled()(Code) | | Getter for property enabled.
Value of property enabled. |
| isInstallInMenu | | public boolean isInstallInMenu()(Code) | | Should this plugin installed itself in the menu bar
|
| isInstalled | | public boolean isInstalled()(Code) | | Getter for property installed.
Value of property installed. |
| setEnabled | | public void setEnabled(boolean enabled)(Code) | | Setter for property enabled.
Parameters:
enabled - New value of property enabled. |
| setInstallInMenu | | public void setInstallInMenu(boolean install)(Code) | | Set if this plugin should install itself in the menubar
|
| setInstalled | | public void setInstalled(boolean installed)(Code) | | Install the plugin.
Note this method also set the installed property.
When the preference is loaded from the xml preference
files the installed property will be set, however the
PluginPreferenceControl will still call setInstalled(true)
later to actually install the plugin.
Parameters:
installed - New value of property installed. |
| setInstalledFrom | | public void setInstalledFrom(int from)(Code) | | Set where this plugin was installed from
either SYSTEM, USER or FILE
|
|
|
|