]> git.proxmox.com Git - mirror_edk2.git/blame - Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/SystemTablesDlg.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 / SystemTablesDlg.java
CommitLineData
06a19cee 1/** @file\r
5b38b75b 2 <<The file is used to create, update SystemTable in the MSA file>>\r
3 \r
4 <<This dialog is used to add or edit a System Table entry in the MSA file.>>\r
06a19cee 5 \r
6 Copyright (c) 2006, Intel Corporation\r
7 All rights reserved. This program and the accompanying materials\r
8 are licensed and made available under the terms and conditions of the BSD License\r
9 which accompanies this distribution. The full text of the license may be found at\r
10 http://opensource.org/licenses/bsd-license.php\r
11 \r
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
14 \r
15 **/\r
16package org.tianocore.frameworkwizard.module.ui.dialog;\r
17\r
18import java.awt.event.ActionEvent;\r
19import java.util.Vector;\r
20\r
21import javax.swing.JButton;\r
22import javax.swing.JComboBox;\r
23import javax.swing.JLabel;\r
24import javax.swing.JPanel;\r
25import javax.swing.JScrollPane;\r
26import javax.swing.JTextField;\r
5b38b75b 27import javax.swing.JTextArea;\r
06a19cee 28\r
29import org.tianocore.frameworkwizard.common.DataType;\r
30import org.tianocore.frameworkwizard.common.DataValidation;\r
31import org.tianocore.frameworkwizard.common.EnumerationData;\r
32import org.tianocore.frameworkwizard.common.Log;\r
33import org.tianocore.frameworkwizard.common.Tools;\r
34import org.tianocore.frameworkwizard.common.ui.ArchCheckBox;\r
35import org.tianocore.frameworkwizard.common.ui.IDialog;\r
36import org.tianocore.frameworkwizard.common.ui.IFrame;\r
37import org.tianocore.frameworkwizard.common.ui.StarLabel;\r
38import org.tianocore.frameworkwizard.module.Identifications.SystemTables.SystemTablesIdentification;\r
39import org.tianocore.frameworkwizard.workspace.WorkspaceTools;\r
40\r
41/**\r
5b38b75b 42 * The class is used to create, update SystemTable of MSA/MBD file It extends\r
43 * IInternalFrame\r
44 * \r
45 * \r
46 * \r
47 */\r
48public class SystemTablesDlg extends IDialog {\r
06a19cee 49\r
a929458e 50 // /\r
51 // / Define class Serial Version UID\r
52 // /\r
53 private static final long serialVersionUID = 7488769180379442276L;\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 jLabelEntry = null;\r
06a19cee 61\r
a929458e 62 private JLabel jLabelUsage = null;\r
06a19cee 63\r
a929458e 64 private JComboBox jComboBoxUsage = null;\r
06a19cee 65\r
a929458e 66 private StarLabel jStarLabel1 = null;\r
06a19cee 67\r
a929458e 68 private StarLabel jStarLabel2 = null;\r
06a19cee 69\r
a929458e 70 private JComboBox jComboBoxGuidC_Name = 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 JLabel jLabelArch = null;\r
06a19cee 77\r
a929458e 78 private JScrollPane jScrollPane = null;\r
06a19cee 79\r
a929458e 80 private JLabel jLabelHelpText = null;\r
06a19cee 81\r
a929458e 82 private JTextArea jTextAreaHelpText = null;\r
06a19cee 83\r
a929458e 84 private JScrollPane jScrollPaneHelpText = null;\r
06a19cee 85\r
a929458e 86 private ArchCheckBox jArchCheckBox = null;\r
06a19cee 87\r
a929458e 88 private JButton jButtonOk = null;\r
06a19cee 89\r
a929458e 90 private JButton jButtonCancel = null;\r
06a19cee 91\r
a929458e 92 //\r
93 // Not used by UI\r
94 //\r
95 private SystemTablesIdentification id = null;\r
96\r
97 private EnumerationData ed = new EnumerationData();\r
98\r
99 private WorkspaceTools wt = new WorkspaceTools();\r
100\r
101 /**\r
102 * This method initializes jComboBoxGuidC_Name\r
103 * \r
104 * @return javax.swing.JComboBox jComboBoxGuidC_Name\r
105 * \r
106 */\r
107 private JComboBox getJComboBoxGuidC_Name() {\r
108 if (jComboBoxGuidC_Name == null) {\r
109 jComboBoxGuidC_Name = new JComboBox();\r
110 jComboBoxGuidC_Name.setBounds(new java.awt.Rectangle(160, 10, 320, 20));\r
111 jComboBoxGuidC_Name.setPreferredSize(new java.awt.Dimension(320, 20));\r
112 jComboBoxGuidC_Name.setToolTipText("Select the GUID C Name of the System Table");\r
113 }\r
114 return jComboBoxGuidC_Name;\r
115 }\r
06a19cee 116\r
a929458e 117 /**\r
118 * This method initializes jComboBoxUsage\r
119 * \r
120 * @return javax.swing.JComboBox jComboBoxUsage\r
121 * \r
122 */\r
123 private JComboBox getJComboBoxUsage() {\r
124 if (jComboBoxUsage == null) {\r
125 jComboBoxUsage = new JComboBox();\r
126 jComboBoxUsage.setBounds(new java.awt.Rectangle(160, 35, 320, 20));\r
127 jComboBoxUsage.setPreferredSize(new java.awt.Dimension(320, 20));\r
128 jComboBoxUsage\r
129 .setToolTipText("<html><table>"\r
130 + "<tr><td>ALWAYS_CONSUMED</td><td>Module requires a GUIDed entry in the system table</td></tr>"\r
131 + "<tr><td>SOMETIMES_CONSUMED</td><td>Module consumes a GUIDed entry in the system<br>table if it is present</td>"\r
132 + "</tr><tr><td>ALWAYS_PRODUCED</td><td>Module always produces a GUIDed entry in the system table</td></tr>"\r
133 + "<tr><td>SOMETIMES_PRODUCED</td><td>Module produces a GUIDed entry in the system table<br>for some of its execution flows.</td></tr>"\r
134 + "</table></html>");\r
135 }\r
136 return jComboBoxUsage;\r
137 }\r
06a19cee 138\r
a929458e 139 /**\r
140 * This method initializes jTextFieldFeatureFlag\r
141 * \r
142 * @return javax.swing.JTextField\r
143 */\r
144 private JTextField getJTextFieldFeatureFlag() {\r
145 if (jTextFieldFeatureFlag == null) {\r
146 jTextFieldFeatureFlag = new JTextField();\r
147 jTextFieldFeatureFlag.setBounds(new java.awt.Rectangle(160, 105, 320, 20));\r
148 jTextFieldFeatureFlag.setPreferredSize(new java.awt.Dimension(320, 20));\r
149 jTextFieldFeatureFlag.setToolTipText("Postfix expression that must evaluate to TRUE or FALSE");\r
150 }\r
151 return jTextFieldFeatureFlag;\r
06a19cee 152 }\r
a929458e 153\r
154 /**\r
155 * This method initializes jScrollPane\r
156 * \r
157 * @return javax.swing.JScrollPane\r
158 */\r
159 private JScrollPane getJScrollPane() {\r
160 if (jScrollPane == null) {\r
161 jScrollPane = new JScrollPane();\r
162 jScrollPane.setViewportView(getJContentPane());\r
163 }\r
164 return jScrollPane;\r
06a19cee 165 }\r
a929458e 166\r
167 /**\r
168 * This method initializes jTextAreaHelpText\r
169 * \r
170 * @return javax.swing.JTextArea\r
171 * \r
172 */\r
173 private JTextArea getJTextAreaHelpText() {\r
174 if (jTextAreaHelpText == null) {\r
175 jTextAreaHelpText = new JTextArea();\r
176 jTextAreaHelpText.setLineWrap(true);\r
177 jTextAreaHelpText.setWrapStyleWord(true);\r
178 }\r
179 return jTextAreaHelpText;\r
06a19cee 180 }\r
a929458e 181\r
182 /**\r
183 * This method initializes jScrollPaneHelpText\r
184 * \r
185 * @returns javax.swing.JScrollPane jScrollPaneHelpText\r
186 */\r
187 private JScrollPane getJScrollPaneHelpText() {\r
188 if (jScrollPaneHelpText == null) {\r
189 jScrollPaneHelpText = new JScrollPane();\r
190 jScrollPaneHelpText.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
195 }\r
196 return jScrollPaneHelpText;\r
06a19cee 197 }\r
a929458e 198\r
199 /**\r
200 * This method initializes jButtonOk\r
201 * \r
202 * @return javax.swing.JButton\r
203 * \r
204 */\r
205 private JButton getJButtonOk() {\r
206 if (jButtonOk == null) {\r
207 jButtonOk = new JButton();\r
208 jButtonOk.setBounds(new java.awt.Rectangle(290, 157, 90, 20));\r
209 jButtonOk.setText("Ok");\r
210 jButtonOk.addActionListener(this);\r
211 }\r
212 return jButtonOk;\r
06a19cee 213 }\r
a929458e 214\r
215 /**\r
216 * This method initializes jButtonCancel\r
217 * \r
218 * @return javax.swing.JButton\r
219 * \r
220 */\r
221 private JButton getJButtonCancel() {\r
222 if (jButtonCancel == null) {\r
223 jButtonCancel = new JButton();\r
224 jButtonCancel.setBounds(new java.awt.Rectangle(390, 157, 90, 20));\r
225 jButtonCancel.setText("Cancel");\r
226 jButtonCancel.addActionListener(this);\r
227 }\r
228 return jButtonCancel;\r
06a19cee 229 }\r
a929458e 230\r
231 public static void main(String[] args) {\r
232\r
06a19cee 233 }\r
a929458e 234\r
235 /**\r
236 * This method initializes this\r
237 * \r
238 */\r
239 private void init() {\r
240 this.setSize(500, 230);\r
241 this.setContentPane(getJScrollPane());\r
242 this.setTitle("System Tables");\r
243 initFrame();\r
244 this.setViewMode(false);\r
245 this.centerWindow();\r
06a19cee 246 }\r
a929458e 247\r
248 /**\r
249 * This method initializes this Fill values to all fields if these values are\r
250 * not empty\r
251 * \r
252 * @param inSystemTablesId\r
253 * \r
254 */\r
255 private void init(SystemTablesIdentification inSystemTablesId) {\r
256 init();\r
257 this.id = inSystemTablesId;\r
258\r
259 if (this.id != null) {\r
260 this.jComboBoxGuidC_Name.setSelectedItem(id.getName());\r
261 this.jComboBoxUsage.setSelectedItem(id.getUsage());\r
262 this.jTextAreaHelpText.setText(id.getHelp());\r
263 this.jTextFieldFeatureFlag.setText(id.getFeatureFlag());\r
264 this.jArchCheckBox.setSelectedItems(id.getSupArchList());\r
265 }\r
06a19cee 266 }\r
a929458e 267\r
268 /**\r
269 * This is the override edit constructor\r
270 * \r
271 * @param inBootModesIdentification\r
272 * @param iFrame\r
273 * \r
274 */\r
275 public SystemTablesDlg(SystemTablesIdentification inSystemTablesIdentification, IFrame iFrame) {\r
276 super(iFrame, true);\r
277 init(inSystemTablesIdentification);\r
06a19cee 278 }\r
a929458e 279\r
280 /**\r
281 * Disable all components when the mode is view\r
282 * \r
283 * @param isView\r
284 * true - The view mode; false - The non-view mode\r
285 * \r
286 */\r
287 public void setViewMode(boolean isView) {\r
288 if (isView) {\r
289 this.jComboBoxUsage.setEnabled(!isView);\r
290 }\r
06a19cee 291 }\r
a929458e 292\r
293 /**\r
294 * This method initializes jContentPane\r
295 * \r
296 * @return javax.swing.JPanel jContentPane\r
297 * \r
298 */\r
299 private JPanel getJContentPane() {\r
300 if (jContentPane == null) {\r
301 jStarLabel1 = new StarLabel();\r
302 jStarLabel1.setLocation(new java.awt.Point(2, 10));\r
303 jLabelEntry = new JLabel();\r
304 jLabelEntry.setText("Table's GUID C Name");\r
305 jLabelEntry.setBounds(new java.awt.Rectangle(15, 10, 145, 20));\r
306 jStarLabel2 = new StarLabel();\r
307 jStarLabel2.setLocation(new java.awt.Point(2, 35));\r
308 jLabelUsage = new JLabel();\r
309 jLabelUsage.setText("Usage");\r
310 jLabelUsage.setBounds(new java.awt.Rectangle(15, 35, 145, 20));\r
311 jLabelHelpText = new JLabel();\r
312 jLabelHelpText.setBounds(new java.awt.Rectangle(14, 60, 145, 20));\r
313 jLabelHelpText.setText("Help Text");\r
314 jLabelFeatureFlag = new JLabel();\r
315 jLabelFeatureFlag.setBounds(new java.awt.Rectangle(15, 105, 140, 20));\r
316 jLabelFeatureFlag.setText("Feature Flag Expression");\r
317 jLabelArch = new JLabel();\r
318 jLabelArch.setBounds(new java.awt.Rectangle(15, 130, 145, 20));\r
319 jLabelArch.setText("Supported Architectures");\r
320 jArchCheckBox = new ArchCheckBox();\r
321 jArchCheckBox.setBounds(new java.awt.Rectangle(160, 130, 320, 20));\r
322 jArchCheckBox.setPreferredSize(new java.awt.Dimension(320, 20));\r
323\r
324 jContentPane = new JPanel();\r
325 jContentPane.setLayout(null);\r
326 jContentPane.setPreferredSize(new java.awt.Dimension(485, 185));\r
327\r
328 jContentPane.add(jLabelEntry, null);\r
329 jContentPane.add(jLabelFeatureFlag, null);\r
330 jContentPane.add(getJTextFieldFeatureFlag(), null);\r
331 jContentPane.add(getJComboBoxGuidC_Name(), null);\r
332 jContentPane.add(jLabelArch, null);\r
333 jContentPane.add(jLabelUsage, null);\r
334 jContentPane.add(getJComboBoxUsage(), null);\r
335\r
336 jContentPane.add(jStarLabel1, null);\r
337 jContentPane.add(jStarLabel2, null);\r
338\r
339 jContentPane.add(jLabelHelpText, null);\r
340 jContentPane.add(getJScrollPaneHelpText(), null);\r
341 jContentPane.add(jArchCheckBox, null);\r
342 jContentPane.add(getJButtonOk(), null);\r
343 jContentPane.add(getJButtonCancel(), null);\r
344 }\r
345 return jContentPane;\r
06a19cee 346 }\r
347\r
a929458e 348 /**\r
349 * This method initializes Usage type\r
350 * \r
351 */\r
352 private void initFrame() {\r
353 Tools.generateComboBoxByVector(jComboBoxUsage, ed.getVSystemTableUsage());\r
354 Tools.generateComboBoxByVector(jComboBoxGuidC_Name, wt.getAllGuidDeclarationsFromWorkspace());\r
06a19cee 355 }\r
356\r
a929458e 357 /*\r
358 * (non-Javadoc)\r
359 * \r
360 * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)\r
361 * \r
362 * Override actionPerformed to listen all actions\r
363 * \r
364 */\r
365 public void actionPerformed(ActionEvent arg0) {\r
366 if (arg0.getSource() == jButtonOk) {\r
367 if (checkAdd()) {\r
368 getCurrentSystemTables();\r
369 this.returnType = DataType.RETURN_TYPE_OK;\r
370 this.setVisible(false);\r
371 }\r
372 }\r
373\r
374 if (arg0.getSource() == jButtonCancel) {\r
375 this.returnType = DataType.RETURN_TYPE_CANCEL;\r
376 this.setVisible(false);\r
377 }\r
06a19cee 378 }\r
379\r
a929458e 380 /**\r
381 * Data validation for all fields\r
382 * \r
383 * @retval true - All datas are valid\r
384 * @retval false - At least one data is invalid\r
385 * \r
386 */\r
387 public boolean checkAdd() {\r
388 //\r
389 // Check if all fields have correct data types\r
390 //\r
391\r
392 //\r
393 // Check FeatureFlag\r
394 //\r
395 if (!isEmpty(this.jTextFieldFeatureFlag.getText())) {\r
396 if (!DataValidation.isFeatureFlag(this.jTextFieldFeatureFlag.getText())) {\r
397 Log.wrn("Update System Tables", "Incorrect data type for Feature Flag");\r
398 return false;\r
399 }\r
400 }\r
401\r
402 return true;\r
403 }\r
06a19cee 404\r
a929458e 405 private SystemTablesIdentification getCurrentSystemTables() {\r
406 String arg0 = this.jComboBoxGuidC_Name.getSelectedItem().toString();\r
407 String arg1 = this.jComboBoxUsage.getSelectedItem().toString();\r
06a19cee 408\r
a929458e 409 String arg2 = this.jTextFieldFeatureFlag.getText();\r
410 Vector<String> arg3 = this.jArchCheckBox.getSelectedItemsVector();\r
411 String arg4 = this.jTextAreaHelpText.getText();\r
06a19cee 412\r
a929458e 413 id = new SystemTablesIdentification(arg0, arg1, arg2, arg3, arg4);\r
414 return id;\r
415 }\r
06a19cee 416\r
a929458e 417 public SystemTablesIdentification getId() {\r
418 return id;\r
419 }\r
5b38b75b 420\r
a929458e 421 public void setId(SystemTablesIdentification id) {\r
422 this.id = id;\r
423 }\r
06a19cee 424}\r