JAL-3814 NONEWS property
[jalview.git] / src / jalview / gui / JalviewChimeraBindingModel.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
7  * Jalview is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License 
9  * as published by the Free Software Foundation, either version 3
10  * of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  */
21 package jalview.gui;
22
23 import jalview.api.AlignmentViewPanel;
24 import jalview.api.structures.JalviewStructureDisplayI;
25 import jalview.datamodel.PDBEntry;
26 import jalview.datamodel.SequenceI;
27 import jalview.ext.rbvi.chimera.JalviewChimeraBinding;
28 import jalview.io.DataSourceType;
29 import jalview.structure.StructureSelectionManager;
30 import jalview.viewmodel.seqfeatures.FeatureRendererModel;
31
32 import javax.swing.SwingUtilities;
33
34 public class JalviewChimeraBindingModel extends JalviewChimeraBinding
35 {
36   private ChimeraViewFrame cvf;
37
38   public JalviewChimeraBindingModel(ChimeraViewFrame chimeraViewFrame,
39           StructureSelectionManager ssm, PDBEntry[] pdbentry,
40           SequenceI[][] sequenceIs, DataSourceType protocol)
41   {
42     super(ssm, pdbentry, sequenceIs, protocol);
43     cvf = chimeraViewFrame;
44   }
45
46   @Override
47   public FeatureRendererModel getFeatureRenderer(AlignmentViewPanel alignment)
48   {
49     AlignmentPanel ap = (alignment == null) ? cvf.getAlignmentPanel()
50             : (AlignmentPanel) alignment;
51     if (ap.av.isShowSequenceFeatures())
52     {
53       return ap.getSeqPanel().seqCanvas.fr;
54     }
55
56     return null;
57   }
58
59   @Override
60   public jalview.api.SequenceRenderer getSequenceRenderer(
61           AlignmentViewPanel alignment)
62   {
63     return new SequenceRenderer(((AlignmentPanel) alignment).av);
64   }
65
66   @Override
67   public void refreshGUI()
68   {
69     javax.swing.SwingUtilities.invokeLater(new Runnable()
70     {
71       @Override
72       public void run()
73       {
74         cvf.updateTitleAndMenus();
75         cvf.revalidate();
76       }
77     });
78   }
79
80   @Override
81   public void updateColours(Object source)
82   {
83     AlignmentPanel ap = (AlignmentPanel) source;
84     // ignore events from panels not used to colour this view
85     if (!cvf.isUsedforcolourby(ap))
86     {
87       return;
88     }
89     if (!isLoadingFromArchive())
90     {
91       colourBySequence(ap);
92     }
93   }
94
95   @Override
96   public void releaseReferences(Object svl)
97   {
98   }
99
100   @Override
101   protected void releaseUIResources()
102   {
103   }
104
105   @Override
106   public void refreshPdbEntries()
107   {
108   }
109
110   /**
111    * Send an asynchronous command to Chimera, in a new thread, optionally with
112    * an 'in progress' message in a progress bar somewhere
113    */
114   @Override
115   protected void sendAsynchronousCommand(final String command,
116           final String progressMsg)
117   {
118     final long handle = progressMsg == null ? 0
119             : cvf.startProgressBar(progressMsg);
120     SwingUtilities.invokeLater(new Runnable()
121     {
122       @Override
123       public void run()
124       {
125         try
126         {
127           sendChimeraCommand(command, false);
128         } finally
129         {
130           if (progressMsg != null)
131           {
132             cvf.stopProgressBar(null, handle);
133           }
134         }
135       }
136     });
137   }
138
139   @Override
140   public JalviewStructureDisplayI getViewer()
141   {
142     return cvf;
143   }
144 }