2a807a3f5149f1279ea54b85ceb9ce144e1c639e
[jalview.git] / src / jalview / ext / archaeopteryx / 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.archaeopteryx;
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.MouseEvent;
29 import java.awt.event.MouseListener;
30
31 /**
32  * 
33  * Interface for binding a tree viewer to Jalview alignments. Assumes a tree
34  * viewer will both want to receive and send selection events.
35  * 
36  * @author kjvanderheide
37  *
38  * @param <N>
39  *          Tree node object.
40  */
41 interface ExternalTreeViewerBindingI<N>
42         extends ActionListener, MouseListener, SelectionListener,
43         SelectionSource
44 {
45   /**
46    * If a node is selected in the tree panel this method highlights the
47    * corresponding sequence in the Jalview alignment view. If an internal node
48    * is selected all child sequences get highlighted as well.
49    */
50   public void showNodeSelectionOnAlign(MouseEvent e);
51
52   public void treeSelectionChanged(SequenceI sequence);
53
54   public void showMatchingSequence(N nodeToMatch);
55
56   public void showMatchingChildSequences(N parentNode);
57
58 }