]> git.proxmox.com Git - mirror_edk2.git/blame - Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/HiiPackagesDlg.java
Fixed Absolute position of fields, Added ToolTipText and made HelpText a Scrolling...
[mirror_edk2.git] / Tools / Source / FrameworkWizard / src / org / tianocore / frameworkwizard / module / ui / dialog / HiiPackagesDlg.java
CommitLineData
06a19cee 1/** @file\r
2 \r
3 The file is used to create, update Formset 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
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
5b38b75b 47 // /\r
48 // / Define class Serial Version UID\r
49 // /\r
50 private static final long serialVersionUID = -6851574146786158116L;\r
06a19cee 51\r
5b38b75b 52 //\r
53 // Define class members\r
54 //\r
55 private JPanel jContentPane = null;\r
06a19cee 56\r
5b38b75b 57 private JLabel jLabelName = null;\r
06a19cee 58\r
5b38b75b 59 private JTextField jTextFieldName = null;\r
06a19cee 60\r
5b38b75b 61 private JLabel jLabelUsage = null;\r
06a19cee 62\r
5b38b75b 63 private JComboBox jComboBoxUsage = null;\r
06a19cee 64\r
5b38b75b 65 private StarLabel jStarLabel1 = null;\r
06a19cee 66\r
5b38b75b 67 private StarLabel jStarLabel2 = null;\r
06a19cee 68\r
5b38b75b 69 private JLabel jLabelFeatureFlag = null;\r
06a19cee 70\r
5b38b75b 71 private JTextField jTextFieldFeatureFlag = null;\r
06a19cee 72\r
5b38b75b 73 private JLabel jLabelArch = null;\r
06a19cee 74\r
5b38b75b 75 private JScrollPane jScrollPane = null;\r
06a19cee 76\r
5b38b75b 77 private JLabel jLabelHelpText = null;\r
06a19cee 78\r
5b38b75b 79 private JTextArea jTextAreaHelpText = null;\r
06a19cee 80\r
5b38b75b 81 private JScrollPane jScrollPaneHelpText = null;\r
06a19cee 82\r
5b38b75b 83 private ArchCheckBox jArchCheckBox = null;\r
06a19cee 84\r
5b38b75b 85 private JButton jButtonOk = null;\r
06a19cee 86\r
5b38b75b 87 private JButton jButtonCancel = null;\r
06a19cee 88\r
5b38b75b 89 //\r
90 // Not used by UI\r
91 //\r
92 private HiiPackagesIdentification id = null;\r
06a19cee 93\r
5b38b75b 94 private EnumerationData ed = new EnumerationData();\r
06a19cee 95\r
5b38b75b 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
106 jTextFieldName.setBounds(new java.awt.Rectangle(160, 10, 320, 20));\r
107 jTextFieldName.setPreferredSize(new java.awt.Dimension(320, 20));\r
108 jTextFieldName.setToolTipText("Enter the C Name of the HII Package");\r
06a19cee 109 }\r
5b38b75b 110 return jTextFieldName;\r
111 }\r
112\r
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
123 jComboBoxUsage.setBounds(new java.awt.Rectangle(160, 35, 320, 20));\r
124 jComboBoxUsage.setPreferredSize(new java.awt.Dimension(320, 20));\r
125 jComboBoxUsage\r
126 .setToolTipText("<html><table><tr><td>ALWAYS_PRODUCED</td><td>Hii is always registered</td></tr><tr><td>SOMETIMES_PRODUCED</td><td>Some executions paths will require the Hii to be registered</td></tr></table></html>");\r
06a19cee 127 }\r
5b38b75b 128 return jComboBoxUsage;\r
129 }\r
130\r
131 /**\r
132 * \r
133 * This method initializes jTextFieldFeatureFlag\r
134 * \r
135 * @return javax.swing.JTextField\r
136 */\r
137 private JTextField getJTextFieldFeatureFlag() {\r
138 if (jTextFieldFeatureFlag == null) {\r
139 jTextFieldFeatureFlag = new JTextField();\r
140 jTextFieldFeatureFlag.setBounds(new java.awt.Rectangle(160, 105, 320, 20));\r
141 jTextFieldFeatureFlag.setPreferredSize(new java.awt.Dimension(320, 20));\r
142 jTextFieldFeatureFlag\r
143 .setToolTipText("Postfix expression that must evaluate to TRUE or FALSE");\r
06a19cee 144 }\r
5b38b75b 145 return jTextFieldFeatureFlag;\r
146 }\r
147\r
148 /**\r
149 * \r
150 * This method initializes jScrollPane\r
151 * \r
152 * @return javax.swing.JScrollPane\r
153 * \r
154 */\r
155 private JScrollPane getJScrollPane() {\r
156 if (jScrollPane == null) {\r
157 jScrollPane = new JScrollPane();\r
158 jScrollPane.setViewportView(getJContentPane());\r
06a19cee 159 }\r
5b38b75b 160 return jScrollPane;\r
161 }\r
162\r
163 /**\r
164 * \r
165 * This method initializes jTextAreaHelpText\r
166 * \r
167 * @return javax.swing.JTextArea jTextAreaHelpText\r
168 * \r
169 */\r
170 private JTextArea getJTextAreaHelpText() {\r
171 if (jTextAreaHelpText == null) {\r
172 jTextAreaHelpText = new JTextArea();\r
173 jTextAreaHelpText.setLineWrap(true);\r
174 jTextAreaHelpText.setWrapStyleWord(true);\r
06a19cee 175 }\r
5b38b75b 176 return jTextAreaHelpText;\r
177 }\r
178\r
179 /**\r
180 * \r
181 * This method initializes jScrollPaneHelpText\r
182 * \r
183 * @return javax.swing.JScrollPane\r
184 * \r
185 */\r
186 private JScrollPane getJScrollPaneHelpText() {\r
187 if (jScrollPaneHelpText == null) {\r
188 jScrollPaneHelpText = new JScrollPane();\r
189 jScrollPaneHelpText\r
190 .setHorizontalScrollBarPolicy(javax.swing.JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);\r
191 jScrollPaneHelpText.setSize(new java.awt.Dimension(320, 40));\r
192 jScrollPaneHelpText.setPreferredSize(new java.awt.Dimension(320, 40));\r
193 jScrollPaneHelpText.setLocation(new java.awt.Point(160, 60));\r
194 jScrollPaneHelpText.setViewportView(getJTextAreaHelpText());\r
06a19cee 195 }\r
5b38b75b 196 return jScrollPaneHelpText;\r
197 }\r
198\r
199 /**\r
200 * \r
201 * This method initializes jButtonOk\r
202 * \r
203 * @return javax.swing.JButton\r
204 * \r
205 */\r
206 private JButton getJButtonOk() {\r
207 if (jButtonOk == null) {\r
208 jButtonOk = new JButton();\r
209 jButtonOk.setBounds(new java.awt.Rectangle(290, 157, 90, 20));\r
210 jButtonOk.setText("Ok");\r
211 jButtonOk.addActionListener(this);\r
06a19cee 212 }\r
5b38b75b 213 return jButtonOk;\r
214 }\r
215\r
216 /**\r
217 *\r
218 * This method initializes jButtonCancel\r
219 * \r
220 * @return javax.swing.JButton\r
221 * \r
222 **/\r
223 private JButton getJButtonCancel() {\r
224 if (jButtonCancel == null) {\r
225 jButtonCancel = new JButton();\r
226 jButtonCancel.setBounds(new java.awt.Rectangle(390, 157, 90, 20));\r
227 jButtonCancel.setText("Cancel");\r
228 jButtonCancel.addActionListener(this);\r
06a19cee 229 }\r
5b38b75b 230 return jButtonCancel;\r
231 }\r
232\r
233 public static void main(String[] args) {\r
234\r
235 }\r
236\r
237 /**\r
238 * \r
239 * This method initializes this\r
240 * \r
241 **/\r
242 private void init() {\r
243 this.setSize(500, 230);\r
244 this.setContentPane(getJScrollPane());\r
245 this.setTitle("Hii Packages");\r
246 initFrame();\r
247 this.setViewMode(false);\r
248 this.centerWindow();\r
249 }\r
250\r
251 /**\r
252 * This method initializes this Fill values to all fields if these values are\r
253 * not empty\r
254 * \r
255 * @param inHiiPackagesId\r
256 * \r
257 **/\r
258 private void init(HiiPackagesIdentification inHiiPackagesId) {\r
259 init();\r
260 this.id = inHiiPackagesId;\r
261\r
262 if (this.id != null) {\r
263 this.jTextFieldName.setText(id.getName());\r
264 this.jComboBoxUsage.setSelectedItem(id.getUsage());\r
265 this.jTextAreaHelpText.setText(id.getHelp());\r
266 this.jTextFieldFeatureFlag.setText(id.getFeatureFlag());\r
267 this.jArchCheckBox.setSelectedItems(id.getSupArchList());\r
06a19cee 268 }\r
5b38b75b 269 }\r
270\r
271 /**\r
272 * This is the override edit constructor\r
273 * \r
274 * @param inHiiPackagesIdentification\r
275 * @param iFrame\r
276 * \r
277 **/\r
278 public HiiPackagesDlg(HiiPackagesIdentification inHiiPackagesIdentification,\r
279 IFrame iFrame) {\r
280 super(iFrame, true);\r
281 init(inHiiPackagesIdentification);\r
282 }\r
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
06a19cee 296 }\r
5b38b75b 297 }\r
298\r
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
309 jStarLabel1.setLocation(new java.awt.Point(2, 10));\r
310 jLabelName = new JLabel();\r
311 jLabelName.setText("Hii Package C Name");\r
312 jLabelName.setBounds(new java.awt.Rectangle(15, 10, 145, 20));\r
313 jStarLabel2 = new StarLabel();\r
314 jStarLabel2.setLocation(new java.awt.Point(2, 35));\r
315 jLabelUsage = new JLabel();\r
316 jLabelUsage.setText("Usage");\r
317 jLabelUsage.setBounds(new java.awt.Rectangle(15, 35, 145, 20));\r
318 jLabelHelpText = new JLabel();\r
319 jLabelHelpText.setBounds(new java.awt.Rectangle(14, 60, 145, 20));\r
320 jLabelHelpText.setText("Help Text");\r
321 jLabelFeatureFlag = new JLabel();\r
322 jLabelFeatureFlag.setBounds(new java.awt.Rectangle(15, 105, 145, 20));\r
323 jLabelFeatureFlag.setText("Feature Flag Expression");\r
324 jLabelArch = new JLabel();\r
325 jLabelArch.setBounds(new java.awt.Rectangle(15, 130, 145, 20));\r
326 jLabelArch.setText("Supported Architectures");\r
327 jArchCheckBox = new ArchCheckBox();\r
328 jArchCheckBox.setBounds(new java.awt.Rectangle(160, 130, 320, 20));\r
329 jArchCheckBox.setPreferredSize(new java.awt.Dimension(320, 20));\r
330\r
331 jContentPane = new JPanel();\r
332 jContentPane.setLayout(null);\r
333 jContentPane.setPreferredSize(new java.awt.Dimension(485, 185));\r
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
356 }\r
357\r
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
365 }\r
366\r
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
06a19cee 382 }\r
383\r
5b38b75b 384 if (arg0.getSource() == jButtonCancel) {\r
385 this.returnType = DataType.RETURN_TYPE_CANCEL;\r
386 this.setVisible(false);\r
06a19cee 387 }\r
5b38b75b 388 }\r
389\r
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
06a19cee 402\r
5b38b75b 403 //\r
404 // Check Hii Package Name\r
405 //\r
406 if (isEmpty(this.jTextFieldName.getText())) {\r
407 Log.wrn("Update Hii Packages",\r
408 "Hii Package Name Record must not be empty");\r
409 return false;\r
06a19cee 410 }\r
411\r
5b38b75b 412 if (!isEmpty(this.jTextFieldName.getText())) {\r
413 if (!DataValidation.isC_NameType(this.jTextFieldName.getText())) {\r
414 Log.wrn("Update Hii Packages",\r
415 "Incorrect data type for Hii Package Name");\r
416 return false;\r
417 }\r
06a19cee 418 }\r
419\r
5b38b75b 420 //\r
421 // Check FeatureFlag\r
422 //\r
423 if (!isEmpty(this.jTextFieldFeatureFlag.getText())) {\r
424 if (!DataValidation.isFeatureFlag(this.jTextFieldFeatureFlag.getText())) {\r
425 Log.wrn("Update Hii Packages", "Incorrect data type for Feature Flag");\r
426 return false;\r
427 }\r
06a19cee 428 }\r
429\r
5b38b75b 430 return true;\r
431 }\r
06a19cee 432\r
5b38b75b 433 private HiiPackagesIdentification getCurrentHiiPackages() {\r
434 String arg0 = this.jTextFieldName.getText();\r
435 String arg1 = this.jComboBoxUsage.getSelectedItem().toString();\r
06a19cee 436\r
5b38b75b 437 String arg2 = this.jTextFieldFeatureFlag.getText();\r
438 Vector<String> arg3 = this.jArchCheckBox.getSelectedItemsVector();\r
439 String arg4 = this.jTextAreaHelpText.getText();\r
06a19cee 440\r
5b38b75b 441 id = new HiiPackagesIdentification(arg0, arg1, arg2, arg3, arg4);\r
442 return id;\r
443 }\r
444 \r
445 public HiiPackagesIdentification getId() {\r
446 return id;\r
447 }\r
06a19cee 448\r
5b38b75b 449 public void setId(HiiPackagesIdentification id) {\r
450 this.id = id;\r
451 }\r
06a19cee 452}\r