src/jalview/structure/StructureListener.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1)
   3  * Copyright (C) 2014 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 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  * The Jalview Authors are detailed in the 'AUTHORS' file.
  18  */
  19 package jalview.structure;
  20
  21 public interface StructureListener
  22 {
  23   /**
  24    *
  25    * @return list of structure files (unique IDs/filenames) that this listener
  26    *         handles messages for, or null if generic listener (only used by
  27    *         removeListener method)
  28    */
  29   public String[] getPdbFile();
  30
  31   /**
  32    * NOT A LISTENER METHOD! called by structure viewer when the given
  33    * atom/structure has been moused over. Typically, implementors call
  34    * StructureSelectionManager.mouseOverStructure
  35    *
  36    * @param atomIndex
  37    * @param strInfo
  38    */
  39   public void mouseOverStructure(int atomIndex, String strInfo);
  40
  41   /**
  42    * called by StructureSelectionManager to inform viewer to highlight given
  43    * atomspec
  44    *
  45    * @param atomIndex
  46    * @param pdbResNum
  47    * @param chain
  48    * @param pdbId
  49    */
  50   public void highlightAtom(int atomIndex, int pdbResNum, String chain,
  51           String pdbId);
  52
  53   /**
  54    * called by StructureSelectionManager when the colours of a sequence
  55    * associated with a structure have changed.
  56    *
  57    * @param source
  58    *          (untyped) usually an alignPanel
  59    */
  60   public void updateColours(Object source);
  61
  62   /**
  63    * called by Jalview to get the colour for the given atomspec
  64    *
  65    * @param atomIndex
  66    * @param pdbResNum
  67    * @param chain
  68    * @param pdbId
  69    * @return
  70    */
  71   public java.awt.Color getColour(int atomIndex, int pdbResNum,
  72           String chain, String pdbId);
  73
  74   /**
  75    * called by structureSelectionManager to instruct implementor to release any
  76    * direct references it may hold to the given object (typically, these are
  77    * Jalview alignment panels).
  78    *
  79    * @param svl
  80    */
  81   public void releaseReferences(Object svl);
  82 }