src/jalview/gui/AquaInternalFrameManager.java

   1 /*
   2  * Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25
  26 package jalview.gui;
  27
  28 import java.awt.Container;
  29 import java.beans.PropertyVetoException;
  30 import java.util.Vector;
  31
  32 import javax.swing.DefaultDesktopManager;
  33 import javax.swing.DesktopManager;
  34 import javax.swing.JInternalFrame;
  35
  36 /**
  37  * Based on AquaInternalFrameManager
  38  *
  39  * DesktopManager implementation for Aqua
  40  *
  41  * Mac is more like Windows than it's like Motif/Basic
  42  *
  43  * From WindowsDesktopManager:
  44  *
  45  * This class implements a DesktopManager which more closely follows the MDI
  46  * model than the DefaultDesktopManager. Unlike the DefaultDesktopManager
  47  * policy, MDI requires that the selected and activated child frames are the
  48  * same, and that that frame always be the top-most window.
  49  * <p>
  50  * The maximized state is managed by the DesktopManager with MDI, instead of
  51  * just being a property of the individual child frame. This means that if the
  52  * currently selected window is maximized and another window is selected, that
  53  * new window will be maximized.
  54  *
  55  * Downloaded from
  56  * https://raw.githubusercontent.com/frohoff/jdk8u-jdk/master/src/macosx/classes/com/apple/laf/AquaInternalFrameManager.java
  57  *
  58  * Patch from Jim Procter - when the most recently opened frame is closed,
  59  * correct behaviour is to go to the next most recent frame, rather than wrap
  60  * around to the bottom of the window stack (as the original implementation
  61  * does)
  62  *
  63  * see com.sun.java.swing.plaf.windows.WindowsDesktopManager
  64  */
  65 public class AquaInternalFrameManager extends DefaultDesktopManager
  66 {
  67   // Variables
  68
  69   /* The frame which is currently selected/activated.
  70    * We store this value to enforce Mac's single-selection model.
  71    */
  72   JInternalFrame fCurrentFrame;
  73
  74   JInternalFrame fInitialFrame;
  75
  76   /* The list of frames, sorted by order of creation.
  77    * This list is necessary because by default the order of
  78    * child frames in the JDesktopPane changes during frame
  79    * activation (the activated frame is moved to index 0).
  80    * We preserve the creation order so that "next" and "previous"
  81    * frame actions make sense.
  82    */
  83   Vector<JInternalFrame> fChildFrames = new Vector<>(1);
  84
  85   /**
  86    * keep a reference to the original LAF manager so we can iconise/de-iconise
  87    * correctly
  88    */
  89   private DesktopManager ourManager;
  90
  91   public AquaInternalFrameManager(DesktopManager desktopManager)
  92   {
  93     ourManager = desktopManager;
  94   }
  95
  96   @Override
  97   public void closeFrame(final JInternalFrame f)
  98   {
  99     if (f == fCurrentFrame)
 100     {
 101       boolean mostRecentFrame = fChildFrames
 102               .indexOf(f) == fChildFrames.size() - 1;
 103       if (!mostRecentFrame)
 104       {
 105         activateNextFrame();
 106       }
 107       else
 108       {
 109         activatePreviousFrame();
 110       }
 111     }
 112     fChildFrames.removeElement(f);
 113     super.closeFrame(f);
 114   }
 115
 116   @Override
 117   public void deiconifyFrame(final JInternalFrame f)
 118   {
 119     JInternalFrame.JDesktopIcon desktopIcon;
 120
 121     desktopIcon = f.getDesktopIcon();
 122     // If the icon moved, move the frame to that spot before expanding it
 123     // reshape does delta checks for us
 124     f.reshape(desktopIcon.getX(), desktopIcon.getY(), f.getWidth(),
 125             f.getHeight());
 126     ourManager.deiconifyFrame(f);
 127   }
 128
 129   void addIcon(final Container c,
 130           final JInternalFrame.JDesktopIcon desktopIcon)
 131   {
 132     c.add(desktopIcon);
 133   }
 134
 135   /**
 136    * Removes the frame from its parent and adds its desktopIcon to the parent.
 137    */
 138   @Override
 139   public void iconifyFrame(final JInternalFrame f)
 140   {
 141     ourManager.iconifyFrame(f);
 142   }
 143
 144   // WindowsDesktopManager code
 145   @Override
 146   public void activateFrame(final JInternalFrame f)
 147   {
 148     try
 149     {
 150       if (f != null)
 151       {
 152         super.activateFrame(f);
 153       }
 154
 155       // If this is the first activation, add to child list.
 156       if (fChildFrames.indexOf(f) == -1)
 157       {
 158         fChildFrames.addElement(f);
 159       }
 160
 161       if (fCurrentFrame != null && f != fCurrentFrame)
 162       {
 163         if (fCurrentFrame.isSelected())
 164         {
 165           fCurrentFrame.setSelected(false);
 166         }
 167       }
 168
 169       if (f != null && !f.isSelected())
 170       {
 171         f.setSelected(true);
 172       }
 173
 174       fCurrentFrame = f;
 175     } catch (final PropertyVetoException e)
 176     {
 177     }
 178   }
 179
 180   private void switchFrame(final boolean next)
 181   {
 182     if (fCurrentFrame == null)
 183     {
 184       // initialize first frame we find
 185       if (fInitialFrame != null)
 186       {
 187         activateFrame(fInitialFrame);
 188       }
 189       return;
 190     }
 191
 192     final int count = fChildFrames.size();
 193     if (count <= 1)
 194     {
 195       // No other child frames.
 196       return;
 197     }
 198
 199     final int currentIndex = fChildFrames.indexOf(fCurrentFrame);
 200     if (currentIndex == -1)
 201     {
 202       // the "current frame" is no longer in the list
 203       fCurrentFrame = null;
 204       return;
 205     }
 206
 207     int nextIndex;
 208     if (next)
 209     {
 210       nextIndex = currentIndex + 1;
 211       if (nextIndex == count)
 212       {
 213         nextIndex = 0;
 214       }
 215     }
 216     else
 217     {
 218       nextIndex = currentIndex - 1;
 219       if (nextIndex == -1)
 220       {
 221         nextIndex = count - 1;
 222       }
 223     }
 224     final JInternalFrame f = fChildFrames.elementAt(nextIndex);
 225     activateFrame(f);
 226     fCurrentFrame = f;
 227   }
 228
 229   /**
 230    * Activate the next child JInternalFrame, as determined by the frames'
 231    * Z-order. If there is only one child frame, it remains activated. If there
 232    * are no child frames, nothing happens.
 233    */
 234   public void activateNextFrame()
 235   {
 236     switchFrame(true);
 237   }
 238
 239   /**
 240    * same as above but will activate a frame if none have been selected
 241    */
 242   public void activateNextFrame(final JInternalFrame f)
 243   {
 244     fInitialFrame = f;
 245     switchFrame(true);
 246   }
 247
 248   /**
 249    * Activate the previous child JInternalFrame, as determined by the frames'
 250    * Z-order. If there is only one child frame, it remains activated. If there
 251    * are no child frames, nothing happens.
 252    */
 253   public void activatePreviousFrame()
 254   {
 255     switchFrame(false);
 256   }
 257 }