Class JaxoExportPS

  • All Implemented Interfaces:
    java.awt.print.Printable, JaxoPlugin, JaxoLocalized

    public class JaxoExportPS
    extends JaxoExport
    implements java.awt.print.Printable
    The class that is responsible for exporting to postscript output: portrait, landscape or EPS are possible options. Asks for an export file name.
    Since:
    2.0
    • Constructor Detail

      • JaxoExportPS

        public JaxoExportPS​(JaxoExportPS.Format psmode)
        Constructor.
        Parameters:
        psmode - PS_PS or PS_EPS.
    • Method Detail

      • isLandscape

        public final boolean isLandscape()
        Returns the landscape mode.
        Returns:
        True for landscape, false for portrait..
      • setLandscape

        public void setLandscape​(boolean value)
        Sets the landscape mode.
        Parameters:
        value - True for landscape, false for portrait.
      • setMode

        public final void setMode​(JaxoExportPS.Format value)
        Sets the export mode.
        Parameters:
        value - The new export mode (PS_XYZ constant).
      • getMode

        public final JaxoExportPS.Format getMode()
        Returns the current export mode.
        Returns:
        The current export mode.
      • getFormatName

        public final java.lang.String getFormatName()
        The name of the plugin (export or import) format.
        Specified by:
        getFormatName in class AbstractJaxoPlugin
        Returns:
        An (internationalized) name of the plugin format.
      • getFileExtension

        public final java.lang.String getFileExtension()
        Extension to be used for plugin files.
        Specified by:
        getFileExtension in class AbstractJaxoPlugin
        Returns:
        The file extension.
      • getFileExtensionDescription

        public final java.lang.String getFileExtensionDescription()
        Description to be used for plugin file extensions.
        Specified by:
        getFileExtensionDescription in class AbstractJaxoPlugin
        Returns:
        An (internationalized) description of the file extension.
      • description

        public java.lang.String description()
        Return a short description (preferably internationalized) of what this plugin does.
        Specified by:
        description in interface JaxoPlugin
        Returns:
        a description.
      • pluginId

        public java.lang.String pluginId()
        This must return the class name of the plugin (MyPlugin.class.getName()). It is used to uniquely identify the plugin.
        Specified by:
        pluginId in interface JaxoPlugin
        Returns:
        the class name of the plugins' main class.
      • getShortName

        public java.lang.String 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".
        Specified by:
        getShortName in interface JaxoPlugin
        Returns:
        The short name of this plugin.
      • exportTo

        protected void exportTo​(java.lang.String fileName)
                         throws JaxoPluginExecutionException
        Export the graph to the given nonempty file name.
        Specified by:
        exportTo in class JaxoExportPlugin
        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.
      • print

        public final int print​(java.awt.Graphics g,
                               java.awt.print.PageFormat pf,
                               int pageIndex)
        The actual printing routine required by the Printable interface.
        Specified by:
        print in interface java.awt.print.Printable
        Parameters:
        g - The specified graphics context.
        pf - The specified page format.
        pageIndex - The specified page index.
        Returns:
        Either Printable.PAGE_EXISTS or Printable.NO_SUCH_PAGE.
      • writePS

        protected final void writePS​(java.io.File file)
        The class that is responsible for exporting to postscript output: portrait, landscape or EPS are possible options. The export file name is given by fileName.
        Parameters:
        file - The export file.
      • preview

        public void preview​(JaxoPreview p,
                            boolean sameWindow)
        Show a preview.
        Specified by:
        preview in class JaxoExportPlugin
        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.
      • getConfigurationPanel

        public javax.swing.JComponent getConfigurationPanel()
        Returns a panel that allows to configure optional parameters of this export format.
        Specified by:
        getConfigurationPanel in class JaxoExportPlugin
        Returns:
        A panel to configure the postscript orientation.