Package net.sf.jaxodraw.io

Class JaxoIO

  • public final class JaxoIO
extends java.lang.Object
    The class responsible for opening/saving JaxoGraphs. Also contains utility methods for file name management etc.
    Since:
    2.0

    • Constructor Summary

      Constructors 
      Constructor Description
      JaxoIO​(java.awt.Component parentc)
      Constructor.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String absoluteName​(java.lang.String fileName)
      Returns the absolute path of the given file name.
      static java.lang.String baseName​(java.lang.String fileName)
      Basename: part before the last '.' that does not occur at the beginning, or the fileName itself if there is none.
      static java.lang.String currentDirectoryString()
      Returns the current directory as a string.
      static java.lang.String directoryString​(java.lang.String fileName)
      Returns the absolute path of he directory that contains the fgiven file.
      static java.lang.String extension​(java.lang.String fileName)
      Extension: part after the last '.' that does not occur at the beginning, or "" if there is none.
      JaxoGraph open()
      Opens a new JaxoGraph: asks for an open file.
      JaxoGraph open​(java.io.File f)
      Opens a new JaxoGraph from the specified file.
      JaxoGraph open​(java.io.File f, boolean guiWarnings)
      Opens a new JaxoGraph from the specified file.
      JaxoGraph open​(java.lang.String name)
      Opens a new JaxoGraph from the specified file fileName.
      void save​(JaxoGraph graph, java.lang.String title, java.lang.String fileName)
      Saves the specified JaxoGraph: if the current JaxoGraph has no save file associated with it, asks for a save file name.
      void saveAs​(JaxoGraph graph, java.lang.String title, java.lang.String fileName)
      Saves the specified JaxoGraph: asks for a save file.
      static java.lang.String shortName​(java.lang.String fileName)
      Returns the short name if the given file.
      static boolean shouldOverwrite​(java.awt.Component parent, java.io.File f)
      Show a dialog if 'f' exists, asking the user whether 'f' should be overwritten and return the result.
      static boolean shouldOverwrite​(java.awt.Component parent, java.io.File f, java.lang.String dTitle)
      Show a dialog if 'f' exists, asking the user whether 'f' should be overwritten and return the result.
      static java.net.URL toURL​(java.io.File f)
      Convert 'f' to URL, and MalformedURLExceptions to IOExceptions.
      static java.lang.String withExtension​(java.lang.String name, java.lang.String extension)
      fileName with "." + extension added unless it is already at the end or the fileName is empty.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • JaxoIO

        public JaxoIO​(java.awt.Component parentc)
        Constructor.
        Parameters:
        parentc - The parent component.

    • Method Detail

      • toURL

        public static java.net.URL toURL​(java.io.File f)
                          throws java.io.IOException
        Convert 'f' to URL, and MalformedURLExceptions to IOExceptions.
        Parameters:
        f - The file to convert.
        Returns:
        The URL of the file.
        Throws:
        java.io.IOException - If the file cannot be converted.

      • absoluteName

        public static java.lang.String absoluteName​(java.lang.String fileName)
        Returns the absolute path of the given file name.
        Parameters:
        fileName - The file name.
        Returns:
        The absolute path.

      • currentDirectoryString

        public static java.lang.String currentDirectoryString()
        Returns the current directory as a string.
        Returns:
        The current directory.

      • directoryString

        public static java.lang.String directoryString​(java.lang.String fileName)
        Returns the absolute path of he directory that contains the fgiven file.
        Parameters:
        fileName - The file name.
        Returns:
        The absolute path of the directory.

      • shortName

        public static java.lang.String shortName​(java.lang.String fileName)
        Returns the short name if the given file.
        Parameters:
        fileName - The file name.
        Returns:
        The short file name.

      • extension

        public static java.lang.String extension​(java.lang.String fileName)
        Extension: part after the last '.' that does not occur at the beginning, or "" if there is none. Always: f.equals(baseName(f) + "." + extension(f))
        Parameters:
        fileName - The file name.
        Returns:
        The file extension.

      • baseName

        public static java.lang.String baseName​(java.lang.String fileName)
        Basename: part before the last '.' that does not occur at the beginning, or the fileName itself if there is none.
        Parameters:
        fileName - The file name.
        Returns:
        The basename.

      • withExtension

        public static java.lang.String withExtension​(java.lang.String name,
                                             java.lang.String extension)
        fileName with "." + extension added unless it is already at the end or the fileName is empty.
        Parameters:
        name - The file name.
        extension - The extension to add.
        Returns:
        The full file name.

      • save

        public void save​(JaxoGraph graph,
                 java.lang.String title,
                 java.lang.String fileName)
        Saves the specified JaxoGraph: if the current JaxoGraph has no save file associated with it, asks for a save file name. Othrewise saves the graph to the default file.
        Parameters:
        title - title of graph (e.g. in tab)
        fileName - suggested file name (if the graph does not have one)
        graph - The graph to be saved.

      • saveAs

        public void saveAs​(JaxoGraph graph,
                   java.lang.String title,
                   java.lang.String fileName)
        Saves the specified JaxoGraph: asks for a save file.
        Parameters:
        title - title of graph (e.g. in tab)
        fileName - suggested file name (if the graph does not have one)
        graph - The graph to be saved.

      • shouldOverwrite

        public static boolean shouldOverwrite​(java.awt.Component parent,
                                      java.io.File f)
        Show a dialog if 'f' exists, asking the user whether 'f' should be overwritten and return the result. Otherwise, return true.
        Parameters:
        parent - parent component for the dialog.
        f - The file to test.
        Returns:
        True if the file should be overwritten.

      • shouldOverwrite

        public static boolean shouldOverwrite​(java.awt.Component parent,
                                      java.io.File f,
                                      java.lang.String dTitle)
        Show a dialog if 'f' exists, asking the user whether 'f' should be overwritten and return the result. Otherwise, return true.
        Parameters:
        parent - parent component for the dialog.
        f - The file to test.
        dTitle - of the question dialog, may be 'null', then a default title will be used.
        Returns:
        True if the file should be overwritten.

      • open

        public JaxoGraph open()
        Opens a new JaxoGraph: asks for an open file.
        Returns:
        The new JaxoGraph or null if the file could not be opened.

      • open

        public JaxoGraph open​(java.lang.String name)
        Opens a new JaxoGraph from the specified file fileName.
        Parameters:
        name - An absolute path to the file to be opened.
        Returns:
        The new JaxoGraph or null if the file could not be opened.

      • open

        public JaxoGraph open​(java.io.File f)
        Opens a new JaxoGraph from the specified file.
        Parameters:
        f - A file to be opened.
        Returns:
        The new JaxoGraph or null if the file could not be opened.

      • open

        public JaxoGraph open​(java.io.File f,
                      boolean guiWarnings)
        Opens a new JaxoGraph from the specified file.
        Parameters:
        f - A file to be opened.
        guiWarnings - set to false to suppress any graphical warning dialogs.
        Returns:
        The new JaxoGraph or null if the file could not be opened.