]> git.proxmox.com Git - mirror_edk2.git/blobdiff - Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/PpisDlg.java
Fixed grammar in messages.
[mirror_edk2.git] / Tools / Source / FrameworkWizard / src / org / tianocore / frameworkwizard / module / ui / dialog / PpisDlg.java
index f7f50017ff630571f5684c8fc21759543c7b724e..77d64f4f49c6a29e3f250a08a71b46d13753584e 100644 (file)
@@ -1,6 +1,6 @@
 /** @file\r
  \r
- The file is used to create, update Ppi of MSA/MBD file\r
+ The file is used to create, update Ppi section of the MSA file\r
  \r
  Copyright (c) 2006, Intel Corporation\r
  All rights reserved. This program and the accompanying materials\r
@@ -25,6 +25,7 @@ import javax.swing.JLabel;
 import javax.swing.JPanel;\r
 import javax.swing.JScrollPane;\r
 import javax.swing.JTextField;\r
+import javax.swing.JTextArea;\r
 \r
 import org.tianocore.frameworkwizard.common.DataType;\r
 import org.tianocore.frameworkwizard.common.DataValidation;\r
@@ -39,19 +40,20 @@ import org.tianocore.frameworkwizard.module.Identifications.Ppis.PpisIdentificat
 import org.tianocore.frameworkwizard.workspace.WorkspaceTools;\r
 \r
 /**\r
- The class is used to create, update Ppi of MSA/MBD file\r
- It extends IInternalFrame\r
\r
- **/\r
+ * The class is used to create, update Ppi section of the MSA file\r
+ * \r
+ * It extends IDialog\r
+ * \r
+ */\r
 public class PpisDlg extends IDialog implements ItemListener {\r
 \r
-    ///\r
-    /// Define class Serial Version UID\r
-    ///\r
+    // /\r
+    // / Define class Serial Version UID\r
+    // /\r
     private static final long serialVersionUID = -4284901202357037724L;\r
 \r
     //\r
-    //Define class members\r
+    // Define class members\r
     //\r
     private JPanel jContentPane = null;\r
 \r
@@ -73,6 +75,8 @@ public class PpisDlg extends IDialog implements ItemListener {
 \r
     private StarLabel jStarLabel2 = null;\r
 \r
+    private StarLabel jStarLabel3 = null;\r
+\r
     private JComboBox jComboBoxPpiType = null;\r
 \r
     private JLabel jLabelArch = null;\r
@@ -81,7 +85,9 @@ public class PpisDlg extends IDialog implements ItemListener {
 \r
     private JLabel jLabelHelpText = null;\r
 \r
-    private JTextField jTextFieldHelpText = null;\r
+    private JTextArea jTextAreaHelpText = null;\r
+\r
+    private JScrollPane jScrollPaneHelpText = null;\r
 \r
     private ArchCheckBox jArchCheckBox = null;\r
 \r
@@ -99,69 +105,76 @@ public class PpisDlg extends IDialog implements ItemListener {
     private EnumerationData ed = new EnumerationData();\r
 \r
     /**\r
-     This method initializes jTextFieldC_Name \r
-     \r
-     @return javax.swing.JTextField jTextFieldC_Name\r
-     \r
-     **/\r
+     * This method initializes jComboBoxPpiType\r
+     * \r
+     * @return javax.swing.JComboBox\r
+     */\r
+    private JComboBox getJComboBoxPpiType() {\r
+        if (jComboBoxPpiType == null) {\r
+            jComboBoxPpiType = new JComboBox();\r
+            jComboBoxPpiType.setBounds(new java.awt.Rectangle(168, 12, 320, 20));\r
+            jComboBoxPpiType.setPreferredSize(new java.awt.Dimension(320, 20));\r
+            jComboBoxPpiType.addItemListener(this);\r
+            jComboBoxPpiType\r
+                            .setToolTipText("<html>PPIs are named by GUID.<br>PPI Notify is consumed via a register PPI Notify mechanism");\r
+        }\r
+        return jComboBoxPpiType;\r
+    }\r
+\r
+    /**\r
+     * This method initializes jTextFieldC_Name\r
+     * \r
+     * @return javax.swing.JTextField jTextFieldC_Name\r
+     * \r
+     */\r
     private JComboBox getJComboBoxCName() {\r
         if (jComboBoxCName == null) {\r
             jComboBoxCName = new JComboBox();\r
-            jComboBoxCName.setBounds(new java.awt.Rectangle(160, 35, 320, 20));\r
+            jComboBoxCName.setBounds(new java.awt.Rectangle(168, 37, 320, 20));\r
             jComboBoxCName.setPreferredSize(new java.awt.Dimension(320, 20));\r
+            jComboBoxCName.setToolTipText("Select Guid C Name of PPI");\r
         }\r
         return jComboBoxCName;\r
     }\r
 \r
     /**\r
-     This method initializes jTextFieldFeatureFlag \r
-     \r
-     @return javax.swing.JTextField jTextFieldFeatureFlag\r
-     \r
-     **/\r
-    private JTextField getJTextFieldFeatureFlag() {\r
-        if (jTextFieldFeatureFlag == null) {\r
-            jTextFieldFeatureFlag = new JTextField();\r
-            jTextFieldFeatureFlag.setBounds(new java.awt.Rectangle(160, 110, 320, 20));\r
-            jTextFieldFeatureFlag.setPreferredSize(new java.awt.Dimension(320, 20));\r
-        }\r
-        return jTextFieldFeatureFlag;\r
-    }\r
-\r
-    /**\r
-     This method initializes jComboBox\r
-     \r
-     @return javax.swing.JComboBox jComboBoxUsage\r
-     \r
-     **/\r
-    private JComboBox getJComboBox() {\r
+     * This method initializes jComboBoxUsage\r
+     * \r
+     * @return javax.swing.JComboBox jComboBoxUsage\r
+     * \r
+     */\r
+    private JComboBox getJComboBoxUsage() {\r
         if (jComboBoxUsage == null) {\r
             jComboBoxUsage = new JComboBox();\r
-            jComboBoxUsage.setBounds(new java.awt.Rectangle(160, 60, 320, 20));\r
+            jComboBoxUsage.setBounds(new java.awt.Rectangle(168, 62, 320, 20));\r
             jComboBoxUsage.setPreferredSize(new java.awt.Dimension(320, 20));\r
+            jComboBoxUsage\r
+                          .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>");\r
         }\r
         return jComboBoxUsage;\r
     }\r
 \r
     /**\r
-     * This method initializes jComboBoxPpiType        \r
-     *         \r
-     * @return javax.swing.JComboBox   \r
+     * This method initializes jTextFieldFeatureFlag\r
+     * \r
+     * @return javax.swing.JTextField jTextFieldFeatureFlag\r
+     * \r
      */\r
-    private JComboBox getJComboBoxPpiType() {\r
-        if (jComboBoxPpiType == null) {\r
-            jComboBoxPpiType = new JComboBox();\r
-            jComboBoxPpiType.setBounds(new java.awt.Rectangle(160, 10, 320, 20));\r
-            jComboBoxPpiType.setPreferredSize(new java.awt.Dimension(320, 20));\r
-            jComboBoxPpiType.addItemListener(this);\r
+    private JTextField getJTextFieldFeatureFlag() {\r
+        if (jTextFieldFeatureFlag == null) {\r
+            jTextFieldFeatureFlag = new JTextField();\r
+            jTextFieldFeatureFlag.setBounds(new java.awt.Rectangle(168, 157, 320, 20));\r
+            jTextFieldFeatureFlag.setPreferredSize(new java.awt.Dimension(320, 20));\r
+            jTextFieldFeatureFlag.setToolTipText("Postfix expression that must evaluate to TRUE or FALSE");\r
+            jTextFieldFeatureFlag.setEnabled(false);\r
         }\r
-        return jComboBoxPpiType;\r
+        return jTextFieldFeatureFlag;\r
     }\r
 \r
     /**\r
-     This method initializes jScrollPane  \r
-     \r
-     @return javax.swing.JScrollPane  \r
+     * This method initializes jScrollPane\r
+     * \r
+     * @return javax.swing.JScrollPane\r
      */\r
     private JScrollPane getJScrollPane() {\r
         if (jScrollPane == null) {\r
@@ -172,30 +185,48 @@ public class PpisDlg extends IDialog implements ItemListener {
     }\r
 \r
     /**\r
-     This method initializes jTextFieldHelpText  \r
-     \r
-     @return javax.swing.JTextField  \r
-     \r
-     **/\r
-    private JTextField getJTextFieldHelpText() {\r
-        if (jTextFieldHelpText == null) {\r
-            jTextFieldHelpText = new JTextField();\r
-            jTextFieldHelpText.setBounds(new java.awt.Rectangle(160, 85, 320, 20));\r
-            jTextFieldHelpText.setPreferredSize(new java.awt.Dimension(320, 20));\r
+     * This method initializes jTextAreaHelpText\r
+     * \r
+     * @return javax.swing.JTextArea\r
+     * \r
+     */\r
+    private JTextArea getJTextAreaHelpText() {\r
+        if (jTextAreaHelpText == null) {\r
+            jTextAreaHelpText = new JTextArea();\r
+            jTextAreaHelpText.setLineWrap(true);\r
+            jTextAreaHelpText.setWrapStyleWord(true);\r
         }\r
-        return jTextFieldHelpText;\r
+        return jTextAreaHelpText;\r
     }\r
 \r
     /**\r
-     This method initializes jButtonOk    \r
-     \r
-     @return javax.swing.JButton  \r
-     \r
-     **/\r
+     * This method initializes jScrollPaneHelpText\r
+     * \r
+     * @return javax.swing.JScrollPane\r
+     * \r
+     */\r
+    private JScrollPane getJScrollPaneHelpText() {\r
+        if (jScrollPaneHelpText == null) {\r
+            jScrollPaneHelpText = new JScrollPane();\r
+            jScrollPaneHelpText.setHorizontalScrollBarPolicy(javax.swing.JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);\r
+            jScrollPaneHelpText.setSize(new java.awt.Dimension(320, 40));\r
+            jScrollPaneHelpText.setPreferredSize(new java.awt.Dimension(320, 40));\r
+            jScrollPaneHelpText.setLocation(new java.awt.Point(168, 87));\r
+            jScrollPaneHelpText.setViewportView(getJTextAreaHelpText());\r
+        }\r
+        return jScrollPaneHelpText;\r
+    }\r
+\r
+    /**\r
+     * This method initializes jButtonOk\r
+     * \r
+     * @return javax.swing.JButton\r
+     * \r
+     */\r
     private JButton getJButtonOk() {\r
         if (jButtonOk == null) {\r
             jButtonOk = new JButton();\r
-            jButtonOk.setBounds(new java.awt.Rectangle(290, 165, 90, 20));\r
+            jButtonOk.setBounds(new java.awt.Rectangle(290, 187, 90, 20));\r
             jButtonOk.setText("Ok");\r
             jButtonOk.addActionListener(this);\r
         }\r
@@ -203,15 +234,15 @@ public class PpisDlg extends IDialog implements ItemListener {
     }\r
 \r
     /**\r
-     This method initializes jButtonCancel    \r
-     \r
-     @return javax.swing.JButton  \r
-     \r
-     **/\r
+     * This method initializes jButtonCancel\r
+     * \r
+     * @return javax.swing.JButton\r
+     * \r
+     */\r
     private JButton getJButtonCancel() {\r
         if (jButtonCancel == null) {\r
             jButtonCancel = new JButton();\r
-            jButtonCancel.setBounds(new java.awt.Rectangle(390, 165, 90, 20));\r
+            jButtonCancel.setBounds(new java.awt.Rectangle(390, 187, 90, 20));\r
             jButtonCancel.setText("Cancel");\r
             jButtonCancel.addActionListener(this);\r
         }\r
@@ -223,24 +254,24 @@ public class PpisDlg extends IDialog implements ItemListener {
     }\r
 \r
     /**\r
-     This method initializes this\r
-     \r
-     **/\r
+     This method initializes this\r
+     * \r
+     */\r
     private void init() {\r
-        this.setSize(500, 225);\r
+        this.setSize(505, 260);\r
         this.setContentPane(getJScrollPane());\r
-        this.setTitle("Ppis");\r
+        this.setTitle("PPI Definitions");\r
         initFrame();\r
         this.centerWindow();\r
     }\r
 \r
     /**\r
-     This method initializes this\r
-     Fill values to all fields if these values are not empty\r
-     \r
-     @param inProtocolsId\r
-\r
-     **/\r
+     * This method initializes this Fill values to all fields if these values are\r
+     * not empty\r
+     * \r
+     @param inProtocolsId\r
+     * \r
+     */\r
     private void init(PpisIdentification inPpisId) {\r
         init();\r
         this.id = inPpisId;\r
@@ -249,77 +280,84 @@ public class PpisDlg extends IDialog implements ItemListener {
             this.jComboBoxCName.setSelectedItem(id.getName());\r
             this.jComboBoxPpiType.setSelectedItem(id.getType());\r
             this.jComboBoxUsage.setSelectedItem(id.getUsage());\r
-            this.jTextFieldHelpText.setText(id.getHelp());\r
+            this.jTextAreaHelpText.setText(id.getHelp());\r
             this.jTextFieldFeatureFlag.setText(id.getFeatureFlag());\r
             this.jArchCheckBox.setSelectedItems(id.getSupArchList());\r
         }\r
     }\r
 \r
     /**\r
-     This is the override edit constructor\r
-     \r
-     @param inProtocolsIdentification\r
-     @param iFrame\r
-     \r
-     **/\r
+     This is the override edit constructor\r
+     * \r
+     @param inProtocolsIdentification\r
+     @param iFrame\r
+     * \r
+     */\r
     public PpisDlg(PpisIdentification inPpisIdentification, IFrame iFrame) {\r
         super(iFrame, true);\r
         init(inPpisIdentification);\r
     }\r
 \r
     /**\r
-     This method initializes jContentPane\r
-     \r
-     @return javax.swing.JPanel jContentPane\r
-     \r
-     **/\r
+     This method initializes jContentPane\r
+     * \r
+     @return javax.swing.JPanel jContentPane\r
+     * \r
+     */\r
     private JPanel getJContentPane() {\r
         if (jContentPane == null) {\r
-            jArchCheckBox = new ArchCheckBox();\r
-            jArchCheckBox.setBounds(new java.awt.Rectangle(160, 135, 320, 20));\r
-            jArchCheckBox.setPreferredSize(new java.awt.Dimension(320, 20));\r
-            jLabelArch = new JLabel();\r
-            jLabelArch.setBounds(new java.awt.Rectangle(15, 135, 140, 20));\r
-            jLabelArch.setText("Arch");\r
+            jStarLabel1 = new StarLabel();\r
+            jStarLabel1.setLocation(new java.awt.Point(2, 12));\r
             jLabelPpiType = new JLabel();\r
-            jLabelPpiType.setBounds(new java.awt.Rectangle(15, 10, 140, 20));\r
-            jLabelPpiType.setText("Ppi Type");\r
+            jLabelPpiType.setBounds(new java.awt.Rectangle(12, 12, 168, 20));\r
+            jLabelPpiType.setText("Select Ppi Type");\r
+\r
+            jStarLabel2 = new StarLabel();\r
+            jStarLabel2.setLocation(new java.awt.Point(2, 37));\r
+            jLabelC_Name = new JLabel();\r
+            jLabelC_Name.setText("PPI GUID C Name");\r
+            jLabelC_Name.setBounds(new java.awt.Rectangle(12, 37, 168, 20));\r
+\r
+            jStarLabel3 = new StarLabel();\r
+            jStarLabel3.setLocation(new java.awt.Point(2, 62));\r
             jLabelUsage = new JLabel();\r
             jLabelUsage.setText("Usage");\r
-            jLabelUsage.setBounds(new java.awt.Rectangle(15, 60, 140, 20));\r
-            jLabelFeatureFlag = new JLabel();\r
-            jLabelFeatureFlag.setText("Feature Flag");\r
-            jLabelFeatureFlag.setBounds(new java.awt.Rectangle(15, 110, 140, 20));\r
-            jLabelC_Name = new JLabel();\r
-            jLabelC_Name.setText("C_Name Type");\r
-            jLabelC_Name.setBounds(new java.awt.Rectangle(15, 35, 140, 20));\r
+            jLabelUsage.setBounds(new java.awt.Rectangle(12, 62, 168, 20));\r
+\r
             jLabelHelpText = new JLabel();\r
-            jLabelHelpText.setBounds(new java.awt.Rectangle(14, 85, 140, 20));\r
+            jLabelHelpText.setBounds(new java.awt.Rectangle(14, 87, 168, 20));\r
             jLabelHelpText.setText("Help Text");\r
 \r
+            jLabelFeatureFlag = new JLabel();\r
+            jLabelFeatureFlag.setText("Feature Flag Expression");\r
+            jLabelFeatureFlag.setBounds(new java.awt.Rectangle(12, 157, 168, 20));\r
+            jLabelFeatureFlag.setEnabled(false);\r
+\r
+            jLabelArch = new JLabel();\r
+            jLabelArch.setBounds(new java.awt.Rectangle(12, 132, 168, 20));\r
+            jLabelArch.setText("Supported Architectures");\r
+            jArchCheckBox = new ArchCheckBox();\r
+            jArchCheckBox.setBounds(new java.awt.Rectangle(168, 132, 320, 20));\r
+            jArchCheckBox.setPreferredSize(new java.awt.Dimension(320, 20));\r
+\r
             jContentPane = new JPanel();\r
             jContentPane.setLayout(null);\r
-            jContentPane.setPreferredSize(new java.awt.Dimension(490, 190));\r
+            jContentPane.setPreferredSize(new java.awt.Dimension(485, 215));\r
 \r
+            jContentPane.add(jStarLabel1, null);\r
+            jContentPane.add(jLabelPpiType, null);\r
+            jContentPane.add(getJComboBoxPpiType(), null);\r
+            jContentPane.add(jStarLabel2, null);\r
             jContentPane.add(jLabelC_Name, null);\r
             jContentPane.add(getJComboBoxCName(), null);\r
-            jContentPane.add(getJTextFieldFeatureFlag(), null);\r
-            jContentPane.add(jLabelFeatureFlag, null);\r
+            jContentPane.add(jStarLabel3, null);\r
             jContentPane.add(jLabelUsage, null);\r
-            jContentPane.add(getJComboBox(), null);\r
-            jContentPane.add(getJComboBoxPpiType(), null);\r
-            jContentPane.add(jLabelArch, null);\r
-            jContentPane.add(jLabelPpiType, null);\r
-            jStarLabel1 = new StarLabel();\r
-            jStarLabel1.setBounds(new java.awt.Rectangle(0, 10, 10, 20));\r
-            jStarLabel2 = new StarLabel();\r
-            jStarLabel2.setBounds(new java.awt.Rectangle(0, 35, 10, 20));\r
-\r
-            jContentPane.add(jStarLabel1, null);\r
-            jContentPane.add(jStarLabel2, null);\r
-\r
+            jContentPane.add(getJComboBoxUsage(), null);\r
             jContentPane.add(jLabelHelpText, null);\r
-            jContentPane.add(getJTextFieldHelpText(), null);\r
+            jContentPane.add(getJScrollPaneHelpText(), null);\r
+            jContentPane.add(jLabelFeatureFlag, null);\r
+            jContentPane.add(getJTextFieldFeatureFlag(), null);\r
+            jContentPane.add(jLabelArch, null);\r
             jContentPane.add(jArchCheckBox, null);\r
             jContentPane.add(getJButtonOk(), null);\r
             jContentPane.add(getJButtonCancel(), null);\r
@@ -328,18 +366,20 @@ public class PpisDlg extends IDialog implements ItemListener {
     }\r
 \r
     /**\r
-     This method initializes Usage type\r
-     \r
-     **/\r
+     This method initializes Usage type\r
+     * \r
+     */\r
     private void initFrame() {\r
         Tools.generateComboBoxByVector(jComboBoxCName, wt.getAllPpiDeclarationsFromWorkspace());\r
         Tools.generateComboBoxByVector(jComboBoxPpiType, ed.getVPpiType());\r
         Tools.generateComboBoxByVector(jComboBoxUsage, ed.getVPpiUsage());\r
     }\r
 \r
-    /* (non-Javadoc)\r
+    /*\r
+     * (non-Javadoc)\r
+     * \r
      * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)\r
-     *\r
+     * \r
      * Override actionPerformed to listen all actions\r
      * \r
      */\r
@@ -359,23 +399,23 @@ public class PpisDlg extends IDialog implements ItemListener {
     }\r
 \r
     /**\r
-     Data validation for all fields\r
-     \r
-     @retval true - All datas are valid\r
-     @retval false - At least one data is invalid\r
-     \r
-     **/\r
+     Data validation for all fields\r
+     * \r
+     @retval true - All datas are valid\r
+     @retval false - At least one data is invalid\r
+     * \r
+     */\r
     public boolean checkAdd() {\r
         //\r
-        // Check if all fields have correct data types \r
+        // Check if all fields have correct data types\r
         //\r
 \r
         //\r
-        // Check Name \r
+        // Check Name\r
         //\r
         if (!isEmpty(this.jComboBoxCName.getSelectedItem().toString())) {\r
             if (!DataValidation.isC_NameType(this.jComboBoxCName.getSelectedItem().toString())) {\r
-                Log.err("Incorrect data type for Ppi/PpiNotify Name");\r
+                Log.wrn("Update Ppis", "Incorrect data type for Ppi/PpiNotify Name");\r
                 return false;\r
             }\r
         }\r
@@ -385,7 +425,7 @@ public class PpisDlg extends IDialog implements ItemListener {
         //\r
         if (!isEmpty(this.jTextFieldFeatureFlag.getText())) {\r
             if (!DataValidation.isFeatureFlag(this.jTextFieldFeatureFlag.getText())) {\r
-                Log.err("Incorrect data type for Feature Flag");\r
+                Log.wrn("Update Ppis", "Incorrect data type for Feature Flag");\r
                 return false;\r
             }\r
         }\r
@@ -400,18 +440,19 @@ public class PpisDlg extends IDialog implements ItemListener {
 \r
         String arg3 = this.jTextFieldFeatureFlag.getText();\r
         Vector<String> arg4 = this.jArchCheckBox.getSelectedItemsVector();\r
-        String arg5 = this.jTextFieldHelpText.getText();\r
+        String arg5 = this.jTextAreaHelpText.getText();\r
 \r
         id = new PpisIdentification(arg0, arg1, arg2, arg3, arg4, arg5);\r
         return id;\r
-    }\r
-\r
-    /* (non-Javadoc)\r
+    } /*\r
+     * (non-Javadoc)\r
+     * \r
      * @see java.awt.event.ItemListener#itemStateChanged(java.awt.event.ItemEvent)\r
-     *\r
+     * \r
      * Reflesh the frame when selected item changed\r
      * \r
      */\r
+\r
     public void itemStateChanged(ItemEvent arg0) {\r
         if (arg0.getSource() == this.jComboBoxPpiType && arg0.getStateChange() == ItemEvent.SELECTED) {\r
             if (this.jComboBoxPpiType.getSelectedItem().toString().equals(ed.getVPpiType().get(0))) {\r