public class Fop
extends org.apache.tools.ant.Task
Constructor and Description |
---|
Fop() |
Modifier and Type | Method and Description |
---|---|
void |
addFileset(org.apache.tools.ant.types.FileSet set)
Adds a set of XSL-FO files (nested fileset attribute).
|
void |
execute() |
File |
getBasedir()
Gets the base directory.
|
List |
getFilesets()
Returns the current list of filesets.
|
File |
getFofile()
Gets the input XSL-FO file.
|
boolean |
getForce()
Gets the force attribute
|
String |
getFormat()
Gets the output format (MIME type).
|
boolean |
getLogFiles()
Returns True if the filename of each file processed should be logged.
|
int |
getMessageType()
Returns the message type corresponding to Project.MSG_*
representing the current message level.
|
File |
getOutdir()
Gets the output directory.
|
File |
getOutfile()
Gets the output file.
|
boolean |
getRelativebase()
Gets the relative base attribute
|
boolean |
getThrowexceptions()
Gets the throw exceptions attribute
|
File |
getUserconfig()
Returns the file for the userconfig.xml.
|
File |
getXmlFile()
Gets the input XML file.
|
File |
getXsltFile()
Gets the input XSLT file.
|
String |
getXsltParams()
Gets the XSLT parameters
|
void |
setBasedir(File baseDir)
Sets the base directory for single FO file (non-fileset) usage
|
void |
setFofile(File foFile)
Sets the input XSL-FO file.
|
void |
setForce(boolean force)
Set whether to check dependencies, or to always generate;
optional, default is false.
|
void |
setFormat(String format)
Sets output format (MIME type).
|
void |
setLogFiles(boolean logFiles)
Controls whether the filenames of the files that are processed are logged
or not.
|
void |
setMessagelevel(String messageLevel)
Sets the message level to be used while processing.
|
void |
setOutdir(File outDir)
Sets the output directory.
|
void |
setOutfile(File outFile)
Sets the output file.
|
void |
setRelativebase(boolean relbase)
Set whether to include files (external-graphics, instream-foreign-object)
from a path relative to the .fo file (true) or the working directory (false, default)
only useful for filesets
|
void |
setThrowexceptions(boolean throwExceptions)
Set whether exceptions are thrown.
|
void |
setUserconfig(File userConfig)
Sets the filename for the userconfig.xml.
|
void |
setXmlFile(File xmlFile)
Sets the input XML file.
|
void |
setXsltFile(File xsltFile)
Sets the input XSLT file.
|
void |
setXsltParams(String xsltParams)
Sets the XSLT parameters
|
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
public void setUserconfig(File userConfig)
userConfig
- Configuration to usepublic File getUserconfig()
public void setFofile(File foFile)
foFile
- input XSL-FO filepublic File getFofile()
public File getXmlFile()
public void setXmlFile(File xmlFile)
xmlFile
- the input XML file.public File getXsltFile()
public void setXsltFile(File xsltFile)
xsltFile
- the input XSLT file.public String getXsltParams()
public void setXsltParams(String xsltParams)
xsltParams
- the XSLT parameterspublic void addFileset(org.apache.tools.ant.types.FileSet set)
set
- a filesetpublic List getFilesets()
public void setRelativebase(boolean relbase)
relbase
- true if paths are relative to file.public boolean getRelativebase()
public void setForce(boolean force)
force
- true if always generate.public boolean getForce()
public void setOutfile(File outFile)
outFile
- File to output topublic File getOutfile()
public void setOutdir(File outDir)
outDir
- Directory to output topublic File getOutdir()
public void setFormat(String format)
format
- the output formatpublic String getFormat()
public void setThrowexceptions(boolean throwExceptions)
throwExceptions
- true if exceptions should be thrownpublic boolean getThrowexceptions()
public void setMessagelevel(String messageLevel)
messageLevel
- (error | warn| info | verbose | debug)public int getMessageType()
Project
public void setBasedir(File baseDir)
baseDir
- File to use as a working directorypublic File getBasedir()
public void setLogFiles(boolean logFiles)
logFiles
- True if the feature should be enabledpublic boolean getLogFiles()
public void execute() throws org.apache.tools.ant.BuildException
execute
in class org.apache.tools.ant.Task
org.apache.tools.ant.BuildException
Copyright © 2025 Apache Software Foundation. All rights reserved.