1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
/*******************************************************************************
* Copyright (c) 2007, 2012 Oracle. All rights reserved.
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0, which accompanies this distribution
* and is available at http://www.eclipse.org/legal/epl-v10.html.
*
* Contributors:
* Oracle - initial API and implementation
******************************************************************************/
package org.eclipse.jpt.common.utility.internal.model.value.swing;
import java.io.Serializable;
import javax.swing.event.EventListenerList;
import javax.swing.event.TreeModelEvent;
import javax.swing.event.TreeModelListener;
import javax.swing.tree.TreeModel;
/**
* Abstract class that should have been provided by the JDK
* (à la {@link javax.swing.AbstractListModel}). This class provides:<ul>
* <li>support for a collection of listeners
* <li>a number of convenience methods for firing events for those listeners
* </ul>
*/
public abstract class AbstractTreeModel
implements TreeModel, Serializable
{
/** Our listeners. */
protected final EventListenerList listenerList;
private static final long serialVersionUID = 1L;
// ********** constructors/initialization **********
protected AbstractTreeModel() {
super();
this.listenerList = new EventListenerList();
}
// ********** partial TreeModel implementation **********
public void addTreeModelListener(TreeModelListener l) {
this.listenerList.add(TreeModelListener.class, l);
}
public void removeTreeModelListener(TreeModelListener l) {
this.listenerList.remove(TreeModelListener.class, l);
}
// ********** queries **********
/**
* Return the model's current collection of listeners.
* (There seems to be a pattern of making this type of method public;
* although it should probably be protected....)
*/
public TreeModelListener[] treeModelListeners() {
return this.listenerList.getListeners(TreeModelListener.class);
}
/**
* Return whether this model has no listeners.
*/
protected boolean hasNoTreeModelListeners() {
return this.listenerList.getListenerCount(TreeModelListener.class) == 0;
}
/**
* Return whether this model has any listeners.
*/
protected boolean hasTreeModelListeners() {
return ! this.hasNoTreeModelListeners();
}
// ********** behavior **********
/**
* Notify listeners of a model change.
* A significant property of the nodes changed, but the nodes themselves
* are still the same objects.
* @see javax.swing.event.TreeModelEvent
* @see javax.swing.event.TreeModelListener
*/
protected void fireTreeNodesChanged(Object[] path, int[] childIndices, Object[] children) {
// guaranteed to return a non-null array
Object[] listeners = this.listenerList.getListenerList();
TreeModelEvent event = null;
// process the listeners last to first, notifying
// those that are interested in this event
for (int i = listeners.length-2; i>=0; i-=2) {
if (listeners[i]==TreeModelListener.class) {
// lazily create the event
if (event == null) {
event = new TreeModelEvent(this, path, childIndices, children);
}
((TreeModelListener) listeners[i+1]).treeNodesChanged(event);
}
}
}
/**
* Notify listeners of a model change.
* A significant property of the node changed, but the node itself is the same object.
* @see javax.swing.event.TreeModelEvent
* @see javax.swing.event.TreeModelListener
*/
protected void fireTreeNodeChanged(Object[] path, int childIndex, Object child) {
this.fireTreeNodesChanged(path, new int[] {childIndex}, new Object[] {child});
}
/**
* Notify listeners of a model change.
* A significant property of the root changed, but the root itself is the same object.
* @see javax.swing.event.TreeModelEvent
* @see javax.swing.event.TreeModelListener
*/
protected void fireTreeRootChanged(Object root) {
this.fireTreeNodesChanged(new Object[] {root}, null, null);
}
/**
* Notify listeners of a model change.
* @see javax.swing.event.TreeModelEvent
* @see javax.swing.event.TreeModelListener
*/
protected void fireTreeNodesInserted(Object[] path, int[] childIndices, Object[] children) {
// guaranteed to return a non-null array
Object[] listeners = this.listenerList.getListenerList();
TreeModelEvent event = null;
// process the listeners last to first, notifying
// those that are interested in this event
for (int i = listeners.length-2; i>=0; i-=2) {
if (listeners[i]==TreeModelListener.class) {
// lazily create the event
if (event == null) {
event = new TreeModelEvent(this, path, childIndices, children);
}
((TreeModelListener) listeners[i+1]).treeNodesInserted(event);
}
}
}
/**
* Notify listeners of a model change.
* @see javax.swing.event.TreeModelEvent
* @see javax.swing.event.TreeModelListener
*/
protected void fireTreeNodeInserted(Object[] path, int childIndex, Object child) {
this.fireTreeNodesInserted(path, new int[] {childIndex}, new Object[] {child});
}
/**
* Notify listeners of a model change.
* @see javax.swing.event.TreeModelEvent
* @see javax.swing.event.TreeModelListener
*/
protected void fireTreeNodesRemoved(Object[] path, int[] childIndices, Object[] children) {
// guaranteed to return a non-null array
Object[] listeners = this.listenerList.getListenerList();
TreeModelEvent event = null;
// process the listeners last to first, notifying
// those that are interested in this event
for (int i = listeners.length-2; i>=0; i-=2) {
if (listeners[i]==TreeModelListener.class) {
// lazily create the event
if (event == null) {
event = new TreeModelEvent(this, path, childIndices, children);
}
((TreeModelListener) listeners[i+1]).treeNodesRemoved(event);
}
}
}
/**
* Notify listeners of a model change.
* @see javax.swing.event.TreeModelEvent
* @see javax.swing.event.TreeModelListener
*/
protected void fireTreeNodeRemoved(Object[] path, int childIndex, Object child) {
this.fireTreeNodesRemoved(path, new int[] {childIndex}, new Object[] {child});
}
/**
* Notify listeners of a model change.
* @see javax.swing.event.TreeModelEvent
* @see javax.swing.event.TreeModelListener
*/
protected void fireTreeStructureChanged(Object[] path) {
// guaranteed to return a non-null array
Object[] listeners = this.listenerList.getListenerList();
TreeModelEvent event = null;
// process the listeners last to first, notifying
// those that are interested in this event
for (int i = listeners.length-2; i>=0; i-=2) {
if (listeners[i]==TreeModelListener.class) {
// lazily create the event
if (event == null) {
event = new TreeModelEvent(this, path);
}
((TreeModelListener) listeners[i+1]).treeStructureChanged(event);
}
}
}
/**
* Notify listeners of a model change.
* @see javax.swing.event.TreeModelEvent
* @see javax.swing.event.TreeModelListener
*/
protected void fireTreeRootReplaced(Object newRoot) {
this.fireTreeStructureChanged(new Object[] {newRoot});
}
}
|
