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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
|
/** @file
The file is used to create, update Events section of the MSA file
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
package org.tianocore.frameworkwizard.module.ui.dialog;
import java.awt.event.ActionEvent;
import java.util.Vector;
import javax.swing.JButton;
import javax.swing.JComboBox;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTextField;
import javax.swing.JTextArea;
import org.tianocore.frameworkwizard.common.DataType;
import org.tianocore.frameworkwizard.common.DataValidation;
import org.tianocore.frameworkwizard.common.EnumerationData;
import org.tianocore.frameworkwizard.common.Log;
import org.tianocore.frameworkwizard.common.Tools;
import org.tianocore.frameworkwizard.common.ui.ArchCheckBox;
import org.tianocore.frameworkwizard.common.ui.IComboBox;
import org.tianocore.frameworkwizard.common.ui.IDialog;
import org.tianocore.frameworkwizard.common.ui.IFrame;
import org.tianocore.frameworkwizard.common.ui.StarLabel;
import org.tianocore.frameworkwizard.module.Identifications.ModuleIdentification;
import org.tianocore.frameworkwizard.module.Identifications.Events.EventsIdentification;
import org.tianocore.frameworkwizard.packaging.PackageIdentification;
import org.tianocore.frameworkwizard.workspace.WorkspaceTools;
/**
* The class is used to create, update Events section of the MSA file
* It extends IDialog
*
* @since ModuleEditor 1.0
*
*/
public class EventsDlg extends IDialog {
// /
// / Define class Serial Version UID
// /
private static final long serialVersionUID = -4396143706422842331L;
//
// Define class members
//
private JPanel jContentPane = null;
private JLabel jLabelEventType = null;
private JLabel jLabelC_Name = null;
private IComboBox iComboBoxGuidC_Name = null;
private JLabel jLabelUsage = null;
private JLabel jLabelGroup = null;
private JComboBox jComboBoxUsage = null;
private JComboBox jComboBoxEventGroup = null;
private StarLabel jStarLabel1 = null;
private StarLabel jStarLabel2 = null;
private StarLabel jStarLabel3 = null;
private StarLabel jStarLabel4 = null;
private JComboBox jComboBoxEventsType = null;
private JScrollPane jScrollPane = null;
private JLabel jLabelArch = null;
private JLabel jLabelHelpText = null;
private JTextArea jTextAreaHelpText = null;
private JScrollPane jScrollPaneHelpText = null;
private JLabel jLabelFeatureFlag = null;
private JTextField jTextFieldFeatureFlag = null;
private ArchCheckBox jArchCheckBox = null;
private JButton jButtonOk = null;
private JButton jButtonCancel = null;
//
// Not used by UI
//
private EventsIdentification id = null;
private EnumerationData ed = new EnumerationData();
private WorkspaceTools wt = new WorkspaceTools();
/**
* This method initializes jComboBoxType
*
* @return javax.swing.JComboBox jComboBoxType
*
*/
private JComboBox getJComboBoxEventsType() {
if (jComboBoxEventsType == null) {
jComboBoxEventsType = new JComboBox();
jComboBoxEventsType.setBounds(new java.awt.Rectangle(168, 12, 320, 20));
jComboBoxEventsType.setPreferredSize(new java.awt.Dimension(320, 20));
jComboBoxEventsType
.setToolTipText("<html>Select CreateEvents if the Module has an event that is waiting to be signaled.<br>"
+ "Select SignalEvents if the Module will signal all events in an event group.<br>"
+ "NOTE: Signal events are named by GUID.</html>");
}
return jComboBoxEventsType;
}
/**
* This method initializes jTextFieldC_Name
*
* @return javax.swing.JTextField jTextFieldC_Name
*
*/
private IComboBox getIComboBoxGuidC_Name() {
if (iComboBoxGuidC_Name == null) {
iComboBoxGuidC_Name = new IComboBox();
iComboBoxGuidC_Name.setBounds(new java.awt.Rectangle(168, 37, 320, 20));
iComboBoxGuidC_Name.setPreferredSize(new java.awt.Dimension(320, 20));
iComboBoxGuidC_Name.setToolTipText("Select the GUID C Name of the Event");
}
return iComboBoxGuidC_Name;
}
/**
* This method initializes jComboBoxEventsType
*
* @return javax.swing.JComboBox
*/
private JComboBox getJComboBoxEventGroup() {
if (jComboBoxEventGroup == null) {
jComboBoxEventGroup = new JComboBox();
jComboBoxEventGroup.setBounds(new java.awt.Rectangle(168, 62, 320, 20));
jComboBoxEventGroup.setPreferredSize(new java.awt.Dimension(320, 20));
jComboBoxEventGroup.setToolTipText("Select Type of Event: Guid or Timer.");
}
return jComboBoxEventGroup;
}
/**
* This method initializes jComboBoxUsage
*
* @return javax.swing.JComboBox jComboBoxUsage
*
*/
private JComboBox getJComboBoxUsage() {
if (jComboBoxUsage == null) {
jComboBoxUsage = new JComboBox();
jComboBoxUsage.setBounds(new java.awt.Rectangle(168, 87, 320, 20));
jComboBoxUsage.setPreferredSize(new java.awt.Dimension(320, 20));
jComboBoxUsage
.setToolTipText("<html><table>"
+ "<tr><td colspan=2 align=center><b>Create Events</b></td></tr>"
+ "<tr><td>ALWAYS_CONSUMED</td><td>Module registers a notification function and REQUIRES that it be<br>"
+ "executed for the module to fully function.</td></tr>"
+ "<tr><td>SOMETIMES_CONSUMED</td><td>Module registers a notification function and calls the function<br>"
+ "when it is signaled</td></tr><tr><td colspan=2 align=center><b>Signal Events</b></td></tr>"
+ "<tr><td>ALWAYS_PRODUCED</td><td>Module will Always signal the event</td></tr>"
+ "<tr><td>SOMETIMES_PRODUCED</td><td>Module will sometimes signal the event</td></tr>"
+ "</table></html>");
}
return jComboBoxUsage;
}
/**
* This method initializes jScrollPane
*
* @return javax.swing.JScrollPane
*/
private JScrollPane getJScrollPane() {
if (jScrollPane == null) {
jScrollPane = new JScrollPane();
jScrollPane.setViewportView(getJContentPane());
}
return jScrollPane;
}
/**
* This method initializes jTextFieldFeatureFlag
*
* @return javax.swing.JTextField
*/
private JTextField getJTextFieldFeatureFlag() {
if (jTextFieldFeatureFlag == null) {
jTextFieldFeatureFlag = new JTextField();
jTextFieldFeatureFlag.setBounds(new java.awt.Rectangle(168, 182, 320, 20));
jTextFieldFeatureFlag.setPreferredSize(new java.awt.Dimension(320, 20));
jTextFieldFeatureFlag.setToolTipText("Postfix expression that must evaluate to TRUE or FALSE");
jTextFieldFeatureFlag.setEnabled(false);
}
return jTextFieldFeatureFlag;
}
/**
* This method initializes jTextAreaHelpText
*
* @return javax.swing.JTextArea
*
*/
private JTextArea getJTextAreaHelpText() {
if (jTextAreaHelpText == null) {
jTextAreaHelpText = new JTextArea();
jTextAreaHelpText.setLineWrap(true);
jTextAreaHelpText.setWrapStyleWord(true);
}
return jTextAreaHelpText;
}
/**
* This method initializes jScrollPaneHelpText
*
* @return javax.swing.JScrollPane
*
*/
private JScrollPane getJScrollPaneHelpText() {
if (jScrollPaneHelpText == null) {
jScrollPaneHelpText = new JScrollPane();
jScrollPaneHelpText.setHorizontalScrollBarPolicy(javax.swing.JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
jScrollPaneHelpText.setSize(new java.awt.Dimension(320, 40));
jScrollPaneHelpText.setPreferredSize(new java.awt.Dimension(320, 40));
jScrollPaneHelpText.setLocation(new java.awt.Point(168, 112));
jScrollPaneHelpText.setViewportView(getJTextAreaHelpText());
}
return jScrollPaneHelpText;
}
/**
* This method initializes jButtonOk
*
* @return javax.swing.JButton
*
*/
private JButton getJButtonOk() {
if (jButtonOk == null) {
jButtonOk = new JButton();
jButtonOk.setBounds(new java.awt.Rectangle(290, 212, 90, 20));
jButtonOk.setText("Ok");
jButtonOk.addActionListener(this);
}
return jButtonOk;
}
/**
* This method initializes jButtonCancel
*
* @return javax.swing.JButton
*
*/
private JButton getJButtonCancel() {
if (jButtonCancel == null) {
jButtonCancel = new JButton();
jButtonCancel.setBounds(new java.awt.Rectangle(390, 212, 90, 20));
jButtonCancel.setText("Cancel");
jButtonCancel.addActionListener(this);
}
return jButtonCancel;
}
public static void main(String[] args) {
}
/**
* This method initializes this
*
*/
private void init() {
this.setSize(505, 280);
this.setContentPane(getJScrollPane());
this.setTitle("Events");
initFrame();
this.setViewMode(false);
this.centerWindow();
}
/**
* This method initializes this Fill values to all fields if these values are
* not empty
*
* @param inEventsId
*
*/
private void init(EventsIdentification inEventsId, ModuleIdentification mid) {
init();
this.id = inEventsId;
//
// Init arch with module's arch
//
this.jArchCheckBox.setEnabledItems(wt.getModuleArch(mid));
//
// Get defined guids from dependent packages
//
Vector<PackageIdentification> vpid = wt.getPackageDependenciesOfModule(mid);
if (vpid.size() <= 0) {
Log
.wrn("Init Guid",
"This module hasn't defined any package dependency, so there is no guid value can be added for event");
}
//
// Init guids drop down list
//
Tools
.generateComboBoxByVector(iComboBoxGuidC_Name,
wt.getAllGuidDeclarationsFromPackages(vpid, EnumerationData.GUID_TYPE_EFI_EVENT));
this.iComboBoxGuidC_Name.insertItemAt(DataType.EMPTY_SELECT_ITEM, 0);
this.iComboBoxGuidC_Name.setSelectedIndex(0);
if (this.id != null) {
String tmpName = id.getName();
if (isEmpty(tmpName)) {
tmpName = DataType.EMPTY_SELECT_ITEM;
}
this.iComboBoxGuidC_Name.setSelectedItem(tmpName);
this.jComboBoxEventsType.setSelectedItem(id.getType());
this.jComboBoxUsage.setSelectedItem(id.getUsage());
this.jTextAreaHelpText.setText(id.getHelp());
jTextFieldFeatureFlag.setText(id.getFeatureFlag());
this.jArchCheckBox.setSelectedItems(id.getSupArchList());
this.jComboBoxEventGroup.setSelectedItem(id.getGroup());
}
}
/**
* This is the override edit constructor
*
* @param inEventsIdentification
* @param iFrame
*
*/
public EventsDlg(EventsIdentification inEventsIdentification, IFrame iFrame, ModuleIdentification mid) {
super(iFrame, true);
init(inEventsIdentification, mid);
}
/**
* Disable all components when the mode is view
*
* @param isView
* true - The view mode; false - The non-view mode
*
*/
public void setViewMode(boolean isView) {
if (isView) {
this.iComboBoxGuidC_Name.setEnabled(!isView);
this.jComboBoxUsage.setEnabled(!isView);
}
}
/**
* This method initializes jContentPane
*
* @return javax.swing.JPanel jContentPane
*
*/
private JPanel getJContentPane() {
if (jContentPane == null) {
jStarLabel1 = new StarLabel();
jStarLabel1.setLocation(new java.awt.Point(2, 12));
jLabelEventType = new JLabel();
jLabelEventType.setText("Select Event Type");
jLabelEventType.setBounds(new java.awt.Rectangle(12, 12, 168, 20));
jStarLabel2 = new StarLabel();
jStarLabel2.setLocation(new java.awt.Point(2, 37));
jLabelC_Name = new JLabel();
jLabelC_Name.setText("Guid C Name");
jLabelC_Name.setBounds(new java.awt.Rectangle(12, 37, 168, 20));
jStarLabel3 = new StarLabel();
jStarLabel3.setLocation(new java.awt.Point(2, 62));
jLabelGroup = new JLabel();
jLabelGroup.setText("Event Group Type");
jLabelGroup.setBounds(new java.awt.Rectangle(12, 62, 168, 20));
jStarLabel4 = new StarLabel();
jStarLabel4.setLocation(new java.awt.Point(2, 87));
jLabelUsage = new JLabel();
jLabelUsage.setText("Usage");
jLabelUsage.setBounds(new java.awt.Rectangle(12, 87, 168, 20));
jLabelHelpText = new JLabel();
jLabelHelpText.setBounds(new java.awt.Rectangle(12, 112, 168, 20));
jLabelHelpText.setText("Help Text");
jLabelFeatureFlag = new JLabel();
jLabelFeatureFlag.setBounds(new java.awt.Rectangle(12, 182, 168, 20));
jLabelFeatureFlag.setText("Feature Flag Expression");
jLabelFeatureFlag.setEnabled(false);
jLabelArch = new JLabel();
jLabelArch.setBounds(new java.awt.Rectangle(12, 157, 168, 20));
jLabelArch.setText("Supported Architectures");
jArchCheckBox = new ArchCheckBox();
jArchCheckBox.setBounds(new java.awt.Rectangle(168, 157, 320, 20));
jArchCheckBox.setPreferredSize(new java.awt.Dimension(320, 20));
jContentPane = new JPanel();
jContentPane.setLayout(null);
jContentPane.setPreferredSize(new java.awt.Dimension(485, 235));
jContentPane.add(jStarLabel1, null);
jContentPane.add(jLabelEventType, null);
jContentPane.add(getJComboBoxEventsType(), null);
//jContentPane.add(jStarLabel2, null);
jContentPane.add(jLabelC_Name, null);
jContentPane.add(getIComboBoxGuidC_Name(), null);
jContentPane.add(jStarLabel3, null);
jContentPane.add(jLabelGroup, null);
jContentPane.add(getJComboBoxEventGroup(), null);
jContentPane.add(jStarLabel4, null);
jContentPane.add(jLabelUsage, null);
jContentPane.add(getJComboBoxUsage(), null);
jContentPane.add(jLabelHelpText, null);
jContentPane.add(getJScrollPaneHelpText(), null);
jContentPane.add(jLabelFeatureFlag, null);
jContentPane.add(getJTextFieldFeatureFlag(), null);
jContentPane.add(jLabelArch, null);
jContentPane.add(jArchCheckBox, null);
jContentPane.add(getJButtonOk(), null);
jContentPane.add(getJButtonCancel(), null);
}
return jContentPane;
}
/**
* This method initializes events groups and usage type
*
*/
private void initFrame() {
Tools.generateComboBoxByVector(jComboBoxEventsType, ed.getVEventType());
Tools.generateComboBoxByVector(jComboBoxEventGroup, ed.getVEventGroup());
Tools.generateComboBoxByVector(jComboBoxUsage, ed.getVEventUsage());
}
/*
* (non-Javadoc)
*
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*
* Override actionPerformed to listen all actions
*
*/
public void actionPerformed(ActionEvent arg0) {
if (arg0.getSource() == jButtonOk) {
if (checkAdd()) {
getCurrentEvents();
this.returnType = DataType.RETURN_TYPE_OK;
this.setVisible(false);
}
}
if (arg0.getSource() == jButtonCancel) {
this.returnType = DataType.RETURN_TYPE_CANCEL;
this.setVisible(false);
}
}
/**
* Data validation for all fields
*
* @retval true - All datas are valid
* @retval false - At least one data is invalid
*
*/
public boolean checkAdd() {
//
// Check if all fields have correct data types
//
//
// Check Name
//
String tmpName = this.iComboBoxGuidC_Name.getSelectedItem().toString();
if (!tmpName.equals(DataType.EMPTY_SELECT_ITEM) && isEmpty(tmpName)) {
if (!DataValidation.isC_NameType(this.iComboBoxGuidC_Name.getSelectedItem().toString())) {
Log.wrn("Update Events", "Incorrect data type for Event Name");
return false;
}
}
//
// Check FeatureFlag
//
if (!isEmpty(this.jTextFieldFeatureFlag.getText())) {
if (!DataValidation.isFeatureFlag(this.jTextFieldFeatureFlag.getText())) {
Log.wrn("Update Events", "Incorrect data type for Feature Flag");
return false;
}
}
return true;
}
private EventsIdentification getCurrentEvents() {
String arg0 = this.iComboBoxGuidC_Name.getSelectedItem().toString();
String arg1 = this.jComboBoxEventsType.getSelectedItem().toString();
String arg2 = this.jComboBoxUsage.getSelectedItem().toString();
String arg3 = this.jTextFieldFeatureFlag.getText();
Vector<String> arg4 = this.jArchCheckBox.getSelectedItemsVector();
String arg5 = this.jTextAreaHelpText.getText();
String arg6 = this.jComboBoxEventGroup.getSelectedItem().toString();
id = new EventsIdentification(arg0, arg1, arg2, arg3, arg4, arg5, arg6);
return id;
}
public EventsIdentification getId() {
return id;
}
public void setId(EventsIdentification id) {
this.id = id;
}
}
|
