src/jalview/ext/treeviewer/TreeFrameI.java

   1 package jalview.ext.treeviewer;
   2
   3 import java.awt.Container;
   4 import java.awt.Dimension;
   5 import java.awt.MenuContainer;
   6 import java.awt.image.ImageObserver;
   7
   8 import javax.accessibility.Accessible;
   9 import javax.swing.RootPaneContainer;
  10 import javax.swing.WindowConstants;
  11 import javax.swing.event.InternalFrameListener;
  12
  13 /**
  14  * Interface for implementing the (probably) top level frame of an external tree
  15  * viewer. Note that this extends many interfaces shared with Swing frames but
  16  * doesn't demand that an implementation actually is a Swing frame.
  17  *
  18  * @author kjvanderheide
  19  *
  20  */
  21 public interface TreeFrameI
  22         extends Accessible, WindowConstants, RootPaneContainer,
  23         ImageObserver, MenuContainer
  24 {
  25   public void addFrameListener(InternalFrameListener listener);
  26
  27   /**
  28    * Method for adding the actual frame to Jalview, probably through
  29    * {@link jalview.gui.Desktop#addInternalFrame(javax.swing.JInternalFrame, String, boolean, int, int, boolean, boolean)}
  30    *
  31    * @param title
  32    * @param makeVisible
  33    * @param width
  34    * @param height
  35    * @param resizable
  36    * @param ignoreMinSize
  37    */
  38   public void addFrameToJalview(String title, boolean makeVisible,
  39           int width, int height, boolean resizable, boolean ignoreMinSize);
  40
  41   /**
  42    * If the tree viewer used supports multiple trees in one frame this method
  43    * should perform the needed adaptations.
  44    */
  45   public abstract void enableMultipleTrees();
  46
  47   public InternalFrameListener[] getFrameListeners();
  48
  49   public abstract int getNumberOfTrees();
  50
  51   public Container getTopLevelAncestor();
  52
  53   public abstract TreeI getTree();
  54
  55   public TreeControlsI getTreeControls();
  56
  57   public abstract TreePanelI getTreePanel();
  58
  59   public TreeViewerBindingI getViewBinding();
  60
  61   public boolean isShowing();
  62
  63   public void removeFrameListener(InternalFrameListener listener);
  64
  65   /**
  66    * @see java.awt.Component#repaint()
  67    */
  68   public void repaint();
  69
  70   public void setMaximumSize(Dimension maximumSize);
  71
  72   public void setMinimumSize(Dimension minimumSize);
  73
  74   public void setPreferredSize(Dimension preferredSize);
  75
  76   public void setViewBinding(TreeViewerBindingI alignmentBinding);
  77
  78 }