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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
/*******************************************************************************
* 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.widgets;
import java.util.ListIterator;
import org.eclipse.jface.dialogs.IMessageProvider;
import org.eclipse.jpt.utility.internal.node.Node;
import org.eclipse.jpt.utility.internal.node.Problem;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.widgets.Shell;
/**
* This dialog is similar to it superclass, <code>Dialog</code>, with
* the added value of an error message label below the main panel. A subclass
* can set this error message as needed so that it can inform the user something
* incorrect has been entered.
* <p>
* If there is an error message, it will be shown. If there is a warning
* message, it will only be shown if there is no error message. Warning messages
* have a different icon than error messages.
*
* @version 2.0
* @since 2.0
*/
public abstract class ValidatingDialog<T extends Node> extends Dialog<T> {
/**
* Creates a new <code>ValidatingDialog</code>.
*
* @param parent The parent shell
*/
public ValidatingDialog(Shell parent) {
super(parent);
}
/**
* Creates a new <code>ValidatingDialog</code>.
*
* @param parent The parent shell
* @param title The dialog's title
*/
public ValidatingDialog(Shell parent, String title) {
super(parent, title);
}
/*
* (non-Javadoc)
*/
@Override
final Node.Validator buildValidator() {
return new Node.Validator() {
public void pause() {
}
public void resume() {
}
public void validate() {
ValidatingDialog.this.validate();
}
};
}
/**
* Clears the messages from the description pane
*/
protected final void clearMessage(){
setMessage(getDescription());
}
/**
* Clears the error message from the description pane.
*/
protected final void clearErrorMessage() {
setErrorMessage(null);
}
/**
* Returns the description shown in the description pane.
*
* @return The description under the description's title
*/
protected String getDescription() {
return null;
}
/**
* Returns the image shown in the description pane.
*
* @return The image of the description pane or <code>null</code> if none is
* required
*/
protected Image getDescriptionImage() {
return null;
}
/**
* Returns the title of the description pane.
*
* @return The title shown in the description pane
*/
protected String getDescriptionTitle() {
return null;
}
/*
* (non-Javadoc)
*/
@Override
protected Point getInitialSize() {
Point result = getShell().computeSize(SWT.DEFAULT, SWT.DEFAULT);
Point paneSize = getPane().getControl().computeSize(SWT.DEFAULT, SWT.DEFAULT);
int width = convertHorizontalDLUsToPixels(400);
result.x = Math.max(width, paneSize.x);
return result;
}
/*
* (non-Javadoc)
*/
@Override
protected final boolean hasTitleArea() {
return true;
}
/*
* (non-Javadoc)
*/
@Override
protected void initializeUI() {
super.initializeUI();
// Update the description title
String descriptionTitle = getDescriptionTitle();
if (descriptionTitle != null) {
setTitle(descriptionTitle);
}
// Update the description title
String description = getDescription();
if (description != null) {
setMessage(description);
}
// Update the description image
Image image = getDescriptionImage();
if (image != null) {
setTitleImage(image);
}
}
/**
* Updates the description pane by showing the given error message and format
* the text with the given list of arguments if any exists.
*
* @param errorMessage The error message to show in the description pane
* @param arguments The list of arguments used to format the error message
*/
protected final void setErrorMessage(String errorMessage, Object... arguments) {
setErrorMessage(NLS.bind(errorMessage, arguments));
}
/**
* Updates the description pane by showing the given warning message and format
* the text with the given list of arguments if any exists.
*
* @param warningMessage The warning message to show in the description pane
* @param arguments The list of arguments used to format the error message
*/
protected final void setWarningMessage(String warningMessage, Object... arguments) {
setMessage(NLS.bind(warningMessage, arguments), IMessageProvider.WARNING);
}
/**
* Updates the error message, either shows the first error problem or hides
* the error pane. If the progress bar is shown, then the error message will
* not be shown.
*/
private void updateMessage() {
if (getSubject().branchProblemsSize() == 0) {
clearMessage();
} else {
for (ListIterator<Problem> problems = getSubject().branchProblems(); problems.hasNext();){
Problem problem = problems.next();
if (problem.messageType() == IMessageProvider.ERROR){
this.setErrorMessage(problem.messageKey(), problem.messageArguments());
}
else if (problem.messageType() == IMessageProvider.WARNING){
this.setWarningMessage(problem.messageKey(), problem.messageArguments());
}
}
}
if (!this.containsErrorMessage()){
clearErrorMessage();
}
}
public final boolean containsErrorMessage(){
boolean error = false;
for (ListIterator<Problem> problems = getSubject().branchProblems(); problems.hasNext();){
Problem problem = problems.next();
if (problem.messageType() ==IMessageProvider.ERROR){
error = true;
}
}
return error;
}
/**
* Validates the state object and based on its status, update the description
* pane to show the first error if any exists and update the enablement of
* the OK button.
*/
private void validate() {
getSubject().validateBranch();
updateMessage();
getButton(OK).setEnabled(!containsErrorMessage());
}
}
|
