]> git.proxmox.com Git - mirror_edk2.git/blobdiff - Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/HiiPackagesDlg.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 / HiiPackagesDlg.java
index 1a024875010b0f10ef4af2b58f90689df1d6325d..1997ab4c8a68f12f558f5358ef0c74e85f80fa97 100644 (file)
@@ -23,6 +23,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
@@ -36,21 +37,20 @@ import org.tianocore.frameworkwizard.common.ui.StarLabel;
 import org.tianocore.frameworkwizard.module.Identifications.HiiPackages.HiiPackagesIdentification;\r
 \r
 /**\r
- The class is used to create, update Formset of MSA/MBD file\r
- It extends IInternalFrame\r
\r
-\r
-\r
- **/\r
+ * The class is used to create, update Hii Packages of the MSA file\r
+ * \r
+ * It extends IDialog\r
+ * \r
+ */\r
 public class HiiPackagesDlg 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 = -6851574146786158116L;\r
 \r
     //\r
-    //Define class members\r
+    // Define class members\r
     //\r
     private JPanel jContentPane = null;\r
 \r
@@ -76,7 +76,9 @@ public class HiiPackagesDlg 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
@@ -92,11 +94,12 @@ public class HiiPackagesDlg extends IDialog {
     private EnumerationData ed = new EnumerationData();\r
 \r
     /**\r
-     This method initializes jTextFieldName \r
-     \r
-     @return javax.swing.JTextField jTextFieldName\r
-     \r
-     **/\r
+     * \r
+     * This method initializes jTextFieldName\r
+     * \r
+     * @return javax.swing.JTextField jTextFieldName\r
+     * \r
+     */\r
     private JTextField getJTextFieldName() {\r
         if (jTextFieldName == null) {\r
             jTextFieldName = new JTextField();\r
@@ -108,38 +111,48 @@ public class HiiPackagesDlg extends IDialog {
     }\r
 \r
     /**\r
-     This method initializes jComboBoxUsage \r
-     \r
-     @return javax.swing.JComboBox jComboBoxUsage\r
-     \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
+            jComboBoxUsage\r
+                          .setToolTipText("<html><table>"\r
+                                          + "<tr><td>ALWAYS_PRODUCED</td><td>Hii is always registered</td></tr>"\r
+                                          + "<tr><td>SOMETIMES_PRODUCED</td><td>Some executions paths will require the Hii to be registered</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
+     * 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
+     * \r
+     * This method initializes jScrollPane\r
+     * \r
+     * @return javax.swing.JScrollPane\r
+     * \r
      */\r
     private JScrollPane getJScrollPane() {\r
         if (jScrollPane == null) {\r
@@ -150,30 +163,51 @@ public class HiiPackagesDlg 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
+     * \r
+     * This method initializes jTextAreaHelpText\r
+     * \r
+     * @return javax.swing.JTextArea jTextAreaHelpText\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
+     * \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(160, 60));\r
+            jScrollPaneHelpText.setViewportView(getJTextAreaHelpText());\r
+        }\r
+        return jScrollPaneHelpText;\r
+    }\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
@@ -181,15 +215,16 @@ public class HiiPackagesDlg 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
@@ -201,11 +236,12 @@ public class HiiPackagesDlg 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("Hii Packages");\r
         initFrame();\r
@@ -214,11 +250,11 @@ public class HiiPackagesDlg extends IDialog {
     }\r
 \r
     /**\r
-     This method initializes this\r
-     Fill values to all fields if these values are not empty\r
-     \r
-     @param inHiiPackagesId\r
-\r
+     * This method initializes this Fill values to all fields if these values are\r
+     * not empty\r
+     * \r
+     @param inHiiPackagesId\r
+     * \r
      **/\r
     private void init(HiiPackagesIdentification inHiiPackagesId) {\r
         init();\r
@@ -227,18 +263,18 @@ public class HiiPackagesDlg extends IDialog {
         if (this.id != null) {\r
             this.jTextFieldName.setText(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 inHiiPackagesIdentification\r
-     @param iFrame\r
-     \r
+     This is the override edit constructor\r
+     * \r
+     @param inHiiPackagesIdentification\r
+     @param iFrame\r
+     * \r
      **/\r
     public HiiPackagesDlg(HiiPackagesIdentification inHiiPackagesIdentification, IFrame iFrame) {\r
         super(iFrame, true);\r
@@ -246,10 +282,12 @@ public class HiiPackagesDlg extends IDialog {
     }\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
@@ -259,56 +297,58 @@ public class HiiPackagesDlg extends IDialog {
     }\r
 \r
     /**\r
-     This method initializes jContentPane\r
-     \r
-     @return javax.swing.JPanel jContentPane\r
-     \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, 110, 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
+            jLabelName = new JLabel();\r
+            jLabelName.setText("Hii Package C Name");\r
+            jLabelName.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
-            jLabelName = new JLabel();\r
-            jLabelName.setText("Name");\r
-            jLabelName.setBounds(new java.awt.Rectangle(15, 10, 140, 20));\r
-            jLabelArch = new JLabel();\r
-            jLabelArch.setBounds(new java.awt.Rectangle(15, 110, 140, 20));\r
-            jLabelArch.setText("Arch");\r
-            jLabelFeatureFlag = new JLabel();\r
-            jLabelFeatureFlag.setBounds(new java.awt.Rectangle(15, 85, 140, 20));\r
-            jLabelFeatureFlag.setText("Feature Flag");\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, 145, 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(jStarLabel1, null);\r
             jContentPane.add(jLabelName, null);\r
-            jContentPane.add(jLabelUsage, null);\r
             jContentPane.add(getJTextFieldName(), null);\r
+\r
+            jContentPane.add(jStarLabel2, null);\r
+            jContentPane.add(jLabelUsage, null);\r
             jContentPane.add(getJComboBoxUsage(), null);\r
 \r
+            jContentPane.add(jLabelHelpText, null);\r
+            jContentPane.add(getJScrollPaneHelpText(), null);\r
+\r
             jContentPane.add(jLabelFeatureFlag, null);\r
-            jContentPane.add(jLabelArch, null);\r
             jContentPane.add(getJTextFieldFeatureFlag(), null);\r
 \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
-\r
-            jContentPane.add(jStarLabel1, null);\r
-            jContentPane.add(jStarLabel2, null);\r
-\r
-            jContentPane.add(jLabelHelpText, null);\r
-            jContentPane.add(getJTextFieldHelpText(), null);\r
+            jContentPane.add(jLabelArch, null);\r
             jContentPane.add(jArchCheckBox, null);\r
+\r
             jContentPane.add(getJButtonOk(), null);\r
             jContentPane.add(getJButtonCancel(), null);\r
         }\r
@@ -316,16 +356,19 @@ public class HiiPackagesDlg extends IDialog {
     }\r
 \r
     /**\r
-     This method initializes Usage type\r
-     \r
-     **/\r
+     * \r
+     * This method initializes Usage type\r
+     * \r
+     */\r
     private void initFrame() {\r
         Tools.generateComboBoxByVector(jComboBoxUsage, ed.getVHiiPackageUsage());\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
@@ -345,22 +388,23 @@ public class HiiPackagesDlg 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
+     * \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 Hii Package Name \r
+        // Check Hii Package Name\r
         //\r
         if (isEmpty(this.jTextFieldName.getText())) {\r
-            Log.wrn("Update Hii Packages", "Hii Package Name Record couldn't be empty");\r
+            Log.wrn("Update Hii Packages", "Hii Package Name Record must not be empty");\r
             return false;\r
         }\r
 \r
@@ -390,7 +434,7 @@ public class HiiPackagesDlg 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 HiiPackagesIdentification(arg0, arg1, arg2, arg3, arg4);\r
         return id;\r