]> git.proxmox.com Git - mirror_edk2.git/blobdiff - Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/PackageDepDlg.java
Added some additional comments in the files, as well as fixed some of them.
[mirror_edk2.git] / Tools / Source / FrameworkWizard / src / org / tianocore / frameworkwizard / module / ui / dialog / PackageDepDlg.java
index 0f96bdf31875a77dd58ee649ca59c0878a431123..2c7a355cc3823c3f9851cb3c61c8f9577eb8ff44 100644 (file)
@@ -1,6 +1,6 @@
 /** @file\r
  \r
- The file is used to create, update Include of MSA/MBD file\r
+ The file is used to create, update Package Dependencies section of the MSA file\r
  \r
  Copyright (c) 2006, Intel Corporation\r
  All rights reserved. This program and the accompanying materials\r
@@ -38,21 +38,19 @@ import org.tianocore.frameworkwizard.packaging.PackageIdentification;
 import org.tianocore.frameworkwizard.workspace.WorkspaceTools;\r
 \r
 /**\r
- The class is used to create, update Include of MSA/MBD file\r
- It extends IInternalFrame\r
\r
-\r
-\r
- **/\r
+ * The class is used to create, update Package Dependencies section of the MSA file\r
+ * \r
+ * It extends IDialog\r
+ * \r
+ */\r
 public class PackageDepDlg 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 = 3465193035145152131L;\r
 \r
     //\r
-    //Define class members\r
+    // Define class members\r
     //\r
     private JPanel jContentPane = null;\r
 \r
@@ -66,8 +64,6 @@ public class PackageDepDlg extends IDialog implements ItemListener {
 \r
     private JTextField jTextFieldPackageGuid = null;\r
 \r
-    private JButton jButtonGenerateGuid = null;\r
-\r
     private JLabel jLabelPackageVersion = null;\r
 \r
     private JTextField jTextFieldPackageVersion = null;\r
@@ -96,14 +92,14 @@ public class PackageDepDlg extends IDialog implements ItemListener {
     private Vector<PackageIdentification> vPackage = wt.getAllPackages();\r
 \r
     /**\r
-     * This method initializes jComboBoxPackageName    \r
-     *         \r
-     * @return javax.swing.JComboBox   \r
+     * This method initializes jComboBoxPackageName\r
+     * \r
+     * @return javax.swing.JComboBox\r
      */\r
     private JComboBox getJComboBoxPackageName() {\r
         if (jComboBoxPackageName == null) {\r
             jComboBoxPackageName = new JComboBox();\r
-            jComboBoxPackageName.setBounds(new java.awt.Rectangle(160, 10, 320, 20));\r
+            jComboBoxPackageName.setBounds(new java.awt.Rectangle(168, 12, 320, 20));\r
             jComboBoxPackageName.setPreferredSize(new java.awt.Dimension(320, 20));\r
             jComboBoxPackageName.setToolTipText("If your Module requires a package list that here.");\r
             jComboBoxPackageName.addItemListener(this);\r
@@ -112,14 +108,14 @@ public class PackageDepDlg extends IDialog implements ItemListener {
     }\r
 \r
     /**\r
-     * This method initializes jTextFieldPackageGuid   \r
-     *         \r
-     * @return javax.swing.JTextField  \r
+     * This method initializes jTextFieldPackageGuid\r
+     * \r
+     * @return javax.swing.JTextField\r
      */\r
     private JTextField getJTextFieldPackageGuid() {\r
         if (jTextFieldPackageGuid == null) {\r
             jTextFieldPackageGuid = new JTextField();\r
-            jTextFieldPackageGuid.setBounds(new java.awt.Rectangle(160, 35, 320, 20));\r
+            jTextFieldPackageGuid.setBounds(new java.awt.Rectangle(168, 37, 320, 20));\r
             jTextFieldPackageGuid.setPreferredSize(new java.awt.Dimension(320, 20));\r
             jTextFieldPackageGuid.setEditable(false);\r
             jTextFieldPackageGuid.setVisible(false);\r
@@ -128,56 +124,43 @@ public class PackageDepDlg extends IDialog implements ItemListener {
     }\r
 \r
     /**\r
-     * This method initializes jButtonGenerateGuid     \r
-     *         \r
-     * @return javax.swing.JButton     \r
-     */\r
-    private JButton getJButtonGenerateGuid() {\r
-        if (jButtonGenerateGuid == null) {\r
-            jButtonGenerateGuid = new JButton();\r
-            jButtonGenerateGuid.setBounds(new java.awt.Rectangle(415, 35, 65, 20));\r
-            jButtonGenerateGuid.setPreferredSize(new java.awt.Dimension(65, 20));\r
-            jButtonGenerateGuid.setText("GEN");\r
-            jButtonGenerateGuid.addActionListener(this);\r
-            jButtonGenerateGuid.setVisible(false);\r
-        }\r
-        return jButtonGenerateGuid;\r
-    }\r
-\r
-    /**\r
-     * This method initializes jTextFieldPackageVersion        \r
-     *         \r
-     * @return javax.swing.JTextField  \r
+     * This method initializes jTextFieldPackageVersion\r
+     * \r
+     * @return javax.swing.JTextField\r
      */\r
     private JTextField getJTextFieldPackageVersion() {\r
         if (jTextFieldPackageVersion == null) {\r
             jTextFieldPackageVersion = new JTextField();\r
-            jTextFieldPackageVersion.setBounds(new java.awt.Rectangle(160, 35, 320, 20));\r
+            jTextFieldPackageVersion.setBounds(new java.awt.Rectangle(168, 37, 320, 20));\r
             jTextFieldPackageVersion.setPreferredSize(new java.awt.Dimension(320, 20));\r
             jTextFieldPackageVersion\r
-                                    .setToolTipText("If this module depends on a specific version of a package, enter the package version here.  If the module can use the latest version that does not break backward compatibility, leave this field blank");\r
+                                    .setToolTipText("<html>If this module depends on a specific version of a package, <br>"\r
+                                                    + "enter the package version here.  <br>"\r
+                                                    + "If the module can use the latest version <br>"\r
+                                                    + "that does not break backward compatibility, <br>"\r
+                                                    + "leave this field blank</html>");\r
         }\r
         return jTextFieldPackageVersion;\r
     }\r
 \r
     /**\r
-     * This method initializes jTextFieldFeatureFlag    \r
-     *  \r
-     * @return javax.swing.JTextField   \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, 60, 320, 20));\r
+            jTextFieldFeatureFlag.setBounds(new java.awt.Rectangle(168, 62, 320, 20));\r
             jTextFieldFeatureFlag.setPreferredSize(new java.awt.Dimension(320, 20));\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
@@ -188,15 +171,15 @@ public class PackageDepDlg extends IDialog implements ItemListener {
     }\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, 115, 90, 20));\r
+            jButtonOk.setBounds(new java.awt.Rectangle(290, 122, 90, 20));\r
             jButtonOk.setText("Ok");\r
             jButtonOk.addActionListener(this);\r
         }\r
@@ -204,15 +187,15 @@ public class PackageDepDlg 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, 115, 90, 20));\r
+            jButtonCancel.setBounds(new java.awt.Rectangle(390, 122, 90, 20));\r
             jButtonCancel.setText("Cancel");\r
             jButtonCancel.addActionListener(this);\r
         }\r
@@ -224,11 +207,11 @@ public class PackageDepDlg 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, 175);\r
+        this.setSize(505, 216);\r
         this.setContentPane(getJScrollPane());\r
         this.setTitle("Package Dependencies");\r
         initFrame();\r
@@ -237,9 +220,9 @@ public class PackageDepDlg extends IDialog implements ItemListener {
     }\r
 \r
     /**\r
-     This method initializes this\r
-     \r
-     **/\r
+     This method initializes this\r
+     * \r
+     */\r
     private void init(PackageDependenciesIdentification inPackageDependenciesIdentification) {\r
         init();\r
         this.pdid = inPackageDependenciesIdentification;\r
@@ -253,20 +236,21 @@ public class PackageDepDlg extends IDialog implements ItemListener {
     }\r
 \r
     /**\r
-     This is the default constructor\r
-     \r
-     **/\r
+     This is the default constructor\r
+     * \r
+     */\r
     public PackageDepDlg(PackageDependenciesIdentification inPackageDependenciesIdentification, IFrame iFrame) {\r
         super(iFrame, true);\r
         init(inPackageDependenciesIdentification);\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.jComboBoxPackageName.setEnabled(!isView);\r
@@ -274,52 +258,54 @@ public class PackageDepDlg extends IDialog implements ItemListener {
     }\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, 85, 320, 20));\r
-            jArchCheckBox.setPreferredSize(new java.awt.Dimension(320, 20));\r
-            jLabelArch = new JLabel();\r
-            jLabelArch.setBounds(new java.awt.Rectangle(15, 85, 140, 20));\r
-            jLabelArch.setText("Sup Arch List");\r
+            jStarLabel1 = new StarLabel();\r
+            jStarLabel1.setLocation(new java.awt.Point(2, 12));\r
+            jLabelPackageName = new JLabel();\r
+            jLabelPackageName.setBounds(new java.awt.Rectangle(12, 12, 168, 20));\r
+            jLabelPackageName.setText("Package Name");\r
+\r
             jLabelPackageVersion = new JLabel();\r
-            jLabelPackageVersion.setBounds(new java.awt.Rectangle(15, 35, 140, 20));\r
+            jLabelPackageVersion.setBounds(new java.awt.Rectangle(12, 37, 168, 20));\r
             jLabelPackageVersion.setText("Package Version");\r
+\r
             jLabelPackageGuid = new JLabel();\r
-            jLabelPackageGuid.setBounds(new java.awt.Rectangle(15, 35, 140, 20));\r
+            jLabelPackageGuid.setBounds(new java.awt.Rectangle(12, 37, 168, 20));\r
             jLabelPackageGuid.setText("Package Guid");\r
             jLabelPackageGuid.setVisible(false);\r
-            jLabelPackageName = new JLabel();\r
-            jLabelPackageName.setBounds(new java.awt.Rectangle(15, 10, 140, 20));\r
-            jLabelPackageName.setText("Package Name");\r
+\r
+            jLabelFeatureFlag = new JLabel();\r
+            jLabelFeatureFlag.setBounds(new java.awt.Rectangle(12, 62, 168, 20));\r
+            jLabelFeatureFlag.setText("Feature Flag Expression");\r
+\r
+            jLabelArch = new JLabel();\r
+            jLabelArch.setBounds(new java.awt.Rectangle(12, 87, 168, 20));\r
+            jLabelArch.setText("Supported Architectures");\r
+            jArchCheckBox = new ArchCheckBox();\r
+            jArchCheckBox.setBounds(new java.awt.Rectangle(168, 87, 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, 140));\r
-\r
-            jContentPane.add(jLabelPackageName, null);\r
-            jStarLabel1 = new StarLabel();\r
-            jStarLabel1.setLocation(new java.awt.Point(0, 10));\r
+            jContentPane.setPreferredSize(new java.awt.Dimension(485, 170));\r
 \r
             jContentPane.add(jStarLabel1, null);\r
+            jContentPane.add(jLabelPackageName, null);\r
             jContentPane.add(getJComboBoxPackageName(), null);\r
             jContentPane.add(jLabelPackageGuid, null);\r
             jContentPane.add(getJTextFieldPackageGuid(), null);\r
-            jContentPane.add(getJButtonGenerateGuid(), null);\r
             jContentPane.add(jLabelPackageVersion, null);\r
             jContentPane.add(getJTextFieldPackageVersion(), null);\r
-\r
-            jLabelFeatureFlag = new JLabel();\r
-            jLabelFeatureFlag.setBounds(new java.awt.Rectangle(15, 60, 140, 20));\r
-            jLabelFeatureFlag.setText("Feature Flag");\r
+            // LAH Not Used here\r
+            // jContentPane.add(getJButtonGenerateGuid(), null);\r
             jContentPane.add(jLabelFeatureFlag, null);\r
             jContentPane.add(getJTextFieldFeatureFlag(), null);\r
-\r
             jContentPane.add(jLabelArch, null);\r
             jContentPane.add(jArchCheckBox, null);\r
             jContentPane.add(getJButtonOk(), null);\r
@@ -328,9 +314,11 @@ public class PackageDepDlg extends IDialog implements ItemListener {
         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
@@ -350,9 +338,9 @@ public class PackageDepDlg extends IDialog implements ItemListener {
     }\r
 \r
     /**\r
-     This method initializes Usage type, Package type and Arch type\r
-     \r
-     **/\r
+     This method initializes Usage type, Package type and Arch type\r
+     * \r
+     */\r
     private void initFrame() {\r
         for (int index = 0; index < vPackage.size(); index++) {\r
             jComboBoxPackageName.addItem(vPackage.elementAt(index).getName());\r
@@ -360,33 +348,33 @@ public class PackageDepDlg extends IDialog implements ItemListener {
     }\r
 \r
     /**\r
-     Data validation for all fields before add current item to Vector\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 before add current item to Vector\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 PackageGuid \r
+        // Check PackageGuid\r
         //\r
-//        if (!isEmpty(this.jTextFieldPackageGuid.getText())) {\r
-//            if (!DataValidation.isGuid(this.jTextFieldPackageGuid.getText())) {\r
-//                Log.err("Incorrect data type for Package Guid");\r
-//                return false;\r
-//            }\r
-//        }\r
+        // if (!isEmpty(this.jTextFieldPackageGuid.getText())) {\r
+        // if (!DataValidation.isGuid(this.jTextFieldPackageGuid.getText())) {\r
+        // Log.err("Incorrect data type for Package Guid");\r
+        // return false;\r
+        // }\r
+        // }\r
 \r
         //\r
-        // Check PackageVersion \r
+        // Check PackageVersion\r
         //\r
         if (!isEmpty(this.jTextFieldPackageVersion.getText())) {\r
             if (!DataValidation.isVersion(this.jTextFieldPackageVersion.getText())) {\r
-                Log.err("Incorrect data type for Package Version");\r
+                Log.wrn("Update Package Dependencies", "Incorrect data type for Package Version");\r
                 return false;\r
             }\r
         }\r
@@ -396,14 +384,13 @@ public class PackageDepDlg 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 Package Dependencies", "Incorrect data type for Feature Flag");\r
                 return false;\r
             }\r
         }\r
 \r
         return true;\r
     }\r
-    \r
 \r
     private PackageDependenciesIdentification getCurrentPackageDependencies() {\r
         String arg0 = this.jComboBoxPackageName.getSelectedItem().toString();\r
@@ -416,9 +403,11 @@ public class PackageDepDlg extends IDialog implements ItemListener {
         return pdid;\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