org.openoffice.da.comp.writer2latex

Class ExternalApps

java.lang.Object

org.openoffice.da.comp.writer2latex.ExternalApps

public class ExternalApps
extends java.lang.Object

This class manages and executes external applications used by the Writer2LaTeX toolbar. These include TeX and friends as well as viewers for the various backend formats. The registry is used for persistent storage of the settings.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BIBTEX
static short	BUILD
static java.lang.String	DVIPS
static java.lang.String	DVIVIEWER
static short	EXPORT
static java.lang.String	LATEX
static java.lang.String	MAKEINDEX
static java.lang.String	MK4HT
static java.lang.String	PDFLATEX
static java.lang.String	PDFVIEWER
static java.lang.String	POSTSCRIPTVIEWER
static short	PREVIEW
static java.lang.String	XELATEX

Constructor Summary

Constructors

Constructor and Description
ExternalApps(com.sun.star.uno.XComponentContext xContext) Construct a new ExternalApps object with empty content

Method Summary

Modifier and Type	Method and Description
int	execute(java.lang.String sAppName, java.lang.String sFileName, java.io.File workDir, java.util.Map<java.lang.String,java.lang.String> env, boolean bWaitFor) Execute an external application
int	execute(java.lang.String sAppName, java.lang.String sCommand, java.lang.String sFileName, java.io.File workDir, java.util.Map<java.lang.String,java.lang.String> env, boolean bWaitFor) Execute an external application
java.lang.String[]	getApplication(java.lang.String sAppName) Get the definition for an external application
short	getProcessingLevel() Get the desired processing level (0: export only, 1: export and build, 2: export, build and preview)
static java.lang.String	getUIAppName(java.lang.String sName) Return the localized name for an external app to use in the UI (only the viewers has a separate UI name)
boolean	getUseDefaultApplication(java.lang.String sAppName) Get the setting to use the system's default application
boolean	isViewer(java.lang.String sAppName)
void	load() Load the external applications from the registry
void	save() Save the external applications to the registry
void	setApplication(java.lang.String sAppName, java.lang.String sExecutable, java.lang.String sOptions) Define an external application
void	setProcessingLevel(short nLevel) Set the desired processing level (0: export only, 1: export and build, 2: export, build and preview)
void	setUseDefaultApplication(java.lang.String sAppName, boolean bUseDefault) Define to use the system's default for an external application.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXPORT

public static final short EXPORT

See Also:

Constant Field Values

BUILD

public static final short BUILD

See Also:

Constant Field Values

PREVIEW

public static final short PREVIEW

See Also:

Constant Field Values

LATEX

public static final java.lang.String LATEX

See Also:

Constant Field Values

PDFLATEX

public static final java.lang.String PDFLATEX

See Also:

Constant Field Values

XELATEX

public static final java.lang.String XELATEX

See Also:

Constant Field Values

BIBTEX

public static final java.lang.String BIBTEX

See Also:

Constant Field Values

MAKEINDEX

public static final java.lang.String MAKEINDEX

See Also:

Constant Field Values

MK4HT

public static final java.lang.String MK4HT

See Also:

Constant Field Values

DVIPS

public static final java.lang.String DVIPS

See Also:

Constant Field Values

DVIVIEWER

public static final java.lang.String DVIVIEWER

See Also:

Constant Field Values

POSTSCRIPTVIEWER

public static final java.lang.String POSTSCRIPTVIEWER

See Also:

Constant Field Values

PDFVIEWER

public static final java.lang.String PDFVIEWER

See Also:

Constant Field Values

Constructor Detail

ExternalApps

public ExternalApps(com.sun.star.uno.XComponentContext xContext)

Construct a new ExternalApps object with empty content

Method Detail

getUIAppName

public static java.lang.String getUIAppName(java.lang.String sName)

Return the localized name for an external app to use in the UI (only the viewers has a separate UI name)

Parameters:

sName - the app name

Returns:

the UI name

setProcessingLevel

public void setProcessingLevel(short nLevel)

Set the desired processing level (0: export only, 1: export and build, 2: export, build and preview)

Parameters:

nLevel - the desired level

getProcessingLevel

public short getProcessingLevel()

Get the desired processing level (0: export only, 1: export and build, 2: export, build and preview)

Returns:

the level

isViewer

public boolean isViewer(java.lang.String sAppName)

setApplication

public void setApplication(java.lang.String sAppName,
                           java.lang.String sExecutable,
                           java.lang.String sOptions)

Define an external application

Parameters:

sAppName - the name of the application to define

sExecutable - the system dependent path to the executable file

sOptions - the options to the external application; %s will be replaced by the filename on execution

getApplication

public java.lang.String[] getApplication(java.lang.String sAppName)

Get the definition for an external application

Parameters:

sAppName - the name of the application to get

Returns:

a String array containing the system dependent path to the executable file as entry 0 and the parameters as entry 1 returns null if the application is unknown

setUseDefaultApplication

public void setUseDefaultApplication(java.lang.String sAppName,
                                     boolean bUseDefault)

Define to use the system's default for an external application. This is only possible if the application is a viewer, otherwise setting the value to true will be ignored

Parameters:

sAppName - the name of the application

bUseDefault - flag defining whether or not to use the default

getUseDefaultApplication

public boolean getUseDefaultApplication(java.lang.String sAppName)

Get the setting to use the system's default application

Parameters:

sAppName - the name of the application

Returns:

true if the system's default should be used, false if not or if the application is unknown

execute

public int execute(java.lang.String sAppName,
                   java.lang.String sFileName,
                   java.io.File workDir,
                   java.util.Map<java.lang.String,java.lang.String> env,
                   boolean bWaitFor)

Execute an external application

Parameters:

sAppName - the name of the application to execute (ignored for default apps)

sFileName - the file name to use

workDir - the working directory to use

env - map of environment variables to set (or null if no variables needs to be set, ignored for default apps)

bWaitFor - true if the method should wait for the execution to finish (ignored for default apps)

Returns:

error code

execute

public int execute(java.lang.String sAppName,
                   java.lang.String sCommand,
                   java.lang.String sFileName,
                   java.io.File workDir,
                   java.util.Map<java.lang.String,java.lang.String> env,
                   boolean bWaitFor)

Execute an external application

Parameters:

sAppName - the name of the application to execute

sCommand - subcommand/option to pass to the command

sFileName - the file name to use

workDir - the working directory to use

env - map of environment variables to set (or null if no variables needs to be set)

bWaitFor - true if the method should wait for the execution to finish

Returns:

error code

load

public void load()

Load the external applications from the registry

save

public void save()

Save the external applications to the registry