Made the Specification look like a comment at the bottom of the page, since it cannot...

[mirror_edk2.git] / Tools / Source / FrameworkWizard / src / org / tianocore / frameworkwizard / module / ui / MsaHeader.java

diff --git a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/MsaHeader.java b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/MsaHeader.java
index 07081bcaee7e4ef06ccfa5cb22a879c9e5321eec..a180910a9f02ac8b88f9c1330bbc0c477ad0194a 100644 (file)
--- a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/MsaHeader.java
+++ b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/MsaHeader.java
@@ -57,6 +57,10 @@ public class MsaHeader extends IInternalFrame {
     ///\r
     private static final long serialVersionUID = -8152099582923006900L;\r
 \r
+    private int dialogWidth = 500;\r
+    \r
+    private int dialogHeight = 630;\r
+    \r
     //\r
     //Define class members\r
     //\r
@@ -148,7 +152,7 @@ public class MsaHeader extends IInternalFrame {
 \r
     private StarLabel jStarLabel14 = null;\r
 \r
-    private StarLabel jStarLabel15 = null;\r
+//    private StarLabel jStarLabel15 = null;\r
 \r
     private JCheckBox jCheckBoxIa32 = null;\r
 \r
@@ -161,7 +165,7 @@ public class MsaHeader extends IInternalFrame {
     private JCheckBox jCheckBoxArm = null;\r
 \r
     private JCheckBox jCheckBoxPpc = null;\r
-\r
+    \r
     //\r
     // Not used for UI\r
     //\r
@@ -373,7 +377,7 @@ public class MsaHeader extends IInternalFrame {
             jTextAreaDescription = new JTextArea();\r
             jTextAreaDescription.setLineWrap(true);\r
             jTextAreaDescription.addFocusListener(this);\r
-            jTextAreaDescription.setToolTipText("A verbose description of the module");\r
+            jTextAreaDescription.setToolTipText("A verbose description of the module.");\r
             jTextAreaDescription.setWrapStyleWord(true);\r
             jTextAreaDescription.setSelectionStart(0);\r
             jTextAreaDescription.setSelectionEnd(0);\r
@@ -390,10 +394,14 @@ public class MsaHeader extends IInternalFrame {
     private JTextField getJTextFieldSpecification() {\r
         if (jTextFieldSpecification == null) {\r
             jTextFieldSpecification = new JTextField();\r
+            \r
             jTextFieldSpecification.setPreferredSize(new java.awt.Dimension(320, 20));\r
             jTextFieldSpecification.setText("FRAMEWORK_BUILD_PACKAGING_SPECIFICATION   0x00000052");\r
+            jTextFieldSpecification.setBorder(null);\r
+            \r
+            \r
             jTextFieldSpecification.setSize(new java.awt.Dimension(320, 20));\r
-            jTextFieldSpecification.setLocation(new java.awt.Point(160, 530));\r
+            jTextFieldSpecification.setLocation(new java.awt.Point(2, dialogHeight - 30));\r
             jTextFieldSpecification.setEditable(false);\r
             jTextFieldSpecification.addFocusListener(this);\r
         }\r
@@ -485,7 +493,7 @@ public class MsaHeader extends IInternalFrame {
             jTextFieldAbstract.setLocation(new java.awt.Point(160, 110));\r
             jTextFieldAbstract.setSize(new java.awt.Dimension(320, 20));\r
             jTextFieldAbstract.addFocusListener(this);\r
-            jTextFieldAbstract.setToolTipText("A one sentence description of this module");\r
+            jTextFieldAbstract.setToolTipText("A one sentence description of this module.");\r
         }\r
         return jTextFieldAbstract;\r
     }\r
@@ -519,7 +527,7 @@ public class MsaHeader extends IInternalFrame {
             jTextFieldURL.setLocation(new java.awt.Point(160, 430));\r
             jTextFieldURL.setSize(new java.awt.Dimension(320, 20));\r
             jTextFieldURL.addFocusListener(this);\r
-            jTextFieldURL.setToolTipText("A URL for the latest version of the license");\r
+            jTextFieldURL.setToolTipText("A URL for the latest version of the license.");\r
         }\r
         return jTextFieldURL;\r
     }\r
@@ -570,7 +578,7 @@ public class MsaHeader extends IInternalFrame {
             jTextAreaCopyright.setSelectionStart(0);\r
             jTextAreaCopyright.setSelectionEnd(0);\r
             jTextAreaCopyright.setBounds(new java.awt.Rectangle(0, 0, 320, 40));\r
-            jTextAreaCopyright.setToolTipText("One or more copyright lines");\r
+            jTextAreaCopyright.setToolTipText("One or more copyright lines.");\r
         }\r
         return jTextAreaCopyright;\r
     }\r
@@ -592,7 +600,7 @@ public class MsaHeader extends IInternalFrame {
                                                  + "A module cannot contain both. <br>"\r
                                                  + "The GUID numbers should be identical <br>"\r
                                                  + "for a binary and source MSA, <br>"\r
-                                                 + "but the BINARY MSA should have <br>"\r
+                                                 + "however the BINARY MSA should have <br>"\r
                                                  + "a higher version number.</html>");\r
         }\r
         return jComboBoxBinaryModule;\r
@@ -609,7 +617,7 @@ public class MsaHeader extends IInternalFrame {
             jTextFieldOutputFileBasename.setBounds(new java.awt.Rectangle(160, 455, 320, 20));\r
             jTextFieldOutputFileBasename.setPreferredSize(new java.awt.Dimension(320, 20));\r
             jTextFieldOutputFileBasename.addFocusListener(this);\r
-            jTextFieldOutputFileBasename.setToolTipText("Enter a single word for generated output file names");\r
+            jTextFieldOutputFileBasename.setToolTipText("Enter a single word for generated output file names.");\r
         }\r
         return jTextFieldOutputFileBasename;\r
     }\r
@@ -680,8 +688,8 @@ public class MsaHeader extends IInternalFrame {
      \r
      **/\r
     private void init() {\r
-        this.setSize(500, 515);\r
-        this.setPreferredSize(new java.awt.Dimension(490, 615));\r
+        this.setSize(dialogWidth, dialogHeight);\r
+        this.setPreferredSize(new java.awt.Dimension(dialogWidth, dialogHeight));\r
         this.setContentPane(getJScrollPane());\r
         this.setTitle("Module Surface Area Header");\r
         initFrame();\r
@@ -818,7 +826,8 @@ public class MsaHeader extends IInternalFrame {
 \r
             jContentPane = new JPanel();\r
             jContentPane.setLayout(null);\r
-            jContentPane.setPreferredSize(new java.awt.Dimension(490, 565));\r
+            jContentPane.setPreferredSize(new java.awt.Dimension(dialogWidth - 10, dialogHeight - 10));\r
+            \r
             jContentPane.addFocusListener(this);\r
 \r
             jContentPane.add(jLabelBaseName, null);\r
@@ -831,7 +840,7 @@ public class MsaHeader extends IInternalFrame {
             jContentPane.add(jLabelLicense, null);\r
             jContentPane.add(jLabelCopyright, null);\r
             jContentPane.add(jLabelDescription, null);\r
-            jContentPane.add(jLabelSpecification, null);\r
+//            jContentPane.add(jLabelSpecification, null);\r
             jContentPane.add(getJTextFieldSpecification(), null);\r
             jContentPane.add(getJButtonOk(), null);\r
             jContentPane.add(getJButtonCancel(), null);\r
@@ -871,8 +880,8 @@ public class MsaHeader extends IInternalFrame {
             jStarLabel13.setLocation(new java.awt.Point(0, 480));\r
             jStarLabel14 = new StarLabel();\r
             jStarLabel14.setLocation(new java.awt.Point(0, 505));\r
-            jStarLabel15 = new StarLabel();\r
-            jStarLabel15.setLocation(new java.awt.Point(0, 530));\r
+//            jStarLabel15 = new StarLabel();\r
+//            jStarLabel15.setLocation(new java.awt.Point(0, 530));\r
 \r
             jContentPane.add(jStarLabel1, null);\r
             jContentPane.add(jStarLabel2, null);\r
@@ -885,7 +894,7 @@ public class MsaHeader extends IInternalFrame {
             jContentPane.add(jStarLabel12, null);\r
             jContentPane.add(jStarLabel13, null);\r
             jContentPane.add(jStarLabel14, null);\r
-            jContentPane.add(jStarLabel15, null);\r
+//            jContentPane.add(jStarLabel15, null);\r
             jContentPane.add(getJScrollPaneCopyright(), null);\r
 \r
             jContentPane.add(getJCheckBoxIa32(), null);\r
@@ -939,12 +948,12 @@ public class MsaHeader extends IInternalFrame {
         // Check Base Name\r
         //\r
         if (isEmpty(this.jTextFieldBaseName.getText())) {\r
-            Log.wrn("Update Msa Header", "Base Name couldn't be empty");\r
+            Log.wrn("Update Msa Header", "Name must be entered!");\r
             //this.jTextFieldBaseName.requestFocus();\r
             return false;\r
         }\r
         if (!DataValidation.isBaseName(this.jTextFieldBaseName.getText())) {\r
-            Log.wrn("Update Msa Header", "Incorrect data type for Base Name");\r
+            Log.wrn("Update Msa Header", "Incorrect data type for Name, it must start with an alpha character!");\r
             //this.jTextFieldBaseName.requestFocus();\r
             return false;\r
         }\r
@@ -953,12 +962,12 @@ public class MsaHeader extends IInternalFrame {
         // Check Guid\r
         //\r
         if (isEmpty(this.jTextFieldGuid.getText())) {\r
-            Log.wrn("Update Msa Header", "Guid Value couldn't be empty");\r
+            Log.wrn("Update Msa Header", "The Guid Value must be entered!");\r
             //this.jTextFieldGuid.requestFocus();\r
             return false;\r
         }\r
         if (!DataValidation.isGuid((this.jTextFieldGuid).getText())) {\r
-            Log.wrn("Update Msa Header", "Incorrect data type for Guid");\r
+            Log.wrn("Update Msa Header", "Incorrect data type for Guid, it must be registry format, 8-4-4-4-12");\r
             //this.jTextFieldGuid.requestFocus();\r
             return false;\r
         }\r
@@ -967,12 +976,12 @@ public class MsaHeader extends IInternalFrame {
         // Check Version\r
         //\r
         if (isEmpty(this.jTextFieldVersion.getText())) {\r
-            Log.wrn("Update Msa Header", "Version couldn't be empty");\r
+            Log.wrn("Update Msa Header", "Version must be entered!");\r
             //this.jTextFieldVersion.requestFocus();\r
             return false;\r
         }\r
         if (!DataValidation.isVersion(this.jTextFieldVersion.getText())) {\r
-            Log.wrn("Update Msa Header", "Incorrect data type for Version");\r
+            Log.wrn("Update Msa Header", "Incorrect data type for Version, it must start with a digit.");\r
             //this.jTextFieldVersion.requestFocus();\r
             return false;\r
         }\r
@@ -981,12 +990,12 @@ public class MsaHeader extends IInternalFrame {
         // Check Abstact\r
         //\r
         if (isEmpty(this.jTextFieldAbstract.getText())) {\r
-            Log.wrn("Update Msa Header", "Abstract couldn't be empty");\r
+            Log.wrn("Update Msa Header", "Abstract must be entered!");\r
             //this.jTextFieldAbstract.requestFocus();\r
             return false;\r
         }\r
         if (!DataValidation.isAbstract(this.jTextFieldAbstract.getText())) {\r
-            Log.wrn("Update Msa Header", "Incorrect data type for Abstract");\r
+            Log.wrn("Update Msa Header", "Incorrect data type for Abstract, is should be a sentence describing the module.");\r
             //this.jTextFieldAbstract.requestFocus();\r
             return false;\r
         }\r
@@ -995,7 +1004,7 @@ public class MsaHeader extends IInternalFrame {
         // Check Description\r
         //\r
         if (isEmpty(this.jTextAreaDescription.getText())) {\r
-            Log.wrn("Update Msa Header", "Description couldn't be empty");\r
+            Log.wrn("Update Msa Header", "Description must be entered!");\r
             //this.jTextAreaDescription.requestFocus();\r
             return false;\r
         }\r
@@ -1004,7 +1013,7 @@ public class MsaHeader extends IInternalFrame {
         // Check Copyright\r
         //\r
         if (isEmpty(this.jTextAreaCopyright.getText())) {\r
-            Log.wrn("Update Msa Header", "Copyright couldn't be empty");\r
+            Log.wrn("Update Msa Header", "Copyright must be entered!");\r
             //this.jTextFieldCopyright.requestFocus();\r
             return false;\r
         }\r
@@ -1013,7 +1022,7 @@ public class MsaHeader extends IInternalFrame {
         // Check License\r
         //\r
         if (isEmpty(this.jTextAreaLicense.getText())) {\r
-            Log.wrn("Update Msa Header", "License couldn't be empty");\r
+            Log.wrn("Update Msa Header", "License must be entered!");\r
             //this.jTextAreaLicense.requestFocus();\r
             return false;\r
         }\r
@@ -1022,11 +1031,14 @@ public class MsaHeader extends IInternalFrame {
         // Check Specification\r
         //\r
         if (isEmpty(this.jTextFieldSpecification.getText())) {\r
-            Log.wrn("Update Msa Header", "Specification couldn't be empty");\r
+            Log.wrn("Update Msa Header", "Specification must exist.");\r
             //this.jTextFieldSpecification.requestFocus();\r
             return false;\r
         }\r
         if (!DataValidation.isSpecification(this.jTextFieldSpecification.getText())) {\r
+            // TODO Add code to check the specification number.\r
+            // Future releases of Schema may require that we process these files\r
+            // differently.\r
             Log.wrn("Update Msa Header", "Incorrect data type for Specification");\r
             //this.jTextFieldSpecification.requestFocus();\r
             return false;\r
@@ -1120,12 +1132,12 @@ public class MsaHeader extends IInternalFrame {
         //\r
         if (arg0.getSource() == this.jTextFieldBaseName) {\r
             if (isEmpty(this.jTextFieldBaseName.getText())) {\r
-                Log.wrn("Update Msa Header", "Base Name couldn't be empty");\r
+                Log.wrn("Update Msa Header", "The Name must be entered!");\r
                 //this.jTextFieldBaseName.requestFocus();\r
                 return;\r
             }\r
             if (!DataValidation.isBaseName(this.jTextFieldBaseName.getText())) {\r
-                Log.wrn("Update Msa Header", "Incorrect data type for Base Name");\r
+                Log.wrn("Update Msa Header", "Incorrect data type for Name, it must begin with an alpha character.");\r
                 //this.jTextFieldBaseName.requestFocus();\r
                 return;\r
             }\r
@@ -1152,12 +1164,12 @@ public class MsaHeader extends IInternalFrame {
         //\r
         if (arg0.getSource() == this.jTextFieldGuid) {\r
             if (isEmpty(this.jTextFieldGuid.getText())) {\r
-                Log.wrn("Update Msa Header", "Guid Value couldn't be empty");\r
+                Log.wrn("Update Msa Header", "Guid must be entered!");\r
                 //this.jTextFieldGuid.requestFocus();\r
                 return;\r
             }\r
             if (!DataValidation.isGuid((this.jTextFieldGuid).getText())) {\r
-                Log.wrn("Update Msa Header", "Incorrect data type for Guid");\r
+                Log.wrn("Update Msa Header", "Incorrect data type for Guid, it must be registry format. (8-4-4-4-12)");\r
                 //this.jTextFieldGuid.requestFocus();\r
                 return;\r
             }\r
@@ -1173,12 +1185,12 @@ public class MsaHeader extends IInternalFrame {
         //\r
         if (arg0.getSource() == this.jTextFieldVersion) {\r
             if (isEmpty(this.jTextFieldVersion.getText())) {\r
-                Log.wrn("Update Msa Header", "Version couldn't be empty");\r
+                Log.wrn("Update Msa Header", "Version must be entered!");\r
                 //this.jTextFieldVersion.requestFocus();\r
                 return;\r
             }\r
             if (!DataValidation.isVersion(this.jTextFieldVersion.getText())) {\r
-                Log.wrn("Update Msa Header", "Incorrect data type for Version");\r
+                Log.wrn("Update Msa Header", "Incorrect data type for Version, it must start with a digit.");\r
                 //this.jTextFieldVersion.requestFocus();\r
                 return;\r
             }\r
@@ -1194,12 +1206,12 @@ public class MsaHeader extends IInternalFrame {
         //\r
         if (arg0.getSource() == this.jTextFieldAbstract) {\r
             if (isEmpty(this.jTextFieldAbstract.getText())) {\r
-                Log.wrn("Update Msa Header", "Abstract couldn't be empty");\r
+                Log.wrn("Update Msa Header", "Abstract must be entered!");\r
                 //this.jTextFieldAbstract.requestFocus();\r
                 return;\r
             }\r
             if (!DataValidation.isAbstract(this.jTextFieldAbstract.getText())) {\r
-                Log.wrn("Update Msa Header", "Incorrect data type for Abstract");\r
+                Log.wrn("Update Msa Header", "Incorrect data type for Abstract, it must be sentence.");\r
                 //this.jTextFieldAbstract.requestFocus();\r
                 return;\r
             }\r
@@ -1215,7 +1227,7 @@ public class MsaHeader extends IInternalFrame {
         //\r
         if (arg0.getSource() == this.jTextAreaDescription) {\r
             if (isEmpty(this.jTextAreaDescription.getText())) {\r
-                Log.wrn("Update Msa Header", "Description couldn't be empty");\r
+                Log.wrn("Update Msa Header", "Description must be entered!");\r
                 //this.jTextAreaDescription.requestFocus();\r
                 return;\r
             }\r
@@ -1231,7 +1243,7 @@ public class MsaHeader extends IInternalFrame {
         //\r
         if (arg0.getSource() == this.jTextAreaCopyright) {\r
             if (isEmpty(this.jTextAreaCopyright.getText())) {\r
-                Log.wrn("Update Msa Header", "Copyright couldn't be empty");\r
+                Log.wrn("Update Msa Header", "Copyright must be entered!");\r
                 //this.jTextFieldCopyright.requestFocus();\r
                 return;\r
             }\r
@@ -1247,7 +1259,7 @@ public class MsaHeader extends IInternalFrame {
         //\r
         if (arg0.getSource() == this.jTextAreaLicense) {\r
             if (isEmpty(this.jTextAreaLicense.getText())) {\r
-                Log.wrn("Update Msa Header", "License couldn't be empty");\r
+                Log.wrn("Update Msa Header", "License must be entered!");\r
                 //this.jTextAreaLicense.requestFocus();\r
                 return;\r
             }\r
@@ -1288,7 +1300,7 @@ public class MsaHeader extends IInternalFrame {
         //\r
         if (arg0.getSource() == this.jTextFieldOutputFileBasename) {\r
             if (isEmpty(this.jTextFieldOutputFileBasename.getText())) {\r
-                Log.wrn("Update Msa Header", "Output File Basename couldn't be empty");\r
+                Log.wrn("Update Msa Header", "Output File Basename must be entered!");\r
                 //                jTextFieldOutputFileBasename.removeFocusListener(this);\r
                 //                jTextFieldOutputFileBasename.requestFocus();\r
                 //                jTextFieldOutputFileBasename.addFocusListener(this);\r