View Javadoc
1   // ******************************************************************************
2   //
3   // Title:       Force Field X.
4   // Description: Force Field X - Software for Molecular Biophysics.
5   // Copyright:   Copyright (c) Michael J. Schnieders 2001-2024.
6   //
7   // This file is part of Force Field X.
8   //
9   // Force Field X is free software; you can redistribute it and/or modify it
10  // under the terms of the GNU General Public License version 3 as published by
11  // the Free Software Foundation.
12  //
13  // Force Field X is distributed in the hope that it will be useful, but WITHOUT
14  // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15  // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16  // details.
17  //
18  // You should have received a copy of the GNU General Public License along with
19  // Force Field X; if not, write to the Free Software Foundation, Inc., 59 Temple
20  // Place, Suite 330, Boston, MA 02111-1307 USA
21  //
22  // Linking this library statically or dynamically with other modules is making a
23  // combined work based on this library. Thus, the terms and conditions of the
24  // GNU General Public License cover the whole combination.
25  //
26  // As a special exception, the copyright holders of this library give you
27  // permission to link this library with independent modules to produce an
28  // executable, regardless of the license terms of these independent modules, and
29  // to copy and distribute the resulting executable under terms of your choice,
30  // provided that you also meet, for each linked independent module, the terms
31  // and conditions of the license of that module. An independent module is a
32  // module which is not derived from or based on this library. If you modify this
33  // library, you may extend this exception to your version of the library, but
34  // you are not obligated to do so. If you do not wish to do so, delete this
35  // exception statement from your version.
36  //
37  // ******************************************************************************
38  package ffx.ui;
39  
40  import java.awt.BorderLayout;
41  import java.awt.Color;
42  import java.awt.GridLayout;
43  import java.io.Serial;
44  import javax.swing.JPanel;
45  
46  /**
47   * The GraphicsPanel class contains the 3D Canvas and its status box.
48   *
49   * @author Michael J. Schnieders
50   */
51  public class GraphicsPanel extends JPanel {
52  
53    @Serial
54    private static final long serialVersionUID = 1L;
55  
56    private final GraphicsCanvas graphicsCanvas;
57  
58    /**
59     * Constructor for GraphicsPanel.
60     *
61     * @param graphicsCanvas a {@link ffx.ui.GraphicsCanvas} object.
62     * @param statusPanel a {@link javax.swing.JPanel} object.
63     */
64    public GraphicsPanel(GraphicsCanvas graphicsCanvas, JPanel statusPanel) {
65      super();
66      setLayout(new BorderLayout());
67      if (graphicsCanvas != null) {
68        JPanel canvasPanel = new JPanel(new GridLayout(1, 1));
69        canvasPanel.add(graphicsCanvas);
70        add(canvasPanel, BorderLayout.CENTER);
71      } else {
72        setBackground(Color.BLACK);
73      }
74      add(statusPanel, BorderLayout.SOUTH);
75      this.graphicsCanvas = graphicsCanvas;
76    }
77  
78    /** {@inheritDoc} */
79    @Override
80    public void setVisible(boolean v) {
81      super.setVisible(v);
82      if (graphicsCanvas != null) {
83        graphicsCanvas.setVisible(v);
84      }
85    }
86  }