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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<meta name="copyright" content="Copyright (c) IBM Corporation and others 2002, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<LINK REL="STYLESHEET" HREF="../../../book.css" CHARSET="UTF-8" TYPE="text/css">
<title>RSE Validator Sample One</title>
</head>
<body bgcolor="#ffffff">
<h1>RSE Dialog Sample</h1>
<p>This is an example of a sample<A href="sampleDlg.gif"> dialog</A> written on top of the RSE base dialog class, and with
typical full error checking.
<pre>
package org.eclipse.rse.samples.ui.frameworks.dialogs;
import org.eclipse.swt.widgets.*;
import org.eclipse.swt.events.*;
import org.eclipse.rse.samples.*;
import org.eclipse.rse.ui.dialogs.SystemPromptDialog;
import org.eclipse.rse.ui.*;
import org.eclipse.rse.ui.widgets.*;
import org.eclipse.rse.ui.messages.*;
import org.eclipse.rse.ui.validators.*;
/**
* <I>A simple example of using the SystemPromptDialog class as the basis for a new dialog</I>.
*/
public class <B>SampleDialog</B> extends SystemPromptDialog
{
// <I>gui widgets</I>
private SystemHistoryCombo namePrompt;
private Text yearPrompt, monthPrompt, dayPrompt;
// <I>input</I>
private SampleCustomer inpCust;
// <I>validators</I>
private ISystemValidator nameValidator, yearValidator, monthValidator, dayValidator;
// <I>message</I>
private SystemMessage errorMessage;
/**
* <I>Constructor for SampleDialog</I>.
*/
public <B>SampleDialog</B>(Shell shell)
{
super(shell, SamplesPlugin.getString("org.eclipse.rse.samples.ui.dialogs.dialog1.title"));
setHelp(SamplesPlugin.HELPPREFIX + "dlg11000");
nameValidator = new <A href="../validators/validatorSample1.html">SampleNameValidator</A>();
yearValidator = new <A href="../validators/validatorSample2.html">SampleBirthYearValidator</A>();
monthValidator = new <A href="../validators/validatorSample3.html">SampleBirthMonthValidator</A>();
dayValidator = new <A href="../validators/validatorSample4.html">SampleBirthDayValidator</A>();
}
/**
* <I>Required parent override.</I>
* <I>This is where we populate the client area</I>
*/
protected Control <B>createInner</B>(Composite parent)
{
int nbrColumns = 2;
Composite parentComposite = SystemWidgetHelpers.createComposite(parent, nbrColumns);
// <I>add gui widgets</I>...
SystemWidgetHelpers.createLabel(parentComposite, SamplesPlugin.getResourceBundle(), "org.eclipse.rse.samples.ui.dialogs.dialog1.name.");
boolean readonly = false;
namePrompt = SystemWidgetHelpers.createHistoryCombo(parentComposite, null, "name.history.key", readonly,
SamplesPlugin.getResourceBundle(), "org.eclipse.rse.samples.ui.dialogs.dialog1.name.tooltip");
addSeparatorLine(parentComposite, nbrColumns);
boolean wantBorder = false;
SystemWidgetHelpers.createLabel(parentComposite, SamplesPlugin.getResourceBundle(),
"org.eclipse.rse.samples.ui.dialogs.dialog1.birthday.verbage.", nbrColumns, wantBorder);
yearPrompt = SystemWidgetHelpers.createLabeledTextField(parentComposite, null,
SamplesPlugin.getResourceBundle(), "org.eclipse.rse.samples.ui.dialogs.dialog1.birthday.year.");
monthPrompt = SystemWidgetHelpers.createLabeledTextField(parentComposite, null,
SamplesPlugin.getResourceBundle(), "org.eclipse.rse.samples.ui.dialogs.dialog1.birthday.month.");
dayPrompt = SystemWidgetHelpers.createLabeledTextField(parentComposite, null,
SamplesPlugin.getResourceBundle(), "org.eclipse.rse.samples.ui.dialogs.dialog1.birthday.day.");
// <I>if given an existing object, prefill it</I>...
inpCust = (SampleCustomer)getInputObject();
if (inpCust != null)
{
namePrompt.setText(inpCust.getName());
yearPrompt.setText(inpCust.getYear());
monthPrompt.setText(inpCust.getMonth());
dayPrompt.setText(inpCust.getDay());
}
// <I>add modify listeners</I>...
namePrompt.addModifyListener( new ModifyListener()
{
public void modifyText(ModifyEvent event)
{
if (validateName())
validate(namePrompt.getCombo());
}
} );
yearPrompt.addModifyListener( new ModifyListener()
{
public void modifyText(ModifyEvent event)
{
if (validateYear())
validate(yearPrompt);
}
} );
monthPrompt.addModifyListener( new ModifyListener()
{
public void modifyText(ModifyEvent event)
{
if (validateMonth())
validate(monthPrompt);
}
} );
dayPrompt.addModifyListener( new ModifyListener()
{
public void modifyText(ModifyEvent event)
{
if (validateDay())
validate(monthPrompt);
}
} );
// <I>initialize enabled state</I>...
setPageComplete(isPageComplete());
return parentComposite;
}
/**
* <I>Required parent override</I>.
* <I>This is where we return the first input control, to give it focus when the dialog appears</I>.
*/
protected Control <B>getInitialFocusControl</B>()
{
return namePrompt.getCombo();
}
/**
* <I>Typical parent override</I>.
* <I>This is where we get control when the user presses OK</I>.
*/
protected boolean <B>processOK</B>()
{
errorMessage = null;
Control controlInError = validate(null);
if (controlInError != null)
controlInError.setFocus();
else
{
SampleCustomer newCust = inpCust;
if (newCust == null)
newCust = new SampleCustomer();
newCust.setName(namePrompt.getText().trim());
newCust.setYear(yearPrompt.getText().trim());
newCust.setMonth(monthPrompt.getText().trim());
newCust.setDay(dayPrompt.getText().trim());
setOutputObject(newCust);
SystemMessage completionMsg = null;
if (inpCust == null)
completionMsg = SamplesPlugin.getPluginMessage("SPPD1010");
else
completionMsg = SamplesPlugin.getPluginMessage("SPPD1011");
completionMsg.makeSubstitution(newCust.getName());
SystemMessageDialog msgDlg = new SystemMessageDialog(getShell(), completionMsg);
msgDlg.open();
}
return isPageComplete();
}
// ---------------------
// <I>Validation methods</I>...
// ---------------------
/**
* <I>Do full validation of all entry fields, optionally skipping a given one</I>.
* <I>@return first control that is found to contain errors. Can be used to set focus</I>.
*/
protected Control <B>validate</B>(Control controlToSkip)
{
Control controlInError = null;
if ((controlToSkip != namePrompt.getCombo()) && !validateName())
controlInError = namePrompt.getCombo();
if ((controlInError==null) && (controlToSkip != yearPrompt) && !validateYear())
controlInError = yearPrompt;
if ((controlInError==null) && (controlToSkip != monthPrompt) && !validateMonth())
controlInError = monthPrompt;
if ((controlInError==null) && (controlToSkip != dayPrompt) && !validateDay())
controlInError = dayPrompt;
return controlInError;
}
/**
* <I>Validate the customer name prompt. We only ensure it is not-empty.</I>
*/
protected boolean <B>validateName</B>()
{
String input = namePrompt.getText().trim();
setErrorMessageAndPageCompletionStatus(nameValidator.validate(input));
return (errorMessage==null);
}
/**
* <I>Validate the customer birth year prompt</I>.
*/
protected boolean <B>validateYear</B>()
{
String input = yearPrompt.getText().trim();
setErrorMessageAndPageCompletionStatus(yearValidator.validate(input));
return (errorMessage==null);
}
/**
* <I>Validate the customer birth month prompt</I>.
*/
protected boolean <B>validateMonth</B>()
{
String input = monthPrompt.getText().trim();
setErrorMessageAndPageCompletionStatus(monthValidator.validate(input));
return (errorMessage==null);
}
/**
* <I>Validate the customer birth day prompt</I>.
*/
protected boolean <B>validateDay</B>()
{
String input = dayPrompt.getText().trim();
setErrorMessageAndPageCompletionStatus(dayValidator.validate(input));
return (errorMessage==null);
}
/**
* <I>A convenience method that issues or clears the error message on the message line</I>,
* <I>and sets the page completion status</I>
*/
protected void <B>setErrorMessageAndPageCompletionStatus</B>(SystemMessage errorMessage)
{
this.errorMessage = errorMessage;
if (errorMessage == null)
clearErrorMessage();
else
setErrorMessage(errorMessage);
setPageComplete(isPageComplete());
}
/**
* <I>Return true if the OK button can be enabled</I>.
*/
protected boolean <B>isPageComplete</B>()
{
return ((errorMessage == null) &&
(namePrompt.getText().trim().length()>0) &&
(yearPrompt.getText().trim().length()>0) &&
(monthPrompt.getText().trim().length()>0) &&
(dayPrompt.getText().trim().length()>0));
}
}</pre>
<P><BR></P>
</body>
</html>
|
