TreeTableModel.class as the respective column class
* in their implementation of the {@link #getColumnClass(int)} method:
*
* public Class<?> getColumnClass(int column)
* {
* if (column == columnThatShouldContainTheTree)
* {
* return TreeTableModel.class;
* }
* // Return other types as desired:
* return Object.class;
* }
* + * The behavior for this is debatable, and should really be offered as a + * property. By returning false, all keyboard actions are implemented in + * terms of the table. By returning true, the tree would get a chance to + * do something with the keyboard events. For the most part this is ok. + * But for certain keys, such as left/right, the tree will + * expand/collapse where as the table focus should really move to a + * different column. Page up/down should also be implemented in terms of + * the table. By returning false this also has the added benefit that + * clicking outside of the bounds of the tree node, but still in the + * tree column will select the row, whereas if this returned true that + * wouldn't be the case. + *
+ * By returning false we are also enforcing the policy that the tree
+ * will never be editable (at least by a key sequence).
+ */
+ @Override
+ public boolean isCellEditable(EventObject e)
+ {
+ if (!(e instanceof MouseEvent))
+ {
+ return false;
+ }
+ MouseEvent me = (MouseEvent) e;
+ for (int counter = getColumnCount() - 1; counter >= 0; counter--)
+ {
+ if (getColumnClass(counter) == TreeTableModel.class)
+ {
+ MouseEvent newME =
+ new MouseEvent(tree, me.getID(), me.getWhen(),
+ me.getModifiers(), me.getX()
+ - getCellRect(0, counter, true).x,
+ me.getY(), me.getClickCount(),
+ me.isPopupTrigger(), me.getButton());
+ tree.dispatchEvent(newME);
+ break;
+ }
+ }
+ return false;
+ }
+ }
+
+ /**
+ * ListToTreeSelectionModelWrapper extends DefaultTreeSelectionModel to
+ * listen for changes in the ListSelectionModel it maintains. Once a change
+ * in the ListSelectionModel happens, the paths are updated in the
+ * DefaultTreeSelectionModel.
+ */
+ class ListToTreeSelectionModelWrapper extends DefaultTreeSelectionModel
+ {
+ /**
+ * Serial UID
+ */
+ private static final long serialVersionUID = -3150534152238745922L;
+
+ /**
+ * Set to true when we are updating the ListSelectionModel.
+ */
+ protected boolean updatingListSelectionModel;
+
+ /**
+ * Default constructor
+ */
+ ListToTreeSelectionModelWrapper()
+ {
+ getListSelectionModel().addListSelectionListener(
+ new ListSelectionListener()
+ {
+ @Override
+ public void valueChanged(ListSelectionEvent e)
+ {
+ updateSelectedPathsFromSelectedRows();
+ }
+ });
+ }
+
+ /**
+ * Returns the list selection model. ListToTreeSelectionModelWrapper
+ * listens for changes to this model and updates the selected paths
+ * accordingly.
+ *
+ * @return The list selection model
+ */
+ ListSelectionModel getListSelectionModel()
+ {
+ return listSelectionModel;
+ }
+
+ /**
+ * This is overridden to set updatingListSelectionModel and
+ * message super. This is the only place DefaultTreeSelectionModel
+ * alters the ListSelectionModel.
+ */
+ @Override
+ public void resetRowSelection()
+ {
+ if (!updatingListSelectionModel)
+ {
+ updatingListSelectionModel = true;
+ try
+ {
+ super.resetRowSelection();
+ }
+ finally
+ {
+ updatingListSelectionModel = false;
+ }
+ }
+ // Notice how we don't message super if
+ // updatingListSelectionModel is true. If
+ // updatingListSelectionModel is true, it implies the
+ // ListSelectionModel has already been updated and the
+ // paths are the only thing that needs to be updated.
+ }
+
+ /**
+ * If updatingListSelectionModel is false, this will reset
+ * the selected paths from the selected rows in the list selection
+ * model.
+ */
+ protected void updateSelectedPathsFromSelectedRows()
+ {
+ if (!updatingListSelectionModel)
+ {
+ updatingListSelectionModel = true;
+ try
+ {
+ // This is way expensive, ListSelectionModel needs an
+ // enumerator for iterating.
+ int min = listSelectionModel.getMinSelectionIndex();
+ int max = listSelectionModel.getMaxSelectionIndex();
+
+ clearSelection();
+ if (min != -1 && max != -1)
+ {
+ for (int counter = min; counter <= max; counter++)
+ {
+ if (listSelectionModel.isSelectedIndex(counter))
+ {
+ TreePath selPath = tree.getPathForRow(counter);
+
+ if (selPath != null)
+ {
+ addSelectionPath(selPath);
+ }
+ }
+ }
+ }
+ }
+ finally
+ {
+ updatingListSelectionModel = false;
+ }
+ }
+ }
+
+ }
+
+ //JPEXS
+ public void setTreeTableModel(TreeTableModel model) {
+ tree.setModel(model);
+ setModel(new TreeTableModelAdapter(model, tree));
+ repaint();
+ }
+}
diff --git a/src/de/javagl/treetable/TreeTableModel.java b/src/de/javagl/treetable/TreeTableModel.java
new file mode 100644
index 000000000..7d8ed26bf
--- /dev/null
+++ b/src/de/javagl/treetable/TreeTableModel.java
@@ -0,0 +1,125 @@
+/*
+ * www.javagl.de - JTreeTable
+ *
+ * Copyright (c) 2016 Marco Hutter - http://www.javagl.de
+ *
+ * This library is based on the code from the article "Creating TreeTables"
+ * by Sun Microsystems (now known as Oracle).
+ *
+ * The original copyright header:
+ *
+ * Copyright 1998 Sun Microsystems, Inc. All Rights Reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * - Neither the name of Sun Microsystems nor the names of its
+ * contributors may be used to endorse or promote products derived
+ * from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package de.javagl.treetable;
+
+import javax.swing.tree.TreeModel;
+
+/**
+ * TreeTableModel is the model used by a JTreeTable. It extends TreeModel
+ * to add methods for getting information about the set of columns each
+ * node in the TreeTableModel may have. Each column, like a column in
+ * a TableModel, has a name and a type associated with it. Each node in
+ * the TreeTableModel can return a value for each of the columns and
+ * set that value if isCellEditable() returns true.
+ *
+ * Note: In order to actually display the JTree in one column of the
+ * JTreeTable, implementors of this class have to return the
+ * TreeTableModel.class as the respective column class
+ * in their implementation of the {@link #getColumnClass(int)} method:
+ *
+ * public Class<?> getColumnClass(int column)
+ * {
+ * if (column == columnThatShouldContainTheTree)
+ * {
+ * return TreeTableModel.class;
+ * }
+ * // Return other types as desired:
+ * return Object.class;
+ * }
+ * TreeTableModel.class.
+ *
+ * @param column The column
+ * @return The column name
+ */
+ Class getColumnClass(int column);
+
+ /**
+ * Returns the value to be displayed for the given node in the
+ * specified column
+ *
+ * @param node The node
+ * @param column The column
+ * @return The object that should be displayed
+ */
+ Object getValueAt(Object node, int column);
+
+ /**
+ * Indicates whether the the value for the given node in the
+ * specified column is editable
+ *
+ * @param node The node
+ * @param column The column
+ * @return Whether the specified value is editable
+ */
+ boolean isCellEditable(Object node, int column);
+
+ /**
+ * Sets the value for the given node in the specified column
+ *
+ * @param value The value to set
+ * @param node The node
+ * @param column The column
+ */
+ void setValueAt(Object value, Object node, int column);
+}
diff --git a/src/de/javagl/treetable/TreeTableModelAdapter.java b/src/de/javagl/treetable/TreeTableModelAdapter.java
new file mode 100644
index 000000000..26fe82d1e
--- /dev/null
+++ b/src/de/javagl/treetable/TreeTableModelAdapter.java
@@ -0,0 +1,203 @@
+/*
+ * www.javagl.de - JTreeTable
+ *
+ * Copyright (c) 2016 Marco Hutter - http://www.javagl.de
+ *
+ * This library is based on the code from the article "Creating TreeTables"
+ * by Sun Microsystems (now known as Oracle).
+ *
+ * The original copyright header:
+ *
+ * Copyright 1998 Sun Microsystems, Inc. All Rights Reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * - Neither the name of Sun Microsystems nor the names of its
+ * contributors may be used to endorse or promote products derived
+ * from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package de.javagl.treetable;
+
+import javax.swing.JTree;
+import javax.swing.SwingUtilities;
+import javax.swing.table.AbstractTableModel;
+import javax.swing.tree.TreePath;
+import javax.swing.event.TreeExpansionEvent;
+import javax.swing.event.TreeExpansionListener;
+import javax.swing.event.TreeModelEvent;
+import javax.swing.event.TreeModelListener;
+
+/**
+ * This is a wrapper class takes a TreeTableModel and implements the table model
+ * interface. The implementation is trivial, with all of the event dispatching
+ * support provided by the superclass: the AbstractTableModel.
+ */
+class TreeTableModelAdapter extends AbstractTableModel
+{
+ /**
+ * Serial UID
+ */
+ private static final long serialVersionUID = 8489726674002235447L;
+
+ /**
+ * The tree that backs this adapter. When the tree is expanded or
+ * collapsed, the table model is updated accordingly
+ */
+ private final JTree tree;
+
+ /**
+ * The backing {@link TreeTableModel}
+ */
+ private final TreeTableModel treeTableModel;
+
+ /**
+ * Default constructor
+ * @param treeTableModel The backing {@link TreeTableModel}
+ * @param tree The tree
+ */
+ TreeTableModelAdapter(TreeTableModel treeTableModel, JTree tree)
+ {
+ this.tree = tree;
+ this.treeTableModel = treeTableModel;
+
+ tree.addTreeExpansionListener(new TreeExpansionListener()
+ {
+ // Don't use fireTableRowsInserted() here; the selection model
+ // would get updated twice.
+ @Override
+ public void treeExpanded(TreeExpansionEvent event)
+ {
+ fireTableDataChanged();
+ }
+
+ @Override
+ public void treeCollapsed(TreeExpansionEvent event)
+ {
+ fireTableDataChanged();
+ }
+ });
+
+ // Install a TreeModelListener that can update the table when
+ // tree changes. We use delayedFireTableDataChanged as we can
+ // not be guaranteed the tree will have finished processing
+ // the event before us.
+ treeTableModel.addTreeModelListener(new TreeModelListener()
+ {
+ @Override
+ public void treeNodesChanged(TreeModelEvent e)
+ {
+ delayedFireTableDataChanged();
+ }
+
+ @Override
+ public void treeNodesInserted(TreeModelEvent e)
+ {
+ delayedFireTableDataChanged();
+ }
+
+ @Override
+ public void treeNodesRemoved(TreeModelEvent e)
+ {
+ delayedFireTableDataChanged();
+ }
+
+ @Override
+ public void treeStructureChanged(TreeModelEvent e)
+ {
+ delayedFireTableDataChanged();
+ }
+ });
+ }
+
+ @Override
+ public int getColumnCount()
+ {
+ return treeTableModel.getColumnCount();
+ }
+
+ @Override
+ public String getColumnName(int column)
+ {
+ return treeTableModel.getColumnName(column);
+ }
+
+ @Override
+ public Class getColumnClass(int column)
+ {
+ return treeTableModel.getColumnClass(column);
+ }
+
+ @Override
+ public int getRowCount()
+ {
+ return tree.getRowCount();
+ }
+
+ @Override
+ public Object getValueAt(int row, int column)
+ {
+ return treeTableModel.getValueAt(nodeForRow(row), column);
+ }
+
+ @Override
+ public boolean isCellEditable(int row, int column)
+ {
+ return treeTableModel.isCellEditable(nodeForRow(row), column);
+ }
+
+ @Override
+ public void setValueAt(Object value, int row, int column)
+ {
+ treeTableModel.setValueAt(value, nodeForRow(row), column);
+ }
+
+
+ /**
+ * Returns the tree node that is located in the specified row
+ *
+ * @param row The row
+ * @return The tree node
+ */
+ private Object nodeForRow(int row)
+ {
+ TreePath treePath = tree.getPathForRow(row);
+ return treePath.getLastPathComponent();
+ }
+
+ /**
+ * Invokes fireTableDataChanged after all the pending events have been
+ * processed. SwingUtilities.invokeLater is used to handle this.
+ */
+ private void delayedFireTableDataChanged()
+ {
+ SwingUtilities.invokeLater(new Runnable()
+ {
+ @Override
+ public void run()
+ {
+ fireTableDataChanged();
+ }
+ });
+ }
+}
diff --git a/src/de/javagl/treetable/package-info.java b/src/de/javagl/treetable/package-info.java
new file mode 100644
index 000000000..35724f64a
--- /dev/null
+++ b/src/de/javagl/treetable/package-info.java
@@ -0,0 +1,9 @@
+/**
+ * A JTreeTable based on the example code from the article "Creating TreeTables"
+ * by Sun Microsystems.