|
fop 0.95 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.fop.tools.anttasks.Fop
public class Fop
Wrapper for FOP which allows it to be accessed from within an Ant task. Accepts the inputs:
Field Summary |
---|
Fields inherited from class org.apache.tools.ant.Task |
---|
target, taskName, taskType, wrapper |
Fields inherited from class org.apache.tools.ant.ProjectComponent |
---|
description, location, project |
Constructor Summary | |
---|---|
Fop()
|
Method Summary | |
---|---|
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 |
java.io.File |
getUserconfig()
Returns the file for the userconfig.xml. |
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 |
setUserconfig(java.io.File userConfig)
Sets the filename for the userconfig.xml. |
Methods inherited from class org.apache.tools.ant.Task |
---|
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
---|
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Fop()
Method Detail |
---|
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 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 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
|
fop 0.95 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |