com.xmlmind.foprocessor

Class FOProcessorBase

java.lang.Object

com.xmlmind.foprocessor.FOProcessorBase

All Implemented Interfaces:

FOProcessor

Direct Known Subclasses:

FOP, XEP, XFC

public abstract class FOProcessorBase
extends Object
implements FOProcessor

A base class for FOProcessors. Provides default implementations for setPreferences(com.xmlmind.util.Preferences), getPreferences() and getPreferencesSheet().

Field Summary

Fields

Modifier and Type	Field and Description
protected Preferences	preferences

Constructor Summary

Constructors

Constructor and Description
FOProcessorBase()

Method Summary

Modifier and Type	Method and Description
Preferences	getPreferences() Returns the object where to read and write user preferences.
PreferencesSheet	getPreferencesSheet() Returns a newly created preferences sheet which can be used to edit the user preferences related to this plug-in.
void	setPreferences(Preferences preferences) Invoked by the environment hosting the plug-in to specify to this plug-in the object where to read and write user preferences.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.xmlmind.foprocessor.FOProcessor

getDescription, getName, processFO

Field Detail

preferences

protected Preferences preferences

Constructor Detail

FOProcessorBase

public FOProcessorBase()

Method Detail

setPreferences

public void setPreferences(Preferences preferences)

Description copied from interface: FOProcessor

Invoked by the environment hosting the plug-in to specify to this plug-in the object where to read and write user preferences.

Specified by:

setPreferences in interface FOProcessor

getPreferences

public Preferences getPreferences()

Description copied from interface: FOProcessor

Returns the object where to read and write user preferences. Returns null unless FOProcessor.setPreferences(com.xmlmind.util.Preferences) has been invoked by the environment hosting the plug-in (that is, XMLmind XML Editor).

Specified by:

getPreferences in interface FOProcessor

getPreferencesSheet

public PreferencesSheet getPreferencesSheet()

Returns a newly created preferences sheet which can be used to edit the user preferences related to this plug-in. May return null.

Specified by:

getPreferencesSheet in interface FOProcessor

Returns:

null