com.xmlmind.xmleditext.xep_foprocessor

Class XEP

java.lang.Object

com.xmlmind.foprocessor.FOProcessorBase

com.xmlmind.xmleditext.xep_foprocessor.XEP

All Implemented Interfaces:

FOProcessor

public class XEP
extends FOProcessorBase

An implementation of FOProcessor based on RenderX XEP.

This implementation is thread-safe.

Field Summary

Fields inherited from class com.xmlmind.foprocessor.FOProcessorBase

preferences

Constructor Summary

Constructors

Constructor and Description
XEP()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns a short (possibly multi-line) description of the XSL-FO processor.
String	getName() Returns the name of the XSL-FO processor.
PreferencesSheet	getPreferencesSheet() Returns a newly created preferences sheet which can be used to edit the user preferences related to this plug-in.
void	processFO(URL inURL, File outFile, String[] parameters, Console console) Converts an XSL-FO file to another format.

Methods inherited from class com.xmlmind.foprocessor.FOProcessorBase

getPreferences, setPreferences

Methods inherited from class java.lang.Object

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

Constructor Detail

XEP

public XEP()

Method Detail

getName

public String getName()

Description copied from interface: FOProcessor

Returns the name of the XSL-FO processor. This name is specified in the processor attribute of the processFO element in order to load the FO processor needed by the process command. Example: <processFO processor="XFC" file="doc.fo" to="doc.rtf"/>.

getDescription

public String getDescription()

Description copied from interface: FOProcessor

Returns a short (possibly multi-line) description of the XSL-FO processor.

getPreferencesSheet

public PreferencesSheet getPreferencesSheet()

Description copied from class: FOProcessorBase

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

Overrides:

getPreferencesSheet in class FOProcessorBase

Returns:

null

processFO

public void processFO(URL inURL,
                      File outFile,
                      String[] parameters,
                      Console console)
               throws Exception

Description copied from interface: FOProcessor

Converts an XSL-FO file to another format.

Parameters:

inURL - the URL of the file containing XSL-FO

outFile - file generated by the XSL-FO processor

parameters - contains parameter name/parameter value pairs. These parameters, which are specific to each XSL-FO processor, are specified using the parameter child element of the processFO element. Example: <parameter name="outputEncoding">Cp1252</parameter>.

console - used to report information, warnings and non-fatal errors

Throws:

Exception - if, for any reason, conversion cannot be completed