]> git.proxmox.com Git - mirror_edk2.git/blame - Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/PackageDepDlg.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 / PackageDepDlg.java
CommitLineData
06a19cee 1/** @file\r
2 \r
3 The file is used to create, update Include 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.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
28\r
29import org.tianocore.frameworkwizard.common.DataType;\r
30import org.tianocore.frameworkwizard.common.DataValidation;\r
31import org.tianocore.frameworkwizard.common.Log;\r
32import org.tianocore.frameworkwizard.common.ui.ArchCheckBox;\r
33import org.tianocore.frameworkwizard.common.ui.IDialog;\r
34import org.tianocore.frameworkwizard.common.ui.IFrame;\r
35import org.tianocore.frameworkwizard.common.ui.StarLabel;\r
36import org.tianocore.frameworkwizard.module.Identifications.PackageDependencies.PackageDependenciesIdentification;\r
37import org.tianocore.frameworkwizard.packaging.PackageIdentification;\r
38import org.tianocore.frameworkwizard.workspace.WorkspaceTools;\r
39\r
40/**\r
ccb063b1 41 * The class is used to create, update Include of MSA/MBD file It extends\r
42 * IInternalFrame\r
43 * \r
44 * \r
45 * \r
46 */\r
06a19cee 47public class PackageDepDlg extends IDialog implements ItemListener {\r
a929458e 48 // /\r
49 // / Define class Serial Version UID\r
50 // /\r
51 private static final long serialVersionUID = 3465193035145152131L;\r
06a19cee 52\r
a929458e 53 //\r
54 // Define class members\r
55 //\r
56 private JPanel jContentPane = null;\r
06a19cee 57\r
a929458e 58 private JLabel jLabelPackageName = null;\r
06a19cee 59\r
a929458e 60 private StarLabel jStarLabel1 = null;\r
06a19cee 61\r
a929458e 62 private JComboBox jComboBoxPackageName = null;\r
06a19cee 63\r
a929458e 64 private JLabel jLabelPackageGuid = null;\r
06a19cee 65\r
a929458e 66 private JTextField jTextFieldPackageGuid = null;\r
06a19cee 67\r
a929458e 68 private JLabel jLabelPackageVersion = null;\r
06a19cee 69\r
a929458e 70 private JTextField jTextFieldPackageVersion = null;\r
06a19cee 71\r
a929458e 72 private JLabel jLabelFeatureFlag = null;\r
06a19cee 73\r
a929458e 74 private JTextField jTextFieldFeatureFlag = null;\r
06a19cee 75\r
a929458e 76 private JScrollPane jScrollPane = null;\r
06a19cee 77\r
a929458e 78 private JLabel jLabelArch = null;\r
06a19cee 79\r
a929458e 80 private ArchCheckBox jArchCheckBox = null;\r
06a19cee 81\r
a929458e 82 private JButton jButtonOk = null;\r
06a19cee 83\r
a929458e 84 private JButton jButtonCancel = null;\r
06a19cee 85\r
a929458e 86 //\r
87 // Not used by UI\r
88 //\r
89 private PackageDependenciesIdentification pdid = null;\r
06a19cee 90\r
a929458e 91 private WorkspaceTools wt = new WorkspaceTools();\r
06a19cee 92\r
a929458e 93 private Vector<PackageIdentification> vPackage = wt.getAllPackages();\r
06a19cee 94\r
a929458e 95 /**\r
96 * This method initializes jComboBoxPackageName\r
97 * \r
98 * @return javax.swing.JComboBox\r
99 */\r
06a19cee 100 private JComboBox getJComboBoxPackageName() {\r
a929458e 101 if (jComboBoxPackageName == null) {\r
102 jComboBoxPackageName = new JComboBox();\r
103 jComboBoxPackageName.setBounds(new java.awt.Rectangle(160, 10, 320, 20));\r
104 jComboBoxPackageName.setPreferredSize(new java.awt.Dimension(320, 20));\r
105 jComboBoxPackageName.setToolTipText("If your Module requires a package list that here.");\r
106 jComboBoxPackageName.addItemListener(this);\r
107 }\r
108 return jComboBoxPackageName;\r
06a19cee 109 }\r
110\r
111 /**\r
ccb063b1 112 * This method initializes jTextFieldPackageGuid\r
113 * \r
114 * @return javax.swing.JTextField\r
06a19cee 115 */\r
116 private JTextField getJTextFieldPackageGuid() {\r
117 if (jTextFieldPackageGuid == null) {\r
118 jTextFieldPackageGuid = new JTextField();\r
119 jTextFieldPackageGuid.setBounds(new java.awt.Rectangle(160, 35, 320, 20));\r
120 jTextFieldPackageGuid.setPreferredSize(new java.awt.Dimension(320, 20));\r
121 jTextFieldPackageGuid.setEditable(false);\r
122 jTextFieldPackageGuid.setVisible(false);\r
123 }\r
124 return jTextFieldPackageGuid;\r
125 }\r
126\r
06a19cee 127 /**\r
ccb063b1 128 * This method initializes jTextFieldPackageVersion\r
129 * \r
130 * @return javax.swing.JTextField\r
06a19cee 131 */\r
132 private JTextField getJTextFieldPackageVersion() {\r
133 if (jTextFieldPackageVersion == null) {\r
134 jTextFieldPackageVersion = new JTextField();\r
135 jTextFieldPackageVersion.setBounds(new java.awt.Rectangle(160, 35, 320, 20));\r
136 jTextFieldPackageVersion.setPreferredSize(new java.awt.Dimension(320, 20));\r
137 jTextFieldPackageVersion\r
a929458e 138 .setToolTipText("<html>If this module depends on a specific version of a package, <br>" +\r
139 "enter the package version here. <br>" +\r
140 "If the module can use the latest version <br>" +\r
141 "that does not break backward compatibility, <br>" +\r
142 "leave this field blank</html>");\r
06a19cee 143 }\r
144 return jTextFieldPackageVersion;\r
145 }\r
146\r
147 /**\r
ccb063b1 148 * This method initializes jTextFieldFeatureFlag\r
149 * \r
150 * @return javax.swing.JTextField\r
06a19cee 151 */\r
152 private JTextField getJTextFieldFeatureFlag() {\r
153 if (jTextFieldFeatureFlag == null) {\r
154 jTextFieldFeatureFlag = new JTextField();\r
155 jTextFieldFeatureFlag.setBounds(new java.awt.Rectangle(160, 60, 320, 20));\r
156 jTextFieldFeatureFlag.setPreferredSize(new java.awt.Dimension(320, 20));\r
157 }\r
158 return jTextFieldFeatureFlag;\r
159 }\r
160\r
161 /**\r
ccb063b1 162 * This method initializes jScrollPane\r
163 * \r
164 * @return javax.swing.JScrollPane\r
06a19cee 165 */\r
166 private JScrollPane getJScrollPane() {\r
167 if (jScrollPane == null) {\r
168 jScrollPane = new JScrollPane();\r
169 jScrollPane.setViewportView(getJContentPane());\r
170 }\r
171 return jScrollPane;\r
172 }\r
173\r
174 /**\r
ccb063b1 175 * This method initializes jButtonOk\r
176 * \r
177 * @return javax.swing.JButton\r
178 * \r
179 */\r
06a19cee 180 private JButton getJButtonOk() {\r
181 if (jButtonOk == null) {\r
182 jButtonOk = new JButton();\r
183 jButtonOk.setBounds(new java.awt.Rectangle(290, 115, 90, 20));\r
184 jButtonOk.setText("Ok");\r
185 jButtonOk.addActionListener(this);\r
186 }\r
187 return jButtonOk;\r
188 }\r
189\r
190 /**\r
ccb063b1 191 * This method initializes jButtonCancel\r
192 * \r
193 * @return javax.swing.JButton\r
194 * \r
195 */\r
06a19cee 196 private JButton getJButtonCancel() {\r
197 if (jButtonCancel == null) {\r
198 jButtonCancel = new JButton();\r
199 jButtonCancel.setBounds(new java.awt.Rectangle(390, 115, 90, 20));\r
200 jButtonCancel.setText("Cancel");\r
201 jButtonCancel.addActionListener(this);\r
202 }\r
203 return jButtonCancel;\r
204 }\r
205\r
206 public static void main(String[] args) {\r
207\r
208 }\r
209\r
210 /**\r
ccb063b1 211 * This method initializes this\r
212 * \r
213 */\r
06a19cee 214 private void init() {\r
f51ee52b 215 this.setSize(508, 188);\r
06a19cee 216 this.setContentPane(getJScrollPane());\r
217 this.setTitle("Package Dependencies");\r
218 initFrame();\r
219 this.setViewMode(false);\r
220 this.centerWindow();\r
221 }\r
222\r
223 /**\r
ccb063b1 224 * This method initializes this\r
225 * \r
226 */\r
06a19cee 227 private void init(PackageDependenciesIdentification inPackageDependenciesIdentification) {\r
228 init();\r
229 this.pdid = inPackageDependenciesIdentification;\r
230 if (pdid != null) {\r
231 this.jComboBoxPackageName.setSelectedItem(pdid.getName());\r
232 this.jTextFieldPackageVersion.setText(pdid.getVersion());\r
233 this.jTextFieldPackageGuid.setText(pdid.getGuid());\r
234 jTextFieldFeatureFlag.setText(pdid.getFeatureFlag());\r
235 this.jArchCheckBox.setSelectedItems(pdid.getSupArchList());\r
236 }\r
237 }\r
238\r
239 /**\r
ccb063b1 240 * This is the default constructor\r
241 * \r
242 */\r
06a19cee 243 public PackageDepDlg(PackageDependenciesIdentification inPackageDependenciesIdentification, IFrame iFrame) {\r
244 super(iFrame, true);\r
245 init(inPackageDependenciesIdentification);\r
246 }\r
247\r
248 /**\r
ccb063b1 249 * Disable all components when the mode is view\r
250 * \r
251 * @param isView\r
252 * true - The view mode; false - The non-view mode\r
253 * \r
254 */\r
06a19cee 255 public void setViewMode(boolean isView) {\r
256 if (isView) {\r
257 this.jComboBoxPackageName.setEnabled(!isView);\r
258 }\r
259 }\r
260\r
261 /**\r
ccb063b1 262 * This method initializes jContentPane\r
263 * \r
264 * @return javax.swing.JPanel jContentPane\r
265 * \r
266 */\r
06a19cee 267 private JPanel getJContentPane() {\r
268 if (jContentPane == null) {\r
a929458e 269 jStarLabel1 = new StarLabel();\r
270 jStarLabel1.setLocation(new java.awt.Point(2, 10));\r
271 jLabelPackageName = new JLabel();\r
272 jLabelPackageName.setBounds(new java.awt.Rectangle(15, 10, 145, 20));\r
273 jLabelPackageName.setText("Package Name");\r
274\r
275 jLabelPackageVersion = new JLabel();\r
276 jLabelPackageVersion.setBounds(new java.awt.Rectangle(15, 35, 145, 20));\r
277 jLabelPackageVersion.setText("Package Version");\r
278\r
279 jLabelPackageGuid = new JLabel();\r
280 jLabelPackageGuid.setBounds(new java.awt.Rectangle(15, 35, 145, 20));\r
281 jLabelPackageGuid.setText("Package Guid");\r
282 jLabelPackageGuid.setVisible(false);\r
283\r
284 jLabelFeatureFlag = new JLabel();\r
285 jLabelFeatureFlag.setBounds(new java.awt.Rectangle(15, 60, 145, 20));\r
286 jLabelFeatureFlag.setText("Feature Flag Expression");\r
287\r
288 jLabelArch = new JLabel();\r
289 jLabelArch.setBounds(new java.awt.Rectangle(15, 85, 145, 20));\r
290 jLabelArch.setText("Supported Architectures");\r
291 jArchCheckBox = new ArchCheckBox();\r
292 jArchCheckBox.setBounds(new java.awt.Rectangle(160, 85, 320, 20));\r
293 jArchCheckBox.setPreferredSize(new java.awt.Dimension(320, 20));\r
06a19cee 294\r
295 jContentPane = new JPanel();\r
296 jContentPane.setLayout(null);\r
ccb063b1 297 jContentPane.setPreferredSize(new java.awt.Dimension(485, 145));\r
a929458e 298\r
06a19cee 299 jContentPane.add(jStarLabel1, null);\r
ccb063b1 300 jContentPane.add(jLabelPackageName, null);\r
06a19cee 301 jContentPane.add(getJComboBoxPackageName(), null);\r
302 jContentPane.add(jLabelPackageGuid, null);\r
303 jContentPane.add(getJTextFieldPackageGuid(), null);\r
06a19cee 304 jContentPane.add(jLabelPackageVersion, null);\r
305 jContentPane.add(getJTextFieldPackageVersion(), null);\r
ccb063b1 306 // LAH Not Used here\r
307 // jContentPane.add(getJButtonGenerateGuid(), null);\r
06a19cee 308 jContentPane.add(jLabelFeatureFlag, null);\r
309 jContentPane.add(getJTextFieldFeatureFlag(), null);\r
06a19cee 310 jContentPane.add(jLabelArch, null);\r
311 jContentPane.add(jArchCheckBox, null);\r
312 jContentPane.add(getJButtonOk(), null);\r
313 jContentPane.add(getJButtonCancel(), null);\r
314 }\r
315 return jContentPane;\r
316 }\r
317\r
ccb063b1 318 /*\r
319 * (non-Javadoc)\r
320 * \r
06a19cee 321 * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)\r
ccb063b1 322 * \r
06a19cee 323 * Override actionPerformed to listen all actions\r
324 * \r
325 */\r
326 public void actionPerformed(ActionEvent arg0) {\r
327 if (arg0.getSource() == jButtonOk) {\r
328 if (checkAdd()) {\r
329 getCurrentPackageDependencies();\r
330 this.returnType = DataType.RETURN_TYPE_OK;\r
331 this.setVisible(false);\r
332 }\r
333 }\r
334\r
335 if (arg0.getSource() == jButtonCancel) {\r
336 this.returnType = DataType.RETURN_TYPE_CANCEL;\r
337 this.setVisible(false);\r
338 }\r
339 }\r
340\r
341 /**\r
ccb063b1 342 * This method initializes Usage type, Package type and Arch type\r
343 * \r
344 */\r
06a19cee 345 private void initFrame() {\r
346 for (int index = 0; index < vPackage.size(); index++) {\r
347 jComboBoxPackageName.addItem(vPackage.elementAt(index).getName());\r
348 }\r
349 }\r
350\r
351 /**\r
ccb063b1 352 * Data validation for all fields before add current item to Vector\r
353 * \r
354 * @retval true - All datas are valid\r
355 * @retval false - At least one data is invalid\r
356 * \r
357 */\r
06a19cee 358 public boolean checkAdd() {\r
359 //\r
ccb063b1 360 // Check if all fields have correct data types\r
06a19cee 361 //\r
362\r
363 //\r
ccb063b1 364 // Check PackageGuid\r
06a19cee 365 //\r
a929458e 366 // if (!isEmpty(this.jTextFieldPackageGuid.getText())) {\r
367 // if (!DataValidation.isGuid(this.jTextFieldPackageGuid.getText())) {\r
368 // Log.err("Incorrect data type for Package Guid");\r
369 // return false;\r
370 // }\r
371 // }\r
06a19cee 372\r
373 //\r
ccb063b1 374 // Check PackageVersion\r
06a19cee 375 //\r
376 if (!isEmpty(this.jTextFieldPackageVersion.getText())) {\r
377 if (!DataValidation.isVersion(this.jTextFieldPackageVersion.getText())) {\r
ed1665f2 378 Log.wrn("Update Package Dependencies", "Incorrect data type for Package Version");\r
06a19cee 379 return false;\r
380 }\r
381 }\r
382\r
383 //\r
384 // Check FeatureFlag\r
385 //\r
386 if (!isEmpty(this.jTextFieldFeatureFlag.getText())) {\r
387 if (!DataValidation.isFeatureFlag(this.jTextFieldFeatureFlag.getText())) {\r
ed1665f2 388 Log.wrn("Update Package Dependencies", "Incorrect data type for Feature Flag");\r
06a19cee 389 return false;\r
390 }\r
391 }\r
392\r
393 return true;\r
394 }\r
06a19cee 395\r
396 private PackageDependenciesIdentification getCurrentPackageDependencies() {\r
397 String arg0 = this.jComboBoxPackageName.getSelectedItem().toString();\r
398 String arg1 = this.jTextFieldPackageVersion.getText();\r
399 String arg2 = this.jTextFieldPackageGuid.getText();\r
400\r
401 String arg3 = this.jTextFieldFeatureFlag.getText();\r
402 Vector<String> arg4 = this.jArchCheckBox.getSelectedItemsVector();\r
403 pdid = new PackageDependenciesIdentification(arg0, arg1, arg2, arg3, arg4);\r
404 return pdid;\r
405 }\r
406\r
ccb063b1 407 /*\r
408 * (non-Javadoc)\r
409 * \r
06a19cee 410 * @see java.awt.event.ItemListener#itemStateChanged(java.awt.event.ItemEvent)\r
ccb063b1 411 * \r
06a19cee 412 * Reflesh the frame when selected item changed\r
413 * \r
414 */\r
415 public void itemStateChanged(ItemEvent arg0) {\r
416 if (arg0.getSource() == this.jComboBoxPackageName && arg0.getStateChange() == ItemEvent.SELECTED) {\r
417 for (int index = 0; index < vPackage.size(); index++) {\r
418 if (this.jComboBoxPackageName.getSelectedItem().toString().equals(vPackage.get(index).getName())) {\r
419 this.jTextFieldPackageGuid.setText(vPackage.get(index).getGuid());\r
420 }\r
421 }\r
422 }\r
423 }\r
424\r
425 public PackageDependenciesIdentification getPdid() {\r
426 return pdid;\r
427 }\r
428\r
429 public void setPdid(PackageDependenciesIdentification pdid) {\r
430 this.pdid = pdid;\r
431 }\r
432\r
433}\r