X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fstructure%2FStructureListener.java;h=e5c5d04f68367cb13d87cbb625466c6c7eaef2c7;hb=4d7f98a6dd54d9863ba449ec79dcd95d25ed863d;hp=5ceefd3f0c04fcc295b99c75ef286bc9f182229f;hpb=797df64fa2a0a30773d0f48f5494d4155e5a8be3;p=jalview.git diff --git a/src/jalview/structure/StructureListener.java b/src/jalview/structure/StructureListener.java index 5ceefd3..e5c5d04 100644 --- a/src/jalview/structure/StructureListener.java +++ b/src/jalview/structure/StructureListener.java @@ -1,68 +1,69 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7) - * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors * * This file is part of Jalview. * * Jalview is free software: you can redistribute it and/or * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. - * + * as published by the Free Software Foundation, either version 3 + * of the License, or (at your option) any later version. + * * Jalview is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty * of MERCHANTABILITY or FITNESS FOR A PARTICULAR * PURPOSE. See the GNU General Public License for more details. * - * You should have received a copy of the GNU General Public License along with Jalview. If not, see . + * You should have received a copy of the GNU General Public License + * along with Jalview. If not, see . + * The Jalview Authors are detailed in the 'AUTHORS' file. */ package jalview.structure; +import jalview.datamodel.SequenceI; + +import java.util.List; + public interface StructureListener { /** - * - * @return list of structure files (unique IDs/filenames) that this listener handles messages for, or null if generic listener (only used by removeListener method) + * Returns a list of structure files (unique IDs/filenames) that this listener + * handles messages for, or null if generic listener (only used by + * removeListener method) */ public String[] getPdbFile(); /** - * NOT A LISTENER METHOD! - * called by structure viewer when the given atom/structure has been moused over. Typically, implementors call StructureSelectionManager.mouseOverStructure - * @param atomIndex - * @param strInfo - */ - public void mouseOverStructure(int atomIndex, String strInfo); - - /** - * called by StructureSelectionManager to inform viewer to highlight given atomspec - * @param atomIndex - * @param pdbResNum - * @param chain - * @param pdbId + * Called by StructureSelectionManager to inform viewer to highlight given + * atom positions + * + * @param atoms */ - public void highlightAtom(int atomIndex, int pdbResNum, String chain, - String pdbId); + public void highlightAtoms(List atoms); /** - * called by StructureSelectionManager when the colours of a sequence associated with a structure have changed. - * @param source (untyped) usually an alignPanel + * Called by StructureSelectionManager when the colours of a sequence + * associated with a structure have changed. + * + * @param source + * (untyped) usually an alignPanel */ public void updateColours(Object source); /** - * called by Jalview to get the colour for the given atomspec - * @param atomIndex - * @param pdbResNum - * @param chain - * @param pdbId - * @return + * Called by structureSelectionManager to instruct implementor to release any + * direct references it may hold to the given object (typically, these are + * Jalview alignment panels). + * + * @param svl */ - public java.awt.Color getColour(int atomIndex, int pdbResNum, - String chain, String pdbId); + public void releaseReferences(Object svl); /** - * called by structureSelectionManager to instruct implementor to release any direct references it may hold to the given object (typically, these are Jalview alignment panels). - * @param svl + * Answers true if this listener is interested in the given sequence + * + * @param seq + * @return */ - public void releaseReferences(Object svl); + public boolean isListeningFor(SequenceI seq); }