src/jalview/api/SplitContainerI.java

   1 package jalview.api;
   2
   3 import jalview.datamodel.AlignmentI;
   4
   5 import java.awt.Component;
   6
   7 /**
   8  * Describes a visual container that can show two alignments.
   9  *
  10  * @author gmcarstairs
  11  *
  12  */
  13 public interface SplitContainerI
  14 {
  15
  16   /**
  17    * Set visibility of the specified split view component.
  18    *
  19    * @param alignFrame
  20    * @param show
  21    */
  22   // TODO need an interface for AlignFrame?
  23   void setComplementVisible(Component alignFrame, boolean show);
  24
  25   /**
  26    * Returns the alignment that is complementary to the one in the given
  27    * AlignFrame, or null.
  28    */
  29   AlignmentI getComplement(Component af);
  30
  31   /**
  32    * Returns the frame title for the alignment that is complementary to the one
  33    * in the given AlignFrame, or null.
  34    *
  35    * @param af
  36    * @return
  37    */
  38   String getComplementTitle(Component af);
  39
  40 }