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

/** @file\r
 \r
 The file is used to create, update Variable of MSA/MBD file\r
 \r
 Copyright (c) 2006, Intel Corporation\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
 http://opensource.org/licenses/bsd-license.php\r
 \r
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
\r
package org.tianocore.frameworkwizard.module.ui.dialog;\r
\r
import java.awt.event.ActionEvent;\r
import java.util.Vector;\r
\r
import javax.swing.JButton;\r
import javax.swing.JComboBox;\r
import javax.swing.JLabel;\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.EnumerationData;\r
import org.tianocore.frameworkwizard.common.Log;\r
import org.tianocore.frameworkwizard.common.Tools;\r
import org.tianocore.frameworkwizard.common.ui.ArchCheckBox;\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.Variables.VariablesIdentification;\r
import org.tianocore.frameworkwizard.workspace.WorkspaceTools;\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
    private static final long serialVersionUID = -6998982978030439446L;\r
\r
    //\r
    // Define class members\r
    //\r
    private JPanel jContentPane = null;\r
\r
    private JLabel jLabelVariableName = null;\r
\r
    private JTextField jTextFieldVariableName = null;\r
\r
    private JLabel jLabelUsage = null;\r
\r
    private JComboBox jComboBoxUsage = null;\r
\r
    private StarLabel jStarLabel1 = null;\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 JComboBox jComboBoxGuidC_Name = null;\r
\r
    private JTextField jTextFieldFeatureFlag = null;\r
\r
    private JLabel jLabelFeatureFlag = null;\r
\r
    private JLabel jLabelArch = null;\r
\r
    private JLabel jLabelHelpText = null;\r
\r
    private JTextArea jTextAreaHelpText = null;\r
\r
    private JScrollPane jScrollPaneHelpText = null;\r
\r
    private ArchCheckBox jArchCheckBox = null;\r
\r
    private JButton jButtonOk = null;\r
\r
    private JButton jButtonCancel = null;\r
\r
    //\r
    // Not used by UI\r
    //\r
    private VariablesIdentification id = null;\r
\r
    private EnumerationData ed = new EnumerationData();\r
\r
    private WorkspaceTools wt = new WorkspaceTools();\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, 0x00FF");\r
        }\r
        return jTextFieldVariableName;\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, 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
     */\r
    private JScrollPane getJScrollPane() {\r
        if (jScrollPane == null) {\r
            jScrollPane = new JScrollPane();\r
            jScrollPane.setViewportView(getJContentPane());\r
        }\r
        return jScrollPane;\r
    }\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, 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 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 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 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.setPreferredSize(new java.awt.Dimension(320, 20));\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
    private JButton getJButtonOk() {\r
        if (jButtonOk == null) {\r
            jButtonOk = new JButton();\r
            jButtonOk.setBounds(new java.awt.Rectangle(290, 182, 90, 20));\r
            jButtonOk.setText("Ok");\r
            jButtonOk.addActionListener(this);\r
        }\r
        return jButtonOk;\r
    }\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, 182, 90, 20));\r
            jButtonCancel.setText("Cancel");\r
            jButtonCancel.addActionListener(this);\r
        }\r
        return jButtonCancel;\r
    }\r
\r
    public static void main(String[] args) {\r
\r
    }\r
\r
    /**\r
     * This method initializes this\r
     * \r
     */\r
    private void init() {\r
        this.setSize(500, 255);\r
        this.setContentPane(getJScrollPane());\r
        this.setTitle("Variables");\r
        initFrame();\r
        this.setViewMode(false);\r
        this.centerWindow();\r
    }\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
\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.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
    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\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
            this.jComboBoxUsage.setEnabled(!isView);\r
        }\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
            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, 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, 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 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(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(jStarLabel3, null);\r
            jContentPane.add(jLabelUsage, null);\r
            jContentPane.add(getJComboBoxUsage(), null);\r
            jContentPane.add(jLabelHelpText, null);\r
            jContentPane.add(getJScrollPaneHelpText(), null);\r
            jContentPane.add(jLabelFeatureFlag, null);\r
            jContentPane.add(getJTextFieldFeatureFlag(), null);\r
            jContentPane.add(jLabelArch, null);\r
            jContentPane.add(jArchCheckBox, null);\r
            jContentPane.add(getJButtonOk(), null);\r
            jContentPane.add(getJButtonCancel(), null);\r
        }\r
        return jContentPane;\r
    }\r
\r
    /*\r
     * (non-Javadoc)\r
     * \r
     * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)\r
     * \r
     * Override actionPerformed to listen all actions\r
     * \r
     */\r
    public void actionPerformed(ActionEvent arg0) {\r
        if (arg0.getSource() == jButtonOk) {\r
            if (checkAdd()) {\r
                getCurrentVariables();\r
                this.returnType = DataType.RETURN_TYPE_OK;\r
                this.setVisible(false);\r
            }\r
        }\r
\r
        if (arg0.getSource() == jButtonCancel) {\r
            this.returnType = DataType.RETURN_TYPE_CANCEL;\r
            this.setVisible(false);\r
        }\r
    }\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
    public boolean checkAdd() {\r
        //\r
        // Check if all fields have correct data types\r
        //\r
\r
        //\r
        // Check VariableName\r
        //\r
        if (isEmpty(this.jTextFieldVariableName.getText())) {\r
            Log.wrn("Update Variables", "Variable Name must not be empty");\r
            return false;\r
        }\r
\r
        if (!isEmpty(this.jTextFieldVariableName.getText())) {\r
            if (!DataValidation.isHexWordArrayType(this.jTextFieldVariableName.getText())) {\r
                Log.wrn("Update Variables", "Incorrect data type for Variable Name");\r
                return false;\r
            }\r
        }\r
\r
        //\r
        // Check FeatureFlag\r
        //\r
        if (!isEmpty(this.jTextFieldFeatureFlag.getText())) {\r
            if (!DataValidation.isFeatureFlag(this.jTextFieldFeatureFlag.getText())) {\r
                Log.wrn("Update Variables", "Incorrect data type for Feature Flag");\r
                return false;\r
            }\r
        }\r
\r
        return true;\r
    }\r
\r
    private VariablesIdentification getCurrentVariables() {\r
        String arg0 = this.jTextFieldVariableName.getText();\r
        String arg1 = this.jComboBoxGuidC_Name.getSelectedItem().toString();\r
        String arg2 = this.jComboBoxUsage.getSelectedItem().toString();\r
\r
        String arg3 = this.jTextFieldFeatureFlag.getText();\r
        Vector<String> arg4 = this.jArchCheckBox.getSelectedItemsVector();\r
        String arg5 = this.jTextAreaHelpText.getText();\r
\r
        id = new VariablesIdentification(arg0, arg1, arg2, arg3, arg4, arg5);\r
        return id;\r
    }\r
\r
    public VariablesIdentification getId() {\r
        return id;\r
    }\r
\r
    public void setId(VariablesIdentification id) {\r
        this.id = id;\r
    }\r
}\r
Commit	Line	Data
06a19cee	1	/** @file\r
	2	\r
	3	The file is used to create, update Variable of MSA/MBD file\r
	4	\r
	5	Copyright (c) 2006, Intel Corporation\r
	6	All rights reserved. This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	**/\r
	15	\r
	16	package org.tianocore.frameworkwizard.module.ui.dialog;\r
	17	\r
	18	import java.awt.event.ActionEvent;\r
	19	import java.util.Vector;\r
	20	\r
	21	import javax.swing.JButton;\r
	22	import javax.swing.JComboBox;\r
	23	import javax.swing.JLabel;\r
	24	import javax.swing.JPanel;\r
	25	import javax.swing.JScrollPane;\r
	26	import javax.swing.JTextField;\r
ccb063b1	27	import javax.swing.JTextArea;\r
06a19cee	28	\r
	29	import org.tianocore.frameworkwizard.common.DataType;\r
	30	import org.tianocore.frameworkwizard.common.DataValidation;\r
	31	import org.tianocore.frameworkwizard.common.EnumerationData;\r
	32	import org.tianocore.frameworkwizard.common.Log;\r
	33	import org.tianocore.frameworkwizard.common.Tools;\r
	34	import org.tianocore.frameworkwizard.common.ui.ArchCheckBox;\r
	35	import org.tianocore.frameworkwizard.common.ui.IDialog;\r
	36	import org.tianocore.frameworkwizard.common.ui.IFrame;\r
	37	import org.tianocore.frameworkwizard.common.ui.StarLabel;\r
	38	import org.tianocore.frameworkwizard.module.Identifications.Variables.VariablesIdentification;\r
	39	import org.tianocore.frameworkwizard.workspace.WorkspaceTools;\r
	40	\r
	41	/**\r
ccb063b1	42	* The class is used to create, update Variable of MSA/MBD file It extends\r
	43	* IDialog\r
	44	* \r
	45	*/\r
06a19cee	46	public class VariablesDlg extends IDialog {\r
06a19cee	47	\r
a929458e	48	// /\r
	49	// / Define class Serial Version UID\r
	50	// /\r
	51	private static final long serialVersionUID = -6998982978030439446L;\r
06a19cee	52	\r
a929458e	53	//\r
	54	// Define class members\r
	55	//\r
	56	private JPanel jContentPane = null;\r
06a19cee	57	\r
a929458e	58	private JLabel jLabelVariableName = null;\r
06a19cee	59	\r
a929458e	60	private JTextField jTextFieldVariableName = null;\r
06a19cee	61	\r
a929458e	62	private JLabel jLabelUsage = null;\r
06a19cee	63	\r
a929458e	64	private JComboBox jComboBoxUsage = null;\r
06a19cee	65	\r
a929458e	66	private StarLabel jStarLabel1 = null;\r
06a19cee	67	\r
a929458e	68	private StarLabel jStarLabel2 = null;\r
06a19cee	69	\r
a929458e	70	private StarLabel jStarLabel3 = null;\r
06a19cee	71	\r
a929458e	72	private JScrollPane jScrollPane = null;\r
06a19cee	73	\r
a929458e	74	private JLabel jLabelGuidCName = null;\r
06a19cee	75	\r
a929458e	76	private JComboBox jComboBoxGuidC_Name = null;\r
06a19cee	77	\r
a929458e	78	private JTextField jTextFieldFeatureFlag = null;\r
06a19cee	79	\r
a929458e	80	private JLabel jLabelFeatureFlag = null;\r
06a19cee	81	\r
a929458e	82	private JLabel jLabelArch = null;\r
06a19cee	83	\r
a929458e	84	private JLabel jLabelHelpText = null;\r
06a19cee	85	\r
a929458e	86	private JTextArea jTextAreaHelpText = null;\r
06a19cee	87	\r
a929458e	88	private JScrollPane jScrollPaneHelpText = null;\r
06a19cee	89	\r
a929458e	90	private ArchCheckBox jArchCheckBox = null;\r
06a19cee	91	\r
a929458e	92	private JButton jButtonOk = null;\r
06a19cee	93	\r
a929458e	94	private JButton jButtonCancel = null;\r
06a19cee	95	\r
a929458e	96	//\r
	97	// Not used by UI\r
	98	//\r
	99	private VariablesIdentification id = null;\r
	100	\r
	101	private EnumerationData ed = new EnumerationData();\r
	102	\r
	103	private WorkspaceTools wt = new WorkspaceTools();\r
	104	\r
	105	/**\r
	106	* This method initializes jTextFieldString\r
	107	* \r
	108	* @return javax.swing.JTextField jTextFieldString\r
	109	* \r
	110	*/\r
	111	private JTextField getJTextFieldString() {\r
	112	if (jTextFieldVariableName == null) {\r
	113	jTextFieldVariableName = new JTextField();\r
	114	jTextFieldVariableName.setSize(new java.awt.Dimension(320, 20));\r
	115	jTextFieldVariableName.setPreferredSize(new java.awt.Dimension(320, 20));\r
	116	jTextFieldVariableName.setLocation(new java.awt.Point(160, 10));\r
	117	jTextFieldVariableName\r
	118	.setToolTipText("Enter a Hex Word Array, you must provide leading Zeros. 0x000a, 0x0010, 0x00FF");\r
	119	}\r
	120	return jTextFieldVariableName;\r
	121	}\r
06a19cee	122	\r
a929458e	123	/**\r
	124	* This method initializes jComboBoxUsage\r
	125	* \r
	126	* @return javax.swing.JComboBox jComboBoxUsage\r
	127	* \r
	128	*/\r
	129	private JComboBox getJComboBoxUsage() {\r
	130	if (jComboBoxUsage == null) {\r
	131	jComboBoxUsage = new JComboBox();\r
	132	jComboBoxUsage.setBounds(new java.awt.Rectangle(160, 60, 320, 20));\r
	133	jComboBoxUsage.setPreferredSize(new java.awt.Dimension(320, 20));\r
	134	jComboBoxUsage\r
	135	.setToolTipText("<html><table>"\r
	136	+ "<tr><td>ALWAYS_CONSUMED</td><td>The module requires the variable entry to be set</td></tr>"\r
	137	+ "<tr><td>SOMETIMES_CONSUMED</td><td>The module will use the variable entry if it is set.</td></tr>"\r
	138	+ "<tr><td>ALWAYS_PRODUCED</td><td>The module will always write the variable.</td></tr>"\r
	139	+ "<tr><td>SOMETIMES_PRODUCED</td><td>The module will sometimes write the variable.</td></tr>"\r
	140	+ "</table></html>");\r
	141	}\r
	142	return jComboBoxUsage;\r
	143	}\r
06a19cee	144	\r
a929458e	145	/**\r
	146	* This method initializes jScrollPane\r
	147	* \r
	148	* @return javax.swing.JScrollPane\r
	149	*/\r
	150	private JScrollPane getJScrollPane() {\r
	151	if (jScrollPane == null) {\r
	152	jScrollPane = new JScrollPane();\r
	153	jScrollPane.setViewportView(getJContentPane());\r
	154	}\r
	155	return jScrollPane;\r
06a19cee	156	}\r
a929458e	157	\r
	158	/**\r
	159	* This method initializes jTextFieldFeatureFlag\r
	160	* \r
	161	* @return javax.swing.JTextField jTextFieldFeatureFlag\r
	162	* \r
	163	*/\r
	164	private JTextField getJTextFieldFeatureFlag() {\r
	165	if (jTextFieldFeatureFlag == null) {\r
	166	jTextFieldFeatureFlag = new JTextField();\r
	167	jTextFieldFeatureFlag.setBounds(new java.awt.Rectangle(160, 130, 320, 20));\r
	168	jTextFieldFeatureFlag.setPreferredSize(new java.awt.Dimension(320, 20));\r
	169	jTextFieldFeatureFlag.setToolTipText("Postfix expression that must evaluate to TRUE or FALSE");\r
	170	}\r
	171	return jTextFieldFeatureFlag;\r
06a19cee	172	}\r
a929458e	173	\r
	174	/**\r
	175	* This method initializes jTextFieldHelpText\r
	176	* \r
	177	* @return javax.swing.JTextField\r
	178	* \r
	179	*/\r
	180	private JTextArea getJTextAreaHelpText() {\r
	181	if (jTextAreaHelpText == null) {\r
	182	jTextAreaHelpText = new JTextArea();\r
	183	jTextAreaHelpText.setLineWrap(true);\r
	184	jTextAreaHelpText.setWrapStyleWord(true);\r
	185	jTextAreaHelpText.setToolTipText("Enter information on how to use this Variable.");\r
	186	}\r
	187	return jTextAreaHelpText;\r
06a19cee	188	}\r
a929458e	189	\r
	190	private JScrollPane getJScrollPaneHelpText() {\r
	191	if (jScrollPaneHelpText == null) {\r
	192	jScrollPaneHelpText = new JScrollPane();\r
	193	jScrollPaneHelpText.setHorizontalScrollBarPolicy(javax.swing.JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);\r
	194	jScrollPaneHelpText.setSize(new java.awt.Dimension(320, 40));\r
	195	jScrollPaneHelpText.setPreferredSize(new java.awt.Dimension(320, 40));\r
	196	jScrollPaneHelpText.setLocation(new java.awt.Point(160, 85));\r
	197	jScrollPaneHelpText.setViewportView(getJTextAreaHelpText());\r
	198	}\r
	199	return jScrollPaneHelpText;\r
06a19cee	200	}\r
a929458e	201	\r
	202	/**\r
	203	* This method initializes jComboBoxGuidC_Name\r
	204	* \r
	205	* @return javax.swing.JComboBox jComboBoxGuidC_Name\r
	206	* \r
	207	*/\r
	208	private JComboBox getJComboBoxGuidC_Name() {\r
	209	if (jComboBoxGuidC_Name == null) {\r
	210	jComboBoxGuidC_Name = new JComboBox();\r
	211	jComboBoxGuidC_Name.setBounds(new java.awt.Rectangle(160, 35, 320, 20));\r
	212	jComboBoxGuidC_Name.setPreferredSize(new java.awt.Dimension(320, 20));\r
	213	jComboBoxGuidC_Name.setToolTipText("Select the GUID C Name of the Variable.");\r
	214	}\r
	215	return jComboBoxGuidC_Name;\r
06a19cee	216	}\r
a929458e	217	\r
	218	/**\r
	219	* This method initializes jButtonOk\r
	220	* \r
	221	* @return javax.swing.JButton\r
	222	* \r
	223	*/\r
	224	private JButton getJButtonOk() {\r
	225	if (jButtonOk == null) {\r
	226	jButtonOk = new JButton();\r
	227	jButtonOk.setBounds(new java.awt.Rectangle(290, 182, 90, 20));\r
	228	jButtonOk.setText("Ok");\r
	229	jButtonOk.addActionListener(this);\r
	230	}\r
	231	return jButtonOk;\r
06a19cee	232	}\r
a929458e	233	\r
	234	/**\r
	235	* This method initializes jButtonCancel\r
	236	* \r
	237	* @return javax.swing.JButton\r
	238	* \r
	239	*/\r
	240	private JButton getJButtonCancel() {\r
	241	if (jButtonCancel == null) {\r
	242	jButtonCancel = new JButton();\r
	243	jButtonCancel.setBounds(new java.awt.Rectangle(390, 182, 90, 20));\r
	244	jButtonCancel.setText("Cancel");\r
	245	jButtonCancel.addActionListener(this);\r
	246	}\r
	247	return jButtonCancel;\r
	248	}\r
	249	\r
	250	public static void main(String[] args) {\r
	251	\r
06a19cee	252	}\r
a929458e	253	\r
	254	/**\r
	255	* This method initializes this\r
	256	* \r
	257	*/\r
	258	private void init() {\r
	259	this.setSize(500, 255);\r
	260	this.setContentPane(getJScrollPane());\r
	261	this.setTitle("Variables");\r
	262	initFrame();\r
	263	this.setViewMode(false);\r
	264	this.centerWindow();\r
06a19cee	265	}\r
a929458e	266	\r
	267	/**\r
	268	* This method initializes this Fill values to all fields if these values are\r
	269	* not empty\r
	270	* \r
	271	* @param inVariablesId\r
	272	* \r
	273	*/\r
	274	private void init(VariablesIdentification inVariablesId) {\r
	275	init();\r
	276	this.id = inVariablesId;\r
	277	\r
	278	if (this.id != null) {\r
	279	this.jTextFieldVariableName.setText(id.getName());\r
	280	this.jComboBoxGuidC_Name.setSelectedItem(id.getGuid());\r
	281	this.jComboBoxUsage.setSelectedItem(id.getUsage());\r
	282	this.jTextAreaHelpText.setText(id.getHelp());\r
	283	this.jTextFieldFeatureFlag.setText(id.getFeatureFlag());\r
	284	this.jArchCheckBox.setSelectedItems(id.getSupArchList());\r
	285	}\r
06a19cee	286	}\r
a929458e	287	\r
	288	/**\r
	289	* This is the override edit constructor\r
	290	* \r
	291	* @param inVariablesIdentification\r
	292	* @param iFrame\r
	293	* \r
	294	*/\r
	295	public VariablesDlg(VariablesIdentification inVariablesIdentification, IFrame iFrame) {\r
	296	super(iFrame, true);\r
	297	init(inVariablesIdentification);\r
06a19cee	298	}\r
a929458e	299	\r
	300	/**\r
	301	* Disable all components when the mode is view\r
	302	* \r
	303	* @param isView\r
	304	* true - The view mode; false - The non-view mode\r
	305	* \r
	306	*/\r
	307	public void setViewMode(boolean isView) {\r
	308	if (isView) {\r
	309	this.jTextFieldVariableName.setEnabled(!isView);\r
	310	this.jComboBoxUsage.setEnabled(!isView);\r
	311	}\r
06a19cee	312	}\r
a929458e	313	\r
	314	/**\r
	315	* This method initializes jContentPane\r
	316	* \r
	317	* @return javax.swing.JPanel jContentPane\r
	318	* \r
	319	*/\r
	320	private JPanel getJContentPane() {\r
	321	if (jContentPane == null) {\r
	322	jStarLabel1 = new StarLabel();\r
	323	jStarLabel1.setLocation(new java.awt.Point(2, 10));\r
	324	jLabelVariableName = new JLabel();\r
	325	jLabelVariableName.setText("Variable Name");\r
	326	jLabelVariableName.setBounds(new java.awt.Rectangle(15, 10, 145, 20));\r
	327	\r
	328	jStarLabel2 = new StarLabel();\r
	329	jStarLabel2.setLocation(new java.awt.Point(2, 35));\r
	330	jLabelGuidCName = new JLabel();\r
	331	jLabelGuidCName.setBounds(new java.awt.Rectangle(15, 35, 145, 20));\r
	332	jLabelGuidCName.setText("Variable Guid C Name");\r
	333	\r
	334	jStarLabel3 = new StarLabel();\r
	335	jStarLabel3.setLocation(new java.awt.Point(2, 60));\r
	336	jLabelUsage = new JLabel();\r
	337	jLabelUsage.setText("Usage");\r
	338	jLabelUsage.setBounds(new java.awt.Rectangle(15, 60, 145, 20));\r
	339	\r
	340	jLabelHelpText = new JLabel();\r
	341	jLabelHelpText.setBounds(new java.awt.Rectangle(14, 85, 145, 20));\r
	342	jLabelHelpText.setText("Help Text");\r
	343	\r
	344	jLabelFeatureFlag = new JLabel();\r
	345	jLabelFeatureFlag.setText("Feature Flag Expression");\r
	346	jLabelFeatureFlag.setBounds(new java.awt.Rectangle(15, 130, 145, 20));\r
	347	\r
	348	jLabelArch = new JLabel();\r
	349	jLabelArch.setBounds(new java.awt.Rectangle(15, 155, 145, 20));\r
	350	jLabelArch.setText("Supported Architectures");\r
	351	jArchCheckBox = new ArchCheckBox();\r
	352	jArchCheckBox.setBounds(new java.awt.Rectangle(160, 155, 320, 20));\r
	353	jArchCheckBox.setPreferredSize(new java.awt.Dimension(320, 20));\r
	354	\r
	355	jContentPane = new JPanel();\r
	356	jContentPane.setLayout(null);\r
	357	jContentPane.setPreferredSize(new java.awt.Dimension(485, 210));\r
	358	\r
	359	jContentPane.add(jStarLabel1, null);\r
	360	jContentPane.add(jLabelVariableName, null);\r
	361	jContentPane.add(getJTextFieldString(), null);\r
	362	jContentPane.add(jStarLabel2, null);\r
	363	jContentPane.add(jLabelGuidCName, null);\r
	364	jContentPane.add(getJComboBoxGuidC_Name(), null);\r
	365	jContentPane.add(jStarLabel3, null);\r
	366	jContentPane.add(jLabelUsage, null);\r
	367	jContentPane.add(getJComboBoxUsage(), null);\r
	368	jContentPane.add(jLabelHelpText, null);\r
	369	jContentPane.add(getJScrollPaneHelpText(), null);\r
	370	jContentPane.add(jLabelFeatureFlag, null);\r
	371	jContentPane.add(getJTextFieldFeatureFlag(), null);\r
	372	jContentPane.add(jLabelArch, null);\r
	373	jContentPane.add(jArchCheckBox, null);\r
	374	jContentPane.add(getJButtonOk(), null);\r
	375	jContentPane.add(getJButtonCancel(), null);\r
	376	}\r
377	return jContentPane;\r
06a19cee	378	}\r
a929458e	379	\r
	380	/*\r
	381	* (non-Javadoc)\r
	382	* \r
	383	* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)\r
	384	* \r
	385	* Override actionPerformed to listen all actions\r
	386	* \r
	387	*/\r
	388	public void actionPerformed(ActionEvent arg0) {\r
	389	if (arg0.getSource() == jButtonOk) {\r
	390	if (checkAdd()) {\r
	391	getCurrentVariables();\r
	392	this.returnType = DataType.RETURN_TYPE_OK;\r
	393	this.setVisible(false);\r
	394	}\r
	395	}\r
	396	\r
	397	if (arg0.getSource() == jButtonCancel) {\r
	398	this.returnType = DataType.RETURN_TYPE_CANCEL;\r
	399	this.setVisible(false);\r
	400	}\r
06a19cee	401	}\r
06a19cee	402	\r
a929458e	403	/**\r
	404	* This method initializes Usage type\r
	405	* \r
	406	*/\r
	407	private void initFrame() {\r
	408	Tools.generateComboBoxByVector(jComboBoxUsage, ed.getVPpiUsage());\r
	409	Tools.generateComboBoxByVector(jComboBoxGuidC_Name, wt.getAllGuidDeclarationsFromWorkspace());\r
ccb063b1	410	}\r
06a19cee	411	\r
a929458e	412	/**\r
	413	* Data validation for all fields\r
	414	* \r
	415	* @retval true - All datas are valid\r
	416	* @retval false - At least one data is invalid\r
	417	* \r
	418	*/\r
	419	public boolean checkAdd() {\r
	420	//\r
	421	// Check if all fields have correct data types\r
	422	//\r
	423	\r
	424	//\r
	425	// Check VariableName\r
	426	//\r
	427	if (isEmpty(this.jTextFieldVariableName.getText())) {\r
	428	Log.wrn("Update Variables", "Variable Name must not be empty");\r
	429	return false;\r
	430	}\r
	431	\r
	432	if (!isEmpty(this.jTextFieldVariableName.getText())) {\r
	433	if (!DataValidation.isHexWordArrayType(this.jTextFieldVariableName.getText())) {\r
	434	Log.wrn("Update Variables", "Incorrect data type for Variable Name");\r
	435	return false;\r
	436	}\r
	437	}\r
	438	\r
	439	//\r
	440	// Check FeatureFlag\r
	441	//\r
	442	if (!isEmpty(this.jTextFieldFeatureFlag.getText())) {\r
	443	if (!DataValidation.isFeatureFlag(this.jTextFieldFeatureFlag.getText())) {\r
	444	Log.wrn("Update Variables", "Incorrect data type for Feature Flag");\r
	445	return false;\r
	446	}\r
	447	}\r
	448	\r
	449	return true;\r
06a19cee	450	}\r
06a19cee	451	\r
a929458e	452	private VariablesIdentification getCurrentVariables() {\r
	453	String arg0 = this.jTextFieldVariableName.getText();\r
	454	String arg1 = this.jComboBoxGuidC_Name.getSelectedItem().toString();\r
	455	String arg2 = this.jComboBoxUsage.getSelectedItem().toString();\r
	456	\r
	457	String arg3 = this.jTextFieldFeatureFlag.getText();\r
	458	Vector<String> arg4 = this.jArchCheckBox.getSelectedItemsVector();\r
	459	String arg5 = this.jTextAreaHelpText.getText();\r
	460	\r
	461	id = new VariablesIdentification(arg0, arg1, arg2, arg3, arg4, arg5);\r
	462	return id;\r
06a19cee	463	}\r
06a19cee	464	\r
a929458e	465	public VariablesIdentification getId() {\r
a929458e	466	return id;\r
06a19cee	467	}\r
ccb063b1	468	\r
a929458e	469	public void setId(VariablesIdentification id) {\r
	470	this.id = id;\r
	471	}\r
06a19cee	472	}\r