TeXOptions
Inheritance: java.lang.Object
public class TeXOptions
TeX file processing options class.
Methods
| Method | Description |
|---|---|
| getJobName() | Gets the name of the job. |
| setJobName(String value) | Sets the name of the job. |
| getTerminalIn() | Gets the input terminal reader. |
| setTerminalIn(IInputTerminal value) | Sets the input terminal reader. |
| getTerminalOut() | Gets the output terminal writer. |
| setTerminalOut(IOutputTerminal value) | Sets the output terminal writer. |
| getInputWorkingDirectory() | Gets input working directory. |
| setInputWorkingDirectory(IInputWorkingDirectory value) | Sets input working directory. |
| getOutputWorkingDirectory() | Gets output working directory. |
| setOutputWorkingDirectory(IOutputWorkingDirectory value) | Sets output working directory. |
| getRequiredInputDirectory() | Gets the directory for the required input, e.g., packages that are beyond Aspose.TeX’s LaTeX support. |
| setRequiredInputDirectory(IInputWorkingDirectory value) | Sets the directory for the required input, e.g., packages that are beyond Aspose.TeX’s LaTeX support. |
| getInteraction() | Gets the interaction mode to run a TeX engine in. |
| setInteraction(Interaction value) | Sets the interaction mode to run a TeX engine in. |
| ignoreMissingPackages() | Gets the flag that instructs the engine whether to halt on missing package read attempt or ignore it. |
| ignoreMissingPackages(boolean value) | Sets the flag that instructs the engine whether to halt on missing package read attempt or ignore it. |
| getSaveOptions() | Gets options used for rendering into destination format (XPS, PDF, image, etc.). |
| setSaveOptions(SaveOptions value) | Sets options used for rendering into destination format (XPS, PDF, image, etc.). |
| getDateTime() | Gets a certain value for date/time primitives like \year, \month, \day and \time. |
| setDateTime(Date value) | Sets a certain value for date/time primitives like \year, \month, \day and \time. |
| repeat() | Gets the flag indicating whether it is necessary to run the TeX job twice in case, for example, there are references in input TeX file(s). |
| repeat(boolean value) | Sets the flag indicating whether it is necessary to run the TeX job twice in case, for example, there are references in input TeX file(s). |
| noLigatures() | Gets the flag that cancels ligatures in all fonts. |
| noLigatures(boolean value) | Sets the flag that cancels ligatures in all fonts. |
| fullInputFileNames() | Gets the flag indicating whether full or short filenames are output to the transcript file and to the terminal when file input begins. |
| fullInputFileNames(boolean value) | Sets the flag indicating whether full or short filenames are output to the transcript file and to the terminal when file input begins. |
| getShellMode() | Gets the availability of \write18. |
| setShellMode(ShellMode value) | Sets the availability of \write18. |
| getExecutables() | A customizable collection of objects that emulate executables, which can be executed using the \write18 commands in Object TeX. |
| consoleAppOptions(TeXConfig config) | Returns options for use in a console application. |
getJobName()
public String getJobName()
Gets the name of the job.
Returns: java.lang.String - The name of the job.
setJobName(String value)
public void setJobName(String value)
Sets the name of the job.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The name of the job. |
getTerminalIn()
public IInputTerminal getTerminalIn()
Gets the input terminal reader.
Returns: IInputTerminal - The input terminal reader.
setTerminalIn(IInputTerminal value)
public void setTerminalIn(IInputTerminal value)
Sets the input terminal reader.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IInputTerminal | The input terminal reader. |
getTerminalOut()
public IOutputTerminal getTerminalOut()
Gets the output terminal writer.
Returns: IOutputTerminal - The output terminal writer.
setTerminalOut(IOutputTerminal value)
public void setTerminalOut(IOutputTerminal value)
Sets the output terminal writer.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IOutputTerminal | The output terminal writer. |
getInputWorkingDirectory()
public IInputWorkingDirectory getInputWorkingDirectory()
Gets input working directory.
Returns: IInputWorkingDirectory - Input working directory.
setInputWorkingDirectory(IInputWorkingDirectory value)
public void setInputWorkingDirectory(IInputWorkingDirectory value)
Sets input working directory.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IInputWorkingDirectory | Input working directory. |
getOutputWorkingDirectory()
public IOutputWorkingDirectory getOutputWorkingDirectory()
Gets output working directory.
Returns: IOutputWorkingDirectory - Output working directory.
setOutputWorkingDirectory(IOutputWorkingDirectory value)
public void setOutputWorkingDirectory(IOutputWorkingDirectory value)
Sets output working directory.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IOutputWorkingDirectory | Output working directory. |
getRequiredInputDirectory()
public IInputWorkingDirectory getRequiredInputDirectory()
Gets the directory for the required input, e.g., packages that are beyond Aspose.TeX’s LaTeX support.
Returns: IInputWorkingDirectory - Input directory.
setRequiredInputDirectory(IInputWorkingDirectory value)
public void setRequiredInputDirectory(IInputWorkingDirectory value)
Sets the directory for the required input, e.g., packages that are beyond Aspose.TeX’s LaTeX support.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IInputWorkingDirectory | Input directory. |
getInteraction()
public Interaction getInteraction()
Gets the interaction mode to run a TeX engine in.
Returns: Interaction - The interaction mode to run a TeX engine in.
setInteraction(Interaction value)
public void setInteraction(Interaction value)
Sets the interaction mode to run a TeX engine in.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Interaction | The interaction mode to run a TeX engine in. |
ignoreMissingPackages()
public boolean ignoreMissingPackages()
Gets the flag that instructs the engine whether to halt on missing package read attempt or ignore it.
Returns: boolean - The flag that instructs the engine whether to halt on missing package read attempt or ignore it.
ignoreMissingPackages(boolean value)
public void ignoreMissingPackages(boolean value)
Sets the flag that instructs the engine whether to halt on missing package read attempt or ignore it.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The flag that instructs the engine whether to halt on missing package read attempt or ignore it. |
getSaveOptions()
public SaveOptions getSaveOptions()
Gets options used for rendering into destination format (XPS, PDF, image, etc.). Default value is the set of default options for rendering to XPS.
Returns: SaveOptions - Options used for rendering into destination format (XPS, PDF, image, etc.).
setSaveOptions(SaveOptions value)
public void setSaveOptions(SaveOptions value)
Sets options used for rendering into destination format (XPS, PDF, image, etc.). Default value is the set of default options for rendering to XPS.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | SaveOptions | Options used for rendering into destination format (XPS, PDF, image, etc.). |
getDateTime()
public Date getDateTime()
Gets a certain value for date/time primitives like \year, \month, \day and \time.
Returns: java.util.Date - A certain value for date/time primitives like \year, \month, \day and \time.
setDateTime(Date value)
public void setDateTime(Date value)
Sets a certain value for date/time primitives like \year, \month, \day and \time.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.util.Date | A certain value for date/time primitives like \year, \month, \day and \time. |
repeat()
public boolean repeat()
Gets the flag indicating whether it is necessary to run the TeX job twice in case, for example, there are references in input TeX file(s). In general, this behavior is useful when the engine collects some data along the typesetting process and stores it in an auxilliary file, all at the first run. And at the second run, the engine somehow uses that data.
Returns: boolean - The flag indicating whether it is necessary to run the TeX job twice.
repeat(boolean value)
public void repeat(boolean value)
Sets the flag indicating whether it is necessary to run the TeX job twice in case, for example, there are references in input TeX file(s). In general, this behavior is useful when the engine collects some data along the typesetting process and stores it in an auxilliary file, all at the first run. And at the second run, the engine somehow uses that data.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The flag indicating whether it is necessary to run the TeX job twice. |
noLigatures()
public boolean noLigatures()
Gets the flag that cancels ligatures in all fonts.
Returns: boolean - The flag that cancels ligatures in all fonts.
noLigatures(boolean value)
public void noLigatures(boolean value)
Sets the flag that cancels ligatures in all fonts.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The flag that cancels ligatures in all fonts. |
fullInputFileNames()
public boolean fullInputFileNames()
Gets the flag indicating whether full or short filenames are output to the transcript file and to the terminal when file input begins.
Returns: boolean - The flag indicating whether full or short filenames are output to the transcript file and to the terminal when file input begins.
fullInputFileNames(boolean value)
public void fullInputFileNames(boolean value)
Sets the flag indicating whether full or short filenames are output to the transcript file and to the terminal when file input begins.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The flag indicating whether full or short filenames are output to the transcript file and to the terminal when file input begins. |
getShellMode()
public ShellMode getShellMode()
Gets the availability of \write18.
Returns: ShellMode - The availability of \write18.
setShellMode(ShellMode value)
public void setShellMode(ShellMode value)
Sets the availability of \write18.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ShellMode | The availability of \write18. |
getExecutables()
public ExecutablesList getExecutables()
A customizable collection of objects that emulate executables, which can be executed using the \write18 commands in Object TeX.
Returns: ExecutablesList - The collection of objects that emulate executables, which can be executed using the \write18 commands in Object TeX.
consoleAppOptions(TeXConfig config)
public static TeXOptions consoleAppOptions(TeXConfig config)
Returns options for use in a console application.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| config | TeXConfig | A TeX configuration. |
Returns: TeXOptions - TeX options.