forester/java/src/org/forester/archaeopteryx/MainPanel.java

   1 // $Id:
   2 // FORESTER -- software libraries and applications
   3 // for evolutionary biology research and applications.
   4 //
   5 // Copyright (C) 2008-2009 Christian M. Zmasek
   6 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
   7 // Copyright (C) 2000-2001 Washington University School of Medicine
   8 // and Howard Hughes Medical Institute
   9 // Copyright (C) 2003-2007 Ethalinda K.S. Cannon
  10 // All rights reserved
  11 //
  12 // This library is free software; you can redistribute it and/or
  13 // modify it under the terms of the GNU Lesser General Public
  14 // License as published by the Free Software Foundation; either
  15 // version 2.1 of the License, or (at your option) any later version.
  16 //
  17 // This library is distributed in the hope that it will be useful,
  18 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20 // Lesser General Public License for more details.
  21 //
  22 // You should have received a copy of the GNU Lesser General Public
  23 // License along with this library; if not, write to the Free Software
  24 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  25 //
  26 // Contact: phylosoft @ gmail . com
  27 // WWW: www.phylosoft.org/forester
  28
  29 package org.forester.archaeopteryx;
  30
  31 import java.awt.BorderLayout;
  32 import java.awt.Dimension;
  33 import java.awt.event.AdjustmentEvent;
  34 import java.awt.event.AdjustmentListener;
  35 import java.awt.event.ComponentEvent;
  36 import java.awt.event.ComponentListener;
  37 import java.awt.image.BufferedImage;
  38 import java.util.ArrayList;
  39 import java.util.Hashtable;
  40 import java.util.List;
  41 import java.util.Set;
  42
  43 import javax.swing.JPanel;
  44 import javax.swing.JScrollPane;
  45 import javax.swing.JTabbedPane;
  46 import javax.swing.SwingConstants;
  47 import javax.swing.event.ChangeEvent;
  48 import javax.swing.event.ChangeListener;
  49
  50 import org.forester.archaeopteryx.phylogeny.data.RenderableDomainArchitecture;
  51 import org.forester.phylogeny.Phylogeny;
  52 import org.forester.util.ForesterUtil;
  53
  54 public class MainPanel extends JPanel implements ComponentListener {
  55
  56     private static final long                serialVersionUID = -2682765312661416435L;
  57     MainFrame                                _mainframe;
  58     List<TreePanel>                          _treepanels;
  59     ControlPanel                             _control_panel;
  60     private List<JScrollPane>                _treegraphic_scroll_panes;
  61     private List<JPanel>                     _treegraphic_scroll_pane_panels;
  62     Configuration                            _configuration;
  63     private JTabbedPane                      _tabbed_pane;
  64     private TreeColorSet                     _colorset;
  65     private TreeFontSet                      _fontset;
  66     private Phylogeny                        _cut_or_copied_tree;
  67     private Set<Integer>                     _copied_and_pasted_nodes;
  68     private Hashtable<String, BufferedImage> _image_map;
  69
  70     MainPanel() {
  71     }
  72
  73     MainPanel( final Configuration configuration, final MainFrame parent ) {
  74         if ( configuration == null ) {
  75             throw new IllegalArgumentException( "configuration is null" );
  76         }
  77         addComponentListener( this );
  78         _configuration = configuration;
  79         _mainframe = parent;
  80         _treepanels = new ArrayList<TreePanel>();
  81         initialize();
  82         _control_panel = new ControlPanel( this, configuration );
  83         add( _control_panel, BorderLayout.WEST );
  84         setupTreeGraphic( configuration, getControlPanel() );
  85         getControlPanel().showWhole();
  86     }
  87
  88     public void addPhylogenyInNewTab( final Phylogeny phy,
  89                                       final Configuration config,
  90                                       final String default_name,
  91                                       final String full_path ) {
  92         final TreePanel treepanel = new TreePanel( phy, config, this );
  93         getControlPanel().phylogenyAdded( config );
  94         treepanel.setControlPanel( getControlPanel() );
  95         _treepanels.add( treepanel );
  96         String name = "";
  97         if ( !ForesterUtil.isEmpty( phy.getName() ) ) {
  98             name = phy.getName();
  99         }
 100         else if ( phy.getIdentifier() != null ) {
 101             name = phy.getIdentifier().toString();
 102         }
 103         else if ( !ForesterUtil.isEmpty( default_name ) ) {
 104             name = default_name;
 105         }
 106         else {
 107             name = "[" + ( getTabbedPane().getTabCount() + 1 ) + "]";
 108         }
 109         final JScrollPane treegraphic_scroll_pane = new JScrollPane( treepanel );
 110         treegraphic_scroll_pane.getHorizontalScrollBar().addAdjustmentListener( new AdjustmentListener() {
 111
 112             @Override
 113             public void adjustmentValueChanged( final AdjustmentEvent e ) {
 114                 if ( treepanel.isOvOn() || getOptions().isShowScale() ) {
 115                     treepanel.repaint();
 116                 }
 117             }
 118         } );
 119         treegraphic_scroll_pane.getVerticalScrollBar().addAdjustmentListener( new AdjustmentListener() {
 120
 121             @Override
 122             public void adjustmentValueChanged( final AdjustmentEvent e ) {
 123                 if ( treepanel.isOvOn() || getOptions().isShowScale() ) {
 124                     treepanel.repaint();
 125                     //System.out.println( e.getValue() );
 126                 }
 127             }
 128         } );
 129         treegraphic_scroll_pane.getHorizontalScrollBar().setUnitIncrement( 10 );
 130         treegraphic_scroll_pane.getHorizontalScrollBar().setBlockIncrement( 200 );
 131         treegraphic_scroll_pane.getVerticalScrollBar().setUnitIncrement( 10 );
 132         treegraphic_scroll_pane.getVerticalScrollBar().setBlockIncrement( 200 );
 133         final JPanel treegraphic_scroll_pane_panel = new JPanel();
 134         treegraphic_scroll_pane_panel.setLayout( new BorderLayout() );
 135         treegraphic_scroll_pane_panel.add( treegraphic_scroll_pane, BorderLayout.CENTER );
 136         _treegraphic_scroll_pane_panels.add( treegraphic_scroll_pane_panel );
 137         _treegraphic_scroll_panes.add( treegraphic_scroll_pane );
 138         getTabbedPane().addTab( name, null, treegraphic_scroll_pane_panel, "" );
 139         getTabbedPane().setSelectedIndex( getTabbedPane().getTabCount() - 1 );
 140         getControlPanel().showWhole();
 141     }
 142
 143     void addPhylogenyInPanel( final Phylogeny phy, final Configuration config ) {
 144         final TreePanel treepanel = new TreePanel( phy, config, this );
 145         getControlPanel().phylogenyAdded( config );
 146         treepanel.setControlPanel( getControlPanel() );
 147         _treepanels.add( treepanel );
 148         final JScrollPane treegraphic_scroll_pane = new JScrollPane( treepanel );
 149         treegraphic_scroll_pane.getHorizontalScrollBar().setUnitIncrement( 20 );
 150         treegraphic_scroll_pane.getHorizontalScrollBar().setBlockIncrement( 50 );
 151         treegraphic_scroll_pane.getVerticalScrollBar().setUnitIncrement( 20 );
 152         treegraphic_scroll_pane.getVerticalScrollBar().setBlockIncrement( 50 );
 153         final JPanel treegraphic_scroll_pane_panel = new JPanel();
 154         treegraphic_scroll_pane_panel.setLayout( new BorderLayout() );
 155         treegraphic_scroll_pane_panel.add( treegraphic_scroll_pane, BorderLayout.CENTER );
 156         _treegraphic_scroll_pane_panels.add( treegraphic_scroll_pane_panel );
 157         _treegraphic_scroll_panes.add( treegraphic_scroll_pane );
 158         add( treegraphic_scroll_pane_panel, BorderLayout.CENTER );
 159     }
 160
 161     void adjustJScrollPane() {
 162         if ( getTabbedPane() != null ) {
 163             getCurrentScrollPanePanel().remove( getCurrentScrollPane() );
 164             getCurrentScrollPanePanel().add( getCurrentScrollPane(), BorderLayout.CENTER );
 165         }
 166         getCurrentScrollPane().revalidate();
 167     }
 168
 169     void closeCurrentPane() {
 170         final int index = getCurrentTabIndex();
 171         if ( ( index >= 0 ) && ( getTabbedPane().getTabCount() > 0 ) ) {
 172             getTabbedPane().remove( index );
 173             getTreePanels().remove( index );
 174             _treegraphic_scroll_panes.remove( index );
 175             _treegraphic_scroll_pane_panels.remove( index );
 176             getControlPanel().phylogenyRemoved( index );
 177         }
 178     }
 179
 180     @Override
 181     public void componentHidden( final ComponentEvent e ) {
 182         // Do nothing.
 183     }
 184
 185     @Override
 186     public void componentMoved( final ComponentEvent e ) {
 187         // Do nothing.
 188     }
 189
 190     @Override
 191     public void componentResized( final ComponentEvent e ) {
 192         if ( getCurrentTreePanel() != null ) {
 193             getCurrentTreePanel().updateOvSettings();
 194             getCurrentTreePanel().updateOvSizes();
 195         }
 196     }
 197
 198     @Override
 199     public void componentShown( final ComponentEvent e ) {
 200         // Do nothing.
 201     }
 202
 203     private Configuration getConfiguration() {
 204         return _configuration;
 205     }
 206
 207     ControlPanel getControlPanel() {
 208         return _control_panel;
 209     }
 210
 211     public Set<Integer> getCopiedAndPastedNodes() {
 212         return _copied_and_pasted_nodes;
 213     }
 214
 215     Phylogeny getCurrentPhylogeny() {
 216         if ( getCurrentTreePanel() == null ) {
 217             return null;
 218         }
 219         return getCurrentTreePanel().getPhylogeny();
 220     }
 221
 222     JScrollPane getCurrentScrollPane() {
 223         if ( _treegraphic_scroll_panes.size() > 0 ) {
 224             final int selected = getTabbedPane().getSelectedIndex();
 225             if ( selected >= 0 ) {
 226                 return _treegraphic_scroll_panes.get( selected );
 227             }
 228             else {
 229                 return _treegraphic_scroll_panes.get( 0 );
 230             }
 231         }
 232         else {
 233             return null;
 234         }
 235     }
 236
 237     JPanel getCurrentScrollPanePanel() {
 238         final int selected = getTabbedPane().getSelectedIndex();
 239         if ( selected >= 0 ) {
 240             return _treegraphic_scroll_pane_panels.get( selected );
 241         }
 242         else {
 243             return _treegraphic_scroll_pane_panels.get( 0 );
 244         }
 245     }
 246
 247     int getCurrentTabIndex() {
 248         final int selected = getTabbedPane().getSelectedIndex();
 249         if ( selected >= 0 ) {
 250             return selected;
 251         }
 252         else {
 253             return 0;
 254         }
 255     }
 256
 257     void setTitleOfSelectedTab( final String title ) {
 258         final int selected = getTabbedPane().getSelectedIndex();
 259         if ( selected >= 0 ) {
 260             getTabbedPane().setTitleAt( selected, title );
 261         }
 262     }
 263
 264     public TreePanel getCurrentTreePanel() {
 265         final int selected = getTabbedPane().getSelectedIndex();
 266         if ( selected >= 0 ) {
 267             return _treepanels.get( selected );
 268         }
 269         else {
 270             if ( _treepanels.size() == 1 ) {
 271                 return _treepanels.get( 0 );
 272             }
 273             else {
 274                 return null;
 275             }
 276         }
 277     }
 278
 279     Phylogeny getCutOrCopiedTree() {
 280         return _cut_or_copied_tree;
 281     }
 282
 283     MainFrame getMainFrame() {
 284         return _mainframe;
 285     }
 286
 287     public Options getOptions() {
 288         return _mainframe.getOptions();
 289     }
 290
 291     Phylogeny getPhylogeny( final int index ) {
 292         if ( getCurrentTreePanel() == null ) {
 293             return null;
 294         }
 295         return _treepanels.get( index ).getPhylogeny();
 296     }
 297
 298     Dimension getSizeOfViewport() {
 299         return getCurrentScrollPane().getViewport().getExtentSize();
 300     }
 301
 302     JTabbedPane getTabbedPane() {
 303         return _tabbed_pane;
 304     }
 305
 306     TreeColorSet getTreeColorSet() {
 307         return _colorset;
 308     }
 309
 310     public TreeFontSet getTreeFontSet() {
 311         return _fontset;
 312     }
 313
 314     List<TreePanel> getTreePanels() {
 315         return _treepanels;
 316     }
 317
 318     void initialize() {
 319         if ( !getConfiguration().isUseNativeUI() ) {
 320             setBackground( getConfiguration().getGuiBackgroundColor() );
 321         }
 322         setTreeFontSet( new TreeFontSet( this ) );
 323         getTreeFontSet().setBaseFont( getOptions().getBaseFont() );
 324         setLayout( new BorderLayout() );
 325         setTreeColorSet( TreeColorSet.createInstance( getConfiguration() ) );
 326         _treegraphic_scroll_panes = new ArrayList<JScrollPane>();
 327         _treegraphic_scroll_pane_panels = new ArrayList<JPanel>();
 328         _tabbed_pane = new JTabbedPane( SwingConstants.TOP );
 329         if ( !getConfiguration().isUseNativeUI() ) {
 330             _tabbed_pane.setBackground( getConfiguration().getGuiBackgroundColor() );
 331             _tabbed_pane.setForeground( getConfiguration().getGuiBackgroundColor() );
 332         }
 333         _tabbed_pane.addChangeListener( new ChangeListener() {
 334
 335             // This method is called whenever the selected tab changes
 336             @Override
 337             public void stateChanged( final ChangeEvent evt ) {
 338                 final JTabbedPane pane = ( JTabbedPane ) evt.getSource();
 339                 getControlPanel().tabChanged();
 340                 // Get current tab
 341                 final int sel = pane.getSelectedIndex();
 342                 if ( sel >= 0 ) {
 343                     if ( !getConfiguration().isUseNativeUI() ) {
 344                         if ( _tabbed_pane.getTabCount() > 0 ) {
 345                             _tabbed_pane.setForegroundAt( sel, Constants.TAB_LABEL_FOREGROUND_COLOR_SELECTED );
 346                             for( int i = 0; i < _tabbed_pane.getTabCount(); ++i ) {
 347                                 if ( i != sel ) {
 348                                     _tabbed_pane.setBackgroundAt( i, getConfiguration().getGuiBackgroundColor() );
 349                                     _tabbed_pane.setForegroundAt( i, getConfiguration().getGuiCheckboxTextColor() );
 350                                 }
 351                             }
 352                         }
 353                     }
 354                 }
 355             }
 356         } );
 357         if ( !getConfiguration().isUseNativeUI() ) {
 358             _tabbed_pane.setFont( ControlPanel.jcb_font );
 359         }
 360         _tabbed_pane.setTabLayoutPolicy( JTabbedPane.SCROLL_TAB_LAYOUT );
 361         add( _tabbed_pane, BorderLayout.CENTER );
 362     }
 363
 364     public void setArrowCursor() {
 365         setCursor( TreePanel.ARROW_CURSOR );
 366         repaint();
 367     }
 368
 369     public void setCopiedAndPastedNodes( final Set<Integer> node_ids ) {
 370         _copied_and_pasted_nodes = node_ids;
 371     }
 372
 373     void setCutOrCopiedTree( final Phylogeny cut_or_copied_tree ) {
 374         _cut_or_copied_tree = cut_or_copied_tree;
 375     }
 376
 377     void setTreeColorSet( final TreeColorSet colorset ) {
 378         _colorset = colorset;
 379         for( final TreePanel p : getTreePanels() ) {
 380             p.setBackground( colorset.getBackgroundColor() );
 381         }
 382     }
 383
 384     void setTreeFontSet( final TreeFontSet fontset ) {
 385         _fontset = fontset;
 386     }
 387
 388     void setupTreeGraphic( final Configuration config_settings, final ControlPanel control ) {
 389         control.setSpeciesColors( config_settings.getSpeciesColors() );
 390         control.setAnnotationColors( config_settings.getAnnotationColors() );
 391         RenderableDomainArchitecture.setColorMap( config_settings.getDomainColors() );
 392     }
 393
 394     public void setWaitCursor() {
 395         setCursor( TreePanel.WAIT_CURSOR );
 396         repaint();
 397     }
 398
 399     void terminate() {
 400         for( final TreePanel atvtreepanel : _treepanels ) {
 401             atvtreepanel.removeAllEditNodeJFrames();
 402         }
 403     }
 404
 405     synchronized void setImageMap( final Hashtable<String, BufferedImage> image_map ) {
 406         _image_map = image_map;
 407     }
 408
 409     synchronized Hashtable<String, BufferedImage> getImageMap() {
 410         return _image_map;
 411     }
 412 }