]> git.proxmox.com Git - mirror_edk2.git/blame - Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/PpisDlg.java
Added some additional comments in the files, as well as fixed some of them.
[mirror_edk2.git] / Tools / Source / FrameworkWizard / src / org / tianocore / frameworkwizard / module / ui / dialog / PpisDlg.java
CommitLineData
06a19cee 1/** @file\r
2 \r
3f62225f 3 The file is used to create, update Ppi 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.event.ActionEvent;\r
18import java.awt.event.ItemEvent;\r
19import java.awt.event.ItemListener;\r
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
5101eff9 28import javax.swing.JTextArea;\r
06a19cee 29\r
30import org.tianocore.frameworkwizard.common.DataType;\r
31import org.tianocore.frameworkwizard.common.DataValidation;\r
32import org.tianocore.frameworkwizard.common.EnumerationData;\r
33import org.tianocore.frameworkwizard.common.Log;\r
34import org.tianocore.frameworkwizard.common.Tools;\r
35import org.tianocore.frameworkwizard.common.ui.ArchCheckBox;\r
36import org.tianocore.frameworkwizard.common.ui.IDialog;\r
37import org.tianocore.frameworkwizard.common.ui.IFrame;\r
38import org.tianocore.frameworkwizard.common.ui.StarLabel;\r
39import org.tianocore.frameworkwizard.module.Identifications.Ppis.PpisIdentification;\r
40import org.tianocore.frameworkwizard.workspace.WorkspaceTools;\r
41\r
42/**\r
9e857952 43 * The class is used to create, update Ppi section of the MSA file\r
44 * \r
45 * It extends IDialog\r
5101eff9 46 * \r
47 */\r
06a19cee 48public class PpisDlg extends IDialog implements ItemListener {\r
49\r
a929458e 50 // /\r
51 // / Define class Serial Version UID\r
52 // /\r
53 private static final long serialVersionUID = -4284901202357037724L;\r
06a19cee 54\r
a929458e 55 //\r
56 // Define class members\r
57 //\r
58 private JPanel jContentPane = null;\r
06a19cee 59\r
a929458e 60 private JLabel jLabelC_Name = null;\r
06a19cee 61\r
a929458e 62 private JComboBox jComboBoxCName = null;\r
06a19cee 63\r
a929458e 64 private JTextField jTextFieldFeatureFlag = null;\r
06a19cee 65\r
a929458e 66 private JLabel jLabelFeatureFlag = null;\r
06a19cee 67\r
a929458e 68 private JLabel jLabelUsage = null;\r
06a19cee 69\r
a929458e 70 private JComboBox jComboBoxUsage = null;\r
06a19cee 71\r
a929458e 72 private JLabel jLabelPpiType = null;\r
06a19cee 73\r
a929458e 74 private StarLabel jStarLabel1 = null;\r
06a19cee 75\r
a929458e 76 private StarLabel jStarLabel2 = null;\r
06a19cee 77\r
a929458e 78 private StarLabel jStarLabel3 = null;\r
06a19cee 79\r
a929458e 80 private JComboBox jComboBoxPpiType = null;\r
06a19cee 81\r
a929458e 82 private JLabel jLabelArch = null;\r
06a19cee 83\r
a929458e 84 private JScrollPane jScrollPane = null;\r
06a19cee 85\r
a929458e 86 private JLabel jLabelHelpText = null;\r
06a19cee 87\r
a929458e 88 private JTextArea jTextAreaHelpText = null;\r
06a19cee 89\r
a929458e 90 private JScrollPane jScrollPaneHelpText = null;\r
06a19cee 91\r
a929458e 92 private ArchCheckBox jArchCheckBox = null;\r
06a19cee 93\r
a929458e 94 private JButton jButtonOk = null;\r
06a19cee 95\r
a929458e 96 private JButton jButtonCancel = null;\r
06a19cee 97\r
a929458e 98 //\r
99 // Not used by UI\r
100 //\r
101 private PpisIdentification id = null;\r
102\r
103 private WorkspaceTools wt = new WorkspaceTools();\r
104\r
105 private EnumerationData ed = new EnumerationData();\r
106\r
107 /**\r
108 * This method initializes jComboBoxPpiType\r
109 * \r
110 * @return javax.swing.JComboBox\r
111 */\r
112 private JComboBox getJComboBoxPpiType() {\r
113 if (jComboBoxPpiType == null) {\r
114 jComboBoxPpiType = new JComboBox();\r
3f62225f 115 jComboBoxPpiType.setBounds(new java.awt.Rectangle(168, 12, 320, 20));\r
a929458e 116 jComboBoxPpiType.setPreferredSize(new java.awt.Dimension(320, 20));\r
117 jComboBoxPpiType.addItemListener(this);\r
118 jComboBoxPpiType\r
119 .setToolTipText("<html>PPIs are named by GUID.<br>PPI Notify is consumed via a register PPI Notify mechanism");\r
120 }\r
121 return jComboBoxPpiType;\r
122 }\r
06a19cee 123\r
a929458e 124 /**\r
125 * This method initializes jTextFieldC_Name\r
126 * \r
127 * @return javax.swing.JTextField jTextFieldC_Name\r
128 * \r
129 */\r
130 private JComboBox getJComboBoxCName() {\r
131 if (jComboBoxCName == null) {\r
132 jComboBoxCName = new JComboBox();\r
3f62225f 133 jComboBoxCName.setBounds(new java.awt.Rectangle(168, 37, 320, 20));\r
a929458e 134 jComboBoxCName.setPreferredSize(new java.awt.Dimension(320, 20));\r
135 jComboBoxCName.setToolTipText("Select Guid C Name of PPI");\r
136 }\r
137 return jComboBoxCName;\r
06a19cee 138 }\r
a929458e 139\r
140 /**\r
141 * This method initializes jComboBoxUsage\r
142 * \r
143 * @return javax.swing.JComboBox jComboBoxUsage\r
144 * \r
145 */\r
146 private JComboBox getJComboBoxUsage() {\r
147 if (jComboBoxUsage == null) {\r
148 jComboBoxUsage = new JComboBox();\r
3f62225f 149 jComboBoxUsage.setBounds(new java.awt.Rectangle(168, 62, 320, 20));\r
a929458e 150 jComboBoxUsage.setPreferredSize(new java.awt.Dimension(320, 20));\r
151 jComboBoxUsage\r
152 .setToolTipText("<html><table><tr><td colspan=2 align=center><b>PPI</b></td></tr><tr><td>ALWAYS_CONSUMED</td><td>Module always consumes the PPI</td></tr><tr><td>SOMETIMES_CONSUMED</td><td>Module sometimes consumes the PPI</td></tr><tr><td>ALWAYS_PRODUCED</td><td>Module always produces the PPI</td></tr><tr><td>SOMETIMES_PRODUCED</td><td>Module sometimes produces the PPI</td></tr><tr><td colspan=2 align=center><b>PPI Notify</b></td></tr><tr><td>SOMETIMES_CONSUMED</td><td>Module will consume the PPI if it is produced. Consumption<br>is defined by executing the PPI notify function</td></tr></table></html>");\r
153 }\r
154 return jComboBoxUsage;\r
06a19cee 155 }\r
a929458e 156\r
157 /**\r
158 * This method initializes jTextFieldFeatureFlag\r
159 * \r
160 * @return javax.swing.JTextField jTextFieldFeatureFlag\r
161 * \r
162 */\r
163 private JTextField getJTextFieldFeatureFlag() {\r
164 if (jTextFieldFeatureFlag == null) {\r
165 jTextFieldFeatureFlag = new JTextField();\r
3f62225f 166 jTextFieldFeatureFlag.setBounds(new java.awt.Rectangle(168, 132, 320, 20));\r
a929458e 167 jTextFieldFeatureFlag.setPreferredSize(new java.awt.Dimension(320, 20));\r
168 jTextFieldFeatureFlag.setToolTipText("Postfix expression that must evaluate to TRUE or FALSE");\r
169 }\r
170 return jTextFieldFeatureFlag;\r
06a19cee 171 }\r
a929458e 172\r
173 /**\r
174 * This method initializes jScrollPane\r
175 * \r
176 * @return javax.swing.JScrollPane\r
177 */\r
178 private JScrollPane getJScrollPane() {\r
179 if (jScrollPane == null) {\r
180 jScrollPane = new JScrollPane();\r
181 jScrollPane.setViewportView(getJContentPane());\r
182 }\r
183 return jScrollPane;\r
06a19cee 184 }\r
a929458e 185\r
186 /**\r
187 * This method initializes jTextAreaHelpText\r
188 * \r
189 * @return javax.swing.JTextArea\r
190 * \r
191 */\r
192 private JTextArea getJTextAreaHelpText() {\r
193 if (jTextAreaHelpText == null) {\r
194 jTextAreaHelpText = new JTextArea();\r
195 jTextAreaHelpText.setLineWrap(true);\r
196 jTextAreaHelpText.setWrapStyleWord(true);\r
197 }\r
198 return jTextAreaHelpText;\r
06a19cee 199 }\r
a929458e 200\r
201 /**\r
202 * This method initializes jScrollPaneHelpText\r
203 * \r
204 * @return javax.swing.JScrollPane\r
205 * \r
206 */\r
207 private JScrollPane getJScrollPaneHelpText() {\r
208 if (jScrollPaneHelpText == null) {\r
209 jScrollPaneHelpText = new JScrollPane();\r
210 jScrollPaneHelpText.setHorizontalScrollBarPolicy(javax.swing.JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);\r
211 jScrollPaneHelpText.setSize(new java.awt.Dimension(320, 40));\r
212 jScrollPaneHelpText.setPreferredSize(new java.awt.Dimension(320, 40));\r
3f62225f 213 jScrollPaneHelpText.setLocation(new java.awt.Point(168, 87));\r
a929458e 214 jScrollPaneHelpText.setViewportView(getJTextAreaHelpText());\r
215 }\r
216 return jScrollPaneHelpText;\r
06a19cee 217 }\r
a929458e 218\r
219 /**\r
220 * This method initializes jButtonOk\r
221 * \r
222 * @return javax.swing.JButton\r
223 * \r
224 */\r
225 private JButton getJButtonOk() {\r
226 if (jButtonOk == null) {\r
227 jButtonOk = new JButton();\r
3f62225f 228 jButtonOk.setBounds(new java.awt.Rectangle(290, 187, 90, 20));\r
a929458e 229 jButtonOk.setText("Ok");\r
230 jButtonOk.addActionListener(this);\r
231 }\r
232 return jButtonOk;\r
06a19cee 233 }\r
a929458e 234\r
235 /**\r
236 * This method initializes jButtonCancel\r
237 * \r
238 * @return javax.swing.JButton\r
239 * \r
240 */\r
241 private JButton getJButtonCancel() {\r
242 if (jButtonCancel == null) {\r
243 jButtonCancel = new JButton();\r
3f62225f 244 jButtonCancel.setBounds(new java.awt.Rectangle(390, 187, 90, 20));\r
a929458e 245 jButtonCancel.setText("Cancel");\r
246 jButtonCancel.addActionListener(this);\r
247 }\r
248 return jButtonCancel;\r
5101eff9 249 }\r
a929458e 250\r
251 public static void main(String[] args) {\r
252\r
5101eff9 253 }\r
a929458e 254\r
255 /**\r
256 * This method initializes this\r
257 * \r
258 */\r
259 private void init() {\r
3f62225f 260 this.setSize(505, 260);\r
a929458e 261 this.setContentPane(getJScrollPane());\r
262 this.setTitle("PPI Definitions");\r
263 initFrame();\r
264 this.centerWindow();\r
5101eff9 265 }\r
a929458e 266\r
267 /**\r
268 * This method initializes this Fill values to all fields if these values are\r
269 * not empty\r
270 * \r
271 * @param inProtocolsId\r
272 * \r
273 */\r
274 private void init(PpisIdentification inPpisId) {\r
275 init();\r
276 this.id = inPpisId;\r
277\r
278 if (this.id != null) {\r
279 this.jComboBoxCName.setSelectedItem(id.getName());\r
280 this.jComboBoxPpiType.setSelectedItem(id.getType());\r
281 this.jComboBoxUsage.setSelectedItem(id.getUsage());\r
282 this.jTextAreaHelpText.setText(id.getHelp());\r
283 this.jTextFieldFeatureFlag.setText(id.getFeatureFlag());\r
284 this.jArchCheckBox.setSelectedItems(id.getSupArchList());\r
285 }\r
5101eff9 286 }\r
a929458e 287\r
288 /**\r
289 * This is the override edit constructor\r
290 * \r
291 * @param inProtocolsIdentification\r
292 * @param iFrame\r
293 * \r
294 */\r
295 public PpisDlg(PpisIdentification inPpisIdentification, IFrame iFrame) {\r
296 super(iFrame, true);\r
297 init(inPpisIdentification);\r
06a19cee 298 }\r
299\r
a929458e 300 /**\r
301 * This method initializes jContentPane\r
302 * \r
303 * @return javax.swing.JPanel jContentPane\r
304 * \r
305 */\r
306 private JPanel getJContentPane() {\r
307 if (jContentPane == null) {\r
308 jStarLabel1 = new StarLabel();\r
3f62225f 309 jStarLabel1.setLocation(new java.awt.Point(2, 12));\r
a929458e 310 jLabelPpiType = new JLabel();\r
3f62225f 311 jLabelPpiType.setBounds(new java.awt.Rectangle(12, 12, 168, 20));\r
a929458e 312 jLabelPpiType.setText("Select Ppi Type");\r
313\r
314 jStarLabel2 = new StarLabel();\r
3f62225f 315 jStarLabel2.setLocation(new java.awt.Point(2, 37));\r
a929458e 316 jLabelC_Name = new JLabel();\r
317 jLabelC_Name.setText("PPI GUID C Name");\r
3f62225f 318 jLabelC_Name.setBounds(new java.awt.Rectangle(12, 37, 168, 20));\r
a929458e 319\r
320 jStarLabel3 = new StarLabel();\r
3f62225f 321 jStarLabel3.setLocation(new java.awt.Point(2, 62));\r
a929458e 322 jLabelUsage = new JLabel();\r
323 jLabelUsage.setText("Usage");\r
3f62225f 324 jLabelUsage.setBounds(new java.awt.Rectangle(12, 62, 168, 20));\r
a929458e 325\r
326 jLabelHelpText = new JLabel();\r
3f62225f 327 jLabelHelpText.setBounds(new java.awt.Rectangle(14, 87, 168, 20));\r
a929458e 328 jLabelHelpText.setText("Help Text");\r
329\r
330 jLabelFeatureFlag = new JLabel();\r
331 jLabelFeatureFlag.setText("Feature Flag Expression");\r
3f62225f 332 jLabelFeatureFlag.setBounds(new java.awt.Rectangle(12, 132, 168, 20));\r
a929458e 333\r
334 jLabelArch = new JLabel();\r
3f62225f 335 jLabelArch.setBounds(new java.awt.Rectangle(12, 157, 168, 20));\r
a929458e 336 jLabelArch.setText("Supported Architectures");\r
337 jArchCheckBox = new ArchCheckBox();\r
3f62225f 338 jArchCheckBox.setBounds(new java.awt.Rectangle(168, 157, 320, 20));\r
a929458e 339 jArchCheckBox.setPreferredSize(new java.awt.Dimension(320, 20));\r
340\r
341 jContentPane = new JPanel();\r
342 jContentPane.setLayout(null);\r
3f62225f 343 jContentPane.setPreferredSize(new java.awt.Dimension(485, 215));\r
a929458e 344\r
345 jContentPane.add(jStarLabel1, null);\r
346 jContentPane.add(jLabelPpiType, null);\r
347 jContentPane.add(getJComboBoxPpiType(), null);\r
348 jContentPane.add(jStarLabel2, null);\r
349 jContentPane.add(jLabelC_Name, null);\r
350 jContentPane.add(getJComboBoxCName(), null);\r
351 jContentPane.add(jStarLabel3, null);\r
352 jContentPane.add(jLabelUsage, null);\r
353 jContentPane.add(getJComboBoxUsage(), null);\r
354 jContentPane.add(jLabelHelpText, null);\r
355 jContentPane.add(getJScrollPaneHelpText(), null);\r
356 jContentPane.add(jLabelFeatureFlag, null);\r
357 jContentPane.add(getJTextFieldFeatureFlag(), null);\r
358 jContentPane.add(jLabelArch, null);\r
359 jContentPane.add(jArchCheckBox, null);\r
360 jContentPane.add(getJButtonOk(), null);\r
361 jContentPane.add(getJButtonCancel(), null);\r
362 }\r
363 return jContentPane;\r
06a19cee 364 }\r
365\r
a929458e 366 /**\r
367 * This method initializes Usage type\r
368 * \r
369 */\r
370 private void initFrame() {\r
371 Tools.generateComboBoxByVector(jComboBoxCName, wt.getAllPpiDeclarationsFromWorkspace());\r
372 Tools.generateComboBoxByVector(jComboBoxPpiType, ed.getVPpiType());\r
373 Tools.generateComboBoxByVector(jComboBoxUsage, ed.getVPpiUsage());\r
06a19cee 374 }\r
375\r
a929458e 376 /*\r
377 * (non-Javadoc)\r
378 * \r
379 * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)\r
380 * \r
381 * Override actionPerformed to listen all actions\r
382 * \r
383 */\r
384 public void actionPerformed(ActionEvent arg0) {\r
385 if (arg0.getSource() == jButtonOk) {\r
386 if (checkAdd()) {\r
387 getCurrentPpis();\r
388 this.returnType = DataType.RETURN_TYPE_OK;\r
389 this.setVisible(false);\r
390 }\r
391 }\r
392\r
393 if (arg0.getSource() == jButtonCancel) {\r
394 this.returnType = DataType.RETURN_TYPE_CANCEL;\r
395 this.setVisible(false);\r
396 }\r
06a19cee 397 }\r
398\r
a929458e 399 /**\r
400 * Data validation for all fields\r
401 * \r
402 * @retval true - All datas are valid\r
403 * @retval false - At least one data is invalid\r
404 * \r
405 */\r
406 public boolean checkAdd() {\r
407 //\r
408 // Check if all fields have correct data types\r
409 //\r
410\r
411 //\r
412 // Check Name\r
413 //\r
414 if (!isEmpty(this.jComboBoxCName.getSelectedItem().toString())) {\r
415 if (!DataValidation.isC_NameType(this.jComboBoxCName.getSelectedItem().toString())) {\r
416 Log.wrn("Update Ppis", "Incorrect data type for Ppi/PpiNotify Name");\r
417 return false;\r
418 }\r
419 }\r
420\r
421 //\r
422 // Check FeatureFlag\r
423 //\r
424 if (!isEmpty(this.jTextFieldFeatureFlag.getText())) {\r
425 if (!DataValidation.isFeatureFlag(this.jTextFieldFeatureFlag.getText())) {\r
426 Log.wrn("Update Ppis", "Incorrect data type for Feature Flag");\r
427 return false;\r
428 }\r
429 }\r
430\r
431 return true;\r
432 }\r
5101eff9 433\r
a929458e 434 private PpisIdentification getCurrentPpis() {\r
06a19cee 435 String arg0 = this.jComboBoxCName.getSelectedItem().toString();\r
436 String arg1 = this.jComboBoxPpiType.getSelectedItem().toString();\r
437 String arg2 = this.jComboBoxUsage.getSelectedItem().toString();\r
438\r
439 String arg3 = this.jTextFieldFeatureFlag.getText();\r
440 Vector<String> arg4 = this.jArchCheckBox.getSelectedItemsVector();\r
5101eff9 441 String arg5 = this.jTextAreaHelpText.getText();\r
06a19cee 442\r
443 id = new PpisIdentification(arg0, arg1, arg2, arg3, arg4, arg5);\r
444 return id;\r
a929458e 445 } /*\r
446 * (non-Javadoc)\r
447 * \r
448 * @see java.awt.event.ItemListener#itemStateChanged(java.awt.event.ItemEvent)\r
449 * \r
450 * Reflesh the frame when selected item changed\r
451 * \r
452 */\r
453\r
454 public void itemStateChanged(ItemEvent arg0) {\r
455 if (arg0.getSource() == this.jComboBoxPpiType && arg0.getStateChange() == ItemEvent.SELECTED) {\r
456 if (this.jComboBoxPpiType.getSelectedItem().toString().equals(ed.getVPpiType().get(0))) {\r
457 Tools.generateComboBoxByVector(this.jComboBoxUsage, ed.getVPpiUsage());\r
458 } else {\r
459 Tools.generateComboBoxByVector(this.jComboBoxUsage, ed.getVPpiNotifyUsage());\r
460 }\r
461 }\r
06a19cee 462 }\r
463\r
a929458e 464 public PpisIdentification getId() {\r
465 return id;\r
466 }\r
06a19cee 467\r
a929458e 468 public void setId(PpisIdentification id) {\r
469 this.id = id;\r
470 }\r
06a19cee 471}\r