]> git.proxmox.com Git - mirror_edk2.git/blame - Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/LibraryClassDefsDlg.java
Fixed grammar in messages.
[mirror_edk2.git] / Tools / Source / FrameworkWizard / src / org / tianocore / frameworkwizard / module / ui / dialog / LibraryClassDefsDlg.java
CommitLineData
06a19cee 1/** @file\r
2 \r
928b45fb 3 The file is used to create, update Library Class Definition section of the MSA file\r
06a19cee 4 \r
5 Copyright (c) 2006, Intel Corporation\r
6 All rights reserved. This program and the accompanying materials\r
7 are licensed and made available under the terms and conditions of the BSD License\r
8 which accompanies this distribution. The full text of the license may be found at\r
9 http://opensource.org/licenses/bsd-license.php\r
10 \r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13 \r
14 **/\r
15package org.tianocore.frameworkwizard.module.ui.dialog;\r
16\r
17import java.awt.Dimension;\r
18import java.awt.event.ActionEvent;\r
19import java.util.Vector;\r
20\r
21import javax.swing.JButton;\r
22import javax.swing.JComboBox;\r
23import javax.swing.JLabel;\r
24import javax.swing.JPanel;\r
25import javax.swing.JScrollPane;\r
26import javax.swing.JTextField;\r
27\r
28import org.tianocore.frameworkwizard.common.DataType;\r
29import org.tianocore.frameworkwizard.common.DataValidation;\r
30import org.tianocore.frameworkwizard.common.EnumerationData;\r
31import org.tianocore.frameworkwizard.common.Log;\r
32import org.tianocore.frameworkwizard.common.Tools;\r
33import org.tianocore.frameworkwizard.common.ui.ArchCheckBox;\r
34import org.tianocore.frameworkwizard.common.ui.IDialog;\r
35import org.tianocore.frameworkwizard.common.ui.IFrame;\r
36import org.tianocore.frameworkwizard.common.ui.StarLabel;\r
37import org.tianocore.frameworkwizard.common.ui.iCheckBoxList.ICheckBoxList;\r
38import org.tianocore.frameworkwizard.module.Identifications.LibraryClass.LibraryClassIdentification;\r
39import org.tianocore.frameworkwizard.workspace.WorkspaceTools;\r
40\r
41/**\r
9e857952 42 * The class is used to create, update Library Class Definition section of the MSA file\r
928b45fb 43 * \r
44 * It extends IDialog\r
45 * \r
9e857952 46 */\r
06a19cee 47public class LibraryClassDefsDlg extends IDialog {\r
48\r
49 ///\r
50 /// Define class Serial Version UID\r
51 ///\r
52 private static final long serialVersionUID = -1743248695411382857L;\r
53\r
54 //\r
55 //Define class members\r
56 //\r
57 private JPanel jContentPane = null;\r
58\r
59 private JComboBox jComboBoxLibraryClassName = null;\r
60\r
61 private JLabel jLabelUsage = null;\r
62\r
63 private JComboBox jComboBoxUsage = null;\r
64\r
65 private JLabel jLabelLibraryClassName = null;\r
66\r
67 private JScrollPane jScrollPane = null;\r
68\r
69 private StarLabel jStarLabel1 = null;\r
70\r
71 private StarLabel jStarLabel2 = null;\r
72\r
73 private JLabel jLabelRecommendedInstanceVersion = null;\r
74\r
75 private JTextField jTextFieldRecommendedInstanceVersion = null;\r
76\r
77 private JLabel jLabelRecommendedInstanceGuid = null;\r
78\r
79 private JTextField jTextFieldRecommendedInstanceGuid = null;\r
80\r
81 private JButton jButtonGenerateGuid = null;\r
82\r
83 private JLabel jLabelFeatureFlag = null;\r
84\r
85 private JTextField jTextFieldFeatureFlag = null;\r
86\r
87 private JLabel jLabelArch = null;\r
88\r
89 private JLabel jLabelModuleList = null;\r
90\r
91 private JScrollPane jScrollPaneModuleList = null;\r
92\r
93 private ICheckBoxList iCheckBoxListModule = null;\r
94\r
95 private JLabel jLabelHelpText = null;\r
96\r
97 private JTextField jTextFieldHelpText = null;\r
98\r
99 private ArchCheckBox jArchCheckBox = null;\r
a929458e 100\r
06a19cee 101 private JButton jButtonOk = null;\r
102\r
103 private JButton jButtonCancel = null;\r
104\r
105 //\r
106 // Not for UI\r
107 //\r
108 private EnumerationData ed = new EnumerationData();\r
109\r
110 private WorkspaceTools wt = new WorkspaceTools();\r
111\r
112 private LibraryClassIdentification lcid = null;\r
113\r
114 /**\r
115 This method initializes jComboBoxSelect \r
116 \r
117 @return javax.swing.JComboBox jComboBoxSelect\r
118 \r
119 **/\r
120 private JComboBox getJComboBoxLibraryClassName() {\r
121 if (jComboBoxLibraryClassName == null) {\r
122 jComboBoxLibraryClassName = new JComboBox();\r
928b45fb 123 jComboBoxLibraryClassName.setBounds(new java.awt.Rectangle(168, 12, 320, 20));\r
06a19cee 124 jComboBoxLibraryClassName.setPreferredSize(new Dimension(320, 20));\r
125 jComboBoxLibraryClassName.setEnabled(true);\r
126 }\r
127 return jComboBoxLibraryClassName;\r
128 }\r
129\r
130 /**\r
131 This method initializes jComboBoxUsage \r
132 \r
133 @return javax.swing.JComboBox jComboBoxUsage\r
134 \r
135 **/\r
136 private JComboBox getJComboBoxUsage() {\r
137 if (jComboBoxUsage == null) {\r
138 jComboBoxUsage = new JComboBox();\r
928b45fb 139 jComboBoxUsage.setBounds(new java.awt.Rectangle(168, 37, 320, 20));\r
06a19cee 140 jComboBoxUsage.setPreferredSize(new Dimension(320, 20));\r
141 }\r
142 return jComboBoxUsage;\r
143 }\r
144\r
145 /**\r
146 This method initializes jScrollPane \r
147 \r
148 @return javax.swing.JScrollPane \r
149 */\r
150 private JScrollPane getJScrollPane() {\r
151 if (jScrollPane == null) {\r
152 jScrollPane = new JScrollPane();\r
153 jScrollPane.setViewportView(getJContentPane());\r
154 }\r
155 return jScrollPane;\r
156 }\r
157\r
158 /**\r
159 * This method initializes jTextFieldRecommendedInstanceVersion \r
160 * \r
161 * @return javax.swing.JTextField \r
162 */\r
163 private JTextField getJTextFieldRecommendedInstanceVersion() {\r
164 if (jTextFieldRecommendedInstanceVersion == null) {\r
165 jTextFieldRecommendedInstanceVersion = new JTextField();\r
166 jTextFieldRecommendedInstanceVersion.setPreferredSize(new java.awt.Dimension(260, 20));\r
167 jTextFieldRecommendedInstanceVersion.setSize(new java.awt.Dimension(260, 20));\r
168 jTextFieldRecommendedInstanceVersion.setLocation(new java.awt.Point(220, 85));\r
169 jTextFieldRecommendedInstanceVersion.setVisible(false);\r
170 }\r
171 return jTextFieldRecommendedInstanceVersion;\r
172 }\r
173\r
174 /**\r
175 * This method initializes jTextFieldRecommendedInstanceGuid \r
176 * \r
177 * @return javax.swing.JTextField \r
178 */\r
179 private JTextField getJTextFieldRecommendedInstanceGuid() {\r
180 if (jTextFieldRecommendedInstanceGuid == null) {\r
181 jTextFieldRecommendedInstanceGuid = new JTextField();\r
182 jTextFieldRecommendedInstanceGuid.setBounds(new java.awt.Rectangle(220, 110, 190, 20));\r
183 jTextFieldRecommendedInstanceGuid.setPreferredSize(new java.awt.Dimension(190, 20));\r
184 jTextFieldRecommendedInstanceGuid.setVisible(false);\r
185 }\r
186 return jTextFieldRecommendedInstanceGuid;\r
187 }\r
188\r
189 /**\r
190 * This method initializes jButtonGenerateGuid \r
191 * \r
192 * @return javax.swing.JButton \r
193 */\r
194 private JButton getJButtonGenerateGuid() {\r
195 if (jButtonGenerateGuid == null) {\r
196 jButtonGenerateGuid = new JButton();\r
928b45fb 197 jButtonGenerateGuid.setBounds(new java.awt.Rectangle(415, 112, 65, 20));\r
06a19cee 198 jButtonGenerateGuid.setPreferredSize(new java.awt.Dimension(65, 20));\r
199 jButtonGenerateGuid.setText("GEN");\r
200 jButtonGenerateGuid.setVisible(false);\r
201 jButtonGenerateGuid.addActionListener(this);\r
202 }\r
203 return jButtonGenerateGuid;\r
204 }\r
205\r
206 /**\r
207 * This method initializes jTextFieldFeatureFlag \r
208 * \r
209 * @return javax.swing.JTextField \r
210 */\r
211 private JTextField getJTextFieldFeatureFlag() {\r
212 if (jTextFieldFeatureFlag == null) {\r
213 jTextFieldFeatureFlag = new JTextField();\r
21b42c66 214 jTextFieldFeatureFlag.setBounds(new java.awt.Rectangle(168,197,320,20));\r
06a19cee 215 jTextFieldFeatureFlag.setPreferredSize(new java.awt.Dimension(320, 20));\r
a929458e 216 jTextFieldFeatureFlag.setToolTipText("Postfix expression that must evaluate to TRUE or FALSE");\r
21b42c66 217 jTextFieldFeatureFlag.setEnabled(false);\r
06a19cee 218 }\r
219 return jTextFieldFeatureFlag;\r
220 }\r
221\r
222 /**\r
223 This method initializes iCheckBoxListArch \r
224 \r
225 @return ICheckBoxList \r
226 **/\r
227 private ICheckBoxList getICheckBoxListSupModuleList() {\r
228 if (iCheckBoxListModule == null) {\r
229 iCheckBoxListModule = new ICheckBoxList();\r
230 }\r
231 return iCheckBoxListModule;\r
232 }\r
233\r
234 /**\r
235 This method initializes jScrollPaneModuleList \r
236 \r
237 @return javax.swing.JScrollPane \r
238 \r
239 **/\r
240 private JScrollPane getJScrollPaneModuleList() {\r
241 if (jScrollPaneModuleList == null) {\r
242 jScrollPaneModuleList = new JScrollPane();\r
21b42c66 243 jScrollPaneModuleList.setBounds(new java.awt.Rectangle(168, 112, 320, 80));\r
06a19cee 244 jScrollPaneModuleList.setPreferredSize(new java.awt.Dimension(320, 80));\r
245 jScrollPaneModuleList.setViewportView(getICheckBoxListSupModuleList());\r
246 }\r
247 return jScrollPaneModuleList;\r
248 }\r
249\r
250 /**\r
251 This method initializes jTextFieldHelpText \r
252 \r
253 @return javax.swing.JTextField \r
254 \r
255 **/\r
256 private JTextField getJTextFieldHelpText() {\r
257 if (jTextFieldHelpText == null) {\r
258 jTextFieldHelpText = new JTextField();\r
928b45fb 259 jTextFieldHelpText.setBounds(new java.awt.Rectangle(168, 62, 320, 20));\r
06a19cee 260 jTextFieldHelpText.setPreferredSize(new java.awt.Dimension(320, 20));\r
261 }\r
262 return jTextFieldHelpText;\r
263 }\r
264\r
265 /**\r
266 This method initializes jButtonOk \r
267 \r
268 @return javax.swing.JButton \r
269 \r
270 **/\r
271 private JButton getJButtonOk() {\r
272 if (jButtonOk == null) {\r
273 jButtonOk = new JButton();\r
928b45fb 274 jButtonOk.setBounds(new java.awt.Rectangle(300, 232, 90, 20));\r
06a19cee 275 jButtonOk.setText("Ok");\r
276 jButtonOk.addActionListener(this);\r
277 }\r
278 return jButtonOk;\r
279 }\r
280\r
281 /**\r
282 This method initializes jButtonCancel \r
283 \r
284 @return javax.swing.JButton \r
285 \r
286 **/\r
287 private JButton getJButtonCancel() {\r
288 if (jButtonCancel == null) {\r
289 jButtonCancel = new JButton();\r
928b45fb 290 jButtonCancel.setBounds(new java.awt.Rectangle(400, 232, 90, 20));\r
06a19cee 291 jButtonCancel.setText("Cancel");\r
292 jButtonCancel.addActionListener(this);\r
293 }\r
294 return jButtonCancel;\r
295 }\r
296\r
297 public static void main(String[] args) {\r
298\r
299 }\r
300\r
301 /**\r
302 This is the default constructor\r
303 \r
304 **/\r
305 public LibraryClassDefsDlg(LibraryClassIdentification inLibraryClassIdentification, IFrame iFrame) {\r
306 super(iFrame, true);\r
307 init(inLibraryClassIdentification);\r
308 }\r
309\r
310 /**\r
311 This method initializes this\r
312 \r
313 **/\r
314 private void init() {\r
315 this.setContentPane(getJScrollPane());\r
316 this.setTitle("Library Class Definitions");\r
928b45fb 317 this.setBounds(new java.awt.Rectangle(0, 0, 505, 305));\r
06a19cee 318 initFrame();\r
319 this.setViewMode(false);\r
320 this.centerWindow();\r
321 }\r
322\r
323 /**\r
324 This method initializes this\r
325 \r
326 **/\r
327 private void init(LibraryClassIdentification inLibraryClassIdentification) {\r
328 init();\r
329 this.lcid = inLibraryClassIdentification;\r
330 if (lcid != null) {\r
331 this.jComboBoxLibraryClassName.setSelectedItem(lcid.getLibraryClassName());\r
332 this.jComboBoxUsage.setSelectedItem(lcid.getUsage());\r
333 this.jTextFieldRecommendedInstanceVersion.setText(lcid.getRecommendedInstanceVersion());\r
334 this.jTextFieldRecommendedInstanceGuid.setText(lcid.getRecommendedInstanceGuid());\r
335 this.jTextFieldFeatureFlag.setText(lcid.getFeatureFlag());\r
336 this.jArchCheckBox.setSelectedItems(lcid.getSupArchList());\r
337 this.iCheckBoxListModule.setAllItemsUnchecked();\r
338 this.iCheckBoxListModule.initCheckedItem(true, lcid.getSupModuleList());\r
339 this.jTextFieldHelpText.setText(lcid.getHelp());\r
340 }\r
341 }\r
342\r
343 /**\r
344 Disable all components when the mode is view\r
345 \r
346 @param isView true - The view mode; false - The non-view mode\r
347 \r
348 **/\r
349 public void setViewMode(boolean isView) {\r
350 if (isView) {\r
351 this.jComboBoxLibraryClassName.setEnabled(!isView);\r
352 this.jComboBoxUsage.setEnabled(!isView);\r
353 }\r
354 }\r
355\r
356 /**\r
357 This method initializes jContentPane\r
358 \r
359 @return javax.swing.JPanel jContentPane\r
360 \r
361 **/\r
362 private JPanel getJContentPane() {\r
363 if (jContentPane == null) {\r
364 jArchCheckBox = new ArchCheckBox();\r
21b42c66 365 jArchCheckBox.setBounds(new java.awt.Rectangle(168, 87, 320, 20));\r
06a19cee 366 jArchCheckBox.setPreferredSize(new java.awt.Dimension(320, 20));\r
367 jLabelHelpText = new JLabel();\r
928b45fb 368 jLabelHelpText.setBounds(new java.awt.Rectangle(12, 62, 168, 20));\r
06a19cee 369 jLabelHelpText.setText("Help Text");\r
370 jLabelModuleList = new JLabel();\r
21b42c66 371 jLabelModuleList.setBounds(new java.awt.Rectangle(12, 112, 168, 20));\r
ccb063b1 372 jLabelModuleList.setText("Supported Module Types");\r
06a19cee 373 jLabelArch = new JLabel();\r
21b42c66 374 jLabelArch.setBounds(new java.awt.Rectangle(12, 87, 168, 20));\r
ccb063b1 375 jLabelArch.setText("Supported Architectures");\r
06a19cee 376 jLabelFeatureFlag = new JLabel();\r
21b42c66 377 jLabelFeatureFlag.setBounds(new java.awt.Rectangle(12,197,168,20));\r
a929458e 378 jLabelFeatureFlag.setText("Feature Flag Expression");\r
21b42c66 379 jLabelFeatureFlag.setEnabled(false);\r
06a19cee 380 jLabelRecommendedInstanceGuid = new JLabel();\r
21b42c66 381 jLabelRecommendedInstanceGuid.setBounds(new java.awt.Rectangle(12, 87, 200, 20));\r
06a19cee 382 jLabelRecommendedInstanceGuid.setText("Recommended Instance Guid");\r
383 jLabelRecommendedInstanceGuid.setVisible(false);\r
384 jLabelRecommendedInstanceVersion = new JLabel();\r
928b45fb 385 jLabelRecommendedInstanceVersion.setBounds(new java.awt.Rectangle(12, 87, 200, 20));\r
06a19cee 386 jLabelRecommendedInstanceVersion.setText("Recommended Instance Version");\r
387 jLabelRecommendedInstanceVersion.setVisible(false);\r
388 jLabelLibraryClassName = new JLabel();\r
928b45fb 389 jLabelLibraryClassName.setBounds(new java.awt.Rectangle(12, 12, 168, 20));\r
06a19cee 390 jLabelLibraryClassName.setText("Library Class Name");\r
391 jLabelUsage = new JLabel();\r
928b45fb 392 jLabelUsage.setBounds(new java.awt.Rectangle(12, 37, 168, 20));\r
06a19cee 393 jLabelUsage.setText("Usage");\r
394 jContentPane = new JPanel();\r
395 jContentPane.setLayout(null);\r
928b45fb 396 jContentPane.setPreferredSize(new java.awt.Dimension(495, 255));\r
06a19cee 397\r
398 jContentPane.add(getJComboBoxLibraryClassName(), null);\r
399 jContentPane.add(jLabelUsage, null);\r
400 jContentPane.add(getJComboBoxUsage(), null);\r
401 jContentPane.add(jLabelLibraryClassName, null);\r
402 jContentPane.add(jLabelRecommendedInstanceVersion, null);\r
403 jContentPane.add(getJTextFieldRecommendedInstanceVersion(), null);\r
404 jContentPane.add(jLabelRecommendedInstanceGuid, null);\r
405 jContentPane.add(getJTextFieldRecommendedInstanceGuid(), null);\r
406 jContentPane.add(getJButtonGenerateGuid(), null);\r
407 jContentPane.add(jLabelFeatureFlag, null);\r
408 jContentPane.add(getJTextFieldFeatureFlag(), null);\r
409 jContentPane.add(jLabelArch, null);\r
410 jStarLabel1 = new StarLabel();\r
ccb063b1 411 jStarLabel1.setLocation(new java.awt.Point(2, 10));\r
06a19cee 412 jStarLabel2 = new StarLabel();\r
ccb063b1 413 jStarLabel2.setLocation(new java.awt.Point(2, 35));\r
06a19cee 414\r
415 jContentPane.add(jStarLabel1, null);\r
416 jContentPane.add(jStarLabel2, null);\r
417 jContentPane.add(jLabelModuleList, null);\r
418 jContentPane.add(getJScrollPaneModuleList(), null);\r
419 jContentPane.add(jLabelHelpText, null);\r
420 jContentPane.add(getJTextFieldHelpText(), null);\r
421 jContentPane.add(jArchCheckBox, null);\r
422 jContentPane.add(getJButtonOk(), null);\r
423 jContentPane.add(getJButtonCancel(), null);\r
424 }\r
425 return jContentPane;\r
426 }\r
427\r
428 /**\r
429 This method initializes all existing libraries and usage types\r
430 \r
431 **/\r
432 private void initFrame() {\r
433 Tools.generateComboBoxByVector(jComboBoxLibraryClassName, wt.getAllLibraryClassDefinitionsFromWorkspace());\r
434 Tools.generateComboBoxByVector(jComboBoxUsage, ed.getVLibraryUsage());\r
435 this.iCheckBoxListModule.setAllItems(ed.getVFrameworkModuleTypes());\r
436 }\r
437\r
438 /* (non-Javadoc)\r
439 * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)\r
440 *\r
441 * Override actionPerformed to listen all actions\r
442 * \r
443 */\r
444 public void actionPerformed(ActionEvent arg0) {\r
445 if (arg0.getSource() == jButtonGenerateGuid) {\r
446 this.jTextFieldRecommendedInstanceGuid.setText(Tools.generateUuidString());\r
447 }\r
448\r
449 if (arg0.getSource() == jButtonOk) {\r
450 if (checkAdd()) {\r
451 getCurrentLibraryClass();\r
452 this.returnType = DataType.RETURN_TYPE_OK;\r
453 this.setVisible(false);\r
454 }\r
455 }\r
456\r
457 if (arg0.getSource() == jButtonCancel) {\r
458 this.returnType = DataType.RETURN_TYPE_CANCEL;\r
459 this.setVisible(false);\r
460 }\r
461 }\r
462\r
463 /**\r
464 Data validation for all fields\r
465 \r
466 @retval true - All datas are valid\r
467 @retval false - At least one data is invalid\r
468 \r
469 **/\r
470 public boolean checkAdd() {\r
471 //\r
472 // Check LibraryClass\r
473 //\r
474 if (this.jComboBoxLibraryClassName.getSelectedItem() == null) {\r
ed1665f2 475 Log.wrn("Update Library Class Definitions", "No Library Class can be added");\r
06a19cee 476 return false;\r
477 }\r
478 if (!DataValidation.isLibraryClass(this.jComboBoxLibraryClassName.getSelectedItem().toString())) {\r
ed1665f2 479 Log.wrn("Update Library Class Definitions", "Incorrect data type for Library Class");\r
06a19cee 480 return false;\r
481 }\r
482\r
483 //\r
484 // Check RecommendedInstanceVersion\r
485 //\r
486 // if (!isEmpty(this.jTextFieldRecommendedInstanceVersion.getText())) {\r
487 // if (!DataValidation.isRecommendedInstanceVersion(this.jTextFieldRecommendedInstanceVersion.getText())) {\r
488 // Log.err("Incorrect data type for Recommended Instance Version");\r
489 // return false;\r
490 // }\r
491 // }\r
492\r
493 //\r
494 // Check RecommendedInstanceGuid\r
495 //\r
496 // if (!isEmpty(this.jTextFieldRecommendedInstanceGuid.getText())) {\r
497 // if (!DataValidation.isGuid(this.jTextFieldRecommendedInstanceGuid.getText())) {\r
498 // Log.err("Incorrect data type for Recommended Instance Guid");\r
499 // return false;\r
500 // }\r
501 // }\r
502\r
503 //\r
504 // Check FeatureFlag\r
505 //\r
506 if (!isEmpty(this.jTextFieldFeatureFlag.getText())) {\r
507 if (!DataValidation.isFeatureFlag(this.jTextFieldFeatureFlag.getText())) {\r
ed1665f2 508 Log.wrn("Update Library Class Definitions", "Incorrect data type for Feature Flag");\r
06a19cee 509 return false;\r
510 }\r
511 }\r
512\r
513 return true;\r
514 }\r
515\r
516 private LibraryClassIdentification getCurrentLibraryClass() {\r
517 String name = this.jComboBoxLibraryClassName.getSelectedItem().toString();\r
518 String usage = this.jComboBoxUsage.getSelectedItem().toString();\r
519 String version = this.jTextFieldRecommendedInstanceVersion.getText();\r
520 String guid = this.jTextFieldRecommendedInstanceGuid.getText();\r
521 String featureFlag = this.jTextFieldFeatureFlag.getText();\r
522 Vector<String> arch = this.jArchCheckBox.getSelectedItemsVector();\r
523 Vector<String> module = this.iCheckBoxListModule.getAllCheckedItemsString();\r
524 String help = this.jTextFieldHelpText.getText();\r
525 lcid = new LibraryClassIdentification(name, usage, version, guid, arch, featureFlag, module, help);\r
526 return lcid;\r
527 }\r
528\r
529 public LibraryClassIdentification getLcid() {\r
530 return lcid;\r
531 }\r
532\r
533 public void setLcid(LibraryClassIdentification lcid) {\r
534 this.lcid = lcid;\r
535 }\r
536}\r