public interface ApplicationPlugin
| Modifier and Type | Field and Description |
|---|---|
static int |
DIALOG_WIDGET
typical panel to be placed on any settings dialog as
defined in the ECU Definition (ini) file.
|
static int |
PERSISTENT_DIALOG_PANEL
Like a typical panel, but persistently listed on the menu
independent of ecu configuration.
|
static double |
PLUGIN_API_VERSION
TunerStudio Plugin API Specification Currently 1.1
|
static int |
TAB_PANEL
panel to be added as a tab on the main display area
|
| Modifier and Type | Method and Description |
|---|---|
void |
close()
called when the visual JComponents is dismissed.
|
boolean |
displayPlugin(java.lang.String controllerSignature)
This is called each time menu are being reconstructed.
|
java.lang.String |
getAuthor()
the Author of this plugin
|
java.lang.String |
getDescription()
Description for this plugin.
|
java.lang.String |
getDisplayName()
the name for this plugin to be displayed on the
menu or tab
|
java.lang.String |
getHelpUrl()
returns a url to web help for this plugin.
|
java.lang.String |
getIdName()
return the identifier for this plugin/panel
this will be the reference used in the ui structure of the
ecu configuration / ini file
|
javax.swing.JComponent |
getPluginPanel()
Provides access to the main plugin visual component.
|
int |
getPluginType()
The type of plugin the host application should recognize this as
|
double |
getRequiredPluginSpec()
the minimum Plugin specification your plugin requires to perform
as expected.
|
java.lang.String |
getVersion()
the version of the plugin implementation.
|
void |
initialize(ControllerAccess controllerAccess)
This will be called when the plugin is about to be displayed.
|
boolean |
isMenuEnabled()
called when on display of a menu or when settings change to determine
if this plugin Menu or tab should be enabled.
|
static final int DIALOG_WIDGET
static final int PERSISTENT_DIALOG_PANEL
static final int TAB_PANEL
static final double PLUGIN_API_VERSION
java.lang.String getIdName()
int getPluginType()
DIALOG_PANEL, PERSISTENT_PANEL, TAB_PANELjava.lang.String getDisplayName()
java.lang.String getDescription()
void initialize(ControllerAccess controllerAccess)
controllerAccess - An implementation of ControllerAccess with an
OuputChannelManager and ControllerParameterManager
for access to the Controller.boolean displayPlugin(java.lang.String controllerSignature)
controllerSignature - The signature of the Controller configuration about to
become active as the working configurationboolean isMenuEnabled()
java.lang.String getAuthor()
javax.swing.JComponent getPluginPanel()
void close()
java.lang.String getHelpUrl()
java.lang.String getVersion()
double getRequiredPluginSpec()