]> git.proxmox.com Git - mirror_edk2.git/blame - Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/PpisDlg.java
Fixed grammar in messages.
[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
21b42c66 166 jTextFieldFeatureFlag.setBounds(new java.awt.Rectangle(168, 157, 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
21b42c66 169 jTextFieldFeatureFlag.setEnabled(false);\r
a929458e 170 }\r
171 return jTextFieldFeatureFlag;\r
06a19cee 172 }\r
a929458e 173\r
174 /**\r
175 * This method initializes jScrollPane\r
176 * \r
177 * @return javax.swing.JScrollPane\r
178 */\r
179 private JScrollPane getJScrollPane() {\r
180 if (jScrollPane == null) {\r
181 jScrollPane = new JScrollPane();\r
182 jScrollPane.setViewportView(getJContentPane());\r
183 }\r
184 return jScrollPane;\r
06a19cee 185 }\r
a929458e 186\r
187 /**\r
188 * This method initializes jTextAreaHelpText\r
189 * \r
190 * @return javax.swing.JTextArea\r
191 * \r
192 */\r
193 private JTextArea getJTextAreaHelpText() {\r
194 if (jTextAreaHelpText == null) {\r
195 jTextAreaHelpText = new JTextArea();\r
196 jTextAreaHelpText.setLineWrap(true);\r
197 jTextAreaHelpText.setWrapStyleWord(true);\r
198 }\r
199 return jTextAreaHelpText;\r
06a19cee 200 }\r
a929458e 201\r
202 /**\r
203 * This method initializes jScrollPaneHelpText\r
204 * \r
205 * @return javax.swing.JScrollPane\r
206 * \r
207 */\r
208 private JScrollPane getJScrollPaneHelpText() {\r
209 if (jScrollPaneHelpText == null) {\r
210 jScrollPaneHelpText = new JScrollPane();\r
211 jScrollPaneHelpText.setHorizontalScrollBarPolicy(javax.swing.JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);\r
212 jScrollPaneHelpText.setSize(new java.awt.Dimension(320, 40));\r
213 jScrollPaneHelpText.setPreferredSize(new java.awt.Dimension(320, 40));\r
3f62225f 214 jScrollPaneHelpText.setLocation(new java.awt.Point(168, 87));\r
a929458e 215 jScrollPaneHelpText.setViewportView(getJTextAreaHelpText());\r
216 }\r
217 return jScrollPaneHelpText;\r
06a19cee 218 }\r
a929458e 219\r
220 /**\r
221 * This method initializes jButtonOk\r
222 * \r
223 * @return javax.swing.JButton\r
224 * \r
225 */\r
226 private JButton getJButtonOk() {\r
227 if (jButtonOk == null) {\r
228 jButtonOk = new JButton();\r
3f62225f 229 jButtonOk.setBounds(new java.awt.Rectangle(290, 187, 90, 20));\r
a929458e 230 jButtonOk.setText("Ok");\r
231 jButtonOk.addActionListener(this);\r
232 }\r
233 return jButtonOk;\r
06a19cee 234 }\r
a929458e 235\r
236 /**\r
237 * This method initializes jButtonCancel\r
238 * \r
239 * @return javax.swing.JButton\r
240 * \r
241 */\r
242 private JButton getJButtonCancel() {\r
243 if (jButtonCancel == null) {\r
244 jButtonCancel = new JButton();\r
3f62225f 245 jButtonCancel.setBounds(new java.awt.Rectangle(390, 187, 90, 20));\r
a929458e 246 jButtonCancel.setText("Cancel");\r
247 jButtonCancel.addActionListener(this);\r
248 }\r
249 return jButtonCancel;\r
5101eff9 250 }\r
a929458e 251\r
252 public static void main(String[] args) {\r
253\r
5101eff9 254 }\r
a929458e 255\r
256 /**\r
257 * This method initializes this\r
258 * \r
259 */\r
260 private void init() {\r
3f62225f 261 this.setSize(505, 260);\r
a929458e 262 this.setContentPane(getJScrollPane());\r
263 this.setTitle("PPI Definitions");\r
264 initFrame();\r
265 this.centerWindow();\r
5101eff9 266 }\r
a929458e 267\r
268 /**\r
269 * This method initializes this Fill values to all fields if these values are\r
270 * not empty\r
271 * \r
272 * @param inProtocolsId\r
273 * \r
274 */\r
275 private void init(PpisIdentification inPpisId) {\r
276 init();\r
277 this.id = inPpisId;\r
278\r
279 if (this.id != null) {\r
280 this.jComboBoxCName.setSelectedItem(id.getName());\r
281 this.jComboBoxPpiType.setSelectedItem(id.getType());\r
282 this.jComboBoxUsage.setSelectedItem(id.getUsage());\r
283 this.jTextAreaHelpText.setText(id.getHelp());\r
284 this.jTextFieldFeatureFlag.setText(id.getFeatureFlag());\r
285 this.jArchCheckBox.setSelectedItems(id.getSupArchList());\r
286 }\r
5101eff9 287 }\r
a929458e 288\r
289 /**\r
290 * This is the override edit constructor\r
291 * \r
292 * @param inProtocolsIdentification\r
293 * @param iFrame\r
294 * \r
295 */\r
296 public PpisDlg(PpisIdentification inPpisIdentification, IFrame iFrame) {\r
297 super(iFrame, true);\r
298 init(inPpisIdentification);\r
06a19cee 299 }\r
300\r
a929458e 301 /**\r
302 * This method initializes jContentPane\r
303 * \r
304 * @return javax.swing.JPanel jContentPane\r
305 * \r
306 */\r
307 private JPanel getJContentPane() {\r
308 if (jContentPane == null) {\r
309 jStarLabel1 = new StarLabel();\r
3f62225f 310 jStarLabel1.setLocation(new java.awt.Point(2, 12));\r
a929458e 311 jLabelPpiType = new JLabel();\r
3f62225f 312 jLabelPpiType.setBounds(new java.awt.Rectangle(12, 12, 168, 20));\r
a929458e 313 jLabelPpiType.setText("Select Ppi Type");\r
314\r
315 jStarLabel2 = new StarLabel();\r
3f62225f 316 jStarLabel2.setLocation(new java.awt.Point(2, 37));\r
a929458e 317 jLabelC_Name = new JLabel();\r
318 jLabelC_Name.setText("PPI GUID C Name");\r
3f62225f 319 jLabelC_Name.setBounds(new java.awt.Rectangle(12, 37, 168, 20));\r
a929458e 320\r
321 jStarLabel3 = new StarLabel();\r
3f62225f 322 jStarLabel3.setLocation(new java.awt.Point(2, 62));\r
a929458e 323 jLabelUsage = new JLabel();\r
324 jLabelUsage.setText("Usage");\r
3f62225f 325 jLabelUsage.setBounds(new java.awt.Rectangle(12, 62, 168, 20));\r
a929458e 326\r
327 jLabelHelpText = new JLabel();\r
3f62225f 328 jLabelHelpText.setBounds(new java.awt.Rectangle(14, 87, 168, 20));\r
a929458e 329 jLabelHelpText.setText("Help Text");\r
330\r
331 jLabelFeatureFlag = new JLabel();\r
332 jLabelFeatureFlag.setText("Feature Flag Expression");\r
21b42c66 333 jLabelFeatureFlag.setBounds(new java.awt.Rectangle(12, 157, 168, 20));\r
334 jLabelFeatureFlag.setEnabled(false);\r
a929458e 335\r
336 jLabelArch = new JLabel();\r
21b42c66 337 jLabelArch.setBounds(new java.awt.Rectangle(12, 132, 168, 20));\r
a929458e 338 jLabelArch.setText("Supported Architectures");\r
339 jArchCheckBox = new ArchCheckBox();\r
21b42c66 340 jArchCheckBox.setBounds(new java.awt.Rectangle(168, 132, 320, 20));\r
a929458e 341 jArchCheckBox.setPreferredSize(new java.awt.Dimension(320, 20));\r
342\r
343 jContentPane = new JPanel();\r
344 jContentPane.setLayout(null);\r
3f62225f 345 jContentPane.setPreferredSize(new java.awt.Dimension(485, 215));\r
a929458e 346\r
347 jContentPane.add(jStarLabel1, null);\r
348 jContentPane.add(jLabelPpiType, null);\r
349 jContentPane.add(getJComboBoxPpiType(), null);\r
350 jContentPane.add(jStarLabel2, null);\r
351 jContentPane.add(jLabelC_Name, null);\r
352 jContentPane.add(getJComboBoxCName(), null);\r
353 jContentPane.add(jStarLabel3, null);\r
354 jContentPane.add(jLabelUsage, null);\r
355 jContentPane.add(getJComboBoxUsage(), null);\r
356 jContentPane.add(jLabelHelpText, null);\r
357 jContentPane.add(getJScrollPaneHelpText(), null);\r
358 jContentPane.add(jLabelFeatureFlag, null);\r
359 jContentPane.add(getJTextFieldFeatureFlag(), null);\r
360 jContentPane.add(jLabelArch, null);\r
361 jContentPane.add(jArchCheckBox, null);\r
362 jContentPane.add(getJButtonOk(), null);\r
363 jContentPane.add(getJButtonCancel(), null);\r
364 }\r
365 return jContentPane;\r
06a19cee 366 }\r
367\r
a929458e 368 /**\r
369 * This method initializes Usage type\r
370 * \r
371 */\r
372 private void initFrame() {\r
373 Tools.generateComboBoxByVector(jComboBoxCName, wt.getAllPpiDeclarationsFromWorkspace());\r
374 Tools.generateComboBoxByVector(jComboBoxPpiType, ed.getVPpiType());\r
375 Tools.generateComboBoxByVector(jComboBoxUsage, ed.getVPpiUsage());\r
06a19cee 376 }\r
377\r
a929458e 378 /*\r
379 * (non-Javadoc)\r
380 * \r
381 * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)\r
382 * \r
383 * Override actionPerformed to listen all actions\r
384 * \r
385 */\r
386 public void actionPerformed(ActionEvent arg0) {\r
387 if (arg0.getSource() == jButtonOk) {\r
388 if (checkAdd()) {\r
389 getCurrentPpis();\r
390 this.returnType = DataType.RETURN_TYPE_OK;\r
391 this.setVisible(false);\r
392 }\r
393 }\r
394\r
395 if (arg0.getSource() == jButtonCancel) {\r
396 this.returnType = DataType.RETURN_TYPE_CANCEL;\r
397 this.setVisible(false);\r
398 }\r
06a19cee 399 }\r
400\r
a929458e 401 /**\r
402 * Data validation for all fields\r
403 * \r
404 * @retval true - All datas are valid\r
405 * @retval false - At least one data is invalid\r
406 * \r
407 */\r
408 public boolean checkAdd() {\r
409 //\r
410 // Check if all fields have correct data types\r
411 //\r
412\r
413 //\r
414 // Check Name\r
415 //\r
416 if (!isEmpty(this.jComboBoxCName.getSelectedItem().toString())) {\r
417 if (!DataValidation.isC_NameType(this.jComboBoxCName.getSelectedItem().toString())) {\r
418 Log.wrn("Update Ppis", "Incorrect data type for Ppi/PpiNotify Name");\r
419 return false;\r
420 }\r
421 }\r
422\r
423 //\r
424 // Check FeatureFlag\r
425 //\r
426 if (!isEmpty(this.jTextFieldFeatureFlag.getText())) {\r
427 if (!DataValidation.isFeatureFlag(this.jTextFieldFeatureFlag.getText())) {\r
428 Log.wrn("Update Ppis", "Incorrect data type for Feature Flag");\r
429 return false;\r
430 }\r
431 }\r
432\r
433 return true;\r
434 }\r
5101eff9 435\r
a929458e 436 private PpisIdentification getCurrentPpis() {\r
06a19cee 437 String arg0 = this.jComboBoxCName.getSelectedItem().toString();\r
438 String arg1 = this.jComboBoxPpiType.getSelectedItem().toString();\r
439 String arg2 = this.jComboBoxUsage.getSelectedItem().toString();\r
440\r
441 String arg3 = this.jTextFieldFeatureFlag.getText();\r
442 Vector<String> arg4 = this.jArchCheckBox.getSelectedItemsVector();\r
5101eff9 443 String arg5 = this.jTextAreaHelpText.getText();\r
06a19cee 444\r
445 id = new PpisIdentification(arg0, arg1, arg2, arg3, arg4, arg5);\r
446 return id;\r
a929458e 447 } /*\r
448 * (non-Javadoc)\r
449 * \r
450 * @see java.awt.event.ItemListener#itemStateChanged(java.awt.event.ItemEvent)\r
451 * \r
452 * Reflesh the frame when selected item changed\r
453 * \r
454 */\r
455\r
456 public void itemStateChanged(ItemEvent arg0) {\r
457 if (arg0.getSource() == this.jComboBoxPpiType && arg0.getStateChange() == ItemEvent.SELECTED) {\r
458 if (this.jComboBoxPpiType.getSelectedItem().toString().equals(ed.getVPpiType().get(0))) {\r
459 Tools.generateComboBoxByVector(this.jComboBoxUsage, ed.getVPpiUsage());\r
460 } else {\r
461 Tools.generateComboBoxByVector(this.jComboBoxUsage, ed.getVPpiNotifyUsage());\r
462 }\r
463 }\r
06a19cee 464 }\r
465\r
a929458e 466 public PpisIdentification getId() {\r
467 return id;\r
468 }\r
06a19cee 469\r
a929458e 470 public void setId(PpisIdentification id) {\r
471 this.id = id;\r
472 }\r
06a19cee 473}\r