|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.jaxodraw.plugin.AbstractJaxoPlugin
net.sf.jaxodraw.plugin.JaxoExportPlugin
public abstract class JaxoExportPlugin
An abstract superclass for all export plugins.
Constructor Summary | |
---|---|
JaxoExportPlugin()
|
Method Summary | |
---|---|
abstract void |
commitConfiguration()
Apply the changes made in the configuration panel. |
protected java.lang.String |
errorDialogMessage(java.lang.String fileName)
Returns a default error message for exporting to 'fileName'. |
void |
export(JaxoGraph exportGraph,
java.lang.String fileName)
Export a graph to a file. |
void |
export(java.lang.String fileName)
Export the current graph to the given nonempty file name. |
protected abstract void |
exportTo(java.lang.String fileName)
Export the graph to the given nonempty file name. |
protected java.awt.Dimension |
getCanvasSize()
Returns the canvas size. |
java.lang.String |
getColorSpaceWarningForLaTeX()
Returns an internationalized warning when the color space is the complete one. |
abstract javax.swing.JComponent |
getConfigurationPanel()
Returns a panel that allows to configure optional parameters of this export format. |
JaxoGraph |
getGraph()
Returns the current graph to export. |
java.lang.String |
getLaTeXTextWarning()
Returns an internationalized warning when latex texts are present in the graph. |
java.lang.String |
getPSTextWarning()
Returns an internationalized warning when postscript texts are present in the graph. |
java.lang.String |
getPSTextWarningForLaTeX()
Returns an internationalized warning when postscript texts are present in the graph. |
abstract java.lang.String |
getWarningForGraph()
Returns a warning, eg if a part of the graph cannot be exported to the current format. |
protected void |
paintGraph(java.awt.Graphics2D g2d,
boolean printing)
Paint the graph. |
void |
preview(JaxoPreview p)
Show a preview in a new window. |
abstract void |
preview(JaxoPreview p,
boolean sameWindow)
Show a preview. |
void |
setCanvasSize(java.awt.Dimension value)
Set the canvas size. |
void |
setGraph(JaxoGraph newGraph)
Sets the graph to export. |
protected void |
showErrorDialog(java.lang.String message)
Show an error message window, unless silent. |
Methods inherited from class net.sf.jaxodraw.plugin.AbstractJaxoPlugin |
---|
close, close, close, close, getClassName, getFailure, getFileExtension, getFileExtensionDescription, getFormatName, getLang, getLog, getParentComponent, getProperties, getProperty, getProperty, getShortGraphName, hasFailed, isSilent, loadProperties, pluginName, registerDictionary, setFailure, setParentComponent, setProperty, setShortGraphName, setSilent, storeProperties |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface net.sf.jaxodraw.plugin.JaxoPlugin |
---|
description, getShortName, makeAvailableAtRuntime, pluginId, version |
Methods inherited from interface net.sf.jaxodraw.util.JaxoLocalized |
---|
updateLanguage |
Constructor Detail |
---|
public JaxoExportPlugin()
Method Detail |
---|
public final void setGraph(JaxoGraph newGraph)
newGraph
- The graph to export.public final JaxoGraph getGraph()
public void setCanvasSize(java.awt.Dimension value)
value
- The canvas size.protected java.awt.Dimension getCanvasSize()
public final void export(java.lang.String fileName)
fileName
- The file to export to.public void export(JaxoGraph exportGraph, java.lang.String fileName)
exportGraph
- The graph to export.fileName
- Absolute path of the file to export to.public void preview(JaxoPreview p)
p
- The JaxoPreview to use.protected void paintGraph(java.awt.Graphics2D g2d, boolean printing)
g2d
- the graphics context to paint to.printing
- set to true to suppress any UI-elements or aids.protected void showErrorDialog(java.lang.String message)
message
- The message to display.protected java.lang.String errorDialogMessage(java.lang.String fileName)
fileName
- The file name to insert in the message.
public java.lang.String getLaTeXTextWarning()
public java.lang.String getPSTextWarning()
public java.lang.String getPSTextWarningForLaTeX()
public java.lang.String getColorSpaceWarningForLaTeX()
public abstract void commitConfiguration()
public abstract javax.swing.JComponent getConfigurationPanel()
protected abstract void exportTo(java.lang.String fileName) throws JaxoPluginExecutionException
fileName
- The file to export to.
JaxoPluginExecutionException
- if exporting fails.
The exception message sould be displayable in error dialogs,
so it should be an internationalized string.public abstract void preview(JaxoPreview p, boolean sameWindow)
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.public abstract java.lang.String getWarningForGraph()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |