TeXJob

Inheritance: java.lang.Object

public class TeXJob

Implements features of a TeX job.

Constructors

Constructor	Description
TeXJob(InputStream stream, Device device, TeXOptions options)	Creates a TeX job for running the engine in production mode to typeset a TeX file.
TeXJob(String path, Device device, TeXOptions options)	Creates a TeX job for running the engine in production mode to typeset a TeX file.
TeXJob(Device device, TeXOptions options)	Creates a TeX job for running the engine in production mode to typeset a TeX file.

Methods

Method	Description
run()	Runs TeX job.
createFormat(String path, TeXOptions options)	Runs TeX engine in INITEX mode to create a format file (.fmt).

TeXJob(InputStream stream, Device device, TeXOptions options)

public TeXJob(InputStream stream, Device device, TeXOptions options)

Creates a TeX job for running the engine in production mode to typeset a TeX file.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	The stream containing the TeX file.
device	Device	The device defining output representation.
options	TeXOptions	TeX engine run options.

TeXJob(String path, Device device, TeXOptions options)

public TeXJob(String path, Device device, TeXOptions options)

Creates a TeX job for running the engine in production mode to typeset a TeX file.

Parameters:

Parameter	Type	Description
path	java.lang.String	The path to the TeX file.
device	Device	The device defining output representation.
options	TeXOptions	TeX engine run options.

TeXJob(Device device, TeXOptions options)

public TeXJob(Device device, TeXOptions options)

Creates a TeX job for running the engine in production mode to typeset a TeX file. The engine will prompt the file name as soon as it starts. Thus this run is supposed to be interactive.

Parameters:

Parameter	Type	Description
device	Device	The device defining output representation.
options	TeXOptions	TeX engine run options.

run()

public TeXJobResult run()

Runs TeX job.

Returns: TeXJobResult - The result of the job execution.

createFormat(String path, TeXOptions options)

public static void createFormat(String path, TeXOptions options)

Runs TeX engine in INITEX mode to create a format file (.fmt).

Parameters:

Parameter	Type	Description
path	java.lang.String	The path to the main format source file.
options	TeXOptions	TeX engine run options.