geotools/selection/TableSelectionSynchronizer.java

/** 
 Copyright 2008 Stefan Alfons Krüger 
 
 atlas-framework - This file is part of the Atlas Framework

 This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
 This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
 You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA

 Diese Bibliothek ist freie Software; Sie dürfen sie unter den Bedingungen der GNU Lesser General Public License, wie von der Free Software Foundation veröffentlicht, weiterverteilen und/oder modifizieren; entweder gemäß Version 2.1 der Lizenz oder (nach Ihrer Option) jeder späteren Version.
 Diese Bibliothek wird in der Hoffnung weiterverbreitet, daß sie nützlich sein wird, jedoch OHNE IRGENDEINE GARANTIE, auch ohne die implizierte Garantie der MARKTREIFE oder der VERWENDBARKEIT FÜR EINEN BESTIMMTEN ZWECK. Mehr Details finden Sie in der GNU Lesser General Public License.
 Sie sollten eine Kopie der GNU Lesser General Public License zusammen mit dieser Bibliothek erhalten haben; falls nicht, schreiben Sie an die Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA.
 **/
package skrueger.geotools.selection;

import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.util.Vector;

import javax.swing.JTable;
import javax.swing.ListSelectionModel;
import javax.swing.event.ListSelectionEvent;
import javax.swing.event.ListSelectionListener;
import javax.swing.table.TableModel;

import org.geotools.feature.Feature;

import schmitzm.geotools.gui.FeatureCollectionTableModel;
import schmitzm.swing.table.PipedTableModel;
import schmitzm.swing.table.SelectionTableModel;
import skrueger.geotools.selection.StyledFeatureLayerSelectionModel;
import skrueger.geotools.selection.StyledLayerSelectionEvent;
import skrueger.geotools.selection.StyledLayerSelectionModel;

/**
 * This class keeps the selection of a (feature) {@link JTable} synchronized
 * with the {@link StyledLayerSelectionModel} of a layer. This is done by
 * implementing:
 * <ul>
 * <li>a {@link PropertyChangeListener} which listens to the
 * {@link StyledLayerSelectionModel} and accordingly changes the {@link JTable}
 * selection</li>
 * <li>a {@link ListSelectionListener} which listens to the {@link JTable} and
 * accordingly changes the {@link StyledLayerSelectionModel} selection</li>
 * </ul>
 * After creating, the instance of this synchronizer must be added as listener
 * to both, the {@link StyledLayerSelectionModel} and the table's
 * {@link ListSelectionModel}.
 * 
 * @author <a href="mailto:[email protected]">Martin Schmitz</a>
 *         (University of Bonn/Germany)
 */
public class TableSelectionSynchronizer extends StyledLayerSelectionModelSynchronizer<StyledFeatureLayerSelectionModel> implements ListSelectionListener {
        /**
         * Holds the table to keep synchronized with the layer selection model.
         */
        protected JTable featureTable = null;
        /** Holds the table's data. */
        protected FeatureCollectionTableModel featureTableModel = null;

        /**
         * Creates a new synchronizer
         * 
         * @param layerSelModel
         *            layer selection model to keep synchronized with the feature
         *            table
         * @param table
         *            table to keep synchronized with the layer selection model
         */
        public TableSelectionSynchronizer(StyledFeatureLayerSelectionModel layerSelModel, JTable table) {
                super(layerSelModel);

                TableModel model = table.getModel();
                if (model instanceof PipedTableModel)
                        model = ((PipedTableModel) table.getModel()).getPipedModel();

                if (!(model instanceof FeatureCollectionTableModel))
                        throw new IllegalArgumentException(
                                        "Table must have a model instance of FeatureCollectionTableModel");

                this.featureTableModel = (FeatureCollectionTableModel) model;
                this.featureTable = table;
        }

        /**
         * Called by {@link StyledLayerSelectionModel} when a the selection on other
         * selection components (map, chart, ...) has changed. When calling this
         * method changes the table selection according to the
         * {@link StyledLayerSelectionModel} selection.
         * 
         * @param evt
         *            an event
         */
        @Override
        public void propertyChange(PropertyChangeEvent evt) {
                if (!(evt instanceof StyledLayerSelectionEvent))
                        return;
                StyledLayerSelectionEvent selEvt = (StyledLayerSelectionEvent) evt;
                // Only react on own layer and ignore events invoked by
                // this component itself
                if (selEvt.getEmitter() != layerSelModel || selectionChangeCausedByMe)
                        return;
                // Apply new selection on table (except this event is one of
                // some more events)
                Vector<Feature> newSelection = layerSelModel.getSelection();
                if (newSelection == null)
                        return;
                
                LOGGER.debug("Table pop changed "+selEvt);
                LOGGER.debug("Table pop changed to "+newSelection);

                // Avoid event circles in valueChanged(..)
                selectionChangeCausedByMe = true;

                ListSelectionModel tableSelModel = featureTable.getSelectionModel();
                tableSelModel.setValueIsAdjusting(true);
                tableSelModel.clearSelection();
                for (Feature f : newSelection) {
                        int modelIdx = featureTableModel.findFeature(f);
                        if (modelIdx >= 0) {
                                int tableIdx = featureTable.convertRowIndexToView(modelIdx);
                                tableSelModel.addSelectionInterval(tableIdx, tableIdx);
                        }
                }
                tableSelModel.setValueIsAdjusting(false); // event is fired
                // autmatically!

                // Danger of event circles in valueChanged(..) banned
                selectionChangeCausedByMe = false;
        }

        /**
         * Called when the table selection is changed by the user. When calling this
         * method changes the selection of the {@link StyledLayerSelectionModel}.
         * 
         * @param evt
         *            an event
         */
        @Override
        public void valueChanged(ListSelectionEvent evt) {
                // ignore event if it is part of multiple events
                if (evt != null && evt.getValueIsAdjusting())
                        return;
                // ignore event if it is caused by the DpLayerVectorSelectionModel
                if (selectionChangeCausedByMe)
                        return;

                // Avoid event circles in propertyChange(..)
                selectionChangeCausedByMe = true;

                // reset the selection of the DpLayerSelectionModel
                layerSelModel.setValueIsAdjusting(true);
                for (int i = evt.getFirstIndex(); i <= evt.getLastIndex(); i++) {
                        Feature changedFeature = featureTableModel.getFeature(featureTable
                                        .convertRowIndexToModel(i));
                        if (featureTable.isRowSelected(i))
                                layerSelModel.addSelection(changedFeature);
                        else
                                layerSelModel.removeSelection(changedFeature);
                }
                layerSelModel.setValueIsAdjusting(false);

                // Danger of event circles in propertyChange(..) banned
                selectionChangeCausedByMe = false;
        }
}
1	/**
2	Copyright 2008 Stefan Alfons Krüger
3
4	atlas-framework - This file is part of the Atlas Framework
5
6	This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
7	This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
8	You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
9
10	Diese Bibliothek ist freie Software; Sie dürfen sie unter den Bedingungen der GNU Lesser General Public License, wie von der Free Software Foundation veröffentlicht, weiterverteilen und/oder modifizieren; entweder gemäß Version 2.1 der Lizenz oder (nach Ihrer Option) jeder späteren Version.
11	Diese Bibliothek wird in der Hoffnung weiterverbreitet, daß sie nützlich sein wird, jedoch OHNE IRGENDEINE GARANTIE, auch ohne die implizierte Garantie der MARKTREIFE oder der VERWENDBARKEIT FÜR EINEN BESTIMMTEN ZWECK. Mehr Details finden Sie in der GNU Lesser General Public License.
12	Sie sollten eine Kopie der GNU Lesser General Public License zusammen mit dieser Bibliothek erhalten haben; falls nicht, schreiben Sie an die Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA.
13	**/
14	package skrueger.geotools.selection;
15
16	import java.beans.PropertyChangeEvent;
17	import java.beans.PropertyChangeListener;
18	import java.util.Vector;
19
20	import javax.swing.JTable;
21	import javax.swing.ListSelectionModel;
22	import javax.swing.event.ListSelectionEvent;
23	import javax.swing.event.ListSelectionListener;
24	import javax.swing.table.TableModel;
25
26	import org.geotools.feature.Feature;
27
28	import schmitzm.geotools.gui.FeatureCollectionTableModel;
29	import schmitzm.swing.table.PipedTableModel;
30	import schmitzm.swing.table.SelectionTableModel;
31	import skrueger.geotools.selection.StyledFeatureLayerSelectionModel;
32	import skrueger.geotools.selection.StyledLayerSelectionEvent;
33	import skrueger.geotools.selection.StyledLayerSelectionModel;
34
35	/**
36	* This class keeps the selection of a (feature) {@link JTable} synchronized
37	* with the {@link StyledLayerSelectionModel} of a layer. This is done by
38	* implementing:
39	* <ul>
40	* <li>a {@link PropertyChangeListener} which listens to the
41	* {@link StyledLayerSelectionModel} and accordingly changes the {@link JTable}
42	* selection</li>
43	* <li>a {@link ListSelectionListener} which listens to the {@link JTable} and
44	* accordingly changes the {@link StyledLayerSelectionModel} selection</li>
45	* </ul>
46	* After creating, the instance of this synchronizer must be added as listener
47	* to both, the {@link StyledLayerSelectionModel} and the table's
48	* {@link ListSelectionModel}.
49	*
50	* @author <a href="mailto:[email protected]">Martin Schmitz</a>
51	* (University of Bonn/Germany)
52	*/
53	public class TableSelectionSynchronizer extends StyledLayerSelectionModelSynchronizer<StyledFeatureLayerSelectionModel> implements ListSelectionListener {
54	/**
55	* Holds the table to keep synchronized with the layer selection model.
56	*/
57	protected JTable featureTable = null;
58	/** Holds the table's data. */
59	protected FeatureCollectionTableModel featureTableModel = null;
60
61	/**
62	* Creates a new synchronizer
63	*
64	* @param layerSelModel
65	* layer selection model to keep synchronized with the feature
66	* table
67	* @param table
68	* table to keep synchronized with the layer selection model
69	*/
70	public TableSelectionSynchronizer(StyledFeatureLayerSelectionModel layerSelModel, JTable table) {
71	super(layerSelModel);
72
73	TableModel model = table.getModel();
74	if (model instanceof PipedTableModel)
75	model = ((PipedTableModel) table.getModel()).getPipedModel();
76
77	if (!(model instanceof FeatureCollectionTableModel))
78	throw new IllegalArgumentException(
79	"Table must have a model instance of FeatureCollectionTableModel");
80
81	this.featureTableModel = (FeatureCollectionTableModel) model;
82	this.featureTable = table;
83	}
84
85	/**
86	* Called by {@link StyledLayerSelectionModel} when a the selection on other
87	* selection components (map, chart, ...) has changed. When calling this
88	* method changes the table selection according to the
89	* {@link StyledLayerSelectionModel} selection.
90	*
91	* @param evt
92	* an event
93	*/
94	@Override
95	public void propertyChange(PropertyChangeEvent evt) {
96	if (!(evt instanceof StyledLayerSelectionEvent))
97	return;
98	StyledLayerSelectionEvent selEvt = (StyledLayerSelectionEvent) evt;
99	// Only react on own layer and ignore events invoked by
100	// this component itself
101	if (selEvt.getEmitter() != layerSelModel \|\| selectionChangeCausedByMe)
102	return;
103	// Apply new selection on table (except this event is one of
104	// some more events)
105	Vector<Feature> newSelection = layerSelModel.getSelection();
106	if (newSelection == null)
107	return;
108
109	LOGGER.debug("Table pop changed "+selEvt);
110	LOGGER.debug("Table pop changed to "+newSelection);
111
112	// Avoid event circles in valueChanged(..)
113	selectionChangeCausedByMe = true;
114
115	ListSelectionModel tableSelModel = featureTable.getSelectionModel();
116	tableSelModel.setValueIsAdjusting(true);
117	tableSelModel.clearSelection();
118	for (Feature f : newSelection) {
119	int modelIdx = featureTableModel.findFeature(f);
120	if (modelIdx >= 0) {
121	int tableIdx = featureTable.convertRowIndexToView(modelIdx);
122	tableSelModel.addSelectionInterval(tableIdx, tableIdx);
123	}
124	}
125	tableSelModel.setValueIsAdjusting(false); // event is fired
126	// autmatically!
127
128	// Danger of event circles in valueChanged(..) banned
129	selectionChangeCausedByMe = false;
130	}
131
132	/**
133	* Called when the table selection is changed by the user. When calling this
134	* method changes the selection of the {@link StyledLayerSelectionModel}.
135	*
136	* @param evt
137	* an event
138	*/
139	@Override
140	public void valueChanged(ListSelectionEvent evt) {
141	// ignore event if it is part of multiple events
142	if (evt != null && evt.getValueIsAdjusting())
143	return;
144	// ignore event if it is caused by the DpLayerVectorSelectionModel
145	if (selectionChangeCausedByMe)
146	return;
147
148	// Avoid event circles in propertyChange(..)
149	selectionChangeCausedByMe = true;
150
151	// reset the selection of the DpLayerSelectionModel
152	layerSelModel.setValueIsAdjusting(true);
153	for (int i = evt.getFirstIndex(); i <= evt.getLastIndex(); i++) {
154	Feature changedFeature = featureTableModel.getFeature(featureTable
155	.convertRowIndexToModel(i));
156	if (featureTable.isRowSelected(i))
157	layerSelModel.addSelection(changedFeature);
158	else
159	layerSelModel.removeSelection(changedFeature);
160	}
161	layerSelModel.setValueIsAdjusting(false);
162
163	// Danger of event circles in propertyChange(..) banned
164	selectionChangeCausedByMe = false;
165	}
166	}
Name	Value
svn:eol-style	native
svn:keywords	Id
svn:mime-type	text/plain