public interface SettingsControl
It is recommended to use the
SettingsApi to store the plugin's settings.
|Modifier and Type||Field and Description|
|Modifier and Type||Method and Description|
Called when the the plugin settings dialog is closed in any other way than pressign the OK button, typically by pressing the Cancel button or clicking on the window close icon or pressing ALT+F4.
Called when the OK button is pressed on the settings dialog.
Receives the reference to the settings dialog.
static final java.lang.String VERSION
void receiveSettingsDialog(javax.swing.JDialog settingsDialog)
The dialog is handled automatically, no need to do anything with it. The reference is handed here so it can serve as the parent dialog for optional child dialogs (for example file chooser dialogs).
This method will be called before
getEditorPanel() is invoked,
but at the time of calling the GUI of the dialog is obviously not yet constructed.
settingsDialog- reference to the settings dialog
Containerthat wraps the editor components to display and edit the settings of the plugin. This can be typically a
The editor components have to be initialized with the current settings of the plugin.
This component will be added to the center (
BorderLayout.CENTER) of the content pane of the settings dialog.
Containerthat wraps the editor components to display and edit the settings of the plugin
The implementation must get the settings from the editor components and store them.
The implementation MUST NOT get and store the settings from the editor components. The implementation may use this to free resources that were allocated for the Settings control. A typical implementation does nothing here.