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     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,
 139                                 null,
 140                                 treegraphic_scroll_pane_panel,
 141                                 Util.createDescriptionForTab( phy, full_path ) );
 142         getTabbedPane().setSelectedIndex( getTabbedPane().getTabCount() - 1 );
 143         getControlPanel().showWhole();
 144     }
 145
 146     void addPhylogenyInPanel( final Phylogeny phy, final Configuration config ) {
 147         final TreePanel treepanel = new TreePanel( phy, config, this );
 148         getControlPanel().phylogenyAdded( config );
 149         treepanel.setControlPanel( getControlPanel() );
 150         _treepanels.add( treepanel );
 151         final JScrollPane treegraphic_scroll_pane = new JScrollPane( treepanel );
 152         treegraphic_scroll_pane.getHorizontalScrollBar().setUnitIncrement( 20 );
 153         treegraphic_scroll_pane.getHorizontalScrollBar().setBlockIncrement( 50 );
 154         treegraphic_scroll_pane.getVerticalScrollBar().setUnitIncrement( 20 );
 155         treegraphic_scroll_pane.getVerticalScrollBar().setBlockIncrement( 50 );
 156         final JPanel treegraphic_scroll_pane_panel = new JPanel();
 157         treegraphic_scroll_pane_panel.setLayout( new BorderLayout() );
 158         treegraphic_scroll_pane_panel.add( treegraphic_scroll_pane, BorderLayout.CENTER );
 159         _treegraphic_scroll_pane_panels.add( treegraphic_scroll_pane_panel );
 160         _treegraphic_scroll_panes.add( treegraphic_scroll_pane );
 161         add( treegraphic_scroll_pane_panel, BorderLayout.CENTER );
 162     }
 163
 164     void adjustJScrollPane() {
 165         if ( getTabbedPane() != null ) {
 166             getCurrentScrollPanePanel().remove( getCurrentScrollPane() );
 167             getCurrentScrollPanePanel().add( getCurrentScrollPane(), BorderLayout.CENTER );
 168         }
 169         getCurrentScrollPane().revalidate();
 170     }
 171
 172     void closeCurrentPane() {
 173         final int index = getCurrentTabIndex();
 174         if ( ( index >= 0 ) && ( getTabbedPane().getTabCount() > 0 ) ) {
 175             getTabbedPane().remove( index );
 176             getTreePanels().remove( index );
 177             _treegraphic_scroll_panes.remove( index );
 178             _treegraphic_scroll_pane_panels.remove( index );
 179             getControlPanel().phylogenyRemoved( index );
 180         }
 181     }
 182
 183     @Override
 184     public void componentHidden( final ComponentEvent e ) {
 185         // Do nothing.
 186     }
 187
 188     @Override
 189     public void componentMoved( final ComponentEvent e ) {
 190         // Do nothing.
 191     }
 192
 193     @Override
 194     public void componentResized( final ComponentEvent e ) {
 195         if ( getCurrentTreePanel() != null ) {
 196             getCurrentTreePanel().updateOvSettings();
 197             getCurrentTreePanel().updateOvSizes();
 198         }
 199     }
 200
 201     @Override
 202     public void componentShown( final ComponentEvent e ) {
 203         // Do nothing.
 204     }
 205
 206     private Configuration getConfiguration() {
 207         return _configuration;
 208     }
 209
 210     ControlPanel getControlPanel() {
 211         return _control_panel;
 212     }
 213
 214     public Set<Integer> getCopiedAndPastedNodes() {
 215         return _copied_and_pasted_nodes;
 216     }
 217
 218     Phylogeny getCurrentPhylogeny() {
 219         if ( getCurrentTreePanel() == null ) {
 220             return null;
 221         }
 222         return getCurrentTreePanel().getPhylogeny();
 223     }
 224
 225     JScrollPane getCurrentScrollPane() {
 226         if ( _treegraphic_scroll_panes.size() > 0 ) {
 227             final int selected = _tabbed_pane.getSelectedIndex();
 228             if ( selected >= 0 ) {
 229                 return _treegraphic_scroll_panes.get( selected );
 230             }
 231             else {
 232                 return _treegraphic_scroll_panes.get( 0 );
 233             }
 234         }
 235         else {
 236             return null;
 237         }
 238     }
 239
 240     JPanel getCurrentScrollPanePanel() {
 241         final int selected = _tabbed_pane.getSelectedIndex();
 242         if ( selected >= 0 ) {
 243             return _treegraphic_scroll_pane_panels.get( selected );
 244         }
 245         else {
 246             return _treegraphic_scroll_pane_panels.get( 0 );
 247         }
 248     }
 249
 250     int getCurrentTabIndex() {
 251         final int selected = _tabbed_pane.getSelectedIndex();
 252         if ( selected >= 0 ) {
 253             return selected;
 254         }
 255         else {
 256             return 0;
 257         }
 258     }
 259
 260     TreePanel getCurrentTreePanel() {
 261         final int selected = getTabbedPane().getSelectedIndex();
 262         if ( selected >= 0 ) {
 263             return _treepanels.get( selected );
 264         }
 265         else {
 266             if ( _treepanels.size() == 1 ) {
 267                 return _treepanels.get( 0 );
 268             }
 269             else {
 270                 return null;
 271             }
 272         }
 273     }
 274
 275     Phylogeny getCutOrCopiedTree() {
 276         return _cut_or_copied_tree;
 277     }
 278
 279     MainFrame getMainFrame() {
 280         return _mainframe;
 281     }
 282
 283     public Options getOptions() {
 284         return _mainframe.getOptions();
 285     }
 286
 287     Phylogeny getPhylogeny( final int index ) {
 288         if ( getCurrentTreePanel() == null ) {
 289             return null;
 290         }
 291         return _treepanels.get( index ).getPhylogeny();
 292     }
 293
 294     Dimension getSizeOfViewport() {
 295         return getCurrentScrollPane().getViewport().getExtentSize();
 296     }
 297
 298     JTabbedPane getTabbedPane() {
 299         return _tabbed_pane;
 300     }
 301
 302     TreeColorSet getTreeColorSet() {
 303         return _colorset;
 304     }
 305
 306     public TreeFontSet getTreeFontSet() {
 307         return _fontset;
 308     }
 309
 310     List<TreePanel> getTreePanels() {
 311         return _treepanels;
 312     }
 313
 314     void initialize() {
 315         if ( !getConfiguration().isUseNativeUI() ) {
 316             setBackground( getConfiguration().getGuiBackgroundColor() );
 317         }
 318         setTreeFontSet( new TreeFontSet( this ) );
 319         getTreeFontSet().setBaseFont( getOptions().getBaseFont() );
 320         setLayout( new BorderLayout() );
 321         setTreeColorSet( TreeColorSet.createInstance( getConfiguration() ) );
 322         _treegraphic_scroll_panes = new ArrayList<JScrollPane>();
 323         _treegraphic_scroll_pane_panels = new ArrayList<JPanel>();
 324         _tabbed_pane = new JTabbedPane( SwingConstants.TOP );
 325         if ( !getConfiguration().isUseNativeUI() ) {
 326             _tabbed_pane.setBackground( getConfiguration().getGuiBackgroundColor() );
 327             _tabbed_pane.setForeground( getConfiguration().getGuiBackgroundColor() );
 328         }
 329         _tabbed_pane.addChangeListener( new ChangeListener() {
 330
 331             // This method is called whenever the selected tab changes
 332             @Override
 333             public void stateChanged( final ChangeEvent evt ) {
 334                 final JTabbedPane pane = ( JTabbedPane ) evt.getSource();
 335                 getControlPanel().tabChanged();
 336                 // Get current tab
 337                 final int sel = pane.getSelectedIndex();
 338                 if ( sel >= 0 ) {
 339                     if ( !getConfiguration().isUseNativeUI() ) {
 340                         if ( _tabbed_pane.getTabCount() > 0 ) {
 341                             _tabbed_pane.setForegroundAt( sel, Constants.TAB_LABEL_FOREGROUND_COLOR_SELECTED );
 342                             for( int i = 0; i < _tabbed_pane.getTabCount(); ++i ) {
 343                                 if ( i != sel ) {
 344                                     _tabbed_pane.setBackgroundAt( i, getConfiguration().getGuiBackgroundColor() );
 345                                     _tabbed_pane.setForegroundAt( i, getConfiguration().getGuiCheckboxTextColor() );
 346                                 }
 347                             }
 348                         }
 349                     }
 350                 }
 351             }
 352         } );
 353         if ( !getConfiguration().isUseNativeUI() ) {
 354             _tabbed_pane.setFont( ControlPanel.jcb_font );
 355         }
 356         _tabbed_pane.setTabLayoutPolicy( JTabbedPane.SCROLL_TAB_LAYOUT );
 357         add( _tabbed_pane, BorderLayout.CENTER );
 358     }
 359
 360     public void setArrowCursor() {
 361         setCursor( TreePanel.ARROW_CURSOR );
 362         repaint();
 363     }
 364
 365     public void setCopiedAndPastedNodes( final Set<Integer> node_ids ) {
 366         _copied_and_pasted_nodes = node_ids;
 367     }
 368
 369     void setCutOrCopiedTree( final Phylogeny cut_or_copied_tree ) {
 370         _cut_or_copied_tree = cut_or_copied_tree;
 371     }
 372
 373     void setTreeColorSet( final TreeColorSet colorset ) {
 374         _colorset = colorset;
 375         for( final TreePanel p : getTreePanels() ) {
 376             p.setBackground( colorset.getBackgroundColor() );
 377         }
 378     }
 379
 380     void setTreeFontSet( final TreeFontSet fontset ) {
 381         _fontset = fontset;
 382     }
 383
 384     void setupTreeGraphic( final Configuration config_settings, final ControlPanel control ) {
 385         control.setSpeciesColors( config_settings.getSpeciesColors() );
 386         control.setAnnotationColors( config_settings.getAnnotationColors() );
 387         RenderableDomainArchitecture.setColorMap( config_settings.getDomainColors() );
 388     }
 389
 390     public void setWaitCursor() {
 391         setCursor( TreePanel.WAIT_CURSOR );
 392         repaint();
 393     }
 394
 395     void terminate() {
 396         for( final TreePanel atvtreepanel : _treepanels ) {
 397             atvtreepanel.removeAllEditNodeJFrames();
 398         }
 399     }
 400
 401     synchronized void setImageMap( final Hashtable<String, BufferedImage> image_map ) {
 402         _image_map = image_map;
 403     }
 404
 405     synchronized Hashtable<String, BufferedImage> getImageMap() {
 406         return _image_map;
 407     }
 408 }