src/jalview/ext/treeviewer/ExternalTreeViewerBindingI.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.ext.treeviewer;
  22
  23 import jalview.datamodel.SequenceI;
  24 import jalview.structure.SelectionListener;
  25 import jalview.structure.SelectionSource;
  26
  27 import java.awt.event.ActionListener;
  28 import java.awt.event.MouseListener;
  29
  30 /**
  31  *
  32  * Interface for binding a tree viewer to Jalview alignments. Assumes a tree
  33  * viewer will both want to receive and send selection events. Note that this
  34  * will take anything as a TreeNode object as no assumptions can be made about
  35  * the inheritance structure of the TreeNode (besides being an Object).
  36  *
  37  * @author kjvanderheide
  38  *
  39  * @param <N>
  40  *          Tree node object.
  41  */
  42 public interface ExternalTreeViewerBindingI<N>
  43         extends ActionListener, MouseListener, SelectionListener,
  44         SelectionSource
  45 {
  46   /**
  47    * If a node is selected in the tree panel this method highlights the
  48    * corresponding sequence in the Jalview alignment view. If an internal node
  49    * is selected all child sequences get highlighted as well.
  50    */
  51   public void showNodeSelectionOnAlign(N node);
  52
  53   public void treeSelectionChanged(SequenceI sequence);
  54
  55   public void showMatchingSequence(N nodeToMatch);
  56
  57   public void showMatchingChildSequences(N parentNode);
  58
  59   public void sortByTree_actionPerformed();
  60
  61 }