]> git.proxmox.com Git - mirror_edk2.git/blame - Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/HiiPackagesDlg.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 / HiiPackagesDlg.java
CommitLineData
06a19cee 1/** @file\r
2 \r
9e857952 3 The file is used to create, update Hii Packages 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.util.Vector;\r
19\r
20import javax.swing.JButton;\r
21import javax.swing.JComboBox;\r
22import javax.swing.JLabel;\r
23import javax.swing.JPanel;\r
24import javax.swing.JScrollPane;\r
25import javax.swing.JTextField;\r
5b38b75b 26import javax.swing.JTextArea;\r
06a19cee 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.module.Identifications.HiiPackages.HiiPackagesIdentification;\r
38\r
39/**\r
5b38b75b 40 * The class is used to create, update Hii Packages of the MSA file\r
41 * \r
42 * It extends IDialog\r
43 * \r
44 */\r
45public class HiiPackagesDlg extends IDialog {\r
06a19cee 46\r
a929458e 47 // /\r
48 // / Define class Serial Version UID\r
49 // /\r
50 private static final long serialVersionUID = -6851574146786158116L;\r
06a19cee 51\r
a929458e 52 //\r
53 // Define class members\r
54 //\r
55 private JPanel jContentPane = null;\r
06a19cee 56\r
a929458e 57 private JLabel jLabelName = null;\r
06a19cee 58\r
a929458e 59 private JTextField jTextFieldName = null;\r
06a19cee 60\r
a929458e 61 private JLabel jLabelUsage = null;\r
06a19cee 62\r
a929458e 63 private JComboBox jComboBoxUsage = null;\r
06a19cee 64\r
a929458e 65 private StarLabel jStarLabel1 = null;\r
06a19cee 66\r
a929458e 67 private StarLabel jStarLabel2 = null;\r
06a19cee 68\r
a929458e 69 private JLabel jLabelFeatureFlag = null;\r
06a19cee 70\r
a929458e 71 private JTextField jTextFieldFeatureFlag = null;\r
06a19cee 72\r
a929458e 73 private JLabel jLabelArch = null;\r
06a19cee 74\r
a929458e 75 private JScrollPane jScrollPane = 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 jScrollPaneHelpText = null;\r
06a19cee 82\r
a929458e 83 private ArchCheckBox jArchCheckBox = null;\r
06a19cee 84\r
a929458e 85 private JButton jButtonOk = null;\r
06a19cee 86\r
a929458e 87 private JButton jButtonCancel = null;\r
06a19cee 88\r
a929458e 89 //\r
90 // Not used by UI\r
91 //\r
92 private HiiPackagesIdentification id = null;\r
93\r
94 private EnumerationData ed = new EnumerationData();\r
95\r
96 /**\r
97 * \r
98 * This method initializes jTextFieldName\r
99 * \r
100 * @return javax.swing.JTextField jTextFieldName\r
101 * \r
102 */\r
103 private JTextField getJTextFieldName() {\r
104 if (jTextFieldName == null) {\r
105 jTextFieldName = new JTextField();\r
3f62225f 106 jTextFieldName.setBounds(new java.awt.Rectangle(168, 12, 320, 20));\r
a929458e 107 jTextFieldName.setPreferredSize(new java.awt.Dimension(320, 20));\r
108 jTextFieldName.setToolTipText("Enter the C Name of the HII Package");\r
109 }\r
110 return jTextFieldName;\r
111 }\r
06a19cee 112\r
a929458e 113 /**\r
114 * \r
115 * This method initializes jComboBoxUsage\r
116 * \r
117 * @return javax.swing.JComboBox jComboBoxUsage\r
118 * \r
119 */\r
120 private JComboBox getJComboBoxUsage() {\r
121 if (jComboBoxUsage == null) {\r
122 jComboBoxUsage = new JComboBox();\r
3f62225f 123 jComboBoxUsage.setBounds(new java.awt.Rectangle(168, 37, 320, 20));\r
a929458e 124 jComboBoxUsage.setPreferredSize(new java.awt.Dimension(320, 20));\r
125 jComboBoxUsage\r
126 .setToolTipText("<html><table>"\r
127 + "<tr><td>ALWAYS_PRODUCED</td><td>Hii is always registered</td></tr>"\r
128 + "<tr><td>SOMETIMES_PRODUCED</td><td>Some executions paths will require the Hii to be registered</td></tr>"\r
129 + "</table></html>");\r
130 }\r
131 return jComboBoxUsage;\r
06a19cee 132 }\r
a929458e 133\r
134 /**\r
135 * \r
136 * This method initializes jTextFieldFeatureFlag\r
137 * \r
138 * @return javax.swing.JTextField\r
139 */\r
140 private JTextField getJTextFieldFeatureFlag() {\r
141 if (jTextFieldFeatureFlag == null) {\r
142 jTextFieldFeatureFlag = new JTextField();\r
3f62225f 143 jTextFieldFeatureFlag.setBounds(new java.awt.Rectangle(168, 107, 320, 20));\r
a929458e 144 jTextFieldFeatureFlag.setPreferredSize(new java.awt.Dimension(320, 20));\r
145 jTextFieldFeatureFlag.setToolTipText("Postfix expression that must evaluate to TRUE or FALSE");\r
146 }\r
147 return jTextFieldFeatureFlag;\r
06a19cee 148 }\r
a929458e 149\r
150 /**\r
151 * \r
152 * This method initializes jScrollPane\r
153 * \r
154 * @return javax.swing.JScrollPane\r
155 * \r
156 */\r
157 private JScrollPane getJScrollPane() {\r
158 if (jScrollPane == null) {\r
159 jScrollPane = new JScrollPane();\r
160 jScrollPane.setViewportView(getJContentPane());\r
161 }\r
162 return jScrollPane;\r
06a19cee 163 }\r
a929458e 164\r
165 /**\r
166 * \r
167 * This method initializes jTextAreaHelpText\r
168 * \r
169 * @return javax.swing.JTextArea jTextAreaHelpText\r
170 * \r
171 */\r
172 private JTextArea getJTextAreaHelpText() {\r
173 if (jTextAreaHelpText == null) {\r
174 jTextAreaHelpText = new JTextArea();\r
175 jTextAreaHelpText.setLineWrap(true);\r
176 jTextAreaHelpText.setWrapStyleWord(true);\r
177 }\r
178 return jTextAreaHelpText;\r
06a19cee 179 }\r
a929458e 180\r
181 /**\r
182 * \r
183 * This method initializes jScrollPaneHelpText\r
184 * \r
185 * @return javax.swing.JScrollPane\r
186 * \r
187 */\r
188 private JScrollPane getJScrollPaneHelpText() {\r
189 if (jScrollPaneHelpText == null) {\r
190 jScrollPaneHelpText = new JScrollPane();\r
191 jScrollPaneHelpText.setHorizontalScrollBarPolicy(javax.swing.JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);\r
192 jScrollPaneHelpText.setSize(new java.awt.Dimension(320, 40));\r
193 jScrollPaneHelpText.setPreferredSize(new java.awt.Dimension(320, 40));\r
3f62225f 194 jScrollPaneHelpText.setLocation(new java.awt.Point(168, 62));\r
a929458e 195 jScrollPaneHelpText.setViewportView(getJTextAreaHelpText());\r
196 }\r
197 return jScrollPaneHelpText;\r
06a19cee 198 }\r
a929458e 199\r
200 /**\r
201 * \r
202 * This method initializes jButtonOk\r
203 * \r
204 * @return javax.swing.JButton\r
205 * \r
206 */\r
207 private JButton getJButtonOk() {\r
208 if (jButtonOk == null) {\r
209 jButtonOk = new JButton();\r
3f62225f 210 jButtonOk.setBounds(new java.awt.Rectangle(290, 162, 90, 20));\r
a929458e 211 jButtonOk.setText("Ok");\r
212 jButtonOk.addActionListener(this);\r
213 }\r
214 return jButtonOk;\r
06a19cee 215 }\r
a929458e 216\r
217 /**\r
218 *\r
219 * This method initializes jButtonCancel\r
220 * \r
221 * @return javax.swing.JButton\r
222 * \r
223 **/\r
224 private JButton getJButtonCancel() {\r
225 if (jButtonCancel == null) {\r
226 jButtonCancel = new JButton();\r
3f62225f 227 jButtonCancel.setBounds(new java.awt.Rectangle(390, 162, 90, 20));\r
a929458e 228 jButtonCancel.setText("Cancel");\r
229 jButtonCancel.addActionListener(this);\r
230 }\r
231 return jButtonCancel;\r
06a19cee 232 }\r
a929458e 233\r
234 public static void main(String[] args) {\r
235\r
06a19cee 236 }\r
a929458e 237\r
238 /**\r
239 * \r
240 * This method initializes this\r
241 * \r
242 **/\r
243 private void init() {\r
3f62225f 244 this.setSize(505, 235);\r
a929458e 245 this.setContentPane(getJScrollPane());\r
246 this.setTitle("Hii Packages");\r
247 initFrame();\r
248 this.setViewMode(false);\r
249 this.centerWindow();\r
06a19cee 250 }\r
a929458e 251\r
252 /**\r
253 * This method initializes this Fill values to all fields if these values are\r
254 * not empty\r
255 * \r
256 * @param inHiiPackagesId\r
257 * \r
258 **/\r
259 private void init(HiiPackagesIdentification inHiiPackagesId) {\r
260 init();\r
261 this.id = inHiiPackagesId;\r
262\r
263 if (this.id != null) {\r
264 this.jTextFieldName.setText(id.getName());\r
265 this.jComboBoxUsage.setSelectedItem(id.getUsage());\r
266 this.jTextAreaHelpText.setText(id.getHelp());\r
267 this.jTextFieldFeatureFlag.setText(id.getFeatureFlag());\r
268 this.jArchCheckBox.setSelectedItems(id.getSupArchList());\r
269 }\r
06a19cee 270 }\r
a929458e 271\r
272 /**\r
273 * This is the override edit constructor\r
274 * \r
275 * @param inHiiPackagesIdentification\r
276 * @param iFrame\r
277 * \r
278 **/\r
279 public HiiPackagesDlg(HiiPackagesIdentification inHiiPackagesIdentification, IFrame iFrame) {\r
280 super(iFrame, true);\r
281 init(inHiiPackagesIdentification);\r
5b38b75b 282 }\r
a929458e 283\r
284 /**\r
285 * \r
286 * Disable all components when the mode is view\r
287 * \r
288 * @param isView\r
289 * true - The view mode; false - The non-view mode\r
290 * \r
291 **/\r
292 public void setViewMode(boolean isView) {\r
293 if (isView) {\r
294 this.jTextFieldName.setEnabled(!isView);\r
295 this.jComboBoxUsage.setEnabled(!isView);\r
296 }\r
06a19cee 297 }\r
298\r
a929458e 299 /**\r
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 jLabelName = new JLabel();\r
311 jLabelName.setText("Hii Package C Name");\r
3f62225f 312 jLabelName.setBounds(new java.awt.Rectangle(12, 12, 155, 20));\r
a929458e 313 jStarLabel2 = new StarLabel();\r
3f62225f 314 jStarLabel2.setLocation(new java.awt.Point(2, 37));\r
a929458e 315 jLabelUsage = new JLabel();\r
316 jLabelUsage.setText("Usage");\r
3f62225f 317 jLabelUsage.setBounds(new java.awt.Rectangle(12, 37, 155, 20));\r
a929458e 318 jLabelHelpText = new JLabel();\r
3f62225f 319 jLabelHelpText.setBounds(new java.awt.Rectangle(12, 62, 155, 20));\r
a929458e 320 jLabelHelpText.setText("Help Text");\r
321 jLabelFeatureFlag = new JLabel();\r
3f62225f 322 jLabelFeatureFlag.setBounds(new java.awt.Rectangle(12, 107, 155, 20));\r
a929458e 323 jLabelFeatureFlag.setText("Feature Flag Expression");\r
324 jLabelArch = new JLabel();\r
3f62225f 325 jLabelArch.setBounds(new java.awt.Rectangle(12, 132, 155, 20));\r
a929458e 326 jLabelArch.setText("Supported Architectures");\r
327 jArchCheckBox = new ArchCheckBox();\r
3f62225f 328 jArchCheckBox.setBounds(new java.awt.Rectangle(168, 132, 320, 20));\r
a929458e 329 jArchCheckBox.setPreferredSize(new java.awt.Dimension(320, 20));\r
330\r
331 jContentPane = new JPanel();\r
332 jContentPane.setLayout(null);\r
3f62225f 333 jContentPane.setPreferredSize(new java.awt.Dimension(480, 180));\r
a929458e 334\r
335 jContentPane.add(jStarLabel1, null);\r
336 jContentPane.add(jLabelName, null);\r
337 jContentPane.add(getJTextFieldName(), null);\r
338\r
339 jContentPane.add(jStarLabel2, null);\r
340 jContentPane.add(jLabelUsage, null);\r
341 jContentPane.add(getJComboBoxUsage(), null);\r
342\r
343 jContentPane.add(jLabelHelpText, null);\r
344 jContentPane.add(getJScrollPaneHelpText(), null);\r
345\r
346 jContentPane.add(jLabelFeatureFlag, null);\r
347 jContentPane.add(getJTextFieldFeatureFlag(), null);\r
348\r
349 jContentPane.add(jLabelArch, null);\r
350 jContentPane.add(jArchCheckBox, null);\r
351\r
352 jContentPane.add(getJButtonOk(), null);\r
353 jContentPane.add(getJButtonCancel(), null);\r
354 }\r
355 return jContentPane;\r
06a19cee 356 }\r
357\r
a929458e 358 /**\r
359 * \r
360 * This method initializes Usage type\r
361 * \r
362 */\r
363 private void initFrame() {\r
364 Tools.generateComboBoxByVector(jComboBoxUsage, ed.getVHiiPackageUsage());\r
06a19cee 365 }\r
366\r
a929458e 367 /*\r
368 * (non-Javadoc)\r
369 * \r
370 * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)\r
371 * \r
372 * Override actionPerformed to listen all actions\r
373 * \r
374 */\r
375 public void actionPerformed(ActionEvent arg0) {\r
376 if (arg0.getSource() == jButtonOk) {\r
377 if (checkAdd()) {\r
378 getCurrentHiiPackages();\r
379 this.returnType = DataType.RETURN_TYPE_OK;\r
380 this.setVisible(false);\r
381 }\r
382 }\r
383\r
384 if (arg0.getSource() == jButtonCancel) {\r
385 this.returnType = DataType.RETURN_TYPE_CANCEL;\r
386 this.setVisible(false);\r
387 }\r
06a19cee 388 }\r
389\r
a929458e 390 /**\r
391 * \r
392 * Data validation for all fields\r
393 * \r
394 * @retval true - All datas are valid\r
395 * @retval false - At least one data is invalid\r
396 * \r
397 */\r
398 public boolean checkAdd() {\r
399 //\r
400 // Check if all fields have correct data types\r
401 //\r
402\r
403 //\r
404 // Check Hii Package Name\r
405 //\r
406 if (isEmpty(this.jTextFieldName.getText())) {\r
407 Log.wrn("Update Hii Packages", "Hii Package Name Record must not be empty");\r
408 return false;\r
409 }\r
410\r
411 if (!isEmpty(this.jTextFieldName.getText())) {\r
412 if (!DataValidation.isC_NameType(this.jTextFieldName.getText())) {\r
413 Log.wrn("Update Hii Packages", "Incorrect data type for Hii Package Name");\r
414 return false;\r
415 }\r
416 }\r
417\r
418 //\r
419 // Check FeatureFlag\r
420 //\r
421 if (!isEmpty(this.jTextFieldFeatureFlag.getText())) {\r
422 if (!DataValidation.isFeatureFlag(this.jTextFieldFeatureFlag.getText())) {\r
423 Log.wrn("Update Hii Packages", "Incorrect data type for Feature Flag");\r
424 return false;\r
425 }\r
426 }\r
427\r
428 return true;\r
06a19cee 429 }\r
430\r
a929458e 431 private HiiPackagesIdentification getCurrentHiiPackages() {\r
432 String arg0 = this.jTextFieldName.getText();\r
433 String arg1 = this.jComboBoxUsage.getSelectedItem().toString();\r
06a19cee 434\r
a929458e 435 String arg2 = this.jTextFieldFeatureFlag.getText();\r
436 Vector<String> arg3 = this.jArchCheckBox.getSelectedItemsVector();\r
437 String arg4 = this.jTextAreaHelpText.getText();\r
06a19cee 438\r
a929458e 439 id = new HiiPackagesIdentification(arg0, arg1, arg2, arg3, arg4);\r
440 return id;\r
441 }\r
06a19cee 442\r
a929458e 443 public HiiPackagesIdentification getId() {\r
444 return id;\r
445 }\r
06a19cee 446\r
a929458e 447 public void setId(HiiPackagesIdentification id) {\r
448 this.id = id;\r
449 }\r
06a19cee 450}\r