]> git.proxmox.com Git - mirror_edk2.git/blobdiff - Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/VariablesDlg.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 / VariablesDlg.java
index 4394112bbe681f7e78b7159c906df107f20cd893..0761d30693f5b3ad6d512c8f22d53329746296e7 100644 (file)
@@ -24,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
@@ -38,19 +39,19 @@ import org.tianocore.frameworkwizard.module.Identifications.Variables.VariablesI
 import org.tianocore.frameworkwizard.workspace.WorkspaceTools;\r
 \r
 /**\r
- The class is used to create, update Variable of MSA/MBD file\r
- It extends IInternalFrame\r
\r
- **/\r
+ * The class is used to create, update Variable of MSA/MBD file It extends\r
+ * IDialog\r
+ * \r
+ */\r
 public class VariablesDlg 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 = -6998982978030439446L;\r
 \r
     //\r
-    //Define class members\r
+    // Define class members\r
     //\r
     private JPanel jContentPane = null;\r
 \r
@@ -66,6 +67,8 @@ public class VariablesDlg extends IDialog {
 \r
     private StarLabel jStarLabel2 = null;\r
 \r
+    private StarLabel jStarLabel3 = null;\r
+\r
     private JScrollPane jScrollPane = null;\r
 \r
     private JLabel jLabelGuidCName = null;\r
@@ -80,7 +83,9 @@ public class VariablesDlg 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
@@ -98,11 +103,11 @@ public class VariablesDlg extends IDialog {
     private WorkspaceTools wt = new WorkspaceTools();\r
 \r
     /**\r
-     This method initializes jTextFieldString \r
-     \r
-     @return javax.swing.JTextField jTextFieldString\r
-     \r
-     **/\r
+     * This method initializes jTextFieldString\r
+     * \r
+     @return javax.swing.JTextField jTextFieldString\r
+     * \r
+     */\r
     private JTextField getJTextFieldString() {\r
         if (jTextFieldVariableName == null) {\r
             jTextFieldVariableName = new JTextField();\r
@@ -110,30 +115,37 @@ public class VariablesDlg extends IDialog {
             jTextFieldVariableName.setPreferredSize(new java.awt.Dimension(320, 20));\r
             jTextFieldVariableName.setLocation(new java.awt.Point(160, 10));\r
             jTextFieldVariableName\r
-            .setToolTipText("Enter a Hex Word Array, you must provide leading Zeros. 0x000a, 0x0010, 0x00FF");\r
+                                  .setToolTipText("Enter a Hex Word Array, you must provide leading Zeros. 0x000a, 0x0010, 0x00FF");\r
         }\r
         return jTextFieldVariableName;\r
     }\r
 \r
     /**\r
-     This method initializes jComboBoxUsage \r
-     \r
-     @return javax.swing.JComboBox jComboBoxUsage\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, 60, 320, 20));\r
             jComboBoxUsage.setPreferredSize(new java.awt.Dimension(320, 20));\r
+            jComboBoxUsage\r
+                          .setToolTipText("<html><table>"\r
+                                          + "<tr><td>ALWAYS_CONSUMED</td><td>The module requires the variable entry to be set</td></tr>"\r
+                                          + "<tr><td>SOMETIMES_CONSUMED</td><td>The module will use the variable entry if it is set.</td></tr>"\r
+                                          + "<tr><td>ALWAYS_PRODUCED</td><td>The module will always write the variable.</td></tr>"\r
+                                          + "<tr><td>SOMETIMES_PRODUCED</td><td>The module will sometimes write the variable.</td></tr>"\r
+                                          + "</table></html>");\r
         }\r
         return jComboBoxUsage;\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
@@ -144,42 +156,55 @@ public class VariablesDlg extends IDialog {
     }\r
 \r
     /**\r
-     This method initializes jTextFieldFeatureFlag \r
-     \r
-     @return javax.swing.JTextField jTextFieldFeatureFlag\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.setBounds(new java.awt.Rectangle(160, 130, 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 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
-            jTextFieldHelpText.setToolTipText("Enter information on how to use this Variable.");\r
+     * This method initializes jTextFieldHelpText\r
+     * \r
+     * @return javax.swing.JTextField\r
+     * \r
+     */\r
+    private JTextArea getJTextAreaHelpText() {\r
+        if (jTextAreaHelpText == null) {\r
+            jTextAreaHelpText = new JTextArea();\r
+            jTextAreaHelpText.setLineWrap(true);\r
+            jTextAreaHelpText.setWrapStyleWord(true);\r
+            jTextAreaHelpText.setToolTipText("Enter information on how to use this Variable.");\r
         }\r
-        return jTextFieldHelpText;\r
+        return jTextAreaHelpText;\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(160, 85));\r
+            jScrollPaneHelpText.setViewportView(getJTextAreaHelpText());\r
+        }\r
+        return jScrollPaneHelpText;\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
@@ -191,15 +216,15 @@ public class VariablesDlg extends IDialog {
     }\r
 \r
     /**\r
-     This method initializes jButtonOk    \r
-     \r
-     @return javax.swing.JButton  \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, 182, 90, 20));\r
             jButtonOk.setText("Ok");\r
             jButtonOk.addActionListener(this);\r
         }\r
@@ -207,15 +232,15 @@ public class VariablesDlg 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, 165, 90, 20));\r
+            jButtonCancel.setBounds(new java.awt.Rectangle(390, 182, 90, 20));\r
             jButtonCancel.setText("Cancel");\r
             jButtonCancel.addActionListener(this);\r
         }\r
@@ -227,11 +252,11 @@ public class VariablesDlg 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(510, 240);\r
+        this.setSize(500, 255);\r
         this.setContentPane(getJScrollPane());\r
         this.setTitle("Variables");\r
         initFrame();\r
@@ -240,12 +265,12 @@ public class VariablesDlg extends IDialog {
     }\r
 \r
     /**\r
-     This method initializes this\r
-     Fill values to all fields if these values are not empty\r
-     \r
-     @param inVariablesId\r
-\r
-     **/\r
+     * This method initializes this Fill values to all fields if these values are\r
+     * not empty\r
+     * \r
+     @param inVariablesId\r
+     * \r
+     */\r
     private void init(VariablesIdentification inVariablesId) {\r
         init();\r
         this.id = inVariablesId;\r
@@ -254,30 +279,31 @@ public class VariablesDlg extends IDialog {
             this.jTextFieldVariableName.setText(id.getName());\r
             this.jComboBoxGuidC_Name.setSelectedItem(id.getGuid());\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 inVariablesIdentification\r
-     @param iFrame\r
-     \r
-     **/\r
+     This is the override edit constructor\r
+     * \r
+     @param inVariablesIdentification\r
+     @param iFrame\r
+     * \r
+     */\r
     public VariablesDlg(VariablesIdentification inVariablesIdentification, IFrame iFrame) {\r
         super(iFrame, true);\r
         init(inVariablesIdentification);\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.jTextFieldVariableName.setEnabled(!isView);\r
@@ -286,59 +312,64 @@ public class VariablesDlg 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
-            jArchCheckBox = new ArchCheckBox();\r
-            jArchCheckBox.setBounds(new java.awt.Rectangle(160, 135, 320, 20));\r
-            jArchCheckBox.setPreferredSize(new java.awt.Dimension(320, 20));\r
+            jStarLabel1 = new StarLabel();\r
+            jStarLabel1.setLocation(new java.awt.Point(2, 10));\r
+            jLabelVariableName = new JLabel();\r
+            jLabelVariableName.setText("Variable Name");\r
+            jLabelVariableName.setBounds(new java.awt.Rectangle(15, 10, 145, 20));\r
+\r
+            jStarLabel2 = new StarLabel();\r
+            jStarLabel2.setLocation(new java.awt.Point(2, 35));\r
             jLabelGuidCName = new JLabel();\r
-            jLabelGuidCName.setBounds(new java.awt.Rectangle(15, 35, 140, 20));\r
-            jLabelGuidCName.setText("Guid C Name");\r
+            jLabelGuidCName.setBounds(new java.awt.Rectangle(15, 35, 145, 20));\r
+            jLabelGuidCName.setText("Variable Guid C Name");\r
+\r
+            jStarLabel3 = new StarLabel();\r
+            jStarLabel3.setLocation(new java.awt.Point(2, 60));\r
             jLabelUsage = new JLabel();\r
             jLabelUsage.setText("Usage");\r
-            jLabelUsage.setBounds(new java.awt.Rectangle(15, 60, 140, 20));\r
-            jLabelVariableName = new JLabel();\r
-            jLabelVariableName.setText("Variable Name");\r
-            jLabelVariableName.setLocation(new java.awt.Point(15, 10));\r
-            jLabelVariableName.setSize(new java.awt.Dimension(140, 20));\r
-            jLabelArch = new JLabel();\r
-            jLabelArch.setBounds(new java.awt.Rectangle(15, 135, 140, 20));\r
-            jLabelArch.setText("Arch");\r
+            jLabelUsage.setBounds(new java.awt.Rectangle(15, 60, 145, 20));\r
+\r
+            jLabelHelpText = new JLabel();\r
+            jLabelHelpText.setBounds(new java.awt.Rectangle(14, 85, 145, 20));\r
+            jLabelHelpText.setText("Help Text");\r
+\r
             jLabelFeatureFlag = new JLabel();\r
-            jLabelFeatureFlag.setText("Feature Flag");\r
-            jLabelFeatureFlag.setBounds(new java.awt.Rectangle(15, 110, 140, 20));\r
+            jLabelFeatureFlag.setText("Feature Flag Expression");\r
+            jLabelFeatureFlag.setBounds(new java.awt.Rectangle(15, 130, 145, 20));\r
+\r
+            jLabelArch = new JLabel();\r
+            jLabelArch.setBounds(new java.awt.Rectangle(15, 155, 145, 20));\r
+            jLabelArch.setText("Supported Architectures");\r
+            jArchCheckBox = new ArchCheckBox();\r
+            jArchCheckBox.setBounds(new java.awt.Rectangle(160, 155, 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, 210));\r
 \r
+            jContentPane.add(jStarLabel1, null);\r
             jContentPane.add(jLabelVariableName, null);\r
+            jContentPane.add(getJTextFieldString(), null);\r
+            jContentPane.add(jStarLabel2, null);\r
             jContentPane.add(jLabelGuidCName, null);\r
             jContentPane.add(getJComboBoxGuidC_Name(), null);\r
-            jContentPane.add(getJTextFieldString(), null);\r
+            jContentPane.add(jStarLabel3, null);\r
             jContentPane.add(jLabelUsage, null);\r
             jContentPane.add(getJComboBoxUsage(), null);\r
-            jStarLabel1 = new StarLabel();\r
-            jStarLabel1.setLocation(new java.awt.Point(0, 10));\r
-            jStarLabel2 = new StarLabel();\r
-            jStarLabel2.setLocation(new java.awt.Point(0, 35));\r
-            jLabelHelpText = new JLabel();\r
-            jLabelHelpText.setBounds(new java.awt.Rectangle(14, 85, 140, 20));\r
-            jLabelHelpText.setText("Help Text");\r
-\r
-            jContentPane.add(jStarLabel1, null);\r
-            jContentPane.add(jStarLabel2, null);\r
-\r
-            jContentPane.add(jLabelArch, null);\r
+            jContentPane.add(jLabelHelpText, null);\r
+            jContentPane.add(getJScrollPaneHelpText(), null);\r
             jContentPane.add(jLabelFeatureFlag, null);\r
             jContentPane.add(getJTextFieldFeatureFlag(), null);\r
-            jContentPane.add(jLabelHelpText, null);\r
-            jContentPane.add(getJTextFieldHelpText(), null);\r
+            jContentPane.add(jLabelArch, null);\r
             jContentPane.add(jArchCheckBox, null);\r
             jContentPane.add(getJButtonOk(), null);\r
             jContentPane.add(getJButtonCancel(), null);\r
@@ -346,11 +377,13 @@ public class VariablesDlg extends IDialog {
         return jContentPane;\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
      */\r
     public void actionPerformed(ActionEvent arg0) {\r
         if (arg0.getSource() == jButtonOk) {\r
@@ -368,31 +401,31 @@ public class VariablesDlg 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.getVPpiUsage());\r
         Tools.generateComboBoxByVector(jComboBoxGuidC_Name, wt.getAllGuidDeclarationsFromWorkspace());\r
     }\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 VariableName \r
+        // Check VariableName\r
         //\r
         if (isEmpty(this.jTextFieldVariableName.getText())) {\r
-            Log.wrn("Update Variables", "Variable Name couldn't be empty");\r
+            Log.wrn("Update Variables", "Variable Name must not be empty");\r
             return false;\r
         }\r
 \r
@@ -423,7 +456,7 @@ public class VariablesDlg extends IDialog {
 \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 VariablesIdentification(arg0, arg1, arg2, arg3, arg4, arg5);\r
         return id;\r