src/jalview/structure/StructureListener.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
   3  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 package jalview.structure;
  19
  20 public interface StructureListener
  21 {
  22   /**
  23    *
  24    * @return list of structure files (unique IDs/filenames) that this listener handles messages for, or null if generic listener (only used by removeListener method)
  25    */
  26   public String[] getPdbFile();
  27
  28   /**
  29    * NOT A LISTENER METHOD!
  30    * called by structure viewer when the given atom/structure has been moused over. Typically, implementors call StructureSelectionManager.mouseOverStructure
  31    * @param atomIndex
  32    * @param strInfo
  33    */
  34   public void mouseOverStructure(int atomIndex, String strInfo);
  35
  36   /**
  37    * called by StructureSelectionManager to inform viewer to highlight given atomspec
  38    * @param atomIndex
  39    * @param pdbResNum
  40    * @param chain
  41    * @param pdbId
  42    */
  43   public void highlightAtom(int atomIndex, int pdbResNum, String chain,
  44           String pdbId);
  45
  46   /**
  47    * called by StructureSelectionManager when the colours of a sequence associated with a structure have changed.
  48    * @param source (untyped) usually an alignPanel
  49    */
  50   public void updateColours(Object source);
  51
  52   /**
  53    * called by Jalview to get the colour for the given atomspec
  54    * @param atomIndex
  55    * @param pdbResNum
  56    * @param chain
  57    * @param pdbId
  58    * @return
  59    */
  60   public java.awt.Color getColour(int atomIndex, int pdbResNum,
  61           String chain, String pdbId);
  62
  63   /**
  64    * called by structureSelectionManager to instruct implementor to release any direct references it may hold to the given object (typically, these are Jalview alignment panels).
  65    * @param svl
  66    */
  67   public void releaseReferences(Object svl);
  68 }