All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class mesquite.lib.TreeDisplayExtra 

java.lang.Object
   |
   +----mesquite.lib.TreeDisplayExtra
public abstract class TreeDisplayExtra
extends java.lang.Object
implements mesquite.lib.Listable
A class used for additional graphical and calculations elements to be drawn and calculated within TreeDisplayes -- tree legends, trace characters, etc. The TreeDisplayExtra is notified when the cursor is moved over a branch and so on, and when the tree is drawn the TreeDisplayExtra is notified via drawOnTree so that it can add its items to the tree.

Variable Index

o ownerModule
o totalCreated
o treeDisplay

Constructor Index

o TreeDisplayExtra(MesquiteModule, TreeDisplay)

Method Index

o addPanelPlease(Panel)
o cursorEnterBranch(Tree, int, Graphics)
to inform TreeDisplayExtra that cursor has just entered branch N
o cursorEnterTaxon(Tree, int, Graphics)
to inform TreeDisplayExtra that cursor has just entered name of terminal taxon M
o cursorExitBranch(Tree, int, Graphics)
to inform TreeDisplayExtra that cursor has just exited branch N
o cursorExitTaxon(Tree, int, Graphics)
to inform TreeDisplayExtra that cursor has just exited name of terminal taxon M
o cursorTouchBranch(Tree, int, Graphics)
to inform TreeDisplayExtra that cursor has just touched branch N
o cursorTouchTaxon(Tree, int, Graphics)
to inform TreeDisplayExtra that cursor has just touched name of terminal taxon M
o dispose()
o drawOnTree(Tree, int, Graphics)
draw on the tree passed
o findBranch(Tree, int, int, int)
o getCladeLabelAddition(String, int)
Returns any strings to be appended to clade label.
o getCladeLabelColor(String, int)
Returns the color the extra wants the clade label colored.
o getCladeLabelUnderlined(String, int)
Returns true if this extra wants the clade to have its label underlined
o getName()
o getOwnerModule()
o getPanels()
o getTaxonColor(Taxon)
Returns the color the extra wants the taxon name colored.
o getTaxonStringAddition(Taxon)
Returns any strings to be appended to taxon name.
o getTaxonUnderlined(Taxon)
Returns true if this extra wants the taxon to have its name underlined
o getTreeDisplay()
o printOnTree(Tree, int, Graphics)
print on the tree passed
o removePanelPlease(Panel)
o setTree(Tree, CommandRecord)
notifies the TreeDisplayExtra that the tree has changed, so it knows to redo calculations, and so on
o textAtNode(Tree, int)
return a text version of information at node
o textForLegend()
return a text version of any legends or other explanatory information
o turnOff()
o writeOnTree(Tree, int)
return a text version of information on tree

Variables

o treeDisplay 
 public mesquite.lib.TreeDisplay treeDisplay
o ownerModule 
 public mesquite.lib.MesquiteModule ownerModule
o totalCreated 
 public static long totalCreated

Constructors

o TreeDisplayExtra 
 public TreeDisplayExtra(mesquite.lib.MesquiteModule ownerModule,
                         mesquite.lib.TreeDisplay treeDisplay)

Methods

o getOwnerModule 
 public mesquite.lib.MesquiteModule getOwnerModule()
o getName 
 public java.lang.String getName()
o getTreeDisplay 
 public mesquite.lib.TreeDisplay getTreeDisplay()
o dispose 
 public void dispose()
o setTree 
 public abstract void setTree(mesquite.lib.Tree tree,
                              mesquite.lib.CommandRecord commandRec)
notifies the TreeDisplayExtra that the tree has changed, so it knows to redo calculations, and so on

o drawOnTree 
 public abstract void drawOnTree(mesquite.lib.Tree tree,
                                 int drawnRoot,
                                 java.awt.Graphics g)
draw on the tree passed

o printOnTree 
 public abstract void printOnTree(mesquite.lib.Tree tree,
                                  int drawnRoot,
                                  java.awt.Graphics g)
print on the tree passed

o writeOnTree 
 public java.lang.String writeOnTree(mesquite.lib.Tree tree,
                                     int node)
return a text version of information on tree

o getTaxonUnderlined 
 public boolean getTaxonUnderlined(mesquite.lib.Taxon taxon)
Returns true if this extra wants the taxon to have its name underlined

o getTaxonColor 
 public java.awt.Color getTaxonColor(mesquite.lib.Taxon taxon)
Returns the color the extra wants the taxon name colored.

o getTaxonStringAddition 
 public java.lang.String getTaxonStringAddition(mesquite.lib.Taxon taxon)
Returns any strings to be appended to taxon name.

o getCladeLabelUnderlined 
 public boolean getCladeLabelUnderlined(java.lang.String label,
                                        int N)
Returns true if this extra wants the clade to have its label underlined

o getCladeLabelColor 
 public java.awt.Color getCladeLabelColor(java.lang.String label,
                                          int N)
Returns the color the extra wants the clade label colored.

o getCladeLabelAddition 
 public java.lang.String getCladeLabelAddition(java.lang.String label,
                                               int N)
Returns any strings to be appended to clade label.

o textAtNode 
 public java.lang.String textAtNode(mesquite.lib.Tree tree,
                                    int node)
return a text version of information at node

o textForLegend 
 public java.lang.String textForLegend()
return a text version of any legends or other explanatory information

o findBranch 
 public int findBranch(mesquite.lib.Tree tree,
                       int drawnRoot,
                       int x,
                       int y)
o cursorEnterBranch 
 public void cursorEnterBranch(mesquite.lib.Tree tree,
                               int N,
                               java.awt.Graphics g)
to inform TreeDisplayExtra that cursor has just entered branch N

o cursorExitBranch 
 public void cursorExitBranch(mesquite.lib.Tree tree,
                              int N,
                              java.awt.Graphics g)
to inform TreeDisplayExtra that cursor has just exited branch N

o cursorTouchBranch 
 public void cursorTouchBranch(mesquite.lib.Tree tree,
                               int N,
                               java.awt.Graphics g)
to inform TreeDisplayExtra that cursor has just touched branch N

o cursorEnterTaxon 
 public void cursorEnterTaxon(mesquite.lib.Tree tree,
                              int M,
                              java.awt.Graphics g)
to inform TreeDisplayExtra that cursor has just entered name of terminal taxon M

o cursorExitTaxon 
 public void cursorExitTaxon(mesquite.lib.Tree tree,
                             int M,
                             java.awt.Graphics g)
to inform TreeDisplayExtra that cursor has just exited name of terminal taxon M

o cursorTouchTaxon 
 public void cursorTouchTaxon(mesquite.lib.Tree tree,
                              int M,
                              java.awt.Graphics g)
to inform TreeDisplayExtra that cursor has just touched name of terminal taxon M

o addPanelPlease 
 public void addPanelPlease(java.awt.Panel p)
o removePanelPlease 
 public void removePanelPlease(java.awt.Panel p)
o getPanels 
 protected java.util.Vector getPanels()
o turnOff 
 public void turnOff()

All Packages  Class Hierarchy  This Package  Previous  Next  Index