JAL-3253 preliminary static fixes for JavaScript
[jalview.git] / src / jalview / gui / Desktop.java
index cd8330a..d2967d7 100644 (file)
@@ -20,8 +20,6 @@
  */
 package jalview.gui;
 
-import static jalview.util.UrlConstants.SEQUENCE_ID;
-
 import jalview.api.AlignViewportI;
 import jalview.api.AlignmentViewPanel;
 import jalview.bin.Cache;
@@ -134,26 +132,27 @@ import org.stackoverflowusers.file.WindowsShortcut;
  * @author $author$
  * @version $Revision: 1.155 $
  */
+@SuppressWarnings("serial")
 public class Desktop extends jalview.jbgui.GDesktop
         implements DropTargetListener, ClipboardOwner, IProgressIndicator,
         jalview.api.StructureSelectionManagerProvider
 {
-  private static int DEFAULT_MIN_WIDTH = 300;
+  private final static int DEFAULT_MIN_WIDTH = 300;
 
-  private static int DEFAULT_MIN_HEIGHT = 250;
+  private final static int DEFAULT_MIN_HEIGHT = 250;
 
-  private static int ALIGN_FRAME_DEFAULT_MIN_WIDTH = 600;
+  private final static int ALIGN_FRAME_DEFAULT_MIN_WIDTH = 600;
 
-  private static int ALIGN_FRAME_DEFAULT_MIN_HEIGHT = 70;
+  private final static int ALIGN_FRAME_DEFAULT_MIN_HEIGHT = 70;
 
-  private static final String EXPERIMENTAL_FEATURES = "EXPERIMENTAL_FEATURES";
+  private final static String EXPERIMENTAL_FEATURES = "EXPERIMENTAL_FEATURES";
 
   private JalviewChangeSupport changeSupport = new JalviewChangeSupport();
 
   /**
    * news reader - null if it was never started.
    */
-  private BlogReader jvnews = null;
+  BlogReader jvnews = null;
 
   private File projectFile;
 
@@ -192,16 +191,47 @@ public class Desktop extends jalview.jbgui.GDesktop
             listener);
   }
 
-  /** Singleton Desktop instance */
-  public static Desktop instance;
+  /**
+   * Singleton Desktop instance only in Java;
+   */
+  private static Desktop instance;
 
-  public static MyDesktopPane desktop;
+  public static Desktop getInstance()
+  {
+    Desktop d;
+    @SuppressWarnings("unused")
+    ThreadGroup g = Thread.currentThread().getThreadGroup();
+    /**
+     * @j2sNative d = g._jalviewDesktopInstance;
+     */
+    {
+      d = instance;
+    }
+    return d;
+  }
 
-  public static MyDesktopPane getDesktop()
+  private static void setInstance(Desktop d)
   {
-    // BH 2018 could use currentThread() here as a reference to a
-    // Hashtable<Thread, MyDesktopPane> in JavaScript
-    return desktop;
+    @SuppressWarnings("unused")
+    ThreadGroup g = Thread.currentThread().getThreadGroup();
+    /**
+     * @j2s g._jalviewDesktopInstance = d;
+     */
+    {
+      instance = d;
+    }
+  }
+
+  private MyDesktopPane desktopPane;
+
+  public static MyDesktopPane getDesktopPane()
+  {
+    return getInstance().desktopPane;
+  }
+
+  private void setDesktopPane(MyDesktopPane pane)
+  {
+    getInstance().desktopPane = pane;
   }
 
   static int openFrameCount = 0;
@@ -237,7 +267,7 @@ public class Desktop extends jalview.jbgui.GDesktop
       } catch (NullPointerException npe)
       {
         Point p = getMousePosition();
-        instance.showPasteMenu(p.x, p.y);
+        getInstance().showPasteMenu(p.x, p.y);
       }
     }
 
@@ -285,14 +315,14 @@ public class Desktop extends jalview.jbgui.GDesktop
     public void endDraggingFrame(JComponent f)
     {
       delegate.endDraggingFrame(f);
-      desktop.repaint();
+      getDesktopPane().repaint();
     }
 
     @Override
     public void endResizingFrame(JComponent f)
     {
       delegate.endResizingFrame(f);
-      desktop.repaint();
+      getDesktopPane().repaint();
     }
 
     @Override
@@ -352,7 +382,7 @@ public class Desktop extends jalview.jbgui.GDesktop
      * block are spawned off as threads rather than waited for during this
      * constructor.
      */
-    instance = this;
+    setInstance(this);
     if (!Platform.isJS())
     {
       doVamsasClientCheck();
@@ -365,10 +395,10 @@ public class Desktop extends jalview.jbgui.GDesktop
             false);
     boolean showjconsole = jalview.bin.Cache.getDefault("SHOW_JAVA_CONSOLE",
             false);
-    desktop = new MyDesktopPane(selmemusage);
+    setDesktopPane(new MyDesktopPane(selmemusage));
 
     showMemusage.setSelected(selmemusage);
-    desktop.setBackground(Color.white);
+    getDesktopPane().setBackground(Color.white);
     getContentPane().setLayout(new BorderLayout());
     // alternate config - have scrollbars - see notes in JAL-153
     // JScrollPane sp = new JScrollPane();
@@ -381,17 +411,17 @@ public class Desktop extends jalview.jbgui.GDesktop
       getRootPane().putClientProperty("swingjs.overflow.hidden", "false");
     }
 
-    getContentPane().add(desktop, BorderLayout.CENTER);
-    desktop.setDragMode(JDesktopPane.OUTLINE_DRAG_MODE);
+    getContentPane().add(getDesktopPane(), BorderLayout.CENTER);
+    getDesktopPane().setDragMode(JDesktopPane.OUTLINE_DRAG_MODE);
 
     // This line prevents Windows Look&Feel resizing all new windows to maximum
     // if previous window was maximised
-    desktop.setDesktopManager(new MyDesktopManager(
+    getDesktopPane().setDesktopManager(new MyDesktopManager(
             (Platform.isWindowsAndNotJS() ? new DefaultDesktopManager()
                     : Platform.isAMacAndNotJS()
                             ? new AquaInternalFrameManager(
-                                    desktop.getDesktopManager())
-                            : desktop.getDesktopManager())));
+                                    getDesktopPane().getDesktopManager())
+                            : getDesktopPane().getDesktopManager())));
 
     Rectangle dims = getLastKnownDimensions("");
     if (dims != null)
@@ -480,7 +510,7 @@ public class Desktop extends jalview.jbgui.GDesktop
 
     }
 
-    this.setDropTarget(new java.awt.dnd.DropTarget(desktop, this));
+    this.setDropTarget(new java.awt.dnd.DropTarget(getDesktopPane(), this));
 
     this.addWindowListener(new WindowAdapter()
     {
@@ -512,7 +542,7 @@ public class Desktop extends jalview.jbgui.GDesktop
         }
       }
     });
-    desktop.addMouseListener(ma);
+    getDesktopPane().addMouseListener(ma);
 
   }
 
@@ -577,10 +607,10 @@ public class Desktop extends jalview.jbgui.GDesktop
       public void run()
       {
         Cache.log.debug("Downloading data from identifiers.org");
-        UrlDownloadClient client = new UrlDownloadClient();
+        // UrlDownloadClient client = new UrlDownloadClient();
         try
         {
-          client.download(IdOrgSettings.getUrl(),
+          UrlDownloadClient.download(IdOrgSettings.getUrl(),
                   IdOrgSettings.getDownloadLocation());
         } catch (IOException e)
         {
@@ -598,7 +628,7 @@ public class Desktop extends jalview.jbgui.GDesktop
     showNews(showNews.isSelected());
   }
 
-  void showNews(boolean visible)
+  protected void showNews(boolean visible)
   {
     Cache.log.debug((visible ? "Showing" : "Hiding") + " news.");
     showNews.setSelected(visible);
@@ -610,10 +640,10 @@ public class Desktop extends jalview.jbgui.GDesktop
         public void run()
         {
           long now = System.currentTimeMillis();
-          Desktop.instance.setProgressBar(
+          Desktop.getInstance().setProgressBar(
                   MessageManager.getString("status.refreshing_news"), now);
           jvnews.refreshNews();
-          Desktop.instance.setProgressBar(null, now);
+          Desktop.getInstance().setProgressBar(null, now);
           jvnews.showNews();
         }
       }).start();
@@ -718,7 +748,7 @@ public class Desktop extends jalview.jbgui.GDesktop
     }
   }
 
-  void showPasteMenu(int x, int y)
+  protected void showPasteMenu(int x, int y)
   {
     JPopupMenu popup = new JPopupMenu();
     JMenuItem item = new JMenuItem(
@@ -860,8 +890,7 @@ public class Desktop extends jalview.jbgui.GDesktop
     // A HEADLESS STATE WHEN NO DESKTOP EXISTS. MUST RETURN
     // IF JALVIEW IS RUNNING HEADLESS
     // ///////////////////////////////////////////////
-    if (instance == null || (System.getProperty("java.awt.headless") != null
-            && System.getProperty("java.awt.headless").equals("true")))
+    if (instance == null || Jalview.isHeadlessMode())
     {
       return;
     }
@@ -901,13 +930,13 @@ public class Desktop extends jalview.jbgui.GDesktop
      * add an entry for the new frame in the Window menu 
      * (and remove it when the frame is closed)
      */
-    final JMenuItem menuItem = new JMenuItem(title);
+    JMenuItem menuItem = new JMenuItem(title);
     frame.addInternalFrameListener(new InternalFrameAdapter()
     {
       @Override
       public void internalFrameActivated(InternalFrameEvent evt)
       {
-        JInternalFrame itf = desktop.getSelectedFrame();
+        JInternalFrame itf = getDesktopPane().getSelectedFrame();
         if (itf != null)
         {
           if (itf instanceof AlignFrame)
@@ -939,7 +968,7 @@ public class Desktop extends jalview.jbgui.GDesktop
         {
           menuItem.removeActionListener(menuItem.getActionListeners()[0]);
         }
-        windowMenu.remove(menuItem);
+        getInstance().windowMenu.remove(menuItem);
       };
     });
 
@@ -961,9 +990,9 @@ public class Desktop extends jalview.jbgui.GDesktop
 
     setKeyBindings(frame);
 
-    desktop.add(frame);
+    getDesktopPane().add(frame);
 
-    windowMenu.add(menuItem);
+    getInstance().windowMenu.add(menuItem);
 
     frame.toFront();
     try
@@ -988,7 +1017,6 @@ public class Desktop extends jalview.jbgui.GDesktop
    */
   private static void setKeyBindings(JInternalFrame frame)
   {
-    @SuppressWarnings("serial")
     final Action closeAction = new AbstractAction()
     {
       @Override
@@ -1256,7 +1284,8 @@ public class Desktop extends jalview.jbgui.GDesktop
           {
             String msg = MessageManager
                     .formatMessage("label.couldnt_locate", url);
-            JvOptionPane.showInternalMessageDialog(Desktop.desktop, msg,
+            JvOptionPane.showInternalMessageDialog(Desktop.getDesktopPane(),
+                    msg,
                     MessageManager.getString("label.url_not_found"),
                     JvOptionPane.WARNING_MESSAGE);
 
@@ -1277,7 +1306,8 @@ public class Desktop extends jalview.jbgui.GDesktop
     };
     String dialogOption = MessageManager
             .getString("label.input_alignment_from_url");
-    JvOptionPane.newOptionDialog(desktop).setResponseHandler(0, action)
+    JvOptionPane.newOptionDialog(getDesktopPane())
+            .setResponseHandler(0, action)
             .showInternalDialog(panel, dialogOption,
                     JvOptionPane.YES_NO_CANCEL_OPTION,
                     JvOptionPane.PLAIN_MESSAGE, null, options,
@@ -1363,7 +1393,7 @@ public class Desktop extends jalview.jbgui.GDesktop
   public void aboutMenuItem_actionPerformed(ActionEvent e)
   {
     // StringBuffer message = getAboutMessage(false);
-    // JvOptionPane.showInternalMessageDialog(Desktop.desktop,
+    // JvOptionPane.showInternalMessageDialog(Desktop.getDesktop(),
     //
     // message.toString(), "About Jalview", JvOptionPane.INFORMATION_MESSAGE);
     new Thread(new Runnable()
@@ -1473,7 +1503,7 @@ public class Desktop extends jalview.jbgui.GDesktop
   public void closeAll_actionPerformed(ActionEvent e)
   {
     // TODO show a progress bar while closing?
-    JInternalFrame[] frames = desktop.getAllFrames();
+    JInternalFrame[] frames = getDesktopPane().getAllFrames();
     for (int i = 0; i < frames.length; i++)
     {
       try
@@ -1544,7 +1574,7 @@ public class Desktop extends jalview.jbgui.GDesktop
   @Override
   protected void showMemusage_actionPerformed(ActionEvent e)
   {
-    desktop.showMemoryUsage(showMemusage.isSelected());
+    getDesktopPane().showMemoryUsage(showMemusage.isSelected());
   }
 
   /*
@@ -1581,7 +1611,7 @@ public class Desktop extends jalview.jbgui.GDesktop
 
   void reorderAssociatedWindows(boolean minimize, boolean close)
   {
-    JInternalFrame[] frames = desktop.getAllFrames();
+    JInternalFrame[] frames = getDesktopPane().getAllFrames();
     if (frames == null || frames.length < 1)
     {
       return;
@@ -1765,7 +1795,7 @@ public class Desktop extends jalview.jbgui.GDesktop
     saveState_actionPerformed(true);
   }
 
-  private void setProjectFile(File choice)
+  protected void setProjectFile(File choice)
   {
     this.projectFile = choice;
   }
@@ -1815,7 +1845,7 @@ public class Desktop extends jalview.jbgui.GDesktop
                {
                  Cache.log.error(
                          "Problems whilst loading project from " + choice, ex);
-                 JvOptionPane.showMessageDialog(Desktop.desktop,
+              JvOptionPane.showMessageDialog(Desktop.getDesktopPane(),
                          MessageManager.formatMessage(
                                  "label.error_whilst_loading_project_from",
                                new Object[]
@@ -1925,7 +1955,7 @@ public class Desktop extends jalview.jbgui.GDesktop
    */
   public static AlignmentPanel[] getAlignmentPanels(String alignmentId)
   {
-    if (Desktop.desktop == null)
+    if (Desktop.getDesktopPane() == null)
     {
       // no frames created and in headless mode
       // TODO: verify that frames are recoverable when in headless mode
@@ -1967,7 +1997,7 @@ public class Desktop extends jalview.jbgui.GDesktop
   public static AlignmentViewport[] getViewports(String sequenceSetId)
   {
     List<AlignmentViewport> viewp = new ArrayList<>();
-    if (desktop != null)
+    if (getDesktopPane() != null)
     {
       AlignFrame[] frames = Desktop.getAlignFrames();
 
@@ -2053,7 +2083,7 @@ public class Desktop extends jalview.jbgui.GDesktop
   {
     source.viewport.setGatherViewsHere(true);
     source.viewport.setExplodedGeometry(source.getBounds());
-    JInternalFrame[] frames = desktop.getAllFrames();
+    JInternalFrame[] frames = getDesktopPane().getAllFrames();
     String viewId = source.viewport.getSequenceSetId();
 
     for (int t = 0; t < frames.length; t++)
@@ -2110,7 +2140,7 @@ public class Desktop extends jalview.jbgui.GDesktop
         String fle = chooser.getSelectedFile().toString();
         if (!vamsasImport(chooser.getSelectedFile()))
         {
-          JvOptionPane.showInternalMessageDialog(Desktop.desktop,
+          JvOptionPane.showInternalMessageDialog(Desktop.getDesktopPane(),
                   MessageManager.formatMessage(
                           "label.couldnt_import_as_vamsas_session",
                           new Object[]
@@ -2411,7 +2441,7 @@ public class Desktop extends jalview.jbgui.GDesktop
         removeProgressPanel(progpanel);
         if (warnmsg != null)
         {
-          JvOptionPane.showInternalMessageDialog(Desktop.desktop,
+          JvOptionPane.showInternalMessageDialog(Desktop.getDesktopPane(),
 
                   warnmsg, warnttl, JvOptionPane.ERROR_MESSAGE);
         }
@@ -2448,7 +2478,7 @@ public class Desktop extends jalview.jbgui.GDesktop
 
   public JInternalFrame[] getAllFrames()
   {
-    return desktop.getAllFrames();
+    return getDesktopPane().getAllFrames();
   }
 
   /**
@@ -2487,7 +2517,7 @@ public class Desktop extends jalview.jbgui.GDesktop
           while (li.hasNext())
           {
             String link = li.next();
-            if (link.contains(SEQUENCE_ID)
+            if (link.contains(UrlConstants.SEQUENCE_ID)
                     && !UrlConstants.isDefaultString(link))
             {
               check = true;
@@ -2534,7 +2564,7 @@ public class Desktop extends jalview.jbgui.GDesktop
           });
           msgPanel.add(jcb);
 
-          JvOptionPane.showMessageDialog(Desktop.desktop, msgPanel,
+          JvOptionPane.showMessageDialog(Desktop.getDesktopPane(), msgPanel,
                   MessageManager
                           .getString("label.SEQUENCE_ID_no_longer_used"),
                   JvOptionPane.WARNING_MESSAGE);
@@ -2649,11 +2679,11 @@ public class Desktop extends jalview.jbgui.GDesktop
   {
     if (Jalview.isHeadlessMode())
     {
-      // Desktop.desktop is null in headless mode
-      return new AlignFrame[] { Jalview.currentAlignFrame };
+      // Desktop.getDesktop() is null in headless mode
+      return new AlignFrame[] { Jalview.getCurrentAlignFrame() };
     }
 
-    JInternalFrame[] frames = Desktop.desktop.getAllFrames();
+    JInternalFrame[] frames = Desktop.getDesktopPane().getAllFrames();
 
     if (frames == null)
     {
@@ -2698,7 +2728,7 @@ public class Desktop extends jalview.jbgui.GDesktop
    */
   public GStructureViewer[] getJmols()
   {
-    JInternalFrame[] frames = Desktop.desktop.getAllFrames();
+    JInternalFrame[] frames = Desktop.getDesktopPane().getAllFrames();
 
     if (frames == null)
     {
@@ -2734,7 +2764,7 @@ public class Desktop extends jalview.jbgui.GDesktop
     } catch (Exception ex)
     {
       jalview.bin.Cache.log.error("Groovy Shell Creation failed.", ex);
-      JvOptionPane.showInternalMessageDialog(Desktop.desktop,
+      JvOptionPane.showInternalMessageDialog(Desktop.getDesktopPane(),
 
               MessageManager.getString("label.couldnt_create_groovy_shell"),
               MessageManager.getString("label.groovy_support_failed"),
@@ -2745,7 +2775,7 @@ public class Desktop extends jalview.jbgui.GDesktop
   /**
    * Open the Groovy console
    */
-  void openGroovyConsole()
+  private void openGroovyConsole()
   {
     if (groovyConsole == null)
     {
@@ -2931,7 +2961,7 @@ public class Desktop extends jalview.jbgui.GDesktop
    */
   public static AlignFrame getAlignFrameFor(AlignViewportI viewport)
   {
-    if (desktop != null)
+    if (getDesktopPane() != null)
     {
       AlignmentPanel[] aps = getAlignmentPanels(
               viewport.getSequenceSetId());
@@ -2993,7 +3023,7 @@ public class Desktop extends jalview.jbgui.GDesktop
       if (discoverer == null)
       {
         discoverer = new jalview.ws.jws1.Discoverer();
-        // register PCS handler for desktop.
+        // register PCS handler for getDesktop().
         discoverer.addPropertyChangeListener(changeSupport);
       }
       // JAL-940 - disabled JWS1 service configuration - always start discoverer
@@ -3075,7 +3105,7 @@ public class Desktop extends jalview.jbgui.GDesktop
                  * 
                  * jd.waitForInput();
                  */
-                JvOptionPane.showConfirmDialog(Desktop.desktop,
+                JvOptionPane.showConfirmDialog(Desktop.getDesktopPane(),
                         new JLabel("<html><table width=\"450\"><tr><td>"
                                 + ermsg + "</td></tr></table>"
                                 + "<p>It may be that you have invalid JABA URLs<br/>in your web service preferences,"
@@ -3101,7 +3131,7 @@ public class Desktop extends jalview.jbgui.GDesktop
     }
   }
 
-  private Runnable serviceChangedDialog = null;
+  Runnable serviceChangedDialog = null;
 
   /**
    * start a thread to open a URL in the configured browser. Pops up a warning
@@ -3112,7 +3142,7 @@ public class Desktop extends jalview.jbgui.GDesktop
    */
   public static void showUrl(final String url)
   {
-    showUrl(url, Desktop.instance);
+    showUrl(url, Desktop.getInstance());
   }
 
   /**
@@ -3141,7 +3171,7 @@ public class Desktop extends jalview.jbgui.GDesktop
           jalview.util.BrowserLauncher.openURL(url);
         } catch (Exception ex)
         {
-          JvOptionPane.showInternalMessageDialog(Desktop.desktop,
+          JvOptionPane.showInternalMessageDialog(Desktop.getDesktopPane(),
                   MessageManager
                           .getString("label.web_browser_not_found_unix"),
                   MessageManager.getString("label.web_browser_not_found"),
@@ -3157,15 +3187,16 @@ public class Desktop extends jalview.jbgui.GDesktop
     }).start();
   }
 
-  public static WsParamSetManager wsparamManager = null;
+  private WsParamSetManager wsparamManager = null;
 
   public static ParamManager getUserParameterStore()
   {
-    if (wsparamManager == null)
+    Desktop d = getInstance();
+    if (d.wsparamManager == null)
     {
-      wsparamManager = new WsParamSetManager();
+      d.wsparamManager = new WsParamSetManager();
     }
-    return wsparamManager;
+    return d.wsparamManager;
   }
 
   /**
@@ -3210,12 +3241,12 @@ public class Desktop extends jalview.jbgui.GDesktop
   /**
    * flag indicating if dialogExecutor should try to acquire a permit
    */
-  private volatile boolean dialogPause = true;
+  volatile boolean dialogPause = true;
 
   /**
    * pause the queue
    */
-  private java.util.concurrent.Semaphore block = new Semaphore(0);
+  java.util.concurrent.Semaphore block = new Semaphore(0);
 
   private static groovy.ui.Console groovyConsole;
 
@@ -3241,7 +3272,7 @@ public class Desktop extends jalview.jbgui.GDesktop
           }
           ;
         }
-        if (instance == null)
+        if (getInstance() == null)
         {
           return;
         }
@@ -3405,7 +3436,7 @@ public class Desktop extends jalview.jbgui.GDesktop
     String topViewId = myTopFrame.viewport.getSequenceSetId();
     String bottomViewId = myBottomFrame.viewport.getSequenceSetId();
 
-    JInternalFrame[] frames = desktop.getAllFrames();
+    JInternalFrame[] frames = getDesktopPane().getAllFrames();
     for (JInternalFrame frame : frames)
     {
       if (frame instanceof SplitFrame && frame != source)
@@ -3468,6 +3499,7 @@ public class Desktop extends jalview.jbgui.GDesktop
    *          - the payload from the drop event
    * @throws Exception
    */
+  @SuppressWarnings("unchecked")
   public static void transferFromDropTarget(List<Object> files,
           List<DataSourceType> protocols, DropTargetDropEvent evt,
           Transferable t) throws Exception
@@ -3538,7 +3570,7 @@ public class Desktop extends jalview.jbgui.GDesktop
     {
       // Works on Windows and MacOSX
       Cache.log.debug("Drop handled as javaFileListFlavor");
-      for (Object file : (List) t
+      for (Object file : (List<Object>) t
               .getTransferData(DataFlavor.javaFileListFlavor))
       {
         files.add(file);
@@ -3702,7 +3734,7 @@ public class Desktop extends jalview.jbgui.GDesktop
           Class<? extends StructureViewerBase> structureViewerClass)
   {
     List<StructureViewerBase> result = new ArrayList<>();
-    JInternalFrame[] frames = Desktop.instance.getAllFrames();
+    JInternalFrame[] frames = Desktop.getInstance().getAllFrames();
 
     for (JInternalFrame frame : frames)
     {
@@ -3721,4 +3753,5 @@ public class Desktop extends jalview.jbgui.GDesktop
     }
     return result;
   }
+
 }