Package net.sf.jaxodraw.io.exports
Class JaxoExportLatex
java.lang.Object
net.sf.jaxodraw.plugin.AbstractJaxoPlugin
net.sf.jaxodraw.plugin.JaxoExportPlugin
net.sf.jaxodraw.io.exports.JaxoExport
net.sf.jaxodraw.io.exports.JaxoExportLatex
- All Implemented Interfaces:
JaxoPlugin
,JaxoLocalized
The class that is responsible for creating LaTex source files that may
be used to produce a postscript file that is (should be) equivalent to
the one produced by JaxoDraw. Not that you need J. Vermaseren's axodraw
package to process the LaTex source.
- Since:
- 2.0
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Apply the changes made in the configuration panel.Return a short description (preferably internationalized) of what this plugin does.protected final void
Export the graph to the given nonempty file name.protected final void
Export the graph to the given nonempty file name.Returns a panel that allows to configure optional parameters of this export format.final String
Extension to be used for plugin files.final String
Description to be used for plugin file extensions.final String
The name of the plugin (export or import) format.Return a short name for this plugin.Returns a warning if the current graph contains a LaTeX text.final String
Returns the exported latex file as a String.pluginId()
This must return the class name of the plugin (MyPlugin.class.getName()).void
preview
(JaxoPreview p, boolean sameWindow) Show a preview.final void
Updates the component with the current language as set in the preferences (JaxoPrefs.PREF_LANGUAGE
).Methods inherited from class net.sf.jaxodraw.io.exports.JaxoExport
getBuiltInFormats, makeAvailableAtRuntime, version
Methods inherited from class net.sf.jaxodraw.plugin.JaxoExportPlugin
errorDialogMessage, export, export, getCanvasSize, getColorSpaceWarningForLaTeX, getGraph, getLaTeXTextWarning, getPSTextWarning, getPSTextWarningForLaTeX, paintGraph, preview, setCanvasSize, setGraph, showErrorDialog
Methods inherited from class net.sf.jaxodraw.plugin.AbstractJaxoPlugin
close, getClassName, getFailure, getLang, getLog, getParentComponent, getProperties, getProperty, getProperty, getShortGraphName, hasFailed, isSilent, loadProperties, pluginName, registerDictionary, setFailure, setParentComponent, setProperty, setShortGraphName, setSilent, storeProperties
-
Constructor Details
-
JaxoExportLatex
public JaxoExportLatex()
-
-
Method Details
-
getFormatName
The name of the plugin (export or import) format.- Specified by:
getFormatName
in classAbstractJaxoPlugin
- Returns:
- An (internationalized) name of the plugin format.
-
getFileExtension
Extension to be used for plugin files.- Specified by:
getFileExtension
in classAbstractJaxoPlugin
- Returns:
- The file extension.
-
getFileExtensionDescription
Description to be used for plugin file extensions.- Specified by:
getFileExtensionDescription
in classAbstractJaxoPlugin
- Returns:
- An (internationalized) description of the file extension.
-
description
Return a short description (preferably internationalized) of what this plugin does.- Returns:
- a description.
-
pluginId
This must return the class name of the plugin (MyPlugin.class.getName()). It is used to uniquely identify the plugin.- Returns:
- the class name of the plugins' main class.
-
getShortName
Return a short name for this plugin. This is used to construct names of output files, eg to get a "jaxodraw-pdf-plugin.properties" file, the short name should just be "pdf".- Returns:
- The short name of this plugin.
-
getWarningForGraph
Returns a warning if the current graph contains a LaTeX text.- Overrides:
getWarningForGraph
in classJaxoExport
- Returns:
- An (internationalized) warning.
-
exportTo
Export the graph to the given nonempty file name.- Specified by:
exportTo
in classJaxoExportPlugin
- Parameters:
fileName
- The file to export to.- Throws:
JaxoPluginExecutionException
- if exporting fails. The exception message sould be displayable in error dialogs, so it should be an internationalized string.
-
latexFileAsString
Returns the exported latex file as a String.- Returns:
- the LaTeX file as a String.
-
exportTo
Export the graph to the given nonempty file name.- Parameters:
fileName
- The file to export to.rescale
- true if the graph should be rescaled to fit on a page before experting, false otherwise.- Throws:
JaxoPluginExecutionException
- if exporting fails. The exception message sould be displayable in error dialogs, so it should be an internationalized string.
-
preview
Show a preview.- Specified by:
preview
in classJaxoExportPlugin
- Parameters:
p
- The JaxoPreview to show.sameWindow
- If false, a new window will be opened for the preview. If true, and if a preview window for the current format is open already, the same window will be used for the preview. Not all implementations may support this feature.
-
commitConfiguration
public void commitConfiguration()Apply the changes made in the configuration panel.- Specified by:
commitConfiguration
in classJaxoExportPlugin
-
getConfigurationPanel
Returns a panel that allows to configure optional parameters of this export format.- Specified by:
getConfigurationPanel
in classJaxoExportPlugin
- Returns:
- Null by default, no options to configure.
-
updateLanguage
public final void updateLanguage()Updates the component with the current language as set in the preferences (JaxoPrefs.PREF_LANGUAGE
).
-