X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fstructure%2FStructureListener.java;h=6285d286d0f1cacd26bac33f1b5a1e2fd131cb38;hb=02783b1d0f22e82e7854777646e39df0fc77de74;hp=5ceefd3f0c04fcc295b99c75ef286bc9f182229f;hpb=797df64fa2a0a30773d0f48f5494d4155e5a8be3;p=jalview.git diff --git a/src/jalview/structure/StructureListener.java b/src/jalview/structure/StructureListener.java index 5ceefd3..6285d28 100644 --- a/src/jalview/structure/StructureListener.java +++ b/src/jalview/structure/StructureListener.java @@ -1,13 +1,13 @@ /* - * 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 2.8) + * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle * * 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. - * + * * 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 @@ -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 @@ -61,7 +71,10 @@ public interface StructureListener 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). + * 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);