Oxygen XML Editor 16.1 Author API

ro.sync.exml.plugin.option
Class OptionPagePluginExtension

java.lang.Object
  extended by ro.sync.exml.plugin.option.OptionPagePluginExtension
All Implemented Interfaces:
PluginExtension

@API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class OptionPagePluginExtension
extends java.lang.Object
implements PluginExtension

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.

Since:
15

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

OptionPagePluginExtension

public OptionPagePluginExtension()
Method Detail

apply

public abstract void apply(PluginWorkspace pluginWorkspace)
This method is called when "Apply" or "OK" button are pressed in from the GUI option page. All options associated with the option page must be saved on this method.

Parameters:
pluginWorkspace - Access the entire workspace of Oxygen. It can be used to retrieve the OptionsStorage and perform options save operations on it.

restoreDefaults

public abstract void restoreDefaults()
This method is called when "Restore defaults" button is pressed from the GUI option page. All options associated with the option page must be restored to their default values.


getTitle

public abstract java.lang.String getTitle()
Retrieves the option page title.

Returns:
The option page title used in GUI.

init

public abstract javax.swing.JComponent init(PluginWorkspace pluginWorkspace)
Initializes the GUI for the option page and loads the stored option values.

Parameters:
pluginWorkspace - Access the entire workspace of Oxygen. It can be used to retrieve the OptionsStorage and perform options save/load operations it.
Returns:
The GUI component of the option page.

Oxygen XML Editor 16.1 Author API

© Copyright SyncRO Soft SRL 2002 - 2014. All rights reserved.