public class Fop
extends org.apache.tools.ant.Task
Constructor | Description |
---|---|
Fop() |
Modifier and Type | Method | Description |
---|---|---|
void |
addFileset(org.apache.tools.ant.types.FileSet set) |
Adds a set of XSL-FO files (nested fileset attribute).
|
void |
execute() |
|
java.io.File |
getBasedir() |
Gets the base directory.
|
java.util.List |
getFilesets() |
Returns the current list of filesets.
|
java.io.File |
getFofile() |
Gets the input XSL-FO file.
|
boolean |
getForce() |
Gets the force attribute
|
java.lang.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.
|
java.io.File |
getOutdir() |
Gets the output directory.
|
java.io.File |
getOutfile() |
Gets the output file.
|
boolean |
getRelativebase() |
Gets the relative base attribute
|
boolean |
getThrowexceptions() |
Gets the throw exceptions attribute
|
java.io.File |
getUserconfig() |
Returns the file for the userconfig.xml.
|
java.io.File |
getXmlFile() |
Gets the input XML file.
|
java.io.File |
getXsltFile() |
Gets the input XSLT file.
|
java.lang.String |
getXsltParams() |
Gets the XSLT parameters
|
void |
setBasedir(java.io.File baseDir) |
Sets the base directory for single FO file (non-fileset) usage
|
void |
setFofile(java.io.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(java.lang.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(java.lang.String messageLevel) |
Sets the message level to be used while processing.
|
void |
setOutdir(java.io.File outDir) |
Sets the output directory.
|
void |
setOutfile(java.io.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(java.io.File userConfig) |
Sets the filename for the userconfig.xml.
|
void |
setXmlFile(java.io.File xmlFile) |
Sets the input XML file.
|
void |
setXsltFile(java.io.File xsltFile) |
Sets the input XSLT file.
|
void |
setXsltParams(java.lang.String xsltParams) |
Sets the XSLT parameters
|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
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(java.io.File userConfig)
userConfig
- Configuration to usepublic java.io.File getUserconfig()
public void setFofile(java.io.File foFile)
foFile
- input XSL-FO filepublic java.io.File getFofile()
public java.io.File getXmlFile()
public void setXmlFile(java.io.File xmlFile)
xmlFile
- the input XML file.public java.io.File getXsltFile()
public void setXsltFile(java.io.File xsltFile)
xsltFile
- the input XSLT file.public java.lang.String getXsltParams()
public void setXsltParams(java.lang.String xsltParams)
xsltParams
- the XSLT parameterspublic void addFileset(org.apache.tools.ant.types.FileSet set)
set
- a filesetpublic java.util.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(java.io.File outFile)
outFile
- File to output topublic java.io.File getOutfile()
public void setOutdir(java.io.File outDir)
outDir
- Directory to output topublic java.io.File getOutdir()
public void setFormat(java.lang.String format)
format
- the output formatpublic java.lang.String getFormat()
public void setThrowexceptions(boolean throwExceptions)
throwExceptions
- true if exceptions should be thrownpublic boolean getThrowexceptions()
public void setMessagelevel(java.lang.String messageLevel)
messageLevel
- (error | warn| info | verbose | debug)public int getMessageType()
Project
public void setBasedir(java.io.File baseDir)
baseDir
- File to use as a working directorypublic java.io.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 1999-2016 The Apache Software Foundation. All Rights Reserved.