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

   1 /** @file
   2
   3  The file is used to create, update Formset 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.HiiPackageUsage;
  31 import org.tianocore.HiiPackagesDocument;
  32 import org.tianocore.HiiPackagesDocument.HiiPackages;
  33 import org.tianocore.HiiPackagesDocument.HiiPackages.HiiPackage;
  34 import org.tianocore.ModuleSurfaceAreaDocument.ModuleSurfaceArea;
  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.HiiPackages.HiiPackagesIdentification;
  43 import org.tianocore.frameworkwizard.module.Identifications.HiiPackages.HiiPackagesVector;
  44 import org.tianocore.frameworkwizard.module.ui.dialog.HiiPackagesDlg;
  45
  46 /**
  47  The class is used to create, update Formset of MSA/MBD file
  48  It extends IInternalFrame
  49
  50  **/
  51 public class ModuleHiiPackages extends IInternalFrame {
  52
  53     ///
  54     /// Define class Serial Version UID
  55     ///
  56     private static final long serialVersionUID = -6851574146786158116L;
  57
  58     //
  59     //Define class members
  60     //
  61     private JPanel jContentPane = null;
  62
  63     private JButton jButtonAdd = null;
  64
  65     private JButton jButtonRemove = null;
  66
  67     private JButton jButtonUpdate = null;
  68
  69     private JScrollPane jScrollPane = null;
  70
  71     private JScrollPane jScrollPaneTable = null;
  72
  73     private JTable jTable = null;
  74
  75     //
  76     // Not used by UI
  77     //
  78     private OpeningModuleType omt = null;
  79
  80     private ModuleSurfaceArea msa = null;
  81
  82     private HiiPackagesDocument.HiiPackages hiiPackages = null;
  83
  84     private HiiPackagesIdentification id = null;
  85
  86     private HiiPackagesVector vid = new HiiPackagesVector();
  87
  88     private IDefaultTableModel model = null;
  89
  90     private int selectedRow = -1;
  91
  92     private IFrame parentFrame = null;
  93
  94     /**
  95      This method initializes jButtonAdd
  96
  97      @return javax.swing.JButton jButtonAdd
  98
  99      **/
 100     private JButton getJButtonAdd() {
 101         if (jButtonAdd == null) {
 102             jButtonAdd = new JButton();
 103             jButtonAdd.setBounds(new java.awt.Rectangle(230, 195, 90, 20));
 104             jButtonAdd.setText("Add");
 105             jButtonAdd.addActionListener(this);
 106             jButtonAdd.setPreferredSize(new java.awt.Dimension(90, 20));
 107         }
 108         return jButtonAdd;
 109     }
 110
 111     /**
 112      This method initializes jButtonRemove
 113
 114      @return javax.swing.JButton jButtonRemove
 115
 116      **/
 117     private JButton getJButtonRemove() {
 118         if (jButtonRemove == null) {
 119             jButtonRemove = new JButton();
 120             jButtonRemove.setBounds(new java.awt.Rectangle(400, 195, 90, 20));
 121             jButtonRemove.setText("Remove");
 122             jButtonRemove.addActionListener(this);
 123             jButtonRemove.setPreferredSize(new java.awt.Dimension(90, 20));
 124         }
 125         return jButtonRemove;
 126     }
 127
 128     /**
 129      This method initializes jButtonUpdate
 130
 131      @return javax.swing.JButton jButtonUpdate
 132
 133      **/
 134     private JButton getJButtonUpdate() {
 135         if (jButtonUpdate == null) {
 136             jButtonUpdate = new JButton();
 137             jButtonUpdate.setBounds(new java.awt.Rectangle(315, 195, 90, 20));
 138             jButtonUpdate.setPreferredSize(new java.awt.Dimension(90, 20));
 139             jButtonUpdate.setText("Edit");
 140             jButtonUpdate.addActionListener(this);
 141         }
 142         return jButtonUpdate;
 143     }
 144
 145     /**
 146      This method initializes jScrollPane
 147
 148      @return javax.swing.JScrollPane
 149      */
 150     private JScrollPane getJScrollPane() {
 151         if (jScrollPane == null) {
 152             jScrollPane = new JScrollPane();
 153             jScrollPane.setViewportView(getJContentPane());
 154         }
 155         return jScrollPane;
 156     }
 157
 158     /**
 159      This method initializes jScrollPaneTable
 160
 161      @return javax.swing.JScrollPane
 162      **/
 163     private JScrollPane getJScrollPaneTable() {
 164         if (jScrollPaneTable == null) {
 165             jScrollPaneTable = new JScrollPane();
 166             jScrollPaneTable.setBounds(new java.awt.Rectangle(15, 10, 470, 420));
 167             jScrollPaneTable.setPreferredSize(new Dimension(470, 420));
 168             jScrollPaneTable.setViewportView(getJTable());
 169         }
 170         return jScrollPaneTable;
 171     }
 172
 173     /**
 174      This method initializes jTable
 175
 176      @return javax.swing.JTable
 177      **/
 178     private JTable getJTable() {
 179         if (jTable == null) {
 180             jTable = new JTable();
 181             model = new IDefaultTableModel();
 182             jTable = new JTable(model);
 183             jTable.setRowHeight(20);
 184
 185             model.addColumn("Hii Package C_Name");
 186             model.addColumn("Usage");
 187
 188             jTable.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
 189             jTable.getSelectionModel().addListSelectionListener(this);
 190             jTable.getModel().addTableModelListener(this);
 191             jTable.addMouseListener(this);
 192         }
 193         return jTable;
 194     }
 195
 196     public static void main(String[] args) {
 197
 198     }
 199
 200     /**
 201      This method initializes this
 202
 203      **/
 204     private void init() {
 205         this.setSize(500, 515);
 206         this.setContentPane(getJScrollPane());
 207         this.setTitle("Hii Packages");
 208     }
 209
 210     /**
 211      This method initializes this
 212      Fill values to all fields if these values are not empty
 213
 214      @param inPackageDependencies
 215
 216      **/
 217     private void init(HiiPackages inHiiPackages) {
 218         init();
 219         this.hiiPackages = inHiiPackages;
 220
 221         if (this.hiiPackages != null) {
 222             if (this.hiiPackages.getHiiPackageList().size() > 0) {
 223                 for (int index = 0; index < this.hiiPackages.getHiiPackageList().size(); index++) {
 224                     String arg0 = hiiPackages.getHiiPackageList().get(index).getHiiCName();
 225                     String arg1 = null;
 226                     if (hiiPackages.getHiiPackageList().get(index).getUsage() != null) {
 227                         arg1 = hiiPackages.getHiiPackageList().get(index).getUsage().toString();
 228                     }
 229
 230                     String arg2 = hiiPackages.getHiiPackageList().get(index).getFeatureFlag();
 231                     Vector<String> arg3 = Tools.convertListToVector(hiiPackages.getHiiPackageList().get(index)
 232                                                                                .getSupArchList());
 233                     String arg4 = hiiPackages.getHiiPackageList().get(index).getHelpText();
 234
 235                     id = new HiiPackagesIdentification(arg0, arg1, arg2, arg3, arg4);
 236                     vid.addHiiPackages(id);
 237                 }
 238             }
 239         }
 240         showTable();
 241     }
 242
 243     /**
 244      This is the default constructor
 245
 246      **/
 247     public ModuleHiiPackages() {
 248         super();
 249         init();
 250         this.setVisible(true);
 251     }
 252
 253     /**
 254      *
 255      */
 256     /**
 257      This is the override edit constructor
 258
 259      @param inFormsets The input data of HiiPackagesDocument.HiiPackages
 260
 261      **/
 262     public ModuleHiiPackages(OpeningModuleType inOmt, IFrame iFrame) {
 263         super();
 264         this.omt = inOmt;
 265         this.msa = omt.getXmlMsa();
 266         this.parentFrame = iFrame;
 267         init(msa.getHiiPackages());
 268         this.setVisible(true);
 269     }
 270
 271     /**
 272      This method initializes jContentPane
 273
 274      @return javax.swing.JPanel jContentPane
 275
 276      **/
 277     private JPanel getJContentPane() {
 278         if (jContentPane == null) {
 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         HiiPackagesDlg dlg = new HiiPackagesDlg(vid.getHiiPackages(index), this.parentFrame, omt.getId());
 293         int result = dlg.showDialog();
 294         if (result == DataType.RETURN_TYPE_OK) {
 295             if (index == -1) {
 296                 this.vid.addHiiPackages(dlg.getId());
 297             } else {
 298                 this.vid.setHiiPackages(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 Hii Packages", "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             if (selectedRow > -1) {
 360                 this.model.removeRow(selectedRow);
 361                 this.vid.removeHiiPackages(selectedRow);
 362                 selectedRow = -1;
 363                 this.save();
 364             }
 365         }
 366     }
 367
 368     /**
 369      Save all components of hiiPackages
 370      if exists formset, set the value directly
 371      if not exists formset, new an instance first
 372
 373      **/
 374     public void save() {
 375         try {
 376             int count = this.vid.size();
 377
 378             this.hiiPackages = HiiPackages.Factory.newInstance();
 379             if (count > 0) {
 380                 for (int index = 0; index < count; index++) {
 381                     HiiPackage p = HiiPackage.Factory.newInstance();
 382                     if (!isEmpty(vid.getHiiPackages(index).getName())) {
 383                         p.setHiiCName(vid.getHiiPackages(index).getName());
 384                     }
 385                     if (!isEmpty(vid.getHiiPackages(index).getUsage())) {
 386                         p.setUsage(HiiPackageUsage.Enum.forString(vid.getHiiPackages(index).getUsage()));
 387                     }
 388                     if (!isEmpty(vid.getHiiPackages(index).getFeatureFlag())) {
 389                         p.setFeatureFlag(vid.getHiiPackages(index).getFeatureFlag());
 390                     }
 391                     if (vid.getHiiPackages(index).getSupArchList() != null
 392                         && vid.getHiiPackages(index).getSupArchList().size() > 0) {
 393                         p.setSupArchList(vid.getHiiPackages(index).getSupArchList());
 394                     }
 395                     if (!isEmpty(vid.getHiiPackages(index).getHelp())) {
 396                         p.setHelpText(vid.getHiiPackages(index).getHelp());
 397                     }
 398                     this.hiiPackages.addNewHiiPackage();
 399                     this.hiiPackages.setHiiPackageArray(hiiPackages.getHiiPackageList().size() - 1, p);
 400                 }
 401             }
 402
 403             this.msa.setHiiPackages(hiiPackages);
 404             this.omt.setSaved(false);
 405         } catch (Exception e) {
 406             Log.wrn("Update hiiPackages", e.getMessage());
 407             Log.err("Update hiiPackages", e.getMessage());
 408         }
 409     }
 410
 411     /* (non-Javadoc)
 412      * @see javax.swing.event.ListSelectionListener#valueChanged(javax.swing.event.ListSelectionEvent)
 413      *
 414      */
 415     public void valueChanged(ListSelectionEvent arg0) {
 416         if (arg0.getValueIsAdjusting()) {
 417             return;
 418         }
 419         ListSelectionModel lsm = (ListSelectionModel) arg0.getSource();
 420         if (lsm.isSelectionEmpty()) {
 421             return;
 422         } else {
 423             selectedRow = lsm.getMinSelectionIndex();
 424         }
 425     }
 426
 427     /* (non-Javadoc)
 428      * @see java.awt.event.MouseListener#mouseClicked(java.awt.event.MouseEvent)
 429      *
 430      */
 431     public void mouseClicked(MouseEvent arg0) {
 432         if (arg0.getClickCount() == 2) {
 433             if (this.selectedRow < 0) {
 434                 return;
 435             } else {
 436                 showEdit(selectedRow);
 437             }
 438         }
 439     }
 440
 441     /* (non-Javadoc)
 442      * @see java.awt.event.ComponentListener#componentResized(java.awt.event.ComponentEvent)
 443      *
 444      * Override componentResized to resize all components when frame's size is changed
 445      */
 446     public void componentResized(ComponentEvent arg0) {
 447         int intCurrentWidth = this.getJContentPane().getWidth();
 448         int intCurrentHeight = this.getJContentPane().getHeight();
 449         int intPreferredWidth = this.getJContentPane().getPreferredSize().width;
 450         int intPreferredHeight = this.getJContentPane().getPreferredSize().height;
 451
 452         Tools.resizeComponent(this.jScrollPaneTable, intCurrentWidth, intCurrentHeight, intPreferredWidth,
 453                               intPreferredHeight);
 454         Tools.relocateComponent(this.jButtonAdd, intCurrentWidth, intCurrentHeight, intPreferredWidth,
 455                                 intPreferredHeight, DataType.SPACE_TO_RIGHT_FOR_ADD_BUTTON,
 456                                 DataType.SPACE_TO_BOTTOM_FOR_ADD_BUTTON);
 457         Tools.relocateComponent(this.jButtonRemove, intCurrentWidth, intCurrentHeight, intPreferredWidth,
 458                                 intPreferredHeight, DataType.SPACE_TO_RIGHT_FOR_REMOVE_BUTTON,
 459                                 DataType.SPACE_TO_BOTTOM_FOR_REMOVE_BUTTON);
 460         Tools.relocateComponent(this.jButtonUpdate, intCurrentWidth, intCurrentHeight, intPreferredWidth,
 461                                 intPreferredHeight, DataType.SPACE_TO_RIGHT_FOR_UPDATE_BUTTON,
 462                                 DataType.SPACE_TO_BOTTOM_FOR_UPDATE_BUTTON);
 463     }
 464 }