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

/** @file\r
 \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
 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
package org.tianocore.frameworkwizard.module.ui.dialog;\r
\r
import java.awt.event.ActionEvent;\r
import java.awt.event.ItemEvent;\r
import java.awt.event.ItemListener;\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
\r
import org.tianocore.frameworkwizard.common.DataType;\r
import org.tianocore.frameworkwizard.common.DataValidation;\r
import org.tianocore.frameworkwizard.common.Log;\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.PackageDependencies.PackageDependenciesIdentification;\r
import org.tianocore.frameworkwizard.packaging.PackageIdentification;\r
import org.tianocore.frameworkwizard.workspace.WorkspaceTools;\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
    // / Define class Serial Version UID\r
    // /\r
    private static final long serialVersionUID = 3465193035145152131L;\r
\r
    //\r
    // Define class members\r
    //\r
    private JPanel jContentPane = null;\r
\r
    private JLabel jLabelPackageName = null;\r
\r
    private StarLabel jStarLabel1 = null;\r
\r
    private JComboBox jComboBoxPackageName = null;\r
\r
    private JLabel jLabelPackageGuid = null;\r
\r
    private JTextField jTextFieldPackageGuid = null;\r
\r
    private JLabel jLabelPackageVersion = null;\r
\r
    private JTextField jTextFieldPackageVersion = null;\r
\r
    private JLabel jLabelFeatureFlag = null;\r
\r
    private JTextField jTextFieldFeatureFlag = null;\r
\r
    private JScrollPane jScrollPane = null;\r
\r
    private JLabel jLabelArch = 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 PackageDependenciesIdentification pdid = null;\r
\r
    private WorkspaceTools wt = new WorkspaceTools();\r
\r
    private Vector<PackageIdentification> vPackage = wt.getAllPackages();\r
\r
    /**\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(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
        }\r
        return jComboBoxPackageName;\r
    }\r
\r
    /**\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(168, 37, 320, 20));\r
            jTextFieldPackageGuid.setPreferredSize(new java.awt.Dimension(320, 20));\r
            jTextFieldPackageGuid.setEditable(false);\r
            jTextFieldPackageGuid.setVisible(false);\r
        }\r
        return jTextFieldPackageGuid;\r
    }\r
\r
    /**\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(168, 37, 320, 20));\r
            jTextFieldPackageVersion.setPreferredSize(new java.awt.Dimension(320, 20));\r
            jTextFieldPackageVersion\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
     */\r
    private JTextField getJTextFieldFeatureFlag() {\r
        if (jTextFieldFeatureFlag == null) {\r
            jTextFieldFeatureFlag = new JTextField();\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
     */\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 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, 122, 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, 122, 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(505, 216);\r
        this.setContentPane(getJScrollPane());\r
        this.setTitle("Package Dependencies");\r
        initFrame();\r
        this.setViewMode(false);\r
        this.centerWindow();\r
    }\r
\r
    /**\r
     * This method initializes this\r
     * \r
     */\r
    private void init(PackageDependenciesIdentification inPackageDependenciesIdentification) {\r
        init();\r
        this.pdid = inPackageDependenciesIdentification;\r
        if (pdid != null) {\r
            this.jComboBoxPackageName.setSelectedItem(pdid.getName());\r
            this.jTextFieldPackageVersion.setText(pdid.getVersion());\r
            this.jTextFieldPackageGuid.setText(pdid.getGuid());\r
            jTextFieldFeatureFlag.setText(pdid.getFeatureFlag());\r
            this.jArchCheckBox.setSelectedItems(pdid.getSupArchList());\r
        }\r
    }\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\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
        }\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, 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(12, 37, 168, 20));\r
            jLabelPackageVersion.setText("Package Version");\r
\r
            jLabelPackageGuid = new JLabel();\r
            jLabelPackageGuid.setBounds(new java.awt.Rectangle(12, 37, 168, 20));\r
            jLabelPackageGuid.setText("Package Guid");\r
            jLabelPackageGuid.setVisible(false);\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(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(jLabelPackageVersion, null);\r
            jContentPane.add(getJTextFieldPackageVersion(), null);\r
            // LAH Not Used here\r
            // jContentPane.add(getJButtonGenerateGuid(), 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
                getCurrentPackageDependencies();\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, 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
        }\r
    }\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
        //\r
\r
        //\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
\r
        //\r
        // Check PackageVersion\r
        //\r
        if (!isEmpty(this.jTextFieldPackageVersion.getText())) {\r
            if (!DataValidation.isVersion(this.jTextFieldPackageVersion.getText())) {\r
                Log.wrn("Update Package Dependencies", "Incorrect data type for Package Version");\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 Package Dependencies", "Incorrect data type for Feature Flag");\r
                return false;\r
            }\r
        }\r
\r
        return true;\r
    }\r
\r
    private PackageDependenciesIdentification getCurrentPackageDependencies() {\r
        String arg0 = this.jComboBoxPackageName.getSelectedItem().toString();\r
        String arg1 = this.jTextFieldPackageVersion.getText();\r
        String arg2 = this.jTextFieldPackageGuid.getText();\r
\r
        String arg3 = this.jTextFieldFeatureFlag.getText();\r
        Vector<String> arg4 = this.jArchCheckBox.getSelectedItemsVector();\r
        pdid = new PackageDependenciesIdentification(arg0, arg1, arg2, arg3, arg4);\r
        return pdid;\r
    }\r
\r
    /*\r
     * (non-Javadoc)\r
     * \r
     * @see java.awt.event.ItemListener#itemStateChanged(java.awt.event.ItemEvent)\r
     * \r
     * Reflesh the frame when selected item changed\r
     * \r
     */\r
    public void itemStateChanged(ItemEvent arg0) {\r
        if (arg0.getSource() == this.jComboBoxPackageName && arg0.getStateChange() == ItemEvent.SELECTED) {\r
            for (int index = 0; index < vPackage.size(); index++) {\r
                if (this.jComboBoxPackageName.getSelectedItem().toString().equals(vPackage.get(index).getName())) {\r
                    this.jTextFieldPackageGuid.setText(vPackage.get(index).getGuid());\r
                }\r
            }\r
        }\r
    }\r
\r
    public PackageDependenciesIdentification getPdid() {\r
        return pdid;\r
    }\r
\r
    public void setPdid(PackageDependenciesIdentification pdid) {\r
        this.pdid = pdid;\r
    }\r
\r
}\r