]> git.proxmox.com Git - mirror_edk2.git/blobdiff - Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/SystemTablesDlg.java
1. Change ToolCode from text field to drop down list, and user can enter their custom...
[mirror_edk2.git] / Tools / Source / FrameworkWizard / src / org / tianocore / frameworkwizard / module / ui / dialog / SystemTablesDlg.java
index d866e01cd9283c06f3a18bbfd214c6a2eb5b636d..f2b92ba7ef7f743246cae73c243ed683169cabd4 100644 (file)
@@ -1,6 +1,7 @@
 /** @file\r
-\r
- The file is used to create, update SystemTable of MSA/MBD file\r
+ <<The file is used to create, update SystemTable in the MSA file>>\r
\r
+ <<This dialog is used to add or edit a System Table entry in the MSA file.>>\r
  \r
  Copyright (c) 2006, Intel Corporation\r
  All rights reserved. This program and the accompanying materials\r
@@ -23,6 +24,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
@@ -37,21 +39,21 @@ import org.tianocore.frameworkwizard.module.Identifications.SystemTables.SystemT
 import org.tianocore.frameworkwizard.workspace.WorkspaceTools;\r
 \r
 /**\r
- The class is used to create, update SystemTable of MSA/MBD file\r
It extends IInternalFrame\r
\r
-\r
-\r
- **/\r
+ * The class is used to create, update SystemTable of MSA/MBD file It extends\r
* IInternalFrame\r
+ * \r
+ * \r
+ * \r
+ */\r
 public class SystemTablesDlg extends IDialog {\r
 \r
-    ///\r
-    /// Define class Serial Version UID\r
-    ///\r
+    // /\r
+    // / Define class Serial Version UID\r
+    // /\r
     private static final long serialVersionUID = 7488769180379442276L;\r
 \r
     //\r
-    //Define class members\r
+    // Define class members\r
     //\r
     private JPanel jContentPane = null;\r
 \r
@@ -77,7 +79,9 @@ public class SystemTablesDlg extends IDialog {
 \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
@@ -95,54 +99,62 @@ public class SystemTablesDlg extends IDialog {
     private WorkspaceTools wt = new WorkspaceTools();\r
 \r
     /**\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, 35, 320, 20));\r
-            jComboBoxUsage.setPreferredSize(new java.awt.Dimension(320, 20));\r
-        }\r
-        return jComboBoxUsage;\r
-    }\r
-\r
-    /**\r
-     This method initializes jTextField \r
-     \r
-     @return javax.swing.JTextField jTextFieldC_Name\r
-     \r
-     **/\r
+     * This method initializes jComboBoxGuidC_Name\r
+     * \r
+     * @return javax.swing.JComboBox jComboBoxGuidC_Name\r
+     * \r
+     */\r
     private JComboBox getJComboBoxGuidC_Name() {\r
         if (jComboBoxGuidC_Name == null) {\r
             jComboBoxGuidC_Name = new JComboBox();\r
             jComboBoxGuidC_Name.setBounds(new java.awt.Rectangle(160, 10, 320, 20));\r
             jComboBoxGuidC_Name.setPreferredSize(new java.awt.Dimension(320, 20));\r
-            jComboBoxGuidC_Name.setToolTipText("Select the GUID C Name of the Hob");\r
+            jComboBoxGuidC_Name.setToolTipText("Select the GUID C Name of the System Table");\r
         }\r
         return jComboBoxGuidC_Name;\r
     }\r
 \r
     /**\r
-     * This method initializes jTextFieldFeatureFlag   \r
-     *         \r
-     * @return javax.swing.JTextField  \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, 35, 320, 20));\r
+            jComboBoxUsage.setPreferredSize(new java.awt.Dimension(320, 20));\r
+            jComboBoxUsage\r
+                          .setToolTipText("<html><table>"\r
+                                          + "<tr><td>ALWAYS_CONSUMED</td><td>Module requires a GUIDed entry in the system table</td></tr>"\r
+                                          + "<tr><td>SOMETIMES_CONSUMED</td><td>Module consumes a GUIDed entry in the system<br>table if it is present</td>"\r
+                                          + "</tr><tr><td>ALWAYS_PRODUCED</td><td>Module always produces a GUIDed entry in the system table</td></tr>"\r
+                                          + "<tr><td>SOMETIMES_PRODUCED</td><td>Module produces a GUIDed entry in the system table<br>for some of its execution flows.</td></tr>"\r
+                                          + "</table></html>");\r
+        }\r
+        return jComboBoxUsage;\r
+    }\r
+\r
+    /**\r
+     * This method initializes jTextFieldFeatureFlag\r
+     * \r
+     * @return javax.swing.JTextField\r
      */\r
     private JTextField getJTextFieldFeatureFlag() {\r
         if (jTextFieldFeatureFlag == null) {\r
             jTextFieldFeatureFlag = new JTextField();\r
-            jTextFieldFeatureFlag.setBounds(new java.awt.Rectangle(160, 85, 320, 20));\r
+            jTextFieldFeatureFlag.setBounds(new java.awt.Rectangle(160, 105, 320, 20));\r
             jTextFieldFeatureFlag.setPreferredSize(new java.awt.Dimension(320, 20));\r
+            jTextFieldFeatureFlag.setToolTipText("Postfix expression that must evaluate to TRUE or FALSE");\r
         }\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
@@ -153,30 +165,47 @@ public class SystemTablesDlg extends IDialog {
     }\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, 60, 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
+     * @returns javax.swing.JScrollPane jScrollPaneHelpText\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(160, 60));\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, 140, 90, 20));\r
+            jButtonOk.setBounds(new java.awt.Rectangle(290, 157, 90, 20));\r
             jButtonOk.setText("Ok");\r
             jButtonOk.addActionListener(this);\r
         }\r
@@ -184,15 +213,15 @@ public class SystemTablesDlg extends IDialog {
     }\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, 140, 90, 20));\r
+            jButtonCancel.setBounds(new java.awt.Rectangle(390, 157, 90, 20));\r
             jButtonCancel.setText("Cancel");\r
             jButtonCancel.addActionListener(this);\r
         }\r
@@ -204,11 +233,11 @@ public class SystemTablesDlg extends IDialog {
     }\r
 \r
     /**\r
-     This method initializes this\r
-     \r
-     **/\r
+     This method initializes this\r
+     * \r
+     */\r
     private void init() {\r
-        this.setSize(500, 200);\r
+        this.setSize(500, 230);\r
         this.setContentPane(getJScrollPane());\r
         this.setTitle("System Tables");\r
         initFrame();\r
@@ -217,12 +246,12 @@ public class SystemTablesDlg extends IDialog {
     }\r
 \r
     /**\r
-     This method initializes this\r
-     Fill values to all fields if these values are not empty\r
-     \r
-     @param inSystemTablesId\r
-\r
-     **/\r
+     * This method initializes this Fill values to all fields if these values are\r
+     * not empty\r
+     * \r
+     @param inSystemTablesId\r
+     * \r
+     */\r
     private void init(SystemTablesIdentification inSystemTablesId) {\r
         init();\r
         this.id = inSystemTablesId;\r
@@ -230,30 +259,31 @@ public class SystemTablesDlg extends IDialog {
         if (this.id != null) {\r
             this.jComboBoxGuidC_Name.setSelectedItem(id.getName());\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 inBootModesIdentification\r
-     @param iFrame\r
-     \r
-     **/\r
+     This is the override edit constructor\r
+     * \r
+     @param inBootModesIdentification\r
+     @param iFrame\r
+     * \r
+     */\r
     public SystemTablesDlg(SystemTablesIdentification inSystemTablesIdentification, IFrame iFrame) {\r
         super(iFrame, true);\r
         init(inSystemTablesIdentification);\r
     }\r
 \r
     /**\r
-     Disable all components when the mode is view\r
-     \r
-     @param isView true - The view mode; false - The non-view mode\r
-     \r
-     **/\r
+     * Disable all components when the mode is view\r
+     * \r
+     * @param isView\r
+     *          true - The view mode; false - The non-view mode\r
+     * \r
+     */\r
     public void setViewMode(boolean isView) {\r
         if (isView) {\r
             this.jComboBoxUsage.setEnabled(!isView);\r
@@ -261,35 +291,39 @@ public class SystemTablesDlg extends IDialog {
     }\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
-            jLabelArch = new JLabel();\r
-            jLabelArch.setBounds(new java.awt.Rectangle(15, 110, 140, 20));\r
-            jLabelArch.setText("Arch");\r
-            jArchCheckBox = new ArchCheckBox();\r
-            jArchCheckBox.setBounds(new java.awt.Rectangle(160, 110, 320, 20));\r
-            jArchCheckBox.setPreferredSize(new java.awt.Dimension(320, 20));\r
-            jLabelFeatureFlag = new JLabel();\r
-            jLabelFeatureFlag.setBounds(new java.awt.Rectangle(15, 85, 140, 20));\r
-            jLabelFeatureFlag.setText("Feature Flag");\r
+            jStarLabel1 = new StarLabel();\r
+            jStarLabel1.setLocation(new java.awt.Point(2, 10));\r
+            jLabelEntry = new JLabel();\r
+            jLabelEntry.setText("Table's GUID C Name");\r
+            jLabelEntry.setBounds(new java.awt.Rectangle(15, 10, 145, 20));\r
+            jStarLabel2 = new StarLabel();\r
+            jStarLabel2.setLocation(new java.awt.Point(2, 35));\r
             jLabelUsage = new JLabel();\r
             jLabelUsage.setText("Usage");\r
-            jLabelUsage.setBounds(new java.awt.Rectangle(15, 35, 140, 20));\r
-            jLabelEntry = new JLabel();\r
-            jLabelEntry.setText("Guid C_Name");\r
-            jLabelEntry.setBounds(new java.awt.Rectangle(15, 10, 140, 20));\r
+            jLabelUsage.setBounds(new java.awt.Rectangle(15, 35, 145, 20));\r
             jLabelHelpText = new JLabel();\r
-            jLabelHelpText.setBounds(new java.awt.Rectangle(14, 60, 140, 20));\r
+            jLabelHelpText.setBounds(new java.awt.Rectangle(14, 60, 145, 20));\r
             jLabelHelpText.setText("Help Text");\r
+            jLabelFeatureFlag = new JLabel();\r
+            jLabelFeatureFlag.setBounds(new java.awt.Rectangle(15, 105, 140, 20));\r
+            jLabelFeatureFlag.setText("Feature Flag Expression");\r
+            jLabelArch = new JLabel();\r
+            jLabelArch.setBounds(new java.awt.Rectangle(15, 130, 145, 20));\r
+            jLabelArch.setText("Supported Architectures");\r
+            jArchCheckBox = new ArchCheckBox();\r
+            jArchCheckBox.setBounds(new java.awt.Rectangle(160, 130, 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, 165));\r
+            jContentPane.setPreferredSize(new java.awt.Dimension(485, 185));\r
 \r
             jContentPane.add(jLabelEntry, null);\r
             jContentPane.add(jLabelFeatureFlag, null);\r
@@ -298,16 +332,12 @@ public class SystemTablesDlg extends IDialog {
             jContentPane.add(jLabelArch, null);\r
             jContentPane.add(jLabelUsage, null);\r
             jContentPane.add(getJComboBoxUsage(), 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(jLabelHelpText, null);\r
-            jContentPane.add(getJTextFieldHelpText(), null);\r
+            jContentPane.add(getJScrollPaneHelpText(), null);\r
             jContentPane.add(jArchCheckBox, null);\r
             jContentPane.add(getJButtonOk(), null);\r
             jContentPane.add(getJButtonCancel(), null);\r
@@ -316,19 +346,21 @@ public class SystemTablesDlg extends IDialog {
     }\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(jComboBoxUsage, ed.getVSystemTableUsage());\r
         Tools.generateComboBoxByVector(jComboBoxGuidC_Name, wt.getAllGuidDeclarationsFromWorkspace());\r
     }\r
 \r
-    /* (non-Javadoc)\r
+    /*\r
+     * (non-Javadoc)\r
+     * \r
      * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)\r
-     *\r
-     *  Override actionPerformed to listen all actions\r
-     *  \r
+     * \r
+     * Override actionPerformed to listen all actions\r
+     * \r
      */\r
     public void actionPerformed(ActionEvent arg0) {\r
         if (arg0.getSource() == jButtonOk) {\r
@@ -346,15 +378,15 @@ public class SystemTablesDlg extends IDialog {
     }\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
@@ -362,7 +394,7 @@ public class SystemTablesDlg extends IDialog {
         //\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 System Tables", "Incorrect data type for Feature Flag");\r
                 return false;\r
             }\r
         }\r
@@ -376,7 +408,7 @@ public class SystemTablesDlg extends IDialog {
 \r
         String arg2 = this.jTextFieldFeatureFlag.getText();\r
         Vector<String> arg3 = this.jArchCheckBox.getSelectedItemsVector();\r
-        String arg4 = this.jTextFieldHelpText.getText();\r
+        String arg4 = this.jTextAreaHelpText.getText();\r
 \r
         id = new SystemTablesIdentification(arg0, arg1, arg2, arg3, arg4);\r
         return id;\r