]> git.proxmox.com Git - mirror_edk2.git/blame - Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/ModulePCDs.java
Fixed grammar in messages.
[mirror_edk2.git] / Tools / Source / FrameworkWizard / src / org / tianocore / frameworkwizard / module / ui / ModulePCDs.java
CommitLineData
a13899c5 1/** @file\r
2 \r
3 The file is used to create, update PCD 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;\r
16\r
06a19cee 17import java.awt.Dimension;\r
a13899c5 18import java.awt.event.ActionEvent;\r
19import java.awt.event.ComponentEvent;\r
06a19cee 20import java.awt.event.MouseEvent;\r
a13899c5 21import java.util.Vector;\r
22\r
23import javax.swing.JButton;\r
a13899c5 24import javax.swing.JPanel;\r
25import javax.swing.JScrollPane;\r
06a19cee 26import javax.swing.JTable;\r
27import javax.swing.ListSelectionModel;\r
28import javax.swing.event.ListSelectionEvent;\r
a13899c5 29\r
30import org.tianocore.PcdCodedDocument;\r
31import org.tianocore.PcdItemTypes;\r
fd16c6d5 32import org.tianocore.PcdUsage;\r
a13899c5 33import org.tianocore.ModuleSurfaceAreaDocument.ModuleSurfaceArea;\r
34import org.tianocore.PcdCodedDocument.PcdCoded;\r
35import org.tianocore.PcdCodedDocument.PcdCoded.PcdEntry;\r
36import org.tianocore.frameworkwizard.common.DataType;\r
06a19cee 37import org.tianocore.frameworkwizard.common.IDefaultTableModel;\r
a13899c5 38import org.tianocore.frameworkwizard.common.Log;\r
a13899c5 39import org.tianocore.frameworkwizard.common.Tools;\r
79cb6fdb 40import org.tianocore.frameworkwizard.common.Identifications.OpeningModuleType;\r
06a19cee 41import org.tianocore.frameworkwizard.common.ui.IFrame;\r
a13899c5 42import org.tianocore.frameworkwizard.common.ui.IInternalFrame;\r
79cb6fdb 43import org.tianocore.frameworkwizard.module.Identifications.PcdCoded.PcdCodedIdentification;\r
44import org.tianocore.frameworkwizard.module.Identifications.PcdCoded.PcdCodedVector;\r
06a19cee 45import org.tianocore.frameworkwizard.module.ui.dialog.PCDsDlg;\r
a13899c5 46\r
47/**\r
48 The class is used to create, update PCD of MSA/MBD file\r
49 It extends IInternalFrame\r
50 \r
51\r
52\r
53 **/\r
54public class ModulePCDs extends IInternalFrame {\r
55\r
56 ///\r
57 /// Define class Serial Version UID\r
58 ///\r
59 private static final long serialVersionUID = 2227717658188438696L;\r
60\r
61 //\r
62 //Define class members\r
63 //\r
64 private JPanel jContentPane = null;\r
65\r
a13899c5 66 private JButton jButtonAdd = null;\r
67\r
68 private JButton jButtonRemove = null;\r
69\r
70 private JButton jButtonUpdate = null;\r
71\r
72 private JScrollPane jScrollPane = null;\r
73\r
06a19cee 74 private JScrollPane jScrollPaneTable = null;\r
a13899c5 75\r
06a19cee 76 private JTable jTable = null;\r
a13899c5 77\r
78 //\r
79 // Not used by UI\r
80 //\r
a13899c5 81 private OpeningModuleType omt = null;\r
82\r
83 private ModuleSurfaceArea msa = null;\r
84\r
85 private PcdCodedDocument.PcdCoded pcds = null;\r
86\r
87 private PcdCodedIdentification id = null;\r
88\r
89 private PcdCodedVector vid = new PcdCodedVector();\r
90\r
06a19cee 91 private IDefaultTableModel model = null;\r
a13899c5 92\r
06a19cee 93 private int selectedRow = -1;\r
a13899c5 94\r
95 /**\r
96 This method initializes jButtonAdd \r
97 \r
98 @return javax.swing.JButton jButtonAdd\r
99 \r
100 **/\r
101 private JButton getJButtonAdd() {\r
102 if (jButtonAdd == null) {\r
103 jButtonAdd = new JButton();\r
104 jButtonAdd.setBounds(new java.awt.Rectangle(230, 245, 80, 20));\r
105 jButtonAdd.setText("Add");\r
106 jButtonAdd.addActionListener(this);\r
107 jButtonAdd.setPreferredSize(new java.awt.Dimension(80, 20));\r
108 }\r
109 return jButtonAdd;\r
110 }\r
111\r
112 /**\r
113 This method initializes jButtonRemove \r
114 \r
115 @return javax.swing.JButton jButtonRemove\r
116 \r
117 **/\r
118 private JButton getJButtonRemove() {\r
119 if (jButtonRemove == null) {\r
120 jButtonRemove = new JButton();\r
121 jButtonRemove.setBounds(new java.awt.Rectangle(400, 245, 80, 20));\r
122 jButtonRemove.setText("Remove");\r
123 jButtonRemove.addActionListener(this);\r
124 jButtonRemove.setPreferredSize(new java.awt.Dimension(80, 20));\r
125 }\r
126 return jButtonRemove;\r
127 }\r
128\r
129 /**\r
130 This method initializes jButtonUpdate \r
131 \r
132 @return javax.swing.JButton jButtonUpdate\r
133 \r
134 **/\r
135 private JButton getJButtonUpdate() {\r
136 if (jButtonUpdate == null) {\r
137 jButtonUpdate = new JButton();\r
138 jButtonUpdate.setBounds(new java.awt.Rectangle(315, 245, 80, 20));\r
139 jButtonUpdate.setPreferredSize(new java.awt.Dimension(80, 20));\r
06a19cee 140 jButtonUpdate.setText("Edit");\r
a13899c5 141 jButtonUpdate.addActionListener(this);\r
142 }\r
143 return jButtonUpdate;\r
144 }\r
145\r
a13899c5 146 /**\r
147 This method initializes jScrollPane \r
148 \r
149 @return javax.swing.JScrollPane \r
150 */\r
151 private JScrollPane getJScrollPane() {\r
152 if (jScrollPane == null) {\r
153 jScrollPane = new JScrollPane();\r
154 jScrollPane.setViewportView(getJContentPane());\r
155 }\r
156 return jScrollPane;\r
157 }\r
158\r
159 /**\r
06a19cee 160 This method initializes jScrollPaneTable \r
161 \r
162 @return javax.swing.JScrollPane \r
163 **/\r
164 private JScrollPane getJScrollPaneTable() {\r
165 if (jScrollPaneTable == null) {\r
166 jScrollPaneTable = new JScrollPane();\r
167 jScrollPaneTable.setBounds(new java.awt.Rectangle(15, 10, 470, 420));\r
168 jScrollPaneTable.setPreferredSize(new Dimension(470, 420));\r
169 jScrollPaneTable.setViewportView(getJTable());\r
a13899c5 170 }\r
06a19cee 171 return jScrollPaneTable;\r
a13899c5 172 }\r
173\r
174 /**\r
06a19cee 175 This method initializes jTable \r
176 \r
177 @return javax.swing.JTable \r
178 **/\r
179 private JTable getJTable() {\r
180 if (jTable == null) {\r
181 jTable = new JTable();\r
182 model = new IDefaultTableModel();\r
183 jTable = new JTable(model);\r
184 jTable.setRowHeight(20);\r
185\r
186 model.addColumn("Name");\r
187 model.addColumn("Type");\r
188 model.addColumn("Value");\r
fd16c6d5 189 model.addColumn("Usage");\r
06a19cee 190\r
191 jTable.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);\r
192 jTable.getSelectionModel().addListSelectionListener(this);\r
193 jTable.getModel().addTableModelListener(this);\r
194 jTable.addMouseListener(this);\r
a13899c5 195 }\r
06a19cee 196 return jTable;\r
a13899c5 197 }\r
198\r
06a19cee 199 public static void main(String[] args) {\r
200\r
a13899c5 201 }\r
202\r
203 /**\r
06a19cee 204 This method initializes this\r
205 \r
a13899c5 206 **/\r
06a19cee 207 private void init() {\r
208 this.setSize(500, 515);\r
209 this.setContentPane(getJScrollPane());\r
210 this.setTitle("Pcd Coded");\r
a13899c5 211 }\r
212\r
213 /**\r
06a19cee 214 This method initializes this\r
215 Fill values to all fields if these values are not empty\r
216 \r
217 @param inPackageDependencies\r
a13899c5 218\r
219 **/\r
06a19cee 220 private void init(PcdCoded inPcdCodeds) {\r
221 init();\r
222 this.pcds = inPcdCodeds;\r
223\r
224 if (this.pcds != null) {\r
225 if (this.pcds.getPcdEntryList().size() > 0) {\r
226 for (int index = 0; index < this.pcds.getPcdEntryList().size(); index++) {\r
227 String arg0 = pcds.getPcdEntryList().get(index).getCName();\r
228 String arg1 = pcds.getPcdEntryList().get(index).getTokenSpaceGuidCName();\r
229\r
230 String arg2 = pcds.getPcdEntryList().get(index).getFeatureFlag();\r
231 Vector<String> arg3 = Tools.convertListToVector(pcds.getPcdEntryList().get(index).getSupArchList());\r
232\r
233 String arg4 = pcds.getPcdEntryList().get(index).getDefaultValue();\r
234 String arg5 = pcds.getPcdEntryList().get(index).getHelpText();\r
235 String arg6 = null;\r
236 if (pcds.getPcdEntryList().get(index).getPcdItemType() != null) {\r
237 arg6 = pcds.getPcdEntryList().get(index).getPcdItemType().toString();\r
238 }\r
fd16c6d5 239 String arg7 = null;\r
240 if (pcds.getPcdEntryList().get(index).getUsage() != null) {\r
241 arg7 = pcds.getPcdEntryList().get(index).getUsage().toString();\r
242 }\r
243 id = new PcdCodedIdentification(arg0, arg1, arg2, arg3, arg4, arg5, arg6, arg7);\r
06a19cee 244 vid.addPcdCoded(id);\r
245 }\r
246 }\r
247 }\r
248 showTable();\r
a13899c5 249 }\r
250\r
a13899c5 251 /**\r
252 This is the default constructor\r
253 \r
254 **/\r
255 public ModulePCDs() {\r
256 super();\r
257 init();\r
258 this.setVisible(true);\r
259 }\r
260\r
261 /**\r
262 This is the override edit constructor\r
263 \r
264 @param inPcds The input data of PCDsDocument.PCDs\r
265 \r
266 **/\r
267 public ModulePCDs(OpeningModuleType inOmt) {\r
268 super();\r
269 this.omt = inOmt;\r
270 this.msa = omt.getXmlMsa();\r
271 init(msa.getPcdCoded());\r
272 this.setVisible(true);\r
273 }\r
274\r
a13899c5 275 /**\r
276 This method initializes jContentPane\r
277 \r
278 @return javax.swing.JPanel jContentPane\r
279 \r
280 **/\r
281 private JPanel getJContentPane() {\r
282 if (jContentPane == null) {\r
a13899c5 283 jContentPane = new JPanel();\r
284 jContentPane.setLayout(null);\r
06a19cee 285 jContentPane.setPreferredSize(new java.awt.Dimension(490, 490));\r
286\r
a13899c5 287 jContentPane.add(getJButtonAdd(), null);\r
288 jContentPane.add(getJButtonRemove(), null);\r
289 jContentPane.add(getJButtonUpdate(), null);\r
06a19cee 290 jContentPane.add(getJScrollPaneTable(), null);\r
a13899c5 291 }\r
292 return jContentPane;\r
293 }\r
294\r
06a19cee 295 private void showEdit(int index) {\r
296 PCDsDlg dlg = new PCDsDlg(vid.getPcdCoded(index), new IFrame());\r
297 int result = dlg.showDialog();\r
298 if (result == DataType.RETURN_TYPE_OK) {\r
299 if (index == -1) {\r
300 this.vid.addPcdCoded(dlg.getId());\r
301 } else {\r
302 this.vid.setPcdCoded(dlg.getId(), index);\r
303 }\r
304 this.showTable();\r
305 this.save();\r
306 dlg.dispose();\r
307 }\r
308 if (result == DataType.RETURN_TYPE_CANCEL) {\r
309 dlg.dispose();\r
310 }\r
311 }\r
312\r
a13899c5 313 /**\r
06a19cee 314 Clear all table rows\r
a13899c5 315 \r
316 **/\r
06a19cee 317 private void clearAll() {\r
318 if (model != null) {\r
319 for (int index = model.getRowCount() - 1; index >= 0; index--) {\r
320 model.removeRow(index);\r
321 }\r
322 }\r
323 }\r
324\r
325 /**\r
326 Read content of vector and put then into table\r
327 \r
328 **/\r
329 private void showTable() {\r
330 clearAll();\r
331\r
332 if (vid.size() > 0) {\r
333 for (int index = 0; index < vid.size(); index++) {\r
334 model.addRow(vid.toStringVector(index));\r
335 }\r
336 }\r
337 this.jTable.repaint();\r
338 this.jTable.updateUI();\r
a13899c5 339 }\r
340\r
341 /* (non-Javadoc)\r
342 * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)\r
343 *\r
344 * Override actionPerformed to listen all actions\r
345 * \r
346 */\r
347 public void actionPerformed(ActionEvent arg0) {\r
348 if (arg0.getSource() == jButtonAdd) {\r
06a19cee 349 showEdit(-1);\r
a13899c5 350 }\r
351 if (arg0.getSource() == jButtonUpdate) {\r
06a19cee 352 if (this.selectedRow < 0) {\r
ed1665f2 353 Log.wrn("Update PcdCoded", "Please select one record first.");\r
a13899c5 354 return;\r
355 }\r
06a19cee 356 showEdit(selectedRow);\r
a13899c5 357 }\r
a13899c5 358\r
06a19cee 359 if (arg0.getSource() == jButtonRemove) {\r
360 if (jTable.isEditing()) {\r
361 jTable.getCellEditor().stopCellEditing();\r
a13899c5 362 }\r
06a19cee 363 if (selectedRow > -1) {\r
364 this.model.removeRow(selectedRow);\r
365 this.vid.removePcdCoded(selectedRow);\r
366 selectedRow = -1;\r
367 this.save();\r
a13899c5 368 }\r
369 }\r
a13899c5 370 }\r
371\r
372 /**\r
373 Save all components of PCDs\r
374 if exists pcds, set the value directly\r
375 if not exists pcds, new an instance first\r
376 \r
377 **/\r
378 public void save() {\r
379 try {\r
380 int count = this.vid.size();\r
381\r
382 this.pcds = PcdCoded.Factory.newInstance();\r
383 if (count > 0) {\r
384 for (int index = 0; index < count; index++) {\r
385 PcdEntry p = PcdEntry.Factory.newInstance();\r
386 if (!isEmpty(vid.getPcdCoded(index).getName())) {\r
387 p.setCName(vid.getPcdCoded(index).getName());\r
388 }\r
389 if (!isEmpty(vid.getPcdCoded(index).getGuid())) {\r
390 p.setTokenSpaceGuidCName(vid.getPcdCoded(index).getGuid());\r
391 }\r
392 if (!isEmpty(vid.getPcdCoded(index).getFeatureFlag())) {\r
393 p.setFeatureFlag(vid.getPcdCoded(index).getFeatureFlag());\r
394 }\r
06a19cee 395 if (vid.getPcdCoded(index).getSupArchList() != null\r
396 && vid.getPcdCoded(index).getSupArchList().size() > 0) {\r
a13899c5 397 p.setSupArchList(vid.getPcdCoded(index).getSupArchList());\r
398 }\r
399 if (!isEmpty(vid.getPcdCoded(index).getValue())) {\r
400 p.setDefaultValue(vid.getPcdCoded(index).getValue());\r
401 }\r
402 if (!isEmpty(vid.getPcdCoded(index).getHelp())) {\r
403 p.setHelpText(vid.getPcdCoded(index).getHelp());\r
404 }\r
405 if (!isEmpty(vid.getPcdCoded(index).getType())) {\r
406 p.setPcdItemType(PcdItemTypes.Enum.forString(vid.getPcdCoded(index).getType()));\r
407 }\r
fd16c6d5 408 if (!isEmpty(vid.getPcdCoded(index).getUsage())) {\r
409 p.setUsage(PcdUsage.Enum.forString(vid.getPcdCoded(index).getUsage()));\r
410 }\r
a13899c5 411 this.pcds.addNewPcdEntry();\r
412 this.pcds.setPcdEntryArray(pcds.getPcdEntryList().size() - 1, p);\r
413 }\r
414 }\r
415\r
416 this.msa.setPcdCoded(pcds);\r
417 this.omt.setSaved(false);\r
418 } catch (Exception e) {\r
ed1665f2 419 Log.wrn("Update PcdCoded", e.getMessage());\r
420 Log.err("Update PcdCoded", e.getMessage());\r
a13899c5 421 }\r
422 }\r
423\r
06a19cee 424 /* (non-Javadoc)\r
425 * @see javax.swing.event.ListSelectionListener#valueChanged(javax.swing.event.ListSelectionEvent)\r
426 *\r
427 */\r
428 public void valueChanged(ListSelectionEvent arg0) {\r
429 if (arg0.getValueIsAdjusting()) {\r
430 return;\r
431 }\r
432 ListSelectionModel lsm = (ListSelectionModel) arg0.getSource();\r
433 if (lsm.isSelectionEmpty()) {\r
434 return;\r
435 } else {\r
436 selectedRow = lsm.getMinSelectionIndex();\r
437 }\r
438 }\r
439\r
440 /* (non-Javadoc)\r
441 * @see java.awt.event.MouseListener#mouseClicked(java.awt.event.MouseEvent)\r
442 *\r
443 */\r
444 public void mouseClicked(MouseEvent arg0) {\r
445 if (arg0.getClickCount() == 2) {\r
446 if (this.selectedRow < 0) {\r
447 return;\r
448 } else {\r
449 showEdit(selectedRow);\r
450 }\r
451 }\r
452 }\r
453\r
a13899c5 454 /* (non-Javadoc)\r
455 * @see java.awt.event.ComponentListener#componentResized(java.awt.event.ComponentEvent)\r
456 * \r
457 * Override componentResized to resize all components when frame's size is changed\r
458 */\r
459 public void componentResized(ComponentEvent arg0) {\r
460 int intCurrentWidth = this.getJContentPane().getWidth();\r
461 int intCurrentHeight = this.getJContentPane().getHeight();\r
462 int intPreferredWidth = this.getJContentPane().getPreferredSize().width;\r
463 int intPreferredHeight = this.getJContentPane().getPreferredSize().height;\r
464\r
8792f60f 465 Tools.resizeComponent(this.jScrollPaneTable, intCurrentWidth, intCurrentHeight, intPreferredWidth,\r
466 intPreferredHeight);\r
467 Tools.relocateComponent(this.jButtonAdd, intCurrentWidth, intCurrentHeight, intPreferredWidth,\r
468 intPreferredHeight, DataType.SPACE_TO_RIGHT_FOR_ADD_BUTTON,\r
469 DataType.SPACE_TO_BOTTOM_FOR_ADD_BUTTON);\r
470 Tools.relocateComponent(this.jButtonRemove, intCurrentWidth, intCurrentHeight, intPreferredWidth,\r
471 intPreferredHeight, DataType.SPACE_TO_RIGHT_FOR_REMOVE_BUTTON,\r
472 DataType.SPACE_TO_BOTTOM_FOR_REMOVE_BUTTON);\r
473 Tools.relocateComponent(this.jButtonUpdate, intCurrentWidth, intCurrentHeight, intPreferredWidth,\r
474 intPreferredHeight, DataType.SPACE_TO_RIGHT_FOR_UPDATE_BUTTON,\r
475 DataType.SPACE_TO_BOTTOM_FOR_UPDATE_BUTTON);\r
a13899c5 476 }\r
a13899c5 477}\r