Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/PpisDlg.java

   1 /** @file
   2
   3  The file is used to create, update Ppi 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.dialog;
  16
  17 import java.awt.event.ActionEvent;
  18 import java.awt.event.ItemEvent;
  19 import java.awt.event.ItemListener;
  20 import java.util.Vector;
  21
  22 import javax.swing.JButton;
  23 import javax.swing.JComboBox;
  24 import javax.swing.JLabel;
  25 import javax.swing.JPanel;
  26 import javax.swing.JScrollPane;
  27 import javax.swing.JTextField;
  28 import javax.swing.JTextArea;
  29
  30 import org.tianocore.frameworkwizard.common.DataType;
  31 import org.tianocore.frameworkwizard.common.DataValidation;
  32 import org.tianocore.frameworkwizard.common.EnumerationData;
  33 import org.tianocore.frameworkwizard.common.Log;
  34 import org.tianocore.frameworkwizard.common.Tools;
  35 import org.tianocore.frameworkwizard.common.ui.ArchCheckBox;
  36 import org.tianocore.frameworkwizard.common.ui.IDialog;
  37 import org.tianocore.frameworkwizard.common.ui.IFrame;
  38 import org.tianocore.frameworkwizard.common.ui.StarLabel;
  39 import org.tianocore.frameworkwizard.module.Identifications.Ppis.PpisIdentification;
  40 import org.tianocore.frameworkwizard.workspace.WorkspaceTools;
  41
  42 /**
  43  * The class is used to create, update Ppi of MSA/MBD file It extends
  44  * IInternalFrame
  45  *
  46  */
  47 public class PpisDlg extends IDialog implements ItemListener {
  48
  49   // /
  50   // / Define class Serial Version UID
  51   // /
  52   private static final long serialVersionUID = -4284901202357037724L;
  53
  54   //
  55   // Define class members
  56   //
  57   private JPanel jContentPane = null;
  58
  59   private JLabel jLabelC_Name = null;
  60
  61   private JComboBox jComboBoxCName = null;
  62
  63   private JTextField jTextFieldFeatureFlag = null;
  64
  65   private JLabel jLabelFeatureFlag = null;
  66
  67   private JLabel jLabelUsage = null;
  68
  69   private JComboBox jComboBoxUsage = null;
  70
  71   private JLabel jLabelPpiType = null;
  72
  73   private StarLabel jStarLabel1 = null;
  74
  75   private StarLabel jStarLabel2 = null;
  76
  77   private StarLabel jStarLabel3 = null;
  78
  79   private JComboBox jComboBoxPpiType = null;
  80
  81   private JLabel jLabelArch = null;
  82
  83   private JScrollPane jScrollPane = null;
  84
  85   private JLabel jLabelHelpText = null;
  86
  87   private JTextArea jTextAreaHelpText = null;
  88
  89   private JScrollPane jScrollPaneHelpText = null;
  90
  91   private ArchCheckBox jArchCheckBox = null;
  92
  93   private JButton jButtonOk = null;
  94
  95   private JButton jButtonCancel = null;
  96
  97   //
  98   // Not used by UI
  99   //
 100   private PpisIdentification id = null;
 101
 102   private WorkspaceTools wt = new WorkspaceTools();
 103
 104   private EnumerationData ed = new EnumerationData();
 105
 106   /**
 107    * This method initializes jComboBoxPpiType
 108    *
 109    * @return javax.swing.JComboBox
 110    */
 111   private JComboBox getJComboBoxPpiType() {
 112     if (jComboBoxPpiType == null) {
 113       jComboBoxPpiType = new JComboBox();
 114       jComboBoxPpiType.setBounds(new java.awt.Rectangle(160, 10, 320, 20));
 115       jComboBoxPpiType.setPreferredSize(new java.awt.Dimension(320, 20));
 116       jComboBoxPpiType.addItemListener(this);
 117       jComboBoxPpiType.setToolTipText("<html>PPIs are named by GUID.<br>PPI Notify is consumed via a register PPI Notify mechanism");
 118     }
 119     return jComboBoxPpiType;
 120   }
 121
 122   /**
 123    * This method initializes jTextFieldC_Name
 124    *
 125    * @return javax.swing.JTextField jTextFieldC_Name
 126    *
 127    */
 128   private JComboBox getJComboBoxCName() {
 129     if (jComboBoxCName == null) {
 130       jComboBoxCName = new JComboBox();
 131       jComboBoxCName.setBounds(new java.awt.Rectangle(160, 35, 320, 20));
 132       jComboBoxCName.setPreferredSize(new java.awt.Dimension(320, 20));
 133       jComboBoxCName.setToolTipText("Select Guid C Name of PPI");
 134     }
 135     return jComboBoxCName;
 136   }
 137
 138   /**
 139    * This method initializes jComboBoxUsage
 140    *
 141    * @return javax.swing.JComboBox jComboBoxUsage
 142    *
 143    */
 144   private JComboBox getJComboBoxUsage() {
 145     if (jComboBoxUsage == null) {
 146       jComboBoxUsage = new JComboBox();
 147       jComboBoxUsage.setBounds(new java.awt.Rectangle(160, 60, 320, 20));
 148       jComboBoxUsage.setPreferredSize(new java.awt.Dimension(320, 20));
 149       jComboBoxUsage.setToolTipText("<html><table><tr><td colspan=2 align=center><b>PPI</b></td></tr><tr><td>ALWAYS_CONSUMED</td><td>Module always consumes the PPI</td></tr><tr><td>SOMETIMES_CONSUMED</td><td>Module sometimes consumes the PPI</td></tr><tr><td>ALWAYS_PRODUCED</td><td>Module always produces the PPI</td></tr><tr><td>SOMETIMES_PRODUCED</td><td>Module sometimes produces the PPI</td></tr><tr><td colspan=2 align=center><b>PPI Notify</b></td></tr><tr><td>SOMETIMES_CONSUMED</td><td>Module will consume the PPI if it is produced. Consumption<br>is defined by executing the PPI notify function</td></tr></table></html>");
 150     }
 151     return jComboBoxUsage;
 152   }
 153
 154   /**
 155    * This method initializes jTextFieldFeatureFlag
 156    *
 157    * @return javax.swing.JTextField jTextFieldFeatureFlag
 158    *
 159    */
 160   private JTextField getJTextFieldFeatureFlag() {
 161     if (jTextFieldFeatureFlag == null) {
 162       jTextFieldFeatureFlag = new JTextField();
 163       jTextFieldFeatureFlag
 164           .setBounds(new java.awt.Rectangle(160, 130, 320, 20));
 165       jTextFieldFeatureFlag.setPreferredSize(new java.awt.Dimension(320, 20));
 166       jTextFieldFeatureFlag
 167           .setToolTipText("Postfix expression that must evaluate to TRUE or FALSE");
 168     }
 169     return jTextFieldFeatureFlag;
 170   }
 171
 172   /**
 173    * This method initializes jScrollPane
 174    *
 175    * @return javax.swing.JScrollPane
 176    */
 177   private JScrollPane getJScrollPane() {
 178     if (jScrollPane == null) {
 179       jScrollPane = new JScrollPane();
 180       jScrollPane.setViewportView(getJContentPane());
 181     }
 182     return jScrollPane;
 183   }
 184
 185   /**
 186    * This method initializes jTextAreaHelpText
 187    *
 188    * @return javax.swing.JTextArea
 189    *
 190    */
 191   private JTextArea getJTextAreaHelpText() {
 192     if (jTextAreaHelpText == null) {
 193       jTextAreaHelpText = new JTextArea();
 194       jTextAreaHelpText.setLineWrap(true);
 195       jTextAreaHelpText.setWrapStyleWord(true);
 196     }
 197     return jTextAreaHelpText;
 198   }
 199
 200   /**
 201    * This method initializes jScrollPaneHelpText
 202    *
 203    * @return javax.swing.JScrollPane
 204    *
 205    */
 206   private JScrollPane getJScrollPaneHelpText() {
 207     if (jScrollPaneHelpText == null) {
 208       jScrollPaneHelpText = new JScrollPane();
 209       jScrollPaneHelpText
 210           .setHorizontalScrollBarPolicy(javax.swing.JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
 211       jScrollPaneHelpText.setSize(new java.awt.Dimension(320, 40));
 212       jScrollPaneHelpText.setPreferredSize(new java.awt.Dimension(320, 40));
 213       jScrollPaneHelpText.setLocation(new java.awt.Point(160, 85));
 214       jScrollPaneHelpText.setViewportView(getJTextAreaHelpText());
 215     }
 216     return jScrollPaneHelpText;
 217   }
 218
 219   /**
 220    * This method initializes jButtonOk
 221    *
 222    * @return javax.swing.JButton
 223    *
 224    */
 225   private JButton getJButtonOk() {
 226     if (jButtonOk == null) {
 227       jButtonOk = new JButton();
 228       jButtonOk.setBounds(new java.awt.Rectangle(290, 182, 90, 20));
 229       jButtonOk.setText("Ok");
 230       jButtonOk.addActionListener(this);
 231     }
 232     return jButtonOk;
 233   }
 234
 235   /**
 236    * This method initializes jButtonCancel
 237    *
 238    * @return javax.swing.JButton
 239    *
 240    */
 241   private JButton getJButtonCancel() {
 242     if (jButtonCancel == null) {
 243       jButtonCancel = new JButton();
 244       jButtonCancel.setBounds(new java.awt.Rectangle(390, 182, 90, 20));
 245       jButtonCancel.setText("Cancel");
 246       jButtonCancel.addActionListener(this);
 247     }
 248     return jButtonCancel;
 249   }
 250
 251   public static void main(String[] args) {
 252
 253   }
 254
 255   /**
 256    * This method initializes this
 257    *
 258    */
 259   private void init() {
 260     this.setSize(500, 255);
 261     this.setContentPane(getJScrollPane());
 262     this.setTitle("PPI Definitions");
 263     initFrame();
 264     this.centerWindow();
 265   }
 266
 267   /**
 268    * This method initializes this Fill values to all fields if these values are
 269    * not empty
 270    *
 271    * @param inProtocolsId
 272    *
 273    */
 274   private void init(PpisIdentification inPpisId) {
 275     init();
 276     this.id = inPpisId;
 277
 278     if (this.id != null) {
 279       this.jComboBoxCName.setSelectedItem(id.getName());
 280       this.jComboBoxPpiType.setSelectedItem(id.getType());
 281       this.jComboBoxUsage.setSelectedItem(id.getUsage());
 282       this.jTextAreaHelpText.setText(id.getHelp());
 283       this.jTextFieldFeatureFlag.setText(id.getFeatureFlag());
 284       this.jArchCheckBox.setSelectedItems(id.getSupArchList());
 285     }
 286   }
 287
 288   /**
 289    * This is the override edit constructor
 290    *
 291    * @param inProtocolsIdentification
 292    * @param iFrame
 293    *
 294    */
 295   public PpisDlg(PpisIdentification inPpisIdentification, IFrame iFrame) {
 296     super(iFrame, true);
 297     init(inPpisIdentification);
 298   }
 299
 300   /**
 301    * This method initializes jContentPane
 302    *
 303    * @return javax.swing.JPanel jContentPane
 304    *
 305    */
 306   private JPanel getJContentPane() {
 307     if (jContentPane == null) {
 308       jStarLabel1 = new StarLabel();
 309       jStarLabel1.setLocation(new java.awt.Point(2, 10));
 310       jLabelPpiType = new JLabel();
 311       jLabelPpiType.setBounds(new java.awt.Rectangle(15, 10, 145, 20));
 312       jLabelPpiType.setText("Ppi Type");
 313
 314       jStarLabel2 = new StarLabel();
 315       jStarLabel2.setLocation(new java.awt.Point(2, 35));
 316       jLabelC_Name = new JLabel();
 317       jLabelC_Name.setText("PPI GUID C Name");
 318       jLabelC_Name.setBounds(new java.awt.Rectangle(15, 35, 145, 20));
 319
 320       jStarLabel3 = new StarLabel();
 321       jStarLabel3.setLocation(new java.awt.Point(2, 60));
 322       jLabelUsage = new JLabel();
 323       jLabelUsage.setText("Usage");
 324       jLabelUsage.setBounds(new java.awt.Rectangle(15, 60, 145, 20));
 325
 326       jLabelHelpText = new JLabel();
 327       jLabelHelpText.setBounds(new java.awt.Rectangle(14, 85, 145, 20));
 328       jLabelHelpText.setText("Help Text");
 329
 330       jLabelFeatureFlag = new JLabel();
 331       jLabelFeatureFlag.setText("Feature Flag");
 332       jLabelFeatureFlag.setBounds(new java.awt.Rectangle(15, 130, 145, 20));
 333
 334       jLabelArch = new JLabel();
 335       jLabelArch.setBounds(new java.awt.Rectangle(15, 155, 145, 20));
 336       jLabelArch.setText("Arch");
 337       jArchCheckBox = new ArchCheckBox();
 338       jArchCheckBox.setBounds(new java.awt.Rectangle(160, 155, 320, 20));
 339       jArchCheckBox.setPreferredSize(new java.awt.Dimension(320, 20));
 340
 341       jContentPane = new JPanel();
 342       jContentPane.setLayout(null);
 343       jContentPane.setPreferredSize(new java.awt.Dimension(485, 210));
 344
 345       jContentPane.add(jStarLabel1, null);
 346       jContentPane.add(jLabelPpiType, null);
 347       jContentPane.add(getJComboBoxPpiType(), null);
 348       jContentPane.add(jStarLabel2, null);
 349       jContentPane.add(jLabelC_Name, null);
 350       jContentPane.add(getJComboBoxCName(), null);
 351       jContentPane.add(jStarLabel3, null);
 352       jContentPane.add(jLabelUsage, null);
 353       jContentPane.add(getJComboBoxUsage(), null);
 354       jContentPane.add(jLabelHelpText, null);
 355       jContentPane.add(getJScrollPaneHelpText(), null);
 356       jContentPane.add(jLabelFeatureFlag, null);
 357       jContentPane.add(getJTextFieldFeatureFlag(), null);
 358       jContentPane.add(jLabelArch, null);
 359       jContentPane.add(jArchCheckBox, null);
 360       jContentPane.add(getJButtonOk(), null);
 361       jContentPane.add(getJButtonCancel(), null);
 362     }
 363     return jContentPane;
 364   }
 365
 366   /**
 367    * This method initializes Usage type
 368    *
 369    */
 370   private void initFrame() {
 371     Tools.generateComboBoxByVector(jComboBoxCName, wt
 372         .getAllPpiDeclarationsFromWorkspace());
 373     Tools.generateComboBoxByVector(jComboBoxPpiType, ed.getVPpiType());
 374     Tools.generateComboBoxByVector(jComboBoxUsage, ed.getVPpiUsage());
 375   }
 376
 377   /*
 378    * (non-Javadoc)
 379    *
 380    * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
 381    *
 382    * Override actionPerformed to listen all actions
 383    *
 384    */
 385   public void actionPerformed(ActionEvent arg0) {
 386     if (arg0.getSource() == jButtonOk) {
 387       if (checkAdd()) {
 388         getCurrentPpis();
 389         this.returnType = DataType.RETURN_TYPE_OK;
 390         this.setVisible(false);
 391       }
 392     }
 393
 394     if (arg0.getSource() == jButtonCancel) {
 395       this.returnType = DataType.RETURN_TYPE_CANCEL;
 396       this.setVisible(false);
 397     }
 398   }
 399
 400   /**
 401    * Data validation for all fields
 402    *
 403    * @retval true - All datas are valid
 404    * @retval false - At least one data is invalid
 405    *
 406    */
 407   public boolean checkAdd() {
 408     //
 409     // Check if all fields have correct data types
 410     //
 411
 412     //
 413     // Check Name
 414     //
 415     if (!isEmpty(this.jComboBoxCName.getSelectedItem().toString())) {
 416       if (!DataValidation.isC_NameType(this.jComboBoxCName.getSelectedItem()
 417           .toString())) {
 418         Log.wrn("Update Ppis", "Incorrect data type for Ppi/PpiNotify Name");
 419         return false;
 420       }
 421     }
 422
 423     //
 424     // Check FeatureFlag
 425     //
 426     if (!isEmpty(this.jTextFieldFeatureFlag.getText())) {
 427       if (!DataValidation.isFeatureFlag(this.jTextFieldFeatureFlag.getText())) {
 428         Log.wrn("Update Ppis", "Incorrect data type for Feature Flag");
 429         return false;
 430       }
 431     }
 432
 433     return true;
 434   }
 435
 436 private PpisIdentification getCurrentPpis() {
 437         String arg0 = this.jComboBoxCName.getSelectedItem().toString();
 438         String arg1 = this.jComboBoxPpiType.getSelectedItem().toString();
 439         String arg2 = this.jComboBoxUsage.getSelectedItem().toString();
 440
 441         String arg3 = this.jTextFieldFeatureFlag.getText();
 442         Vector<String> arg4 = this.jArchCheckBox.getSelectedItemsVector();
 443         String arg5 = this.jTextAreaHelpText.getText();
 444
 445         id = new PpisIdentification(arg0, arg1, arg2, arg3, arg4, arg5);
 446         return id;
 447     }  /*
 448          * (non-Javadoc)
 449          *
 450          * @see java.awt.event.ItemListener#itemStateChanged(java.awt.event.ItemEvent)
 451          *
 452          * Reflesh the frame when selected item changed
 453          *
 454          */
 455   public void itemStateChanged(ItemEvent arg0) {
 456     if (arg0.getSource() == this.jComboBoxPpiType
 457         && arg0.getStateChange() == ItemEvent.SELECTED) {
 458       if (this.jComboBoxPpiType.getSelectedItem().toString().equals(
 459           ed.getVPpiType().get(0))) {
 460         Tools.generateComboBoxByVector(this.jComboBoxUsage, ed.getVPpiUsage());
 461       } else {
 462         Tools.generateComboBoxByVector(this.jComboBoxUsage, ed
 463             .getVPpiNotifyUsage());
 464       }
 465     }
 466   }
 467
 468   public PpisIdentification getId() {
 469     return id;
 470   }
 471
 472   public void setId(PpisIdentification id) {
 473     this.id = id;
 474   }
 475 }