JAL-1645 Version-Rel Version 2.9 Year-Rel 2015 Licensing glob
[jalview.git] / src / org / jibble / epsgraphics / EpsDocument.java
index cae9835..1e71632 100755 (executable)
-/* \r
-Copyright Paul James Mutton, 2001-2004, http://www.jibble.org/\r
-\r
-This file is part of EpsGraphics2D.\r
-\r
-This software is dual-licensed, allowing you to choose between the GNU\r
-General Public License (GPL) and the www.jibble.org Commercial License.\r
-Since the GPL may be too restrictive for use in a proprietary application,\r
-a commercial license is also provided. Full license information can be\r
-found at http://www.jibble.org/licenses/\r
-\r
-$Author$\r
-$Id$\r
-\r
-*/\r
-\r
-package org.jibble.epsgraphics;\r
-\r
-import java.util.*;\r
-import java.io.*;\r
-\r
-\r
-/**\r
- * This represents an EPS document. Several EpsGraphics2D objects may point\r
- * to the same EpsDocument.\r
- *  <p>\r
- * Copyright Paul Mutton,\r
- *           <a href="http://www.jibble.org/">http://www.jibble.org/</a>\r
- * \r
- */\r
-public class EpsDocument {\r
-    \r
-    \r
-    /**\r
-     * Constructs an empty EpsDevice.\r
-     */\r
-    public EpsDocument(String title) {\r
-        _title = title;\r
-        minX = Float.POSITIVE_INFINITY;\r
-        minY = Float.POSITIVE_INFINITY;\r
-        maxX = Float.NEGATIVE_INFINITY;\r
-        maxY = Float.NEGATIVE_INFINITY;\r
-        _stringWriter = new StringWriter();\r
-        _bufferedWriter = new BufferedWriter(_stringWriter);\r
-    }\r
-    \r
-    /**\r
-     * Constructs an empty EpsDevice that writes directly to a file.\r
-     * Bounds must be set before use.\r
-     */\r
-    public EpsDocument(String title, OutputStream outputStream, int minX, int minY, int maxX, int maxY) throws IOException {\r
-        _title = title;\r
-        this.minX = minX;\r
-        this.minY = minY;\r
-        this.maxX = maxX;\r
-        this.maxY = maxY;\r
-        _bufferedWriter = new BufferedWriter(new OutputStreamWriter(outputStream));\r
-        write(_bufferedWriter);\r
-    }\r
-    \r
-    \r
-    /**\r
-     * Returns the title of the EPS document.\r
-     */\r
-    public synchronized String getTitle() {\r
-        return _title;\r
-    }\r
-    \r
-    \r
-    /**\r
-     * Updates the bounds of the current EPS document.\r
-     */\r
-    public synchronized void updateBounds(double x, double y) {\r
-        if (x > maxX) {\r
-            maxX = (float) x;\r
-        }\r
-        if (x < minX) {\r
-            minX = (float) x;\r
-        }\r
-        if (y > maxY) {\r
-            maxY = (float) y;\r
-        }\r
-        if (y < minY) {\r
-            minY = (float) y;\r
-        }\r
-    }\r
-    \r
-    \r
-    /**\r
-     * Appends a line to the EpsDocument.  A new line character is added\r
-     * to the end of the line when it is added.\r
-     */\r
-    public synchronized void append(EpsGraphics2D g, String line) {\r
-        if (_lastG == null) {\r
-            _lastG = g;\r
-        }\r
-        else if (g != _lastG) {\r
-            EpsGraphics2D lastG = _lastG;\r
-            _lastG = g;\r
-            // We are being drawn on with a different EpsGraphics2D context.\r
-            // We may need to update the clip, etc from this new context.\r
-            if (g.getClip() != lastG.getClip()) {\r
-                g.setClip(g.getClip());\r
-            }\r
-            if (!g.getColor().equals(lastG.getColor())) {\r
-                g.setColor(g.getColor());\r
-            }\r
-            if (!g.getBackground().equals(lastG.getBackground())) {\r
-                g.setBackground(g.getBackground());\r
-            }\r
-            // We don't need this, as this only affects the stroke and font,\r
-            // which are dealt with separately later on.\r
-            //if (!g.getTransform().equals(lastG.getTransform())) {\r
-            //    g.setTransform(g.getTransform());\r
-            //}\r
-            if (!g.getPaint().equals(lastG.getPaint())) {\r
-                g.setPaint(g.getPaint());\r
-            }\r
-            if (!g.getComposite().equals(lastG.getComposite())) {\r
-                g.setComposite(g.getComposite());\r
-            }\r
-            if (!g.getComposite().equals(lastG.getComposite())) {\r
-                g.setComposite(g.getComposite());\r
-            }\r
-            if (!g.getFont().equals(lastG.getFont())) {\r
-                g.setFont(g.getFont());\r
-            }\r
-            if (!g.getStroke().equals(lastG.getStroke())) {\r
-                g.setStroke(g.getStroke());\r
-            }\r
-        }\r
-        _lastG = g;\r
-        \r
-        try {\r
-            _bufferedWriter.write(line + "\n");\r
-        }\r
-        catch (IOException e) {\r
-            throw new EpsException("Could not write to the output file: " + e);\r
-        }\r
-    }\r
-    \r
-    \r
-    /**\r
-     * Outputs the contents of the EPS document to the specified\r
-     * Writer, complete with headers and bounding box.\r
-     */\r
-    public synchronized void write(Writer writer) throws IOException {\r
-        float offsetX = -minX;\r
-        float offsetY = -minY;\r
-        \r
-        writer.write("%!PS-Adobe-3.0 EPSF-3.0\n");\r
-        writer.write("%%Creator: EpsGraphics2D " + EpsGraphics2D.VERSION + " by Paul Mutton, http://www.jibble.org/\n");\r
-        writer.write("%%Title: " + _title + "\n");\r
-        writer.write("%%CreationDate: " + new Date() + "\n");\r
-        writer.write("%%BoundingBox: 0 0 " + ((int) Math.ceil(maxX + offsetX)) + " " + ((int) Math.ceil(maxY + offsetY)) + "\n");\r
-        writer.write("%%DocumentData: Clean7Bit\n");\r
-        writer.write("%%DocumentProcessColors: Black\n");\r
-        writer.write("%%ColorUsage: Color\n");\r
-        writer.write("%%Origin: 0 0\n");\r
-        writer.write("%%Pages: 1\n");\r
-        writer.write("%%Page: 1 1\n");\r
-        writer.write("%%EndComments\n\n");\r
-        \r
-        writer.write("gsave\n");\r
-        \r
-        if (_stringWriter != null) {\r
-            writer.write(offsetX + " " + (offsetY) + " translate\n");\r
-            \r
-            _bufferedWriter.flush();\r
-            StringBuffer buffer = _stringWriter.getBuffer();\r
-            for (int i = 0; i < buffer.length(); i++) {\r
-                writer.write(buffer.charAt(i));\r
-            }\r
-            \r
-            writeFooter(writer);\r
-        }\r
-        else {\r
-            writer.write(offsetX + " " + ((maxY - minY) - offsetY) + " translate\n");\r
-        }\r
-        \r
-        writer.flush();\r
-    }\r
-    \r
-    \r
-    private void writeFooter(Writer writer) throws IOException {\r
-        writer.write("grestore\n");\r
-        if (isClipSet()) {\r
-            writer.write("grestore\n");\r
-        }\r
-        writer.write("showpage\n");\r
-        writer.write("\n");\r
-        writer.write("%%EOF");\r
-        writer.flush();\r
-    }\r
-    \r
-    \r
-    public synchronized void flush() throws IOException {\r
-        _bufferedWriter.flush();\r
-    }\r
-    \r
-    public synchronized void close() throws IOException {\r
-        if (_stringWriter == null) {\r
-            writeFooter(_bufferedWriter);\r
-            _bufferedWriter.flush();\r
-            _bufferedWriter.close();\r
-        }\r
-    }\r
-    \r
-    \r
-    public boolean isClipSet() {\r
-        return _isClipSet;\r
-    }\r
-    \r
-    public void setClipSet(boolean isClipSet) {\r
-        _isClipSet = isClipSet;\r
-    }\r
-    \r
-    \r
-    private float minX;\r
-    private float minY;\r
-    private float maxX;\r
-    private float maxY;\r
-    \r
-    private boolean _isClipSet = false;\r
-\r
-    private String _title;\r
-    private StringWriter _stringWriter;\r
-    private BufferedWriter _bufferedWriter = null;\r
-    \r
-    // We need to remember which was the last EpsGraphics2D object to use\r
-    // us, as we need to replace the clipping region if another EpsGraphics2D\r
-    // object tries to use us.\r
-    private EpsGraphics2D _lastG = null;\r
-    \r
-}
\ No newline at end of file
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
+ * Copyright (C) 2015 The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+package org.jibble.epsgraphics;
+
+import jalview.util.MessageManager;
+
+import java.io.BufferedWriter;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.io.OutputStreamWriter;
+import java.io.StringWriter;
+import java.io.Writer;
+import java.util.Date;
+
+/**
+ * This represents an EPS document. Several EpsGraphics2D objects may point to
+ * the same EpsDocument.
+ * <p>
+ * Copyright Paul Mutton, <a
+ * href="http://www.jibble.org/">http://www.jibble.org/</a>
+ * 
+ */
+public class EpsDocument
+{
+
+  /**
+   * Constructs an empty EpsDevice.
+   */
+  public EpsDocument(String title)
+  {
+    _title = title;
+    minX = Float.POSITIVE_INFINITY;
+    minY = Float.POSITIVE_INFINITY;
+    maxX = Float.NEGATIVE_INFINITY;
+    maxY = Float.NEGATIVE_INFINITY;
+    _stringWriter = new StringWriter();
+    _bufferedWriter = new BufferedWriter(_stringWriter);
+  }
+
+  /**
+   * Constructs an empty EpsDevice that writes directly to a file. Bounds must
+   * be set before use.
+   */
+  public EpsDocument(String title, OutputStream outputStream, int minX,
+          int minY, int maxX, int maxY) throws IOException
+  {
+    _title = title;
+    this.minX = minX;
+    this.minY = minY;
+    this.maxX = maxX;
+    this.maxY = maxY;
+    _bufferedWriter = new BufferedWriter(new OutputStreamWriter(
+            outputStream));
+    write(_bufferedWriter);
+  }
+
+  /**
+   * Returns the title of the EPS document.
+   */
+  public synchronized String getTitle()
+  {
+    return _title;
+  }
+
+  /**
+   * Updates the bounds of the current EPS document.
+   */
+  public synchronized void updateBounds(double x, double y)
+  {
+    if (x > maxX)
+    {
+      maxX = (float) x;
+    }
+    if (x < minX)
+    {
+      minX = (float) x;
+    }
+    if (y > maxY)
+    {
+      maxY = (float) y;
+    }
+    if (y < minY)
+    {
+      minY = (float) y;
+    }
+  }
+
+  /**
+   * Appends a line to the EpsDocument. A new line character is added to the end
+   * of the line when it is added.
+   */
+  public synchronized void append(EpsGraphics2D g, String line)
+  {
+    if (_lastG == null)
+    {
+      _lastG = g;
+    }
+    else if (g != _lastG)
+    {
+      EpsGraphics2D lastG = _lastG;
+      _lastG = g;
+      // We are being drawn on with a different EpsGraphics2D context.
+      // We may need to update the clip, etc from this new context.
+      if (g.getClip() != lastG.getClip())
+      {
+        g.setClip(g.getClip());
+      }
+      if (!g.getColor().equals(lastG.getColor()))
+      {
+        g.setColor(g.getColor());
+      }
+      if (!g.getBackground().equals(lastG.getBackground()))
+      {
+        g.setBackground(g.getBackground());
+      }
+      // We don't need this, as this only affects the stroke and font,
+      // which are dealt with separately later on.
+      // if (!g.getTransform().equals(lastG.getTransform())) {
+      // g.setTransform(g.getTransform());
+      // }
+      if (!g.getPaint().equals(lastG.getPaint()))
+      {
+        g.setPaint(g.getPaint());
+      }
+      if (!g.getComposite().equals(lastG.getComposite()))
+      {
+        g.setComposite(g.getComposite());
+      }
+      if (!g.getComposite().equals(lastG.getComposite()))
+      {
+        g.setComposite(g.getComposite());
+      }
+      if (!g.getFont().equals(lastG.getFont()))
+      {
+        g.setFont(g.getFont());
+      }
+      if (!g.getStroke().equals(lastG.getStroke()))
+      {
+        g.setStroke(g.getStroke());
+      }
+    }
+    _lastG = g;
+
+    try
+    {
+      _bufferedWriter.write(line + "\n");
+    } catch (IOException e)
+    {
+      throw new EpsException(MessageManager.formatMessage(
+              "exception.eps_coudnt_write_output_file",
+              new String[] { e.getMessage() }));
+    }
+  }
+
+  /**
+   * Outputs the contents of the EPS document to the specified Writer, complete
+   * with headers and bounding box.
+   */
+  public synchronized void write(Writer writer) throws IOException
+  {
+    float offsetX = -minX;
+    float offsetY = -minY;
+
+    writer.write("%!PS-Adobe-3.0 EPSF-3.0\n");
+    writer.write("%%Creator: Jalview "
+            + jalview.bin.Cache.getProperty("VERSION") + " \n");
+    writer.write("%%Title: " + _title + "\n");
+    writer.write("%%CreationDate: " + new Date() + "\n");
+    writer.write("%%BoundingBox: 0 0 " + ((int) Math.ceil(maxX + offsetX))
+            + " " + ((int) Math.ceil(maxY + offsetY)) + "\n");
+    writer.write("%%DocumentData: Clean7Bit\n");
+    writer.write("%%DocumentProcessColors: Black\n");
+    writer.write("%%ColorUsage: Color\n");
+    writer.write("%%Origin: 0 0\n");
+    writer.write("%%Pages: 1\n");
+    writer.write("%%Page: 1 1\n");
+    writer.write("%%EndComments\n\n");
+
+    writer.write("gsave\n");
+
+    if (_stringWriter != null)
+    {
+      writer.write(offsetX + " " + (offsetY) + " translate\n");
+
+      _bufferedWriter.flush();
+      StringBuffer buffer = _stringWriter.getBuffer();
+      for (int i = 0; i < buffer.length(); i++)
+      {
+        writer.write(buffer.charAt(i));
+      }
+
+      writeFooter(writer);
+    }
+    else
+    {
+      writer.write(offsetX + " " + ((maxY - minY) - offsetY)
+              + " translate\n");
+    }
+
+    writer.flush();
+  }
+
+  private void writeFooter(Writer writer) throws IOException
+  {
+    writer.write("grestore\n");
+    if (isClipSet())
+    {
+      writer.write("grestore\n");
+    }
+    writer.write("showpage\n");
+    writer.write("\n");
+    writer.write("%%EOF");
+    writer.flush();
+  }
+
+  public synchronized void flush() throws IOException
+  {
+    _bufferedWriter.flush();
+  }
+
+  public synchronized void close() throws IOException
+  {
+    if (_stringWriter == null)
+    {
+      writeFooter(_bufferedWriter);
+      _bufferedWriter.flush();
+      _bufferedWriter.close();
+    }
+  }
+
+  public boolean isClipSet()
+  {
+    return _isClipSet;
+  }
+
+  public void setClipSet(boolean isClipSet)
+  {
+    _isClipSet = isClipSet;
+  }
+
+  private float minX;
+
+  private float minY;
+
+  private float maxX;
+
+  private float maxY;
+
+  private boolean _isClipSet = false;
+
+  private String _title;
+
+  private StringWriter _stringWriter;
+
+  private BufferedWriter _bufferedWriter = null;
+
+  // We need to remember which was the last EpsGraphics2D object to use
+  // us, as we need to replace the clipping region if another EpsGraphics2D
+  // object tries to use us.
+  private EpsGraphics2D _lastG = null;
+
+}