]> git.proxmox.com Git - mirror_edk2.git/blame - Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/PCDsDlg.java
1. Change ToolCode from text field to drop down list, and user can enter their custom...
[mirror_edk2.git] / Tools / Source / FrameworkWizard / src / org / tianocore / frameworkwizard / module / ui / dialog / PCDsDlg.java
CommitLineData
06a19cee 1/** @file\r
2 \r
3 The file is used to create, update PCD of MSA/MBD file\r
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.event.ActionEvent;\r
9a8d6d9f 18import java.awt.event.ItemEvent;\r
19import java.awt.event.ItemListener;\r
06a19cee 20import java.util.Vector;\r
21\r
22import javax.swing.JButton;\r
23import javax.swing.JComboBox;\r
24import javax.swing.JLabel;\r
25import javax.swing.JPanel;\r
26import javax.swing.JScrollPane;\r
27import javax.swing.JTextField;\r
747e1504 28import javax.swing.JTextArea;\r
06a19cee 29\r
30import org.tianocore.frameworkwizard.common.DataType;\r
31import org.tianocore.frameworkwizard.common.DataValidation;\r
06a19cee 32import org.tianocore.frameworkwizard.common.Log;\r
33import org.tianocore.frameworkwizard.common.Tools;\r
34import org.tianocore.frameworkwizard.common.ui.ArchCheckBox;\r
35import org.tianocore.frameworkwizard.common.ui.IDialog;\r
36import org.tianocore.frameworkwizard.common.ui.IFrame;\r
37import org.tianocore.frameworkwizard.common.ui.StarLabel;\r
38import org.tianocore.frameworkwizard.module.Identifications.PcdCoded.PcdCodedIdentification;\r
9a8d6d9f 39import org.tianocore.frameworkwizard.module.Identifications.PcdCoded.PcdVector;\r
06a19cee 40import org.tianocore.frameworkwizard.workspace.WorkspaceTools;\r
41\r
42/**\r
5101eff9 43 * The class is used to create, update PCD of MSA/MBD file It extends\r
44 * IInternalFrame\r
45 * \r
46 */\r
9a8d6d9f 47public class PCDsDlg extends IDialog implements ItemListener {\r
06a19cee 48\r
a929458e 49 // /\r
50 // / Define class Serial Version UID\r
51 // /\r
52 private static final long serialVersionUID = 2227717658188438696L;\r
06a19cee 53\r
a929458e 54 //\r
55 // Define class members\r
56 //\r
57 private JPanel jContentPane = null;\r
06a19cee 58\r
a929458e 59 private JLabel jLabelItemType = null;\r
06a19cee 60\r
a929458e 61 private JLabel jLabelC_Name = null;\r
06a19cee 62\r
a929458e 63 private JComboBox jComboBoxItemType = null;\r
06a19cee 64\r
a929458e 65 private JComboBox jComboBoxCName = null;\r
06a19cee 66\r
a929458e 67 private JLabel jLabelDefaultValue = null;\r
06a19cee 68\r
a929458e 69 private JTextField jTextFieldDefaultValue = null;\r
06a19cee 70\r
a929458e 71 private StarLabel jStarLabel1 = null;\r
06a19cee 72\r
a929458e 73 private StarLabel jStarLabel2 = null;\r
06a19cee 74\r
a929458e 75 private StarLabel jStarLabel3 = null;\r
06a19cee 76\r
a929458e 77 private JLabel jLabelHelpText = null;\r
06a19cee 78\r
a929458e 79 private JTextArea jTextAreaHelpText = null;\r
06a19cee 80\r
a929458e 81 private JScrollPane jScrollPane = null;\r
06a19cee 82\r
a929458e 83 private JLabel jLabelTokenSpaceGuid = null;\r
06a19cee 84\r
a929458e 85 private JTextField jTextFieldTokenSpaceGuid = null;\r
06a19cee 86\r
a929458e 87 private JLabel jLabelFeatureFlag = null;\r
06a19cee 88\r
a929458e 89 private JTextField jTextFieldFeatureFlag = null;\r
06a19cee 90\r
a929458e 91 private JLabel jLabelArch = null;\r
06a19cee 92\r
a929458e 93 private ArchCheckBox jArchCheckBox = null;\r
06a19cee 94\r
a929458e 95 private JButton jButtonOk = null;\r
06a19cee 96\r
a929458e 97 private JButton jButtonCancel = null;\r
06a19cee 98\r
a929458e 99 private JScrollPane jScrollPaneHelpText = null;\r
06a19cee 100\r
a929458e 101 //\r
102 // Not used by UI\r
103 //\r
104 private PcdCodedIdentification id = null;\r
105\r
106 private WorkspaceTools wt = new WorkspaceTools();\r
107\r
108 private PcdVector pcd = wt.getAllPcdDeclarationsFromWorkspace();\r
109\r
110 /**\r
111 * This method initializes jComboBoxItemType\r
112 * \r
113 * @return javax.swing.JComboBox jComboBoxItemType\r
114 * \r
115 */\r
116 private JComboBox getJComboBoxItemType() {\r
117 if (jComboBoxItemType == null) {\r
118 jComboBoxItemType = new JComboBox();\r
119 jComboBoxItemType.setBounds(new java.awt.Rectangle(160, 35, 320, 20));\r
120 jComboBoxItemType.setPreferredSize(new java.awt.Dimension(320, 20));\r
121 }\r
122 return jComboBoxItemType;\r
123 }\r
747e1504 124\r
a929458e 125 /**\r
126 * This method initializes jTextFieldC_Name\r
127 * \r
128 * @return javax.swing.JTextField jTextFieldC_Name\r
129 * \r
130 */\r
131 private JComboBox getJComboBoxCName() {\r
132 if (jComboBoxCName == null) {\r
133 jComboBoxCName = new JComboBox();\r
134 jComboBoxCName.setBounds(new java.awt.Rectangle(160, 10, 320, 20));\r
135 jComboBoxCName.setPreferredSize(new java.awt.Dimension(320, 20));\r
136 jComboBoxCName.addItemListener(this);\r
137 }\r
138 return jComboBoxCName;\r
06a19cee 139 }\r
a929458e 140\r
141 /**\r
142 * This method initializes jTextFieldDefaultValue\r
143 * \r
144 * @return javax.swing.JTextField jTextFieldDefaultValue\r
145 * \r
146 */\r
147 private JTextField getJTextFieldDefaultValue() {\r
148 if (jTextFieldDefaultValue == null) {\r
149 jTextFieldDefaultValue = new JTextField();\r
150 jTextFieldDefaultValue.setBounds(new java.awt.Rectangle(160, 60, 320, 20));\r
151 jTextFieldDefaultValue.setPreferredSize(new java.awt.Dimension(320, 20));\r
152 }\r
153 return jTextFieldDefaultValue;\r
06a19cee 154 }\r
a929458e 155\r
156 /**\r
157 * This method initializes jTextAreaHelpText\r
158 * \r
159 * @return javax.swing.JTextArea\r
160 */\r
161 private JTextArea getJTextAreaHelpText() {\r
162 if (jTextAreaHelpText == null) {\r
163 jTextAreaHelpText = new JTextArea();\r
164 jTextAreaHelpText.setLineWrap(true);\r
165 jTextAreaHelpText.setWrapStyleWord(true);\r
166 }\r
167 return jTextAreaHelpText;\r
06a19cee 168 }\r
a929458e 169\r
170 /**\r
171 * This method initializes jScrollPaneHelpText\r
172 * \r
173 * @return javax.swing.JScrollPane\r
174 * \r
175 */\r
176 private JScrollPane getJScrollPaneHelpText() {\r
177 if (jScrollPaneHelpText == null) {\r
178 jScrollPaneHelpText = new JScrollPane();\r
179 jScrollPaneHelpText.setHorizontalScrollBarPolicy(javax.swing.JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);\r
180 jScrollPaneHelpText.setSize(new java.awt.Dimension(320, 40));\r
181 jScrollPaneHelpText.setPreferredSize(new java.awt.Dimension(320, 40));\r
182 jScrollPaneHelpText.setLocation(new java.awt.Point(160, 85));\r
183 jScrollPaneHelpText.setViewportView(getJTextAreaHelpText());\r
184 }\r
185 return jScrollPaneHelpText;\r
06a19cee 186 }\r
a929458e 187\r
188 /**\r
189 * This method initializes jScrollPane\r
190 * \r
191 * @return javax.swing.JScrollPane\r
192 */\r
193 private JScrollPane getJScrollPane() {\r
194 if (jScrollPane == null) {\r
195 jScrollPane = new JScrollPane();\r
196 jScrollPane.setViewportView(getJContentPane());\r
197 }\r
198 return jScrollPane;\r
06a19cee 199 }\r
a929458e 200\r
201 /**\r
202 * This method initializes jTextFieldTokenSpaceGuid\r
203 * \r
204 * @return javax.swing.JTextField\r
205 */\r
206 private JTextField getJTextFieldTokenSpaceGuid() {\r
207 if (jTextFieldTokenSpaceGuid == null) {\r
208 jTextFieldTokenSpaceGuid = new JTextField();\r
209 jTextFieldTokenSpaceGuid.setBounds(new java.awt.Rectangle(160, 60, 320, 20));\r
210 jTextFieldTokenSpaceGuid.setPreferredSize(new java.awt.Dimension(320, 20));\r
211 jTextFieldTokenSpaceGuid.setVisible(false);\r
212 }\r
213 return jTextFieldTokenSpaceGuid;\r
06a19cee 214 }\r
a929458e 215\r
216 /**\r
217 * This method initializes jTextFieldFeatureFlag\r
218 * \r
219 * @return javax.swing.JTextField\r
220 */\r
221 private JTextField getJTextFieldFeatureFlag() {\r
222 if (jTextFieldFeatureFlag == null) {\r
223 jTextFieldFeatureFlag = new JTextField();\r
224 jTextFieldFeatureFlag.setBounds(new java.awt.Rectangle(160, 130, 320, 20));\r
225 jTextFieldFeatureFlag.setPreferredSize(new java.awt.Dimension(320, 20));\r
226 jTextFieldFeatureFlag.setToolTipText("Postfix expression that must evaluate to TRUE or FALSE");\r
227 }\r
228 return jTextFieldFeatureFlag;\r
06a19cee 229 }\r
a929458e 230\r
231 /**\r
232 * This method initializes jButtonOk\r
233 * \r
234 * @return javax.swing.JButton\r
235 * \r
236 */\r
237 private JButton getJButtonOk() {\r
238 if (jButtonOk == null) {\r
239 jButtonOk = new JButton();\r
240 jButtonOk.setBounds(new java.awt.Rectangle(290, 182, 90, 20));\r
241 jButtonOk.setText("Ok");\r
242 jButtonOk.addActionListener(this);\r
243 }\r
244 return jButtonOk;\r
06a19cee 245 }\r
a929458e 246\r
247 /**\r
248 * This method initializes jButtonCancel\r
249 * \r
250 * @return javax.swing.JButton\r
251 * \r
252 */\r
253 private JButton getJButtonCancel() {\r
254 if (jButtonCancel == null) {\r
255 jButtonCancel = new JButton();\r
256 jButtonCancel.setBounds(new java.awt.Rectangle(390, 182, 90, 20));\r
257 jButtonCancel.setText("Cancel");\r
258 jButtonCancel.addActionListener(this);\r
259 }\r
260 return jButtonCancel;\r
06a19cee 261 }\r
a929458e 262\r
263 public static void main(String[] args) {\r
264\r
06a19cee 265 }\r
a929458e 266\r
267 /**\r
268 * This method initializes this\r
269 * \r
270 */\r
271 private void init() {\r
272 this.setSize(500, 255);\r
273 this.setContentPane(getJScrollPane());\r
274 this.setTitle("Pcd Coded");\r
275 initFrame();\r
276 this.setViewMode(false);\r
277 this.centerWindow();\r
06a19cee 278 }\r
a929458e 279\r
280 /**\r
281 * This method initializes this Fill values to all fields if these values are\r
282 * not empty\r
283 * \r
284 * @param inPcdCodedId\r
285 * \r
286 */\r
287 private void init(PcdCodedIdentification inPcdCodedId) {\r
288 init();\r
289 this.id = inPcdCodedId;\r
290\r
291 if (this.id != null) {\r
292 this.jComboBoxCName.setSelectedItem(id.getName());\r
293 this.jTextFieldTokenSpaceGuid.setText(id.getGuid());\r
294 this.jTextFieldDefaultValue.setText(id.getValue());\r
295 this.jTextAreaHelpText.setText(id.getHelp());\r
296 this.jComboBoxItemType.setSelectedItem(id.getType());\r
297 this.jTextFieldFeatureFlag.setText(id.getFeatureFlag());\r
298 this.jArchCheckBox.setSelectedItems(id.getSupArchList());\r
299 }\r
06a19cee 300 }\r
a929458e 301\r
302 /**\r
303 * This is the override edit constructor\r
304 * \r
305 * @param inPcdCodedId\r
306 * @param iFrame\r
307 * \r
308 */\r
309 public PCDsDlg(PcdCodedIdentification inPcdCodedId, IFrame iFrame) {\r
310 super(iFrame, true);\r
311 init(inPcdCodedId);\r
5101eff9 312 }\r
a929458e 313\r
314 /**\r
315 * Disable all components when the mode is view\r
316 * \r
317 * @param isView\r
318 * true - The view mode; false - The non-view mode\r
319 * \r
320 */\r
321 public void setViewMode(boolean isView) {\r
322 if (isView) {\r
323 this.jTextFieldDefaultValue.setEnabled(!isView);\r
324 this.jComboBoxItemType.setEnabled(!isView);\r
325 }\r
06a19cee 326 }\r
327\r
a929458e 328 /**\r
329 * This method initializes jContentPane\r
330 * \r
331 * @return javax.swing.JPanel jContentPane\r
332 * \r
333 */\r
334 private JPanel getJContentPane() {\r
335 if (jContentPane == null) {\r
336 jStarLabel1 = new StarLabel();\r
337 jStarLabel1.setLocation(new java.awt.Point(2, 10));\r
338 jLabelC_Name = new JLabel();\r
339 jLabelC_Name.setText("PCD C Name");\r
340 jLabelC_Name.setBounds(new java.awt.Rectangle(15, 10, 145, 20));\r
341\r
342 jStarLabel2 = new StarLabel();\r
343 jStarLabel2.setLocation(new java.awt.Point(2, 35));\r
344 jLabelItemType = new JLabel();\r
345 jLabelItemType.setText("PCD Item Type");\r
346 jLabelItemType.setBounds(new java.awt.Rectangle(15, 35, 145, 20));\r
347\r
348 jLabelDefaultValue = new JLabel();\r
349 jLabelDefaultValue.setText("Default Value");\r
350 jLabelDefaultValue.setBounds(new java.awt.Rectangle(15, 60, 145, 20));\r
351\r
352 jStarLabel3 = new StarLabel();\r
353 jStarLabel3.setLocation(new java.awt.Point(2, 85));\r
354 jLabelHelpText = new JLabel();\r
355 jLabelHelpText.setText("Help Text");\r
356 jLabelHelpText.setBounds(new java.awt.Rectangle(15, 85, 145, 20));\r
357\r
358 jLabelFeatureFlag = new JLabel();\r
359 jLabelFeatureFlag.setText("Feature Flag Expression");\r
360 jLabelFeatureFlag.setBounds(new java.awt.Rectangle(15, 130, 140, 20));\r
361\r
362 jLabelTokenSpaceGuid = new JLabel();\r
363 jLabelTokenSpaceGuid.setText("Token Space C Name");\r
364 jLabelTokenSpaceGuid.setVisible(false);\r
365\r
366 jLabelArch = new JLabel();\r
367 jLabelArch.setText("Supported Architectures");\r
368 jLabelArch.setBounds(new java.awt.Rectangle(15, 155, 145, 20));\r
369 jArchCheckBox = new ArchCheckBox();\r
370 jArchCheckBox.setPreferredSize(new java.awt.Dimension(320, 20));\r
371 jArchCheckBox.setBounds(new java.awt.Rectangle(160, 155, 320, 20));\r
372\r
373 // Hidden field\r
374 jLabelTokenSpaceGuid.setBounds(new java.awt.Rectangle(15, 60, 140, 20));\r
375\r
376 jContentPane = new JPanel();\r
377 jContentPane.setLayout(null);\r
378 jContentPane.setPreferredSize(new java.awt.Dimension(485, 210));\r
379\r
380 jContentPane.add(jStarLabel1, null);\r
381 jContentPane.add(jLabelC_Name, null);\r
382 jContentPane.add(getJComboBoxCName(), null);\r
383 jContentPane.add(jStarLabel2, null);\r
384 jContentPane.add(jLabelItemType, null);\r
385 jContentPane.add(getJComboBoxItemType(), null);\r
386 jContentPane.add(jLabelDefaultValue, null);\r
387 jContentPane.add(getJTextFieldDefaultValue(), null);\r
388 jContentPane.add(jStarLabel3, null);\r
389 jContentPane.add(jLabelHelpText, null);\r
390 jContentPane.add(getJScrollPaneHelpText(), null);\r
391 jContentPane.add(jLabelFeatureFlag, null);\r
392 jContentPane.add(getJTextFieldFeatureFlag(), null);\r
393 jContentPane.add(jLabelArch, null);\r
394 jContentPane.add(jArchCheckBox, null);\r
395 // Hidden\r
396 jContentPane.add(getJTextFieldTokenSpaceGuid(), null);\r
397 jContentPane.add(jLabelTokenSpaceGuid, null);\r
398 jContentPane.add(getJButtonOk(), null);\r
399 jContentPane.add(getJButtonCancel(), null);\r
400 }\r
401 return jContentPane;\r
06a19cee 402 }\r
403\r
a929458e 404 /**\r
405 * This method initializes Usage type, Item type and Datum type\r
406 * \r
407 */\r
408 private void initFrame() {\r
409 for (int index = 0; index < pcd.size(); index++) {\r
410 jComboBoxCName.addItem(pcd.getPcd(index));\r
411 }\r
412\r
413 // Tools.generateComboBoxByVector(jComboBoxItemType, ed.getVPcdItemTypes());\r
06a19cee 414 }\r
415\r
a929458e 416 /*\r
417 * (non-Javadoc)\r
418 * \r
419 * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)\r
420 * \r
421 * Override actionPerformed to listen all actions\r
422 * \r
423 */\r
424 public void actionPerformed(ActionEvent arg0) {\r
425 if (arg0.getSource() == jButtonOk) {\r
426 if (checkAdd()) {\r
427 getCurrentPcdCoded();\r
428 this.returnType = DataType.RETURN_TYPE_OK;\r
429 this.setVisible(false);\r
430 }\r
431 }\r
432\r
433 if (arg0.getSource() == jButtonCancel) {\r
434 this.returnType = DataType.RETURN_TYPE_CANCEL;\r
435 this.setVisible(false);\r
436 }\r
5101eff9 437 }\r
06a19cee 438\r
a929458e 439 /**\r
440 * Data validation for all fields\r
441 * \r
442 * @retval true - All datas are valid\r
443 * @retval false - At least one data is invalid\r
444 * \r
445 */\r
446 public boolean checkAdd() {\r
447 //\r
448 // Check if all fields have correct data types\r
449 //\r
450\r
451 //\r
452 // Check C_Name\r
453 //\r
454 if (!isEmpty(this.jComboBoxCName.getSelectedItem().toString())) {\r
455 if (!DataValidation.isC_NameType(this.jComboBoxCName.getSelectedItem().toString())) {\r
456 Log.wrn("Update PcdCoded", "Incorrect data type for C Name");\r
457 return false;\r
458 }\r
459 }\r
460\r
461 //\r
462 // Check TokenSpaceGuid\r
463 //\r
464 if (!isEmpty(this.jTextFieldTokenSpaceGuid.getText())) {\r
465 if (!DataValidation.isC_NameType(this.jTextFieldTokenSpaceGuid.getText())) {\r
466 Log.wrn("Update PcdCoded",\r
467 "Incorrect data type for the selected pcd entry, please check in in spd file");\r
468 return false;\r
469 }\r
470 }\r
471\r
472 //\r
473 // Check DefaultValue\r
474 //\r
475 if (!isEmpty(this.jTextFieldDefaultValue.getText())) {\r
476 if (!DataValidation.isDefaultValueType(this.jTextFieldDefaultValue.getText())) {\r
477 Log.wrn("Update PcdCoded", "Incorrect data type for Default Value");\r
478 return false;\r
479 }\r
480 }\r
481\r
482 //\r
483 // Check HelpText\r
484 //\r
485 if (isEmpty(this.jTextAreaHelpText.getText())) {\r
486 Log.wrn("Update PcdCoded", "Help Text should not be empty");\r
487 return false;\r
488 }\r
489\r
490 //\r
491 // Check FeatureFlag\r
492 //\r
493 if (!isEmpty(this.jTextFieldFeatureFlag.getText())) {\r
494 if (!DataValidation.isFeatureFlag(this.jTextFieldFeatureFlag.getText())) {\r
495 Log.wrn("Update PcdCoded", "Incorrect data type for Feature Flag");\r
496 return false;\r
497 }\r
498 }\r
499\r
500 return true;\r
5101eff9 501 }\r
06a19cee 502\r
a929458e 503 private PcdCodedIdentification getCurrentPcdCoded() {\r
504 String arg0 = this.jComboBoxCName.getSelectedItem().toString();\r
505 String arg1 = this.jTextFieldTokenSpaceGuid.getText();\r
506\r
507 String arg2 = this.jTextFieldFeatureFlag.getText();\r
508 Vector<String> arg3 = this.jArchCheckBox.getSelectedItemsVector();\r
509\r
510 String arg4 = this.jTextFieldDefaultValue.getText();\r
511 String arg5 = this.jTextAreaHelpText.getText();\r
512 String arg6 = this.jComboBoxItemType.getSelectedItem().toString();\r
513 id = new PcdCodedIdentification(arg0, arg1, arg2, arg3, arg4, arg5, arg6);\r
514 return id;\r
06a19cee 515 }\r
516\r
a929458e 517 public PcdCodedIdentification getId() {\r
518 return id;\r
06a19cee 519 }\r
520\r
a929458e 521 public void setId(PcdCodedIdentification id) {\r
522 this.id = id;\r
06a19cee 523 }\r
9a8d6d9f 524\r
a929458e 525 /*\r
526 * (non-Javadoc)\r
527 * \r
528 * @see java.awt.event.ItemListener#itemStateChanged(java.awt.event.ItemEvent)\r
529 * \r
530 * Reflesh the frame when selected item changed\r
531 * \r
532 */\r
533 public void itemStateChanged(ItemEvent arg0) {\r
534 int index = this.jComboBoxCName.getSelectedIndex();\r
535 if (arg0.getSource() == this.jComboBoxCName && arg0.getStateChange() == ItemEvent.SELECTED) {\r
536 if (pcd.getPcd(index).getGuidCName() == null || isEmpty(pcd.getPcd(index).getGuidCName())\r
537 || pcd.getPcd(index).getType() == null || pcd.getPcd(index).getHelp() == null\r
538 || isEmpty(pcd.getPcd(index).getHelp())) {\r
539 Log.wrn("select pcd entry when editing msa",\r
540 "The selected is defined incorrectly.\r\nPlease check it in spd file");\r
541 } else {\r
542 this.jTextFieldTokenSpaceGuid.setText(pcd.getPcd(index).getGuidCName());\r
543 Tools.generateComboBoxByVector(this.jComboBoxItemType, pcd.getPcd(index).getType());\r
544 this.jTextAreaHelpText.setText(pcd.getPcd(index).getHelp());\r
545 this.jTextAreaHelpText.setSelectionStart(0);\r
546 this.jTextAreaHelpText.setSelectionEnd(0);\r
547 }\r
548 }\r
9a8d6d9f 549 }\r
06a19cee 550}\r