Package eu.simuline.m2latex.core

Enum LatexDev

java.lang.Object

java.lang.Enum<LatexDev>

eu.simuline.m2latex.core.LatexDev

All Implemented Interfaces:

Serializable, Comparable<LatexDev>, java.lang.constant.Constable

public enum LatexDev
extends Enum<LatexDev>

Enumeration of the backends of latex. Currently, there are two, pdf and dvips the latter representing dvi but html and odt are also desirable. The backend also affects the natural graphic formats: Whereas for the backend pdf, also pdf is used, dvips uses postscript-based formats. Created: Tue Oct 18 10:06:30 2016

Version:

1.0

Author:

Ernst Reissner

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
dvips
pdf

Constructor Summary

Constructors

Modifier	Constructor	Description
private	LatexDev()

Method Summary

Modifier and Type	Method	Description
(package private) static LatexDev	devViaDvi(boolean pdfViaDvi)
(package private) abstract String	getGnuplotInTexLanguage()	Returns the name of the language used by the Settings.getGnuplotCommand() to specify graphic without text of a gnuplot-picture.
(package private) abstract String	getGraphicsInTexSuffix()	Returns the suffix of the file to be embedded with \includegraphics in latex-code representing all but text.
(package private) abstract String	getLatexOutputFormat()	Returns the name of the target language latex2dev uses to convert the latex files into.
(package private) abstract String	getSvgExportOption()	Returns the export option used by the command Settings.getSvg2devCommand() which determines the export format.
(package private) abstract String	getXFigInTexLanguage()	Returns the name of the language used by the Settings.getFig2devCommand() to specify graphic without ``special'' text of an xfig-picture.
(package private) abstract boolean	isViaDvi()
(package private) abstract File	latexTargetFile(LatexProcessor.LatexMainDesc desc)	Returns the target file of a LaTeX run.
static LatexDev	valueOf(String name)	Returns the enum constant of this type with the specified name.
static LatexDev[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

pdf

public static final LatexDev pdf

dvips

public static final LatexDev dvips

Constructor Detail

LatexDev

private LatexDev()

Method Detail

values

public static LatexDev[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LatexDev valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getXFigInTexLanguage

abstract String getXFigInTexLanguage()

Returns the name of the language used by the Settings.getFig2devCommand() to specify graphic without ``special'' text of an xfig-picture. The converse is specified by LatexPreProcessor.XFIG_TEX_LANGUAGE. In fact, a file of that format is created which is embedded with \includegraphics in latex-code representing text.

getGnuplotInTexLanguage

abstract String getGnuplotInTexLanguage()

Returns the name of the language used by the Settings.getGnuplotCommand() to specify graphic without text of a gnuplot-picture. In fact, there is a file of that format embedded with \includegraphics in latex-code representing text.

getSvgExportOption

abstract String getSvgExportOption()

Returns the export option used by the command Settings.getSvg2devCommand() which determines the export format. In fact, there is a file of that format to be embedded with \includegraphics in latex-code.

getGraphicsInTexSuffix

abstract String getGraphicsInTexSuffix()

Returns the suffix of the file to be embedded with \includegraphics in latex-code representing all but text. This is used for processing fig-files and for processing svg-files in LatexPreProcessor.runFig2DevInTex(File, LatexDev) and in LatexPreProcessor.runSvg2Dev(File, LatexDev, boolean), whereas for conversion of gnuplot-files, this suffix is set automatically. Note also that this is used to clear the created files in all three cases.

getLatexOutputFormat

abstract String getLatexOutputFormat()

Returns the name of the target language latex2dev uses to convert the latex files into. This is set via option -output-format=.

isViaDvi

abstract boolean isViaDvi()

latexTargetFile

abstract File latexTargetFile(LatexProcessor.LatexMainDesc desc)

Returns the target file of a LaTeX run. This has the suffix given by getLatexOutputFormat().

devViaDvi

static LatexDev devViaDvi(boolean pdfViaDvi)