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
|
/*******************************************************************************
* Copyright (c) 2009, 2011 Andrew Gvozdev and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Andrew Gvozdev - initial API and implementation
*******************************************************************************/
package org.eclipse.cdt.ui.dialogs;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.jface.dialogs.IDialogConstants;
import org.eclipse.jface.dialogs.StatusDialog;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.ModifyEvent;
import org.eclipse.swt.events.ModifyListener;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Text;
/**
* An input dialog for soliciting an input string from the user.
* The string can be validated. In case of problem error/warning/info message
* is shown in status line and decorated with appropriate status icon.
* <p>
* This concrete dialog class can be instantiated as is, or further subclassed as required.
* </p>
* @since 5.2
*/
public class InputStatusDialog extends StatusDialog {
/**
* The title of the dialog.
*/
private String title;
/**
* The message to display, or <code>null</code> if none.
*/
private String message;
/**
* The input value; the empty string by default.
*/
private String value = "";//$NON-NLS-1$
/**
* The input validator, or <code>null</code> if none.
*/
private IInputStatusValidator validator;
/**
* Input text widget.
*/
private Text text;
/**
* Creates an input dialog with OK and Cancel buttons. Note that the dialog
* will have no visual representation (no widgets) until it is told to open.
* <p>
* Note that the <code>open</code> method blocks for input dialogs.
* </p>
*
* @param parentShell
* the parent shell, or <code>null</code> to create a top-level
* shell
* @param dialogTitle
* the dialog title, or <code>null</code> if none
* @param dialogMessage
* the dialog message, or <code>null</code> if none
* @param initialValue
* the initial input value, or <code>null</code> if none
* (equivalent to the empty string)
* @param validator
* an input validator, or <code>null</code> if none
* For a validator, following return statuses are recognized:
* <li/>{@link Status#OK_STATUS} or any {@link IStatus#OK} to indicate no error.
* <li/>{@link IStatus#ERROR} indicates an error.
* <li/>{@link IStatus#WARNING} indicates a warning.
* <li/>{@link IStatus#INFO} indicates an informational message
*/
public InputStatusDialog(Shell parentShell, String dialogTitle, String dialogMessage, String initialValue,
IInputStatusValidator validator) {
super(parentShell);
this.title = dialogTitle;
if (dialogMessage == null) {
this.message = ""; //$NON-NLS-1$
} else {
this.message = dialogMessage;
}
if (initialValue == null) {
this.value = ""; //$NON-NLS-1$
} else {
this.value = initialValue;
}
this.validator = validator;
}
/*
* (non-Javadoc) Method declared on Dialog.
*/
@Override
protected void buttonPressed(int buttonId) {
if (buttonId == IDialogConstants.OK_ID) {
value = text.getText();
} else {
value = null;
}
super.buttonPressed(buttonId);
}
/*
* (non-Javadoc)
*
* @see org.eclipse.jface.window.Window#configureShell(org.eclipse.swt.widgets.Shell)
*/
@Override
protected void configureShell(Shell shell) {
super.configureShell(shell);
if (title != null) {
shell.setText(title);
}
}
@Override
protected Control createDialogArea(Composite parent) {
Composite composite = (Composite) super.createDialogArea(parent);
Label label = new Label(composite, SWT.WRAP);
label.setText(message);
GridData data = new GridData(GridData.GRAB_HORIZONTAL | GridData.GRAB_VERTICAL | GridData.HORIZONTAL_ALIGN_FILL
| GridData.VERTICAL_ALIGN_CENTER);
data.widthHint = convertHorizontalDLUsToPixels(IDialogConstants.MINIMUM_MESSAGE_AREA_WIDTH);
label.setLayoutData(data);
label.setFont(parent.getFont());
text = new Text(composite, getInputTextStyle());
text.setLayoutData(new GridData(GridData.GRAB_HORIZONTAL | GridData.HORIZONTAL_ALIGN_FILL));
text.addModifyListener(new ModifyListener() {
@Override
public void modifyText(ModifyEvent e) {
validateInput();
}
});
text.setFocus();
if (value != null) {
text.setText(value);
text.selectAll();
}
applyDialogFont(composite);
return composite;
}
/**
* Returns the text area.
*
* @return the text area
*/
protected Text getText() {
return text;
}
/**
* Returns the validator.
*
* @return the validator
*/
protected IInputStatusValidator getValidator() {
return validator;
}
/**
* Returns the string typed into this input dialog.
*
* @return the input string
*/
public String getValue() {
return value;
}
/**
* Validates the input.
* <p>
* The default implementation of this framework method delegates the request to the supplied input
* validator object; if it finds the input invalid, the error message is displayed in the dialog's message
* line. This hook method is called whenever the text changes in the input field.
* </p>
*/
protected void validateInput() {
IStatus status = Status.OK_STATUS;
if (validator != null) {
status = validator.isValid(text.getText());
}
updateStatus(status);
}
/**
* Returns the style bits that should be used for the input text field. Defaults to a single line entry.
* Subclasses may override.
*
* @return the integer style bits that should be used when creating the input text
*
*/
protected int getInputTextStyle() {
return SWT.SINGLE | SWT.BORDER;
}
}
|
