]>
Commit | Line | Data |
---|---|---|
06a19cee | 1 | /** @file\r |
2 | \r | |
18916b63 | 3 | The file is used to create, update Package Dependencies 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 | |
15 | package org.tianocore.frameworkwizard.module.ui.dialog;\r | |
16 | \r | |
17 | import java.awt.event.ActionEvent;\r | |
18 | import java.awt.event.ItemEvent;\r | |
19 | import java.awt.event.ItemListener;\r | |
20 | import java.util.Vector;\r | |
21 | \r | |
22 | import javax.swing.JButton;\r | |
23 | import javax.swing.JComboBox;\r | |
24 | import javax.swing.JLabel;\r | |
25 | import javax.swing.JPanel;\r | |
26 | import javax.swing.JScrollPane;\r | |
27 | import javax.swing.JTextField;\r | |
28 | \r | |
29 | import org.tianocore.frameworkwizard.common.DataType;\r | |
30 | import org.tianocore.frameworkwizard.common.DataValidation;\r | |
31 | import org.tianocore.frameworkwizard.common.Log;\r | |
32 | import org.tianocore.frameworkwizard.common.ui.ArchCheckBox;\r | |
33 | import org.tianocore.frameworkwizard.common.ui.IDialog;\r | |
34 | import org.tianocore.frameworkwizard.common.ui.IFrame;\r | |
35 | import org.tianocore.frameworkwizard.common.ui.StarLabel;\r | |
e08433ef | 36 | import org.tianocore.frameworkwizard.module.Identifications.ModuleIdentification;\r |
06a19cee | 37 | import org.tianocore.frameworkwizard.module.Identifications.PackageDependencies.PackageDependenciesIdentification;\r |
38 | import org.tianocore.frameworkwizard.packaging.PackageIdentification;\r | |
39 | import org.tianocore.frameworkwizard.workspace.WorkspaceTools;\r | |
40 | \r | |
41 | /**\r | |
18916b63 | 42 | * The class is used to create, update Package Dependencies section of the MSA file\r |
ccb063b1 | 43 | * \r |
9e857952 | 44 | * It extends IDialog\r |
ccb063b1 | 45 | * \r |
46 | */\r | |
06a19cee | 47 | public 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 | |
18916b63 | 103 | jComboBoxPackageName.setBounds(new java.awt.Rectangle(168, 12, 320, 20));\r |
a929458e | 104 | jComboBoxPackageName.setPreferredSize(new java.awt.Dimension(320, 20));\r |
623db5ca | 105 | jComboBoxPackageName.setToolTipText("If your Module requires a package, list that here.");\r |
a929458e | 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 | |
18916b63 | 119 | jTextFieldPackageGuid.setBounds(new java.awt.Rectangle(168, 37, 320, 20));\r |
06a19cee | 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 | |
18916b63 | 135 | jTextFieldPackageVersion.setBounds(new java.awt.Rectangle(168, 37, 320, 20));\r |
06a19cee | 136 | jTextFieldPackageVersion.setPreferredSize(new java.awt.Dimension(320, 20));\r |
137 | jTextFieldPackageVersion\r | |
9e857952 | 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 | |
21b42c66 | 155 | jTextFieldFeatureFlag.setBounds(new java.awt.Rectangle(168, 87, 320, 20));\r |
06a19cee | 156 | jTextFieldFeatureFlag.setPreferredSize(new java.awt.Dimension(320, 20));\r |
21b42c66 | 157 | jTextFieldFeatureFlag.setEnabled(false);\r |
06a19cee | 158 | }\r |
159 | return jTextFieldFeatureFlag;\r | |
160 | }\r | |
161 | \r | |
162 | /**\r | |
ccb063b1 | 163 | * This method initializes jScrollPane\r |
164 | * \r | |
165 | * @return javax.swing.JScrollPane\r | |
06a19cee | 166 | */\r |
167 | private JScrollPane getJScrollPane() {\r | |
168 | if (jScrollPane == null) {\r | |
169 | jScrollPane = new JScrollPane();\r | |
170 | jScrollPane.setViewportView(getJContentPane());\r | |
171 | }\r | |
172 | return jScrollPane;\r | |
173 | }\r | |
174 | \r | |
175 | /**\r | |
ccb063b1 | 176 | * This method initializes jButtonOk\r |
177 | * \r | |
178 | * @return javax.swing.JButton\r | |
179 | * \r | |
180 | */\r | |
06a19cee | 181 | private JButton getJButtonOk() {\r |
182 | if (jButtonOk == null) {\r | |
183 | jButtonOk = new JButton();\r | |
18916b63 | 184 | jButtonOk.setBounds(new java.awt.Rectangle(290, 122, 90, 20));\r |
06a19cee | 185 | jButtonOk.setText("Ok");\r |
186 | jButtonOk.addActionListener(this);\r | |
187 | }\r | |
188 | return jButtonOk;\r | |
189 | }\r | |
190 | \r | |
191 | /**\r | |
ccb063b1 | 192 | * This method initializes jButtonCancel\r |
193 | * \r | |
194 | * @return javax.swing.JButton\r | |
195 | * \r | |
196 | */\r | |
06a19cee | 197 | private JButton getJButtonCancel() {\r |
198 | if (jButtonCancel == null) {\r | |
199 | jButtonCancel = new JButton();\r | |
18916b63 | 200 | jButtonCancel.setBounds(new java.awt.Rectangle(390, 122, 90, 20));\r |
06a19cee | 201 | jButtonCancel.setText("Cancel");\r |
202 | jButtonCancel.addActionListener(this);\r | |
203 | }\r | |
204 | return jButtonCancel;\r | |
205 | }\r | |
206 | \r | |
207 | public static void main(String[] args) {\r | |
208 | \r | |
209 | }\r | |
210 | \r | |
211 | /**\r | |
ccb063b1 | 212 | * This method initializes this\r |
213 | * \r | |
214 | */\r | |
06a19cee | 215 | private void init() {\r |
18916b63 | 216 | this.setSize(505, 216);\r |
06a19cee | 217 | this.setContentPane(getJScrollPane());\r |
218 | this.setTitle("Package Dependencies");\r | |
219 | initFrame();\r | |
220 | this.setViewMode(false);\r | |
221 | this.centerWindow();\r | |
222 | }\r | |
223 | \r | |
224 | /**\r | |
ccb063b1 | 225 | * This method initializes this\r |
226 | * \r | |
227 | */\r | |
e08433ef | 228 | private void init(PackageDependenciesIdentification inPackageDependenciesIdentification, ModuleIdentification mid) {\r |
06a19cee | 229 | init();\r |
230 | this.pdid = inPackageDependenciesIdentification;\r | |
e08433ef | 231 | \r |
232 | //\r | |
233 | // Init arch with module's arch\r | |
234 | //\r | |
235 | this.jArchCheckBox.setEnabledItems(wt.getModuleArch(mid));\r | |
236 | \r | |
06a19cee | 237 | if (pdid != null) {\r |
238 | this.jComboBoxPackageName.setSelectedItem(pdid.getName());\r | |
239 | this.jTextFieldPackageVersion.setText(pdid.getVersion());\r | |
240 | this.jTextFieldPackageGuid.setText(pdid.getGuid());\r | |
241 | jTextFieldFeatureFlag.setText(pdid.getFeatureFlag());\r | |
242 | this.jArchCheckBox.setSelectedItems(pdid.getSupArchList());\r | |
243 | }\r | |
244 | }\r | |
245 | \r | |
246 | /**\r | |
ccb063b1 | 247 | * This is the default constructor\r |
248 | * \r | |
249 | */\r | |
e08433ef | 250 | public PackageDepDlg(PackageDependenciesIdentification inPackageDependenciesIdentification, IFrame iFrame, ModuleIdentification mid) {\r |
06a19cee | 251 | super(iFrame, true);\r |
e08433ef | 252 | init(inPackageDependenciesIdentification, mid);\r |
06a19cee | 253 | }\r |
254 | \r | |
255 | /**\r | |
ccb063b1 | 256 | * Disable all components when the mode is view\r |
257 | * \r | |
258 | * @param isView\r | |
259 | * true - The view mode; false - The non-view mode\r | |
260 | * \r | |
261 | */\r | |
06a19cee | 262 | public void setViewMode(boolean isView) {\r |
263 | if (isView) {\r | |
264 | this.jComboBoxPackageName.setEnabled(!isView);\r | |
265 | }\r | |
266 | }\r | |
267 | \r | |
268 | /**\r | |
ccb063b1 | 269 | * This method initializes jContentPane\r |
270 | * \r | |
271 | * @return javax.swing.JPanel jContentPane\r | |
272 | * \r | |
273 | */\r | |
06a19cee | 274 | private JPanel getJContentPane() {\r |
275 | if (jContentPane == null) {\r | |
a929458e | 276 | jStarLabel1 = new StarLabel();\r |
18916b63 | 277 | jStarLabel1.setLocation(new java.awt.Point(2, 12));\r |
a929458e | 278 | jLabelPackageName = new JLabel();\r |
18916b63 | 279 | jLabelPackageName.setBounds(new java.awt.Rectangle(12, 12, 168, 20));\r |
a929458e | 280 | jLabelPackageName.setText("Package Name");\r |
281 | \r | |
282 | jLabelPackageVersion = new JLabel();\r | |
18916b63 | 283 | jLabelPackageVersion.setBounds(new java.awt.Rectangle(12, 37, 168, 20));\r |
a929458e | 284 | jLabelPackageVersion.setText("Package Version");\r |
285 | \r | |
286 | jLabelPackageGuid = new JLabel();\r | |
18916b63 | 287 | jLabelPackageGuid.setBounds(new java.awt.Rectangle(12, 37, 168, 20));\r |
a929458e | 288 | jLabelPackageGuid.setText("Package Guid");\r |
289 | jLabelPackageGuid.setVisible(false);\r | |
290 | \r | |
291 | jLabelFeatureFlag = new JLabel();\r | |
21b42c66 | 292 | jLabelFeatureFlag.setBounds(new java.awt.Rectangle(12, 87, 168, 20));\r |
a929458e | 293 | jLabelFeatureFlag.setText("Feature Flag Expression");\r |
21b42c66 | 294 | jLabelFeatureFlag.setEnabled(false);\r |
a929458e | 295 | \r |
296 | jLabelArch = new JLabel();\r | |
21b42c66 | 297 | jLabelArch.setBounds(new java.awt.Rectangle(12, 62, 168, 20));\r |
a929458e | 298 | jLabelArch.setText("Supported Architectures");\r |
299 | jArchCheckBox = new ArchCheckBox();\r | |
21b42c66 | 300 | jArchCheckBox.setBounds(new java.awt.Rectangle(168, 62, 320, 20));\r |
a929458e | 301 | jArchCheckBox.setPreferredSize(new java.awt.Dimension(320, 20));\r |
06a19cee | 302 | \r |
303 | jContentPane = new JPanel();\r | |
304 | jContentPane.setLayout(null);\r | |
18916b63 | 305 | jContentPane.setPreferredSize(new java.awt.Dimension(485, 170));\r |
a929458e | 306 | \r |
06a19cee | 307 | jContentPane.add(jStarLabel1, null);\r |
ccb063b1 | 308 | jContentPane.add(jLabelPackageName, null);\r |
06a19cee | 309 | jContentPane.add(getJComboBoxPackageName(), null);\r |
310 | jContentPane.add(jLabelPackageGuid, null);\r | |
311 | jContentPane.add(getJTextFieldPackageGuid(), null);\r | |
06a19cee | 312 | jContentPane.add(jLabelPackageVersion, null);\r |
313 | jContentPane.add(getJTextFieldPackageVersion(), null);\r | |
ccb063b1 | 314 | // LAH Not Used here\r |
315 | // jContentPane.add(getJButtonGenerateGuid(), null);\r | |
06a19cee | 316 | jContentPane.add(jLabelFeatureFlag, null);\r |
317 | jContentPane.add(getJTextFieldFeatureFlag(), null);\r | |
06a19cee | 318 | jContentPane.add(jLabelArch, null);\r |
319 | jContentPane.add(jArchCheckBox, null);\r | |
320 | jContentPane.add(getJButtonOk(), null);\r | |
321 | jContentPane.add(getJButtonCancel(), null);\r | |
322 | }\r | |
323 | return jContentPane;\r | |
324 | }\r | |
325 | \r | |
ccb063b1 | 326 | /*\r |
327 | * (non-Javadoc)\r | |
328 | * \r | |
06a19cee | 329 | * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)\r |
ccb063b1 | 330 | * \r |
06a19cee | 331 | * Override actionPerformed to listen all actions\r |
332 | * \r | |
333 | */\r | |
334 | public void actionPerformed(ActionEvent arg0) {\r | |
335 | if (arg0.getSource() == jButtonOk) {\r | |
336 | if (checkAdd()) {\r | |
337 | getCurrentPackageDependencies();\r | |
338 | this.returnType = DataType.RETURN_TYPE_OK;\r | |
339 | this.setVisible(false);\r | |
340 | }\r | |
341 | }\r | |
342 | \r | |
343 | if (arg0.getSource() == jButtonCancel) {\r | |
344 | this.returnType = DataType.RETURN_TYPE_CANCEL;\r | |
345 | this.setVisible(false);\r | |
346 | }\r | |
347 | }\r | |
348 | \r | |
349 | /**\r | |
ccb063b1 | 350 | * This method initializes Usage type, Package type and Arch type\r |
351 | * \r | |
352 | */\r | |
06a19cee | 353 | private void initFrame() {\r |
354 | for (int index = 0; index < vPackage.size(); index++) {\r | |
355 | jComboBoxPackageName.addItem(vPackage.elementAt(index).getName());\r | |
356 | }\r | |
357 | }\r | |
358 | \r | |
359 | /**\r | |
ccb063b1 | 360 | * Data validation for all fields before add current item to Vector\r |
361 | * \r | |
362 | * @retval true - All datas are valid\r | |
363 | * @retval false - At least one data is invalid\r | |
364 | * \r | |
365 | */\r | |
06a19cee | 366 | public boolean checkAdd() {\r |
367 | //\r | |
ccb063b1 | 368 | // Check if all fields have correct data types\r |
06a19cee | 369 | //\r |
370 | \r | |
371 | //\r | |
ccb063b1 | 372 | // Check PackageGuid\r |
06a19cee | 373 | //\r |
a929458e | 374 | // if (!isEmpty(this.jTextFieldPackageGuid.getText())) {\r |
375 | // if (!DataValidation.isGuid(this.jTextFieldPackageGuid.getText())) {\r | |
376 | // Log.err("Incorrect data type for Package Guid");\r | |
377 | // return false;\r | |
378 | // }\r | |
379 | // }\r | |
06a19cee | 380 | \r |
381 | //\r | |
ccb063b1 | 382 | // Check PackageVersion\r |
06a19cee | 383 | //\r |
384 | if (!isEmpty(this.jTextFieldPackageVersion.getText())) {\r | |
385 | if (!DataValidation.isVersion(this.jTextFieldPackageVersion.getText())) {\r | |
ed1665f2 | 386 | Log.wrn("Update Package Dependencies", "Incorrect data type for Package Version");\r |
06a19cee | 387 | return false;\r |
388 | }\r | |
389 | }\r | |
390 | \r | |
391 | //\r | |
392 | // Check FeatureFlag\r | |
393 | //\r | |
394 | if (!isEmpty(this.jTextFieldFeatureFlag.getText())) {\r | |
395 | if (!DataValidation.isFeatureFlag(this.jTextFieldFeatureFlag.getText())) {\r | |
ed1665f2 | 396 | Log.wrn("Update Package Dependencies", "Incorrect data type for Feature Flag");\r |
06a19cee | 397 | return false;\r |
398 | }\r | |
399 | }\r | |
400 | \r | |
401 | return true;\r | |
402 | }\r | |
06a19cee | 403 | \r |
404 | private PackageDependenciesIdentification getCurrentPackageDependencies() {\r | |
405 | String arg0 = this.jComboBoxPackageName.getSelectedItem().toString();\r | |
406 | String arg1 = this.jTextFieldPackageVersion.getText();\r | |
407 | String arg2 = this.jTextFieldPackageGuid.getText();\r | |
408 | \r | |
409 | String arg3 = this.jTextFieldFeatureFlag.getText();\r | |
410 | Vector<String> arg4 = this.jArchCheckBox.getSelectedItemsVector();\r | |
411 | pdid = new PackageDependenciesIdentification(arg0, arg1, arg2, arg3, arg4);\r | |
412 | return pdid;\r | |
413 | }\r | |
414 | \r | |
ccb063b1 | 415 | /*\r |
416 | * (non-Javadoc)\r | |
417 | * \r | |
06a19cee | 418 | * @see java.awt.event.ItemListener#itemStateChanged(java.awt.event.ItemEvent)\r |
ccb063b1 | 419 | * \r |
06a19cee | 420 | * Reflesh the frame when selected item changed\r |
421 | * \r | |
422 | */\r | |
423 | public void itemStateChanged(ItemEvent arg0) {\r | |
424 | if (arg0.getSource() == this.jComboBoxPackageName && arg0.getStateChange() == ItemEvent.SELECTED) {\r | |
425 | for (int index = 0; index < vPackage.size(); index++) {\r | |
426 | if (this.jComboBoxPackageName.getSelectedItem().toString().equals(vPackage.get(index).getName())) {\r | |
427 | this.jTextFieldPackageGuid.setText(vPackage.get(index).getGuid());\r | |
428 | }\r | |
429 | }\r | |
430 | }\r | |
431 | }\r | |
432 | \r | |
433 | public PackageDependenciesIdentification getPdid() {\r | |
434 | return pdid;\r | |
435 | }\r | |
436 | \r | |
437 | public void setPdid(PackageDependenciesIdentification pdid) {\r | |
438 | this.pdid = pdid;\r | |
439 | }\r | |
440 | \r | |
441 | }\r |