src/jalview/structure/StructureListener.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.structure;
  22
  23 import java.util.List;
  24
  25 public interface StructureListener
  26 {
  27   /**
  28    * Returns a list of structure files (unique IDs/filenames) that this listener
  29    * handles messages for, or null if generic listener (only used by
  30    * removeListener method)
  31    */
  32   public String[] getPdbFile();
  33
  34   /**
  35    * Called by StructureSelectionManager to inform viewer to highlight given
  36    * atom positions
  37    *
  38    * @param atoms
  39    */
  40   public void highlightAtoms(List<AtomSpec> atoms);
  41
  42   /**
  43    * Called by StructureSelectionManager when the colours of a sequence
  44    * associated with a structure have changed.
  45    *
  46    * @param source
  47    *          (untyped) usually an alignPanel
  48    */
  49   public void updateColours(Object source);
  50
  51   /**
  52    * Called by structureSelectionManager to instruct implementor to release any
  53    * direct references it may hold to the given object (typically, these are
  54    * Jalview alignment panels).
  55    *
  56    * @param svl
  57    */
  58   public void releaseReferences(Object svl);
  59 }