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

   1 /** @file
   2
   3  The file is used to create, update Variable 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.VariableUsage;
  32 import org.tianocore.VariablesDocument;
  33 import org.tianocore.ModuleSurfaceAreaDocument.ModuleSurfaceArea;
  34 import org.tianocore.VariablesDocument.Variables;
  35 import org.tianocore.VariablesDocument.Variables.Variable;
  36 import org.tianocore.frameworkwizard.common.DataType;
  37 import org.tianocore.frameworkwizard.common.IDefaultTableModel;
  38 import org.tianocore.frameworkwizard.common.Log;
  39 import org.tianocore.frameworkwizard.common.Tools;
  40 import org.tianocore.frameworkwizard.common.Identifications.OpeningModuleType;
  41 import org.tianocore.frameworkwizard.common.ui.IFrame;
  42 import org.tianocore.frameworkwizard.common.ui.IInternalFrame;
  43 import org.tianocore.frameworkwizard.module.Identifications.Variables.VariablesIdentification;
  44 import org.tianocore.frameworkwizard.module.Identifications.Variables.VariablesVector;
  45 import org.tianocore.frameworkwizard.module.ui.dialog.VariablesDlg;
  46
  47 /**
  48  The class is used to create, update Variable of MSA/MBD file
  49  It extends IInternalFrame
  50
  51  **/
  52 public class ModuleVariables extends IInternalFrame {
  53
  54     ///
  55     /// Define class Serial Version UID
  56     ///
  57     private static final long serialVersionUID = -6998982978030439446L;
  58
  59     //
  60     //Define class members
  61     //
  62     private JPanel jContentPane = null;
  63
  64     private JButton jButtonAdd = null;
  65
  66     private JButton jButtonRemove = null;
  67
  68     private JButton jButtonUpdate = null;
  69
  70     private JScrollPane jScrollPane = null;
  71
  72     private JScrollPane jScrollPaneTable = null;
  73
  74     private JTable jTable = null;
  75
  76     //
  77     // Not used by UI
  78     //
  79     private OpeningModuleType omt = null;
  80
  81     private ModuleSurfaceArea msa = null;
  82
  83     private VariablesDocument.Variables variables = null;
  84
  85     private VariablesIdentification id = null;
  86
  87     private VariablesVector vid = new VariablesVector();
  88
  89     private IDefaultTableModel model = null;
  90
  91     private int selectedRow = -1;
  92
  93     private IFrame parentFrame = null;
  94
  95     /**
  96      This method initializes jButtonAdd
  97
  98      @return javax.swing.JButton jButtonAdd
  99
 100      **/
 101     private JButton getJButtonAdd() {
 102         if (jButtonAdd == null) {
 103             jButtonAdd = new JButton();
 104             jButtonAdd.setBounds(new java.awt.Rectangle(230, 220, 90, 20));
 105             jButtonAdd.setText("Add");
 106             jButtonAdd.addActionListener(this);
 107             jButtonAdd.setPreferredSize(new java.awt.Dimension(90, 20));
 108         }
 109         return jButtonAdd;
 110     }
 111
 112     /**
 113      This method initializes jButtonRemove
 114
 115      @return javax.swing.JButton jButtonRemove
 116
 117      **/
 118     private JButton getJButtonRemove() {
 119         if (jButtonRemove == null) {
 120             jButtonRemove = new JButton();
 121             jButtonRemove.setBounds(new java.awt.Rectangle(400, 220, 90, 20));
 122             jButtonRemove.setText("Remove");
 123             jButtonRemove.addActionListener(this);
 124             jButtonRemove.setPreferredSize(new java.awt.Dimension(90, 20));
 125         }
 126         return jButtonRemove;
 127     }
 128
 129     /**
 130      This method initializes jButtonUpdate
 131
 132      @return javax.swing.JButton jButtonUpdate
 133
 134      **/
 135     private JButton getJButtonUpdate() {
 136         if (jButtonUpdate == null) {
 137             jButtonUpdate = new JButton();
 138             jButtonUpdate.setBounds(new java.awt.Rectangle(315, 220, 90, 20));
 139             jButtonUpdate.setPreferredSize(new java.awt.Dimension(90, 20));
 140             jButtonUpdate.setText("Edit");
 141             jButtonUpdate.addActionListener(this);
 142         }
 143         return jButtonUpdate;
 144     }
 145
 146     /**
 147      This method initializes jScrollPane
 148
 149      @return javax.swing.JScrollPane
 150      */
 151     private JScrollPane getJScrollPane() {
 152         if (jScrollPane == null) {
 153             jScrollPane = new JScrollPane();
 154             jScrollPane.setViewportView(getJContentPane());
 155         }
 156         return jScrollPane;
 157     }
 158
 159     /**
 160      This method initializes jScrollPaneTable
 161
 162      @return javax.swing.JScrollPane
 163      **/
 164     private JScrollPane getJScrollPaneTable() {
 165         if (jScrollPaneTable == null) {
 166             jScrollPaneTable = new JScrollPane();
 167             jScrollPaneTable.setBounds(new java.awt.Rectangle(15, 10, 470, 420));
 168             jScrollPaneTable.setPreferredSize(new Dimension(470, 420));
 169             jScrollPaneTable.setViewportView(getJTable());
 170         }
 171         return jScrollPaneTable;
 172     }
 173
 174     /**
 175      This method initializes jTable
 176
 177      @return javax.swing.JTable
 178      **/
 179     private JTable getJTable() {
 180         if (jTable == null) {
 181             jTable = new JTable();
 182             model = new IDefaultTableModel();
 183             jTable = new JTable(model);
 184             jTable.setRowHeight(20);
 185
 186             model.addColumn("Name");
 187             model.addColumn("Guid C_Name");
 188             model.addColumn("Usage");
 189
 190             jTable.setSelectionMode(ListSelectionModel.SINGLE_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("Variables");
 210     }
 211
 212     /**
 213      This method initializes this
 214      Fill values to all fields if these values are not empty
 215
 216      @param inPackageDependencies
 217
 218      **/
 219     private void init(Variables inVariables) {
 220         init();
 221         this.variables = inVariables;
 222
 223         if (this.variables != null) {
 224             if (this.variables.getVariableList().size() > 0) {
 225                 for (int index = 0; index < this.variables.getVariableList().size(); index++) {
 226                     String arg0 = Tools.convertUnicodeHexStringToString(variables.getVariableList().get(index)
 227                                                                                  .getVariableName());
 228                     String arg1 = variables.getVariableList().get(index).getGuidCName();
 229                     String arg2 = null;
 230                     if (variables.getVariableList().get(index).getUsage() != null) {
 231                         arg2 = variables.getVariableList().get(index).getUsage().toString();
 232                     }
 233
 234                     String arg3 = variables.getVariableList().get(index).getFeatureFlag();
 235                     Vector<String> arg4 = Tools.convertListToVector(variables.getVariableList().get(index)
 236                                                                              .getSupArchList());
 237                     String arg5 = variables.getVariableList().get(index).getHelpText();
 238                     id = new VariablesIdentification(arg0, arg1, arg2, arg3, arg4, arg5);
 239                     vid.addVariables(id);
 240                 }
 241             }
 242         }
 243         showTable();
 244     }
 245
 246     /**
 247      This is the default constructor
 248
 249      **/
 250     public ModuleVariables() {
 251         super();
 252         init();
 253         this.setVisible(true);
 254     }
 255
 256     /**
 257      This is the override edit constructor
 258
 259      @param inVariables The input data of VariablesDocument.Variables
 260
 261      **/
 262     public ModuleVariables(OpeningModuleType inOmt, IFrame iFrame) {
 263         super();
 264         this.omt = inOmt;
 265         this.msa = omt.getXmlMsa();
 266         this.parentFrame = iFrame;
 267         init(msa.getVariables());
 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         VariablesDlg dlg = new VariablesDlg(vid.getVariables(index), this.parentFrame, omt.getId());
 293         int result = dlg.showDialog();
 294         if (result == DataType.RETURN_TYPE_OK) {
 295             if (index == -1) {
 296                 this.vid.addVariables(dlg.getId());
 297             } else {
 298                 this.vid.setVariables(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 Variables", "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.removeVariables(selectedRow);
 362                 selectedRow = -1;
 363                 this.save();
 364             }
 365         }
 366     }
 367
 368     /**
 369      Save all components of Variables
 370      if exists variables, set the value directly
 371      if not exists variables, new an instance first
 372
 373      **/
 374     public void save() {
 375         try {
 376             int count = this.vid.size();
 377
 378             this.variables = Variables.Factory.newInstance();
 379             if (count > 0) {
 380                 for (int index = 0; index < count; index++) {
 381                     Variable p = Variable.Factory.newInstance();
 382                     if (!isEmpty(vid.getVariables(index).getName())) {
 383                         p.setVariableName(Tools.convertStringToUnicodeHexString(vid.getVariables(index).getName()));
 384                     }
 385                     if (!isEmpty(vid.getVariables(index).getGuid())) {
 386                         p.setGuidCName(vid.getVariables(index).getGuid());
 387                     }
 388                     if (!isEmpty(vid.getVariables(index).getUsage())) {
 389                         p.setUsage(VariableUsage.Enum.forString(vid.getVariables(index).getUsage()));
 390                     }
 391                     if (!isEmpty(vid.getVariables(index).getFeatureFlag())) {
 392                         p.setFeatureFlag(vid.getVariables(index).getFeatureFlag());
 393                     }
 394                     if (vid.getVariables(index).getSupArchList() != null
 395                         && vid.getVariables(index).getSupArchList().size() > 0) {
 396                         p.setSupArchList(vid.getVariables(index).getSupArchList());
 397                     }
 398                     if (!isEmpty(vid.getVariables(index).getHelp())) {
 399                         p.setHelpText(vid.getVariables(index).getHelp());
 400                     }
 401                     this.variables.addNewVariable();
 402                     this.variables.setVariableArray(variables.getVariableList().size() - 1, p);
 403                 }
 404             }
 405
 406             this.msa.setVariables(variables);
 407             this.omt.setSaved(false);
 408         } catch (Exception e) {
 409             Log.wrn("Update Variables", e.getMessage());
 410             Log.err("Update Variables", 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 }