X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fstructure%2FStructureListener.java;h=e07b480aa0dd28f0500053a120078fe9cd8a17a0;hb=b57a02c25e335d033c97f8a6bacd6b54f62bd2b6;hp=4ad4405ed29cf3a67a76cf892f6c22676b6a651a;hpb=d038c9702429f76a1556c7d2b282f26d9feb22f6;p=jalview.git diff --git a/src/jalview/structure/StructureListener.java b/src/jalview/structure/StructureListener.java index 4ad4405..e07b480 100644 --- a/src/jalview/structure/StructureListener.java +++ b/src/jalview/structure/StructureListener.java @@ -1,6 +1,6 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6) - * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle + * 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 * * This file is part of Jalview. * @@ -21,20 +21,26 @@ 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) + * @return 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 + * 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 + * called by StructureSelectionManager to inform viewer to highlight given + * atomspec + * * @param atomIndex * @param pdbResNum * @param chain @@ -44,13 +50,17 @@ public interface StructureListener String pdbId); /** - * 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 @@ -59,4 +69,13 @@ public interface StructureListener */ public java.awt.Color getColour(int atomIndex, int pdbResNum, String chain, String pdbId); + + /** + * 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 void releaseReferences(Object svl); }