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

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