/*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
* Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
*
* This file is part of Jalview.
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)
+ */
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
+ */
public void highlightAtom(int atomIndex, int pdbResNum, String chain,
String pdbId);
+ /**
+ * 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
+ */
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);
}