src/jalview/structure/SequenceListener.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 jalview.datamodel.SearchResultsI;
  24 import jalview.datamodel.SequenceI;
  25
  26 public interface SequenceListener
  27 {
  28   // TODO remove this? never called on SequenceListener type
  29   public void mouseOverSequence(SequenceI sequence, int index, int pos);
  30
  31   /**
  32    * Highlights any position(s) represented by the search results and
  33    * (optionally) returns an informative message about the position(s)
  34    * higlighted
  35    *
  36    * @param results
  37    * @return
  38    */
  39   public String highlightSequence(SearchResultsI results);
  40
  41   // TODO remove this? never called
  42   public void updateColours(SequenceI sequence, int index);
  43
  44   public VamsasSource getVamsasSource();
  45
  46 }