Tools/Java/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/ModuleSystemTables.java

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