|
Oxygen XML Editor 15.0 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectro.sync.exml.plugin.option.OptionPagePluginExtension
@API(type=EXTENDABLE, src=PUBLIC) public abstract class OptionPagePluginExtension
Class used to create plugin option page extension. It receives callbacks for saving options, restoring default options and loading options. The GUI for this option page must be built in order to associated the options with their corresponding GUI components.
Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.
Constructor Summary | |
---|---|
OptionPagePluginExtension()
|
Method Summary | |
---|---|
abstract void |
apply(PluginWorkspace pluginWorkspace)
This method is called when "Apply" or "OK" button are pressed in from the GUI option page. |
abstract java.lang.String |
getTitle()
Retrieves the option page title. |
abstract javax.swing.JComponent |
init(PluginWorkspace pluginWorkspace)
Initializes the GUI for the option page and loads the stored option values. |
abstract void |
restoreDefaults()
This method is called when "Restore defaults" button is pressed from the GUI option page. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public OptionPagePluginExtension()
Method Detail |
---|
public abstract void apply(PluginWorkspace pluginWorkspace)
pluginWorkspace
- Access the entire workspace of Oxygen. It can be used to
retrieve the OptionsStorage
and perform options save operations on it.public abstract void restoreDefaults()
public abstract java.lang.String getTitle()
public abstract javax.swing.JComponent init(PluginWorkspace pluginWorkspace)
pluginWorkspace
- Access the entire workspace of Oxygen. It can be used to
retrieve the OptionsStorage
and perform options save/load operations it.
|
Oxygen XML Editor 15.0 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |