src/jalview/structure/StructureListener.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
   3  * Copyright (C) 2015 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.structure;
  22
  23 import jalview.datamodel.SequenceI;
  24
  25 import java.util.List;
  26
  27 public interface StructureListener
  28 {
  29   /**
  30    * Returns a list of structure files (unique IDs/filenames) that this listener
  31    * handles messages for, or null if generic listener (only used by
  32    * removeListener method)
  33    */
  34   public String[] getPdbFile();
  35
  36   /**
  37    * Called by StructureSelectionManager to inform viewer to highlight given
  38    * atom positions
  39    *
  40    * @param atoms
  41    */
  42   public void highlightAtoms(List<AtomSpec> atoms);
  43
  44   /**
  45    * Called by StructureSelectionManager when the colours of a sequence
  46    * associated with a structure have changed.
  47    *
  48    * @param source
  49    *          (untyped) usually an alignPanel
  50    */
  51   public void updateColours(Object source);
  52
  53   /**
  54    * Called by structureSelectionManager to instruct implementor to release any
  55    * direct references it may hold to the given object (typically, these are
  56    * Jalview alignment panels).
  57    *
  58    * @param svl
  59    */
  60   public void releaseReferences(Object svl);
  61
  62   /**
  63    * Answers true if this listener is interested in the given sequence
  64    *
  65    * @param seq
  66    * @return
  67    */
  68   public boolean isListeningFor(SequenceI seq);
  69 }