/** @file\r
\r
- The file is used to create, update Variable of MSA/MBD file\r
+ The file is used to create, update Variables section of the MSA file\r
\r
Copyright (c) 2006, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
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
import org.tianocore.frameworkwizard.common.ui.IDialog;\r
import org.tianocore.frameworkwizard.common.ui.IFrame;\r
import org.tianocore.frameworkwizard.common.ui.StarLabel;\r
+import org.tianocore.frameworkwizard.module.Identifications.ModuleIdentification;\r
import org.tianocore.frameworkwizard.module.Identifications.Variables.VariablesIdentification;\r
+import org.tianocore.frameworkwizard.packaging.PackageIdentification;\r
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 Variables section of the MSA file\r
+ * \r
+ * It extends 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
\r
private StarLabel jStarLabel2 = null;\r
\r
+ private StarLabel jStarLabel3 = null;\r
+\r
private JScrollPane jScrollPane = null;\r
\r
private JLabel jLabelGuidCName = null;\r
\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
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
jTextFieldVariableName.setSize(new java.awt.Dimension(320, 20));\r
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, ¡");\r
+ jTextFieldVariableName.setLocation(new java.awt.Point(168, 12));\r
+ jTextFieldVariableName.setToolTipText("Enter a string; the tool will convert to Unicode hex");\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.setBounds(new java.awt.Rectangle(168, 62, 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
}\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(168, 157, 320, 20));\r
jTextFieldFeatureFlag.setPreferredSize(new java.awt.Dimension(320, 20));\r
+ jTextFieldFeatureFlag.setToolTipText("Postfix expression that must evaluate to TRUE or FALSE");\r
+ jTextFieldFeatureFlag.setEnabled(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
+ * 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(168, 87));\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
- jComboBoxGuidC_Name.setBounds(new java.awt.Rectangle(160, 35, 320, 20));\r
+ jComboBoxGuidC_Name.setBounds(new java.awt.Rectangle(168, 37, 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 Variable.");\r
}\r
return jComboBoxGuidC_Name;\r
}\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, 187, 90, 20));\r
jButtonOk.setText("Ok");\r
jButtonOk.addActionListener(this);\r
}\r
}\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, 187, 90, 20));\r
jButtonCancel.setText("Cancel");\r
jButtonCancel.addActionListener(this);\r
}\r
}\r
\r
/**\r
- This method initializes this\r
- \r
- **/\r
+ * This method initializes this\r
+ * \r
+ */\r
private void init() {\r
- this.setSize(500, 225);\r
+ this.setSize(505, 260);\r
this.setContentPane(getJScrollPane());\r
this.setTitle("Variables");\r
initFrame();\r
}\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
- private void init(VariablesIdentification inVariablesId) {\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, ModuleIdentification mid) {\r
init();\r
this.id = inVariablesId;\r
\r
+ //\r
+ // Init arch with module's arch\r
+ //\r
+ this.jArchCheckBox.setEnabledItems(wt.getModuleArch(mid));\r
+\r
+ //\r
+ // Get defined guids from dependent packages\r
+ //\r
+ Vector<PackageIdentification> vpid = wt.getPackageDependenciesOfModule(mid);\r
+ if (vpid.size() <= 0) {\r
+ Log\r
+ .wrn("Init Guid",\r
+ "This module hasn't defined any package dependency, so there is no guid value can be added for variable");\r
+ }\r
+ //\r
+ // Init guids drop down list\r
+ //\r
+ Tools\r
+ .generateComboBoxByVector(jComboBoxGuidC_Name,\r
+ wt.getAllGuidDeclarationsFromPackages(vpid, EnumerationData.GUID_TYPE_EFI_VARIABLE));\r
+\r
if (this.id != null) {\r
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 inHobsIdentification\r
- @param iFrame\r
- \r
- **/\r
- public VariablesDlg(VariablesIdentification inVariablesIdentification, IFrame iFrame) {\r
+ * This is the override edit constructor\r
+ * \r
+ * @param inVariablesIdentification\r
+ * @param iFrame\r
+ * \r
+ */\r
+ public VariablesDlg(VariablesIdentification inVariablesIdentification, IFrame iFrame, ModuleIdentification mid) {\r
super(iFrame, true);\r
- init(inVariablesIdentification);\r
+ init(inVariablesIdentification, mid);\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
}\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, 12));\r
+ jLabelVariableName = new JLabel();\r
+ jLabelVariableName.setText("Variable Name");\r
+ jLabelVariableName.setBounds(new java.awt.Rectangle(12, 12, 168, 20));\r
+\r
+ jStarLabel2 = new StarLabel();\r
+ jStarLabel2.setLocation(new java.awt.Point(2, 37));\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(12, 37, 168, 20));\r
+ jLabelGuidCName.setText("Variable Guid C Name");\r
+\r
+ jStarLabel3 = new StarLabel();\r
+ jStarLabel3.setLocation(new java.awt.Point(2, 62));\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(12, 62, 168, 20));\r
+\r
+ jLabelHelpText = new JLabel();\r
+ jLabelHelpText.setBounds(new java.awt.Rectangle(12, 87, 168, 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(12, 157, 168, 20));\r
+ jLabelFeatureFlag.setEnabled(false);\r
+\r
+ jLabelArch = new JLabel();\r
+ jLabelArch.setBounds(new java.awt.Rectangle(12, 132, 168, 20));\r
+ jLabelArch.setText("Supported Architectures");\r
+ jArchCheckBox = new ArchCheckBox();\r
+ jArchCheckBox.setBounds(new java.awt.Rectangle(168, 132, 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, 215));\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
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
}\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
//\r
- // Check VariableName \r
+ // Check VariableName\r
//\r
if (isEmpty(this.jTextFieldVariableName.getText())) {\r
- Log.err("Variable Name couldn't be empty");\r
+ Log.wrn("Update Variables", "Variable Name must be entered!");\r
return false;\r
}\r
-\r
- if (!isEmpty(this.jTextFieldVariableName.getText())) {\r
- if (!DataValidation.isHexWordArrayType(this.jTextFieldVariableName.getText())) {\r
- Log.err("Incorrect data type for Variable Name");\r
- return false;\r
- }\r
+ \r
+ //\r
+ // Check Guid Value\r
+ //\r
+ if (this.jComboBoxGuidC_Name.getSelectedItem() == null) {\r
+ Log.wrn("Update Guids", "Please select one Varibale Guid value");\r
+ return false;\r
}\r
\r
//\r
//\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 Variables", "Incorrect data type for Feature Flag");\r
return false;\r
}\r
}\r
\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
projects / mirror_edk2.git / blobdiff