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

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