src/net/pterodactylus/jsite/gui/FileManager.java

   1 /*
   2  * jSite2 - FileManager.java -
   3  * Copyright © 2008 David Roden
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 package net.pterodactylus.jsite.gui;
  21
  22 import java.awt.BorderLayout;
  23 import java.awt.Color;
  24 import java.awt.Component;
  25 import java.awt.Dimension;
  26 import java.awt.FlowLayout;
  27 import java.awt.Font;
  28 import java.awt.GridBagConstraints;
  29 import java.awt.GridBagLayout;
  30 import java.awt.Insets;
  31 import java.awt.Point;
  32 import java.awt.event.ActionEvent;
  33 import java.awt.event.ActionListener;
  34 import java.awt.event.MouseEvent;
  35 import java.awt.event.MouseListener;
  36 import java.beans.PropertyChangeEvent;
  37 import java.beans.PropertyChangeListener;
  38 import java.util.ArrayList;
  39 import java.util.Collections;
  40 import java.util.HashMap;
  41 import java.util.List;
  42 import java.util.Map;
  43 import java.util.logging.Level;
  44 import java.util.logging.Logger;
  45
  46 import javax.swing.BorderFactory;
  47 import javax.swing.JButton;
  48 import javax.swing.JCheckBoxMenuItem;
  49 import javax.swing.JDialog;
  50 import javax.swing.JLabel;
  51 import javax.swing.JOptionPane;
  52 import javax.swing.JPanel;
  53 import javax.swing.JPopupMenu;
  54 import javax.swing.JScrollPane;
  55 import javax.swing.JTextField;
  56 import javax.swing.JTree;
  57 import javax.swing.event.TreeModelEvent;
  58 import javax.swing.event.TreeModelListener;
  59 import javax.swing.event.TreeSelectionEvent;
  60 import javax.swing.event.TreeSelectionListener;
  61 import javax.swing.tree.DefaultTreeCellRenderer;
  62 import javax.swing.tree.TreeModel;
  63 import javax.swing.tree.TreePath;
  64
  65 import net.pterodactylus.jsite.i18n.I18n;
  66 import net.pterodactylus.jsite.i18n.I18nable;
  67 import net.pterodactylus.jsite.i18n.gui.I18nAction;
  68 import net.pterodactylus.jsite.i18n.gui.I18nLabel;
  69 import net.pterodactylus.jsite.project.FileOverride;
  70 import net.pterodactylus.jsite.project.Project;
  71 import net.pterodactylus.jsite.project.ProjectFile;
  72 import net.pterodactylus.util.logging.Logging;
  73 import net.pterodactylus.util.swing.SwingUtils;
  74
  75 /**
  76  * Manages physical and virtual files in a project.
  77  *
  78  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  79  */
  80 public class FileManager extends JDialog implements I18nable, ActionListener, TreeSelectionListener, MouseListener {
  81
  82         /** Logger. */
  83         private static final Logger logger = Logging.getLogger(FileManager.class.getName());
  84
  85         /** The Swing interface. */
  86         private final SwingInterface swingInterface;
  87
  88         /** The project whose files to manage. */
  89         private final Project project;
  90
  91         /** The tree model for the project files. */
  92         private final ProjectFileTreeModel fileTreeModel;
  93
  94         /** The tree cell renderer. */
  95         private final FileCellRenderer fileCellRenderer;
  96
  97         /** The “rescan” action. */
  98         private I18nAction rescanAction;
  99
 100         /** The “close” action. */
 101         private I18nAction closeAction;
 102
 103         /** The “set default file” action. */
 104         private I18nAction setDefaultFileAction;
 105
 106         /** The “insert” action. */
 107         private I18nAction insertAction;
 108
 109         /** The “project files” label. */
 110         private I18nLabel projectFilesLabel;
 111
 112         /** The tree that shows the files. */
 113         private JTree fileTree;
 114
 115         /** The scroll pane that holds the file tree. */
 116         private JScrollPane fileScrollPane;
 117
 118         /** The “file properties” label. */
 119         private I18nLabel filePropertiesLabel;
 120
 121         /** The “file path” label. */
 122         private I18nLabel filePathLabel;
 123
 124         /** The “file path” textfield. */
 125         private JTextField filePathTextField;
 126
 127         /** The “file name” label. */
 128         private I18nLabel fileNameLabel;
 129
 130         /** The “file name” textfield. */
 131         private JTextField fileNameTextField;
 132
 133         /** The “file size” label. */
 134         private I18nLabel fileSizeLabel;
 135
 136         /** The “file size” text field. */
 137         private JTextField fileSizeTextField;
 138
 139         /** The context menu for the tree. */
 140         private JPopupMenu treeContextMenu;
 141
 142         /** The “insert” checkbox. */
 143         private JCheckBoxMenuItem insertCheckBoxMenuItem;
 144
 145         /**
 146          * Creates a new file manager.
 147          *
 148          * @param swingInterface
 149          *            The Swing interface
 150          * @param project
 151          *            The project whose files to manage
 152          */
 153         public FileManager(SwingInterface swingInterface, Project project) {
 154                 super(swingInterface.getMainWindow(), I18n.get("fileManager.title", project.getName()), true);
 155                 logger.log(Level.FINEST, "project: " + project);
 156                 this.swingInterface = swingInterface;
 157                 this.project = project;
 158                 fileTreeModel = new ProjectFileTreeModel();
 159                 project.addPropertyChangeListener(fileTreeModel);
 160                 fileCellRenderer = new FileCellRenderer();
 161                 initActions();
 162                 initComponents();
 163                 pack();
 164                 SwingUtils.center(this);
 165         }
 166
 167         //
 168         // ACTIONS
 169         //
 170
 171         /**
 172          * @see java.awt.Component#setVisible(boolean)
 173          */
 174         @Override
 175         public void setVisible(boolean visible) {
 176                 if (visible) {
 177                         initiateFileScan();
 178                 }
 179                 super.setVisible(visible);
 180         }
 181
 182         //
 183         // PRIVATE METHODS
 184         //
 185
 186         /**
 187          * Initializes all actions.
 188          */
 189         private void initActions() {
 190                 closeAction = new I18nAction("fileManager.button.close") {
 191
 192                         /**
 193                          * {@inheritDoc}
 194                          */
 195                         public void actionPerformed(ActionEvent e) {
 196                                 setVisible(false);
 197                         }
 198                 };
 199                 rescanAction = new I18nAction("fileManager.button.rescan") {
 200
 201                         /**
 202                          * {@inheritDoc}
 203                          */
 204                         @SuppressWarnings("synthetic-access")
 205                         public void actionPerformed(ActionEvent actionEvent) {
 206                                 initiateFileScan();
 207                         }
 208                 };
 209                 setDefaultFileAction = new I18nAction("fileManager.menu.item.setDefaultFile") {
 210
 211                         /**
 212                          * {@inheritDoc}
 213                          */
 214                         public void actionPerformed(ActionEvent actionEvent) {
 215                                 TreePath selectedPath = fileTree.getSelectionPath();
 216                                 if (selectedPath == null) {
 217                                         logger.log(Level.WARNING, "nothing selected!");
 218                                         return;
 219                                 }
 220                                 ProjectFileWrapper projectFileWrapper = (ProjectFileWrapper) selectedPath.getLastPathComponent();
 221                                 if (isHidden(projectFileWrapper)) {
 222                                         /* TODO - i18n */
 223                                         JOptionPane.showMessageDialog(FileManager.this, I18n.get(""), I18n.get(""), JOptionPane.ERROR_MESSAGE);
 224                                         return;
 225                                 }
 226                                 if (projectFileWrapper.getProjectFile().isDirectory()) {
 227                                         /* TODO - i18n */
 228                                         JOptionPane.showMessageDialog(FileManager.this, I18n.get(""), I18n.get(""), JOptionPane.ERROR_MESSAGE);
 229                                         return;
 230                                 }
 231                                 String completePath = projectFileWrapper.getProjectFile().getCompletePath();
 232                                 project.setDefaultFile(completePath);
 233                         }
 234                 };
 235                 insertAction = new I18nAction("fileManager.menu.item.insert") {
 236
 237                         /**
 238                          * {@inheritDoc}
 239                          */
 240                         public void actionPerformed(ActionEvent e) {
 241                                 /* TODO */
 242                         }
 243                 };
 244         }
 245
 246         /**
 247          * Initializes all components.
 248          */
 249         private void initComponents() {
 250                 treeContextMenu = new JPopupMenu();
 251                 treeContextMenu.add(setDefaultFileAction);
 252                 insertCheckBoxMenuItem = new JCheckBoxMenuItem(insertAction);
 253                 treeContextMenu.add(insertCheckBoxMenuItem);
 254
 255                 JPanel contentPanel = new JPanel(new BorderLayout(12, 12));
 256                 contentPanel.setBorder(BorderFactory.createEmptyBorder(12, 12, 12, 12));
 257
 258                 contentPanel.add(createFileManagerPanel(), BorderLayout.CENTER);
 259                 contentPanel.add(createButtonPanel(), BorderLayout.PAGE_END);
 260
 261                 setContentPane(contentPanel);
 262         }
 263
 264         /**
 265          * Creates the main panel with the file tree and the file properties.
 266          *
 267          * @return The mail panel
 268          */
 269         private Component createFileManagerPanel() {
 270                 JPanel fileManagerPanel = new JPanel(new BorderLayout(12, 12));
 271
 272                 /* file tree panel */
 273                 JPanel fileTreePanel = new JPanel(new BorderLayout(12, 12));
 274                 fileManagerPanel.add(fileTreePanel, BorderLayout.LINE_START);
 275
 276                 fileTree = new JTree(fileTreeModel);
 277                 fileTree.setShowsRootHandles(false);
 278                 fileTree.addTreeSelectionListener(this);
 279                 fileTree.addMouseListener(this);
 280                 fileTree.setCellRenderer(fileCellRenderer);
 281                 fileTreePanel.add(fileScrollPane = new JScrollPane(fileTree), BorderLayout.CENTER);
 282                 fileScrollPane.setPreferredSize(new Dimension(250, 400));
 283
 284                 projectFilesLabel = new I18nLabel("fileManager.label.projectFiles", fileTree);
 285                 JPanel projectFilesLabelPanel = new JPanel(new FlowLayout(FlowLayout.CENTER, 0, 0));
 286                 fileTreePanel.add(projectFilesLabelPanel, BorderLayout.NORTH);
 287                 projectFilesLabelPanel.add(projectFilesLabel);
 288
 289                 /* the right panel */
 290                 JPanel rightPanel = new JPanel(new BorderLayout(12, 12));
 291                 fileManagerPanel.add(rightPanel, BorderLayout.CENTER);
 292
 293                 /* properties panel */
 294                 JPanel propertiesPanel = new JPanel(new GridBagLayout());
 295                 rightPanel.add(propertiesPanel, BorderLayout.CENTER);
 296                 propertiesPanel.setBorder(BorderFactory.createCompoundBorder(BorderFactory.createEtchedBorder(), BorderFactory.createEmptyBorder(12, 12, 12, 12)));
 297
 298                 filePropertiesLabel = new I18nLabel("fileManager.label.fileProperties");
 299                 filePropertiesLabel.setFont(filePropertiesLabel.getFont().deriveFont(Font.BOLD));
 300                 propertiesPanel.add(filePropertiesLabel, new GridBagConstraints(0, 0, 2, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.BOTH, new Insets(0, 0, 0, 0), 0, 0));
 301
 302                 filePathLabel = new I18nLabel("fileManager.label.filePath");
 303                 filePathTextField = new JTextField();
 304                 filePathTextField.setEditable(false);
 305                 propertiesPanel.add(filePathLabel, new GridBagConstraints(0, 1, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.BOTH, new Insets(12, 24, 0, 0), 0, 0));
 306                 propertiesPanel.add(filePathTextField, new GridBagConstraints(1, 1, 1, 1, 1.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.BOTH, new Insets(12, 12, 0, 0), 0, 0));
 307
 308                 fileNameLabel = new I18nLabel("fileManager.label.fileName");
 309                 fileNameTextField = new JTextField();
 310                 fileNameTextField.setEditable(false);
 311                 propertiesPanel.add(fileNameLabel, new GridBagConstraints(0, 2, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.BOTH, new Insets(12, 24, 0, 0), 0, 0));
 312                 propertiesPanel.add(fileNameTextField, new GridBagConstraints(1, 2, 1, 1, 1.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.BOTH, new Insets(12, 12, 0, 0), 0, 0));
 313
 314                 fileSizeLabel = new I18nLabel("fileManager.label.fileSize");
 315                 fileSizeTextField = new JTextField();
 316                 fileSizeTextField.setEditable(false);
 317                 propertiesPanel.add(fileSizeLabel, new GridBagConstraints(0, 3, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.BOTH, new Insets(12, 24, 0, 0), 0, 0));
 318                 propertiesPanel.add(fileSizeTextField, new GridBagConstraints(1, 3, 1, 1, 1.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.BOTH, new Insets(12, 12, 0, 0), 0, 0));
 319
 320                 /* glue panel. */
 321                 propertiesPanel.add(new JPanel(), new GridBagConstraints(0, 4, 2, 1, 1.0, 1.0, GridBagConstraints.LINE_START, GridBagConstraints.BOTH, new Insets(0, 0, 0, 0), 0, 0));
 322
 323                 /* action button panel */
 324                 JPanel actionButtonPanel = new JPanel(new FlowLayout(FlowLayout.LEADING, 12, 12));
 325                 rightPanel.add(actionButtonPanel, BorderLayout.PAGE_END);
 326                 actionButtonPanel.setBorder(BorderFactory.createEtchedBorder());
 327
 328                 JButton rescanButton = new JButton(rescanAction);
 329                 actionButtonPanel.add(rescanButton);
 330
 331                 return fileManagerPanel;
 332         }
 333
 334         /**
 335          * Creates the button panel.
 336          *
 337          * @return The button panel
 338          */
 339         private Component createButtonPanel() {
 340                 JPanel buttonPanel = new JPanel(new FlowLayout(FlowLayout.TRAILING, 12, 12));
 341
 342                 buttonPanel.setBorder(BorderFactory.createEmptyBorder(-12, -12, -12, -12));
 343                 JButton closeButton = new JButton(closeAction);
 344                 buttonPanel.add(closeButton);
 345
 346                 getRootPane().setDefaultButton(closeButton);
 347                 return buttonPanel;
 348         }
 349
 350         /**
 351          * Initiates a file scan.
 352          */
 353         private void initiateFileScan() {
 354                 swingInterface.getThreadPool().execute(new Runnable() {
 355
 356                         /**
 357                          * @see java.lang.Runnable#run()
 358                          */
 359                         @SuppressWarnings("synthetic-access")
 360                         public void run() {
 361                                 fileTree.setEnabled(false);
 362                                 rescanAction.setEnabled(false);
 363                                 ProjectFile baseProjectFile = project.getBaseFile();
 364                                 if (baseProjectFile != null) {
 365                                         fileTreeModel.setBaseProjectFile(baseProjectFile);
 366                                 }
 367                                 // fileScrollPane.revalidate();
 368                                 rescanAction.setEnabled(true);
 369                                 fileTree.setEnabled(true);
 370                         }
 371
 372                 });
 373         }
 374
 375         /**
 376          * Checks whether the given mouse event is a popup trigger and occured over
 377          * a file. If so, the context menu is shown.
 378          *
 379          * @param mouseEvent
 380          *            The mouse event to check
 381          */
 382         private void maybeShowContextMenu(MouseEvent mouseEvent) {
 383                 if (!mouseEvent.isPopupTrigger()) {
 384                         return;
 385                 }
 386                 Point eventLocation = mouseEvent.getPoint();
 387                 TreePath clickedPath = fileTree.getPathForLocation(eventLocation.x, eventLocation.y);
 388                 if (clickedPath == null) {
 389                         return;
 390                 }
 391                 fileTree.setSelectionPath(clickedPath);
 392                 ProjectFileWrapper projectFileWrapper = (ProjectFileWrapper) clickedPath.getLastPathComponent();
 393                 insertCheckBoxMenuItem.setSelected(!isHidden(projectFileWrapper));
 394                 treeContextMenu.show(fileTree, eventLocation.x, eventLocation.y);
 395         }
 396
 397         /**
 398          * Finds whether the {@link ProjectFile} given by
 399          * <code>projectFileWrapper</code> is hidden.
 400          *
 401          * @param projectFileWrapper
 402          *            The wrapped project file
 403          * @return <code>true</code> if the file is hidden and should not be
 404          *         inserted, <code>false</code> otherwise
 405          */
 406         private boolean isHidden(ProjectFileWrapper projectFileWrapper) {
 407                 ProjectFile projectFile = projectFileWrapper.getProjectFile();
 408                 FileOverride fileOverride = project.getFileOverrides().get(projectFile.getCompletePath());
 409                 return ((fileOverride == null) && projectFile.isHidden()) || ((fileOverride != null) && (fileOverride.isInsert()));
 410         }
 411
 412         //
 413         // INTERFACE I18nable
 414         //
 415
 416         /**
 417          * {@inheritDoc}
 418          */
 419         public void updateI18n() {
 420                 setTitle(I18n.get("fileManager.title", project.getName()));
 421                 projectFilesLabel.updateI18n();
 422                 filePropertiesLabel.updateI18n();
 423                 filePathLabel.updateI18n();
 424         }
 425
 426         //
 427         // INTERFACE TreeSelectionListener
 428         //
 429
 430         /**
 431          * {@inheritDoc}
 432          */
 433         public void valueChanged(TreeSelectionEvent treeSelectionEvent) {
 434                 TreePath[] selectedPaths = fileTree.getSelectionPaths();
 435                 if ((selectedPaths != null) && (selectedPaths.length == 1)) {
 436                         Object lastPathComponent = selectedPaths[0].getLastPathComponent();
 437                         if (!(lastPathComponent instanceof ProjectFileWrapper)) {
 438                                 logger.log(Level.SEVERE, "lastPathComponent is not a ProjectFileWrapper!");
 439                                 return;
 440                         }
 441                         ProjectFileWrapper projectFileWrapper = (ProjectFileWrapper) lastPathComponent;
 442                         ProjectFile projectFile = projectFileWrapper.getProjectFile();
 443                         if (projectFile.isFile()) {
 444                                 fileNameTextField.setText(projectFile.getName());
 445                                 fileSizeTextField.setText(String.valueOf(projectFile.getSize()));
 446                         }
 447                 }
 448         }
 449
 450         //
 451         // INTERFACE ActionListener
 452         //
 453
 454         /**
 455          * {@inheritDoc}
 456          */
 457         public void actionPerformed(ActionEvent actionEvent) {
 458                 /* TODO */
 459         }
 460
 461         //
 462         // INTERFACE MouseListener
 463         //
 464
 465         /**
 466          * {@inheritDoc}
 467          */
 468         public void mouseClicked(MouseEvent mouseEvent) {
 469                 maybeShowContextMenu(mouseEvent);
 470         }
 471
 472         /**
 473          * {@inheritDoc}
 474          */
 475         public void mouseEntered(MouseEvent mouseEvent) {
 476                 /* ignore. */
 477         }
 478
 479         /**
 480          * {@inheritDoc}
 481          */
 482         public void mouseExited(MouseEvent mouseEvent) {
 483                 /* ignore. */
 484         }
 485
 486         /**
 487          * {@inheritDoc}
 488          */
 489         public void mousePressed(MouseEvent mouseEvent) {
 490                 maybeShowContextMenu(mouseEvent);
 491         }
 492
 493         /**
 494          * {@inheritDoc}
 495          */
 496         public void mouseReleased(MouseEvent mouseEvent) {
 497                 maybeShowContextMenu(mouseEvent);
 498         }
 499
 500         /**
 501          * Tree cell renderer that takes care of certain display properties for
 502          * project-specific stuff.
 503          *
 504          * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
 505          */
 506         private class FileCellRenderer extends DefaultTreeCellRenderer {
 507
 508                 /**
 509                  * Empty constructor.
 510                  */
 511                 FileCellRenderer() {
 512                         /* do nothing. */
 513                 }
 514
 515                 /**
 516                  * @see javax.swing.tree.TreeCellRenderer#getTreeCellRendererComponent(javax.swing.JTree,
 517                  *      java.lang.Object, boolean, boolean, boolean, int, boolean)
 518                  */
 519                 @SuppressWarnings("synthetic-access")
 520                 @Override
 521                 public Component getTreeCellRendererComponent(JTree tree, Object value, boolean selected, boolean expanded, boolean leaf, int row, boolean hasFocus) {
 522                         Component superCellRenderer = super.getTreeCellRendererComponent(tree, value, selected, expanded, leaf, row, hasFocus);
 523                         if (!(superCellRenderer instanceof JLabel)) {
 524                                 logger.log(Level.SEVERE, "superCellRenderer is not a JLabel!");
 525                                 return superCellRenderer;
 526                         }
 527                         if (!(value instanceof ProjectFileWrapper)) {
 528                                 logger.log(Level.SEVERE, "value is not a ProjectFileWrapper!");
 529                                 return superCellRenderer;
 530                         }
 531                         ProjectFileWrapper projectFileWrapper = (ProjectFileWrapper) value;
 532                         ProjectFile projectFile = projectFileWrapper.getProjectFile();
 533                         String completePath = projectFile.getCompletePath();
 534                         boolean paintBold = false;
 535                         boolean paintHalfColor = false;
 536                         if (projectFile.isFile() && projectFile.isHidden()) {
 537                                 /* TODO - check override */
 538                                 paintHalfColor = true;
 539                         } else if (completePath.equals(project.getDefaultFile())) {
 540                                 paintBold = true;
 541                         } else if (projectFile.getParents().size() == 1) {
 542                                 paintBold = true;
 543                         }
 544                         if (paintHalfColor) {
 545                                 /* TODO - cache colors */
 546                                 Color foreground = superCellRenderer.getForeground();
 547                                 Color background = selected ? getBackgroundSelectionColor() : getBackgroundNonSelectionColor();
 548                                 Color averageColor = new Color((foreground.getRed() + background.getRed()) / 2, (foreground.getGreen() + background.getGreen()) / 2, (foreground.getBlue() + background.getBlue()) / 2);
 549                                 superCellRenderer.setForeground(averageColor);
 550                         } else {
 551                                 superCellRenderer.setForeground(selected ? getTextSelectionColor() : getTextNonSelectionColor());
 552                         }
 553                         if (paintBold) {
 554                                 superCellRenderer.setFont(superCellRenderer.getFont().deriveFont(Font.BOLD));
 555                         } else {
 556                                 superCellRenderer.setFont(superCellRenderer.getFont().deriveFont(Font.PLAIN));
 557                         }
 558                         return superCellRenderer;
 559                 }
 560
 561         }
 562
 563         /**
 564          * TreeModel that is based on {@link Project#getBaseFile()}.
 565          *
 566          * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
 567          */
 568         private class ProjectFileTreeModel implements TreeModel, PropertyChangeListener {
 569
 570                 /** Tree model listeners. */
 571                 private final List<TreeModelListener> treeModelListeners = Collections.synchronizedList(new ArrayList<TreeModelListener>());
 572
 573                 /** The base project file. */
 574                 private ProjectFile baseProjectFile;
 575
 576                 /** Maps path names to project files. */
 577                 private final Map<String, ProjectFile> pathProjectFiles = Collections.synchronizedMap(new HashMap<String, ProjectFile>());
 578
 579                 /** Maps project files to wrappers. */
 580                 private final Map<ProjectFile, ProjectFileWrapper> projectFileWrappers = Collections.synchronizedMap(new HashMap<ProjectFile, ProjectFileWrapper>());
 581
 582                 /**
 583                  * Empty constructor.
 584                  */
 585                 ProjectFileTreeModel() {
 586                         /* do nothing. */
 587                 }
 588
 589                 //
 590                 // EVENT MANAGEMENT
 591                 //
 592
 593                 /**
 594                  * {@inheritDoc}
 595                  */
 596                 public void addTreeModelListener(TreeModelListener treeModelListener) {
 597                         treeModelListeners.add(treeModelListener);
 598                 }
 599
 600                 /**
 601                  * {@inheritDoc}
 602                  */
 603                 public void removeTreeModelListener(TreeModelListener treeModelListener) {
 604                         treeModelListeners.remove(treeModelListener);
 605                 }
 606
 607                 /**
 608                  * Notifies all listeners that a node has changed.
 609                  *
 610                  * @param changedProjectFileWrapper
 611                  *            The wrapper around the changed project file
 612                  */
 613                 protected void fireTreeNodesChanged(ProjectFileWrapper changedProjectFileWrapper) {
 614                         ProjectFile changedProjectFile = changedProjectFileWrapper.getProjectFile();
 615                         ProjectFile changedProjectFileParent = changedProjectFile.getParent();
 616                         ProjectFile currentProjectFileParent = changedProjectFile;
 617                         List<ProjectFileWrapper> parentProjectFileWrappers = new ArrayList<ProjectFileWrapper>();
 618                         do {
 619                                 parentProjectFileWrappers.add(0, projectFileWrappers.get(currentProjectFileParent));
 620                                 currentProjectFileParent = currentProjectFileParent.getParent();
 621                         } while (currentProjectFileParent != null);
 622                         TreeModelEvent treeModelEvent = new TreeModelEvent(this, parentProjectFileWrappers.toArray(), new int[] { getIndexOfChild(projectFileWrappers.get(changedProjectFileParent), changedProjectFileWrapper) }, new Object[] { changedProjectFileWrapper });
 623                         for (TreeModelListener treeModelListener : treeModelListeners) {
 624                                 treeModelListener.treeNodesChanged(treeModelEvent);
 625                         }
 626                 }
 627
 628                 /**
 629                  * Notifies all listeners that the tree structure has changed
 630                  * significantly.
 631                  *
 632                  * @see TreeModelListener#treeStructureChanged(TreeModelEvent)
 633                  * @param newRootNode
 634                  */
 635                 protected void fireTreeStructureChanged(ProjectFileWrapper newRootNode) {
 636                         for (TreeModelListener treeModelListener : treeModelListeners) {
 637                                 treeModelListener.treeStructureChanged(new TreeModelEvent(this, new Object[] { newRootNode }));
 638                         }
 639                 }
 640
 641                 //
 642                 // ACCESSORS
 643                 //
 644
 645                 /**
 646                  * Sets the new base project file. This causes the model to reload.
 647                  *
 648                  * @param baseProjectFile
 649                  *            The new base project file
 650                  */
 651                 @SuppressWarnings("synthetic-access")
 652                 public synchronized void setBaseProjectFile(ProjectFile baseProjectFile) {
 653                         this.baseProjectFile = baseProjectFile;
 654                         projectFileWrappers.clear();
 655                         pathProjectFiles.clear();
 656                         createWrappers(baseProjectFile);
 657                         projectFileWrappers.get(baseProjectFile).setNameOverride(project.getName());
 658                         fireTreeStructureChanged(projectFileWrappers.get(baseProjectFile));
 659                 }
 660
 661                 //
 662                 // PRIVATE METHODS
 663                 //
 664
 665                 /**
 666                  * Creates {@link ProjectFileWrapper}s for all files below the given
 667                  * project file.
 668                  *
 669                  * @param projectFile
 670                  *            The base project file for all project files to create
 671                  *            wrappers for
 672                  */
 673                 private void createWrappers(ProjectFile projectFile) {
 674                         projectFileWrappers.put(projectFile, new ProjectFileWrapper(projectFile));
 675                         pathProjectFiles.put(projectFile.getCompletePath(), projectFile);
 676                         for (ProjectFile projectFileChild : projectFile.getFiles()) {
 677                                 if (projectFileChild.isDirectory()) {
 678                                         createWrappers(projectFileChild);
 679                                 }
 680                                 projectFileWrappers.put(projectFileChild, new ProjectFileWrapper(projectFileChild));
 681                                 pathProjectFiles.put(projectFileChild.getCompletePath(), projectFileChild);
 682                         }
 683                 }
 684
 685                 //
 686                 // INTERFACE TreeModel
 687                 //
 688
 689                 /**
 690                  * {@inheritDoc}
 691                  */
 692                 public Object getRoot() {
 693                         return projectFileWrappers.get(baseProjectFile);
 694                 }
 695
 696                 /**
 697                  * {@inheritDoc}
 698                  */
 699                 @SuppressWarnings("synthetic-access")
 700                 public Object getChild(Object parent, int index) {
 701                         if (!(parent instanceof ProjectFileWrapper)) {
 702                                 logger.log(Level.SEVERE, "parent is not a ProjectFileWrapper!");
 703                                 return null;
 704                         }
 705                         ProjectFileWrapper projectFileWrapper = (ProjectFileWrapper) parent;
 706                         ProjectFile projectFile = projectFileWrapper.getProjectFile();
 707                         return projectFileWrappers.get(projectFile.getFiles().get(index));
 708                 }
 709
 710                 /**
 711                  * {@inheritDoc}
 712                  */
 713                 @SuppressWarnings("synthetic-access")
 714                 public int getChildCount(Object parent) {
 715                         if (!(parent instanceof ProjectFileWrapper)) {
 716                                 logger.log(Level.SEVERE, "parent is not a ProjectFileWrapper!");
 717                                 return -1;
 718                         }
 719                         ProjectFileWrapper projectFileWrapper = (ProjectFileWrapper) parent;
 720                         ProjectFile projectFile = projectFileWrapper.getProjectFile();
 721                         return projectFile.getFiles().size();
 722                 }
 723
 724                 /**
 725                  * {@inheritDoc}
 726                  */
 727                 @SuppressWarnings("synthetic-access")
 728                 public int getIndexOfChild(Object parent, Object child) {
 729                         if (!(parent instanceof ProjectFileWrapper)) {
 730                                 logger.log(Level.SEVERE, "parent is not a ProjectFileWrapper!");
 731                                 return -1;
 732                         }
 733                         if (!(child instanceof ProjectFileWrapper)) {
 734                                 logger.log(Level.SEVERE, "child is not a ProjectFileWrapper!");
 735                                 return -1;
 736                         }
 737                         ProjectFileWrapper projectFileWrapper = (ProjectFileWrapper) parent;
 738                         ProjectFile projectFile = projectFileWrapper.getProjectFile();
 739                         return projectFile.getFiles().indexOf(((ProjectFileWrapper) child).getProjectFile());
 740                 }
 741
 742                 /**
 743                  * {@inheritDoc}
 744                  */
 745                 @SuppressWarnings("synthetic-access")
 746                 public boolean isLeaf(Object node) {
 747                         if (!(node instanceof ProjectFileWrapper)) {
 748                                 logger.log(Level.SEVERE, "node is not a ProjectFileWrapper!");
 749                                 return true;
 750                         }
 751                         ProjectFileWrapper projectFileWrapper = (ProjectFileWrapper) node;
 752                         ProjectFile projectFile = projectFileWrapper.getProjectFile();
 753                         return projectFile.getFiles().isEmpty();
 754                 }
 755
 756                 /**
 757                  * {@inheritDoc}
 758                  */
 759                 public void valueForPathChanged(TreePath path, Object newValue) {
 760                         /* ignore, items will not be modified in tree. */
 761                 }
 762
 763                 //
 764                 // INTERFACE PropertyChangeListener
 765                 //
 766
 767                 /**
 768                  * @see java.beans.PropertyChangeListener#propertyChange(java.beans.PropertyChangeEvent)
 769                  */
 770                 public void propertyChange(PropertyChangeEvent propertyChangeEvent) {
 771                         if (Project.PROPERTY_DEFAULT_FILE.equals(propertyChangeEvent.getPropertyName())) {
 772                                 String oldCompletePath = (String) propertyChangeEvent.getOldValue();
 773                                 String newCompletePath = (String) propertyChangeEvent.getNewValue();
 774                                 ProjectFile oldProjectFile = pathProjectFiles.get(oldCompletePath);
 775                                 ProjectFile newProjectFile = pathProjectFiles.get(newCompletePath);
 776                                 ProjectFileWrapper oldProjectFileWrapper = projectFileWrappers.get(oldProjectFile);
 777                                 ProjectFileWrapper newProjectFileWrapper = projectFileWrappers.get(newProjectFile);
 778                                 System.out.println("oldProjectFileWrapper: " + oldProjectFileWrapper);
 779                                 System.out.println("newProjectFileWrapper: " + newProjectFileWrapper);
 780                                 fireTreeNodesChanged(oldProjectFileWrapper);
 781                                 fireTreeNodesChanged(newProjectFileWrapper);
 782                                 /* HACK - swing sucks a bit. */
 783                                 fileTree.setShowsRootHandles(false);
 784                         }
 785                 }
 786
 787         }
 788
 789         /**
 790          * Wrapper around a {@link ProjectFile} that overwrites
 791          * {@link Object#toString()} to return the project file’s name.
 792          *
 793          * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
 794          */
 795         private static class ProjectFileWrapper {
 796
 797                 /** The wrapped project file. */
 798                 private final ProjectFile projectFile;
 799
 800                 /** The override name. */
 801                 private String nameOverride;
 802
 803                 /**
 804                  * Creates a new wrapper around a project file.
 805                  *
 806                  * @param projectFile
 807                  *            The project file to wrap
 808                  */
 809                 public ProjectFileWrapper(ProjectFile projectFile) {
 810                         this.projectFile = projectFile;
 811                 }
 812
 813                 /**
 814                  * Returns the wrapped project file.
 815                  *
 816                  * @return The wrapped project file
 817                  */
 818                 public ProjectFile getProjectFile() {
 819                         return projectFile;
 820                 }
 821
 822                 /**
 823                  * Sets the name override. If the name override is not <code>null</code>
 824                  * it will be shown insted of the project file’s name.
 825                  *
 826                  * @param nameOverride
 827                  *            The name override
 828                  */
 829                 void setNameOverride(String nameOverride) {
 830                         this.nameOverride = nameOverride;
 831                 }
 832
 833                 /**
 834                  * {@inheritDoc}
 835                  */
 836                 @Override
 837                 public String toString() {
 838                         return (nameOverride != null) ? nameOverride : projectFile.getName();
 839                 }
 840
 841         }
 842
 843 }