blob: c04630b425b3cca6b50ca99271bb26cf76817546 (
plain) (
blame)
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
|
/*******************************************************************************
* Copyright (c) 2008 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.ui.internal.swt;
import org.eclipse.core.runtime.Assert;
import org.eclipse.jpt.common.ui.internal.listeners.SWTPropertyChangeListenerWrapper;
import org.eclipse.jpt.common.ui.internal.widgets.TriStateCheckBox;
import org.eclipse.jpt.utility.internal.StringTools;
import org.eclipse.jpt.utility.model.event.PropertyChangeEvent;
import org.eclipse.jpt.utility.model.listener.PropertyChangeListener;
import org.eclipse.jpt.utility.model.value.PropertyValueModel;
import org.eclipse.jpt.utility.model.value.WritablePropertyValueModel;
import org.eclipse.swt.events.DisposeEvent;
import org.eclipse.swt.events.DisposeListener;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
/**
* This adapter can be used to keep a tri-state check box in synch with
* a model Boolean where the value can be <code>null</code>.
*/
@SuppressWarnings("nls")
public class TriStateCheckBoxModelAdapter {
/** A value model on the underlying model boolean. */
protected final WritablePropertyValueModel<Boolean> booleanHolder;
/**
* A listener that allows us to synchronize the button's selection state with
* the model boolean.
*/
protected final PropertyChangeListener booleanChangeListener;
/** The check box/toggle button we synchronize with the model boolean. */
protected final TriStateCheckBox button;
/**
* A listener that allows us to synchronize the model boolean with
* the button's selection state.
*/
protected final SelectionListener buttonSelectionListener;
/**
* A listener that allows us to stop listening to stuff when the button
* is disposed.
*/
protected final DisposeListener buttonDisposeListener;
// ********** static methods **********
/**
* Adapt the specified boolean to the specified button.
* If the boolean is null, the button's value will be "partially checked"
* (i.e. the button will be checked but grayed out).
*/
public static TriStateCheckBoxModelAdapter adapt(WritablePropertyValueModel<Boolean> booleanHolder, TriStateCheckBox button) {
return new TriStateCheckBoxModelAdapter(booleanHolder, button);
}
// ********** constructors **********
/**
* Constructor - the boolean holder and button are required.
*/
protected TriStateCheckBoxModelAdapter(WritablePropertyValueModel<Boolean> booleanHolder, TriStateCheckBox button) {
super();
Assert.isNotNull(booleanHolder, "The boolean holder cannot be null");
Assert.isNotNull(button, "The check box cannot be null");
this.booleanHolder = booleanHolder;
this.button = button;
this.booleanChangeListener = this.buildBooleanChangeListener();
this.booleanHolder.addPropertyChangeListener(PropertyValueModel.VALUE, this.booleanChangeListener);
this.buttonDisposeListener = this.buildButtonDisposeListener();
this.button.addDisposeListener(this.buttonDisposeListener);
this.buttonSelectionListener = this.buildButtonSelectionListener();
this.button.addSelectionListener(this.buttonSelectionListener);
this.setButtonSelection(this.booleanHolder.getValue());
}
// ********** initialization **********
protected PropertyChangeListener buildBooleanChangeListener() {
return new SWTPropertyChangeListenerWrapper(this.buildBooleanChangeListener_());
}
protected PropertyChangeListener buildBooleanChangeListener_() {
return new PropertyChangeListener() {
public void propertyChanged(PropertyChangeEvent event) {
TriStateCheckBoxModelAdapter.this.booleanChanged(event);
}
@Override
public String toString() {
return "tri-state boolean listener";
}
};
}
protected SelectionListener buildButtonSelectionListener() {
return new SelectionAdapter() {
@Override
public void widgetSelected(SelectionEvent event) {
TriStateCheckBoxModelAdapter.this.buttonSelected(event);
}
@Override
public String toString() {
return "tri-state button selection listener";
}
};
}
protected DisposeListener buildButtonDisposeListener() {
return new DisposeListener() {
public void widgetDisposed(DisposeEvent event) {
TriStateCheckBoxModelAdapter.this.buttonDisposed(event);
}
@Override
public String toString() {
return "tri-state button dispose listener";
}
};
}
// ********** behavior **********
/**
* The model has changed - synchronize the button.
* If the new model value is null, use the adapter's default value
* (which is typically false).
*/
protected void booleanChanged(PropertyChangeEvent event) {
this.setButtonSelection((Boolean) event.getNewValue());
}
protected void setButtonSelection(Boolean selection) {
if (this.button.isDisposed()) {
return;
}
this.button.setSelection(selection);
}
/**
* The button has been "selected" - synchronize the model.
*/
protected void buttonSelected(SelectionEvent event) {
if (this.button.isDisposed()) {
return;
}
this.booleanHolder.setValue(button.getSelection());
}
// ********** dispose **********
protected void buttonDisposed(DisposeEvent event) {
// the button is not yet "disposed" when we receive this event
// so we can still remove our listeners
this.button.removeSelectionListener(this.buttonSelectionListener);
this.button.removeDisposeListener(this.buttonDisposeListener);
this.booleanHolder.removePropertyChangeListener(PropertyValueModel.VALUE, this.booleanChangeListener);
}
// ********** standard methods **********
@Override
public String toString() {
return StringTools.buildToStringFor(this, this.booleanHolder);
}
}
|
