1. Fix EDKT528: Framework wizard should not force user to specify a GuidCName for...

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

/** @file\r
 \r
 The file is used to create, update Events 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.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.IComboBox;\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.Events.EventsIdentification;\r
import org.tianocore.frameworkwizard.packaging.PackageIdentification;\r
import org.tianocore.frameworkwizard.workspace.WorkspaceTools;\r
\r
/**\r
 * The class is used to create, update Events section of the MSA file \r
 * It extends IDialog\r
 * \r
 * @since ModuleEditor 1.0\r
 * \r
 */\r
public class EventsDlg extends IDialog {\r
\r
    // /\r
    // / Define class Serial Version UID\r
    // /\r
    private static final long serialVersionUID = -4396143706422842331L;\r
\r
    //\r
    // Define class members\r
    //\r
    private JPanel jContentPane = null;\r
\r
    private JLabel jLabelEventType = null;\r
\r
    private JLabel jLabelC_Name = null;\r
\r
    private IComboBox iComboBoxGuidC_Name = null;\r
\r
    private JLabel jLabelUsage = null;\r
\r
    private JLabel jLabelGroup = null;\r
\r
    private JComboBox jComboBoxUsage = null;\r
\r
    private JComboBox jComboBoxEventGroup = null;\r
\r
    private StarLabel jStarLabel1 = null;\r
\r
    private StarLabel jStarLabel2 = null;\r
\r
    private StarLabel jStarLabel3 = null;\r
\r
    private StarLabel jStarLabel4 = null;\r
\r
    private JComboBox jComboBoxEventsType = null;\r
\r
    private JScrollPane jScrollPane = 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 JLabel jLabelFeatureFlag = null;\r
\r
    private JTextField jTextFieldFeatureFlag = 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 EventsIdentification id = null;\r
\r
    private EnumerationData ed = new EnumerationData();\r
\r
    private WorkspaceTools wt = new WorkspaceTools();\r
\r
    /**\r
     * This method initializes jComboBoxType\r
     * \r
     * @return javax.swing.JComboBox jComboBoxType\r
     * \r
     */\r
    private JComboBox getJComboBoxEventsType() {\r
        if (jComboBoxEventsType == null) {\r
            jComboBoxEventsType = new JComboBox();\r
            jComboBoxEventsType.setBounds(new java.awt.Rectangle(168, 12, 320, 20));\r
            jComboBoxEventsType.setPreferredSize(new java.awt.Dimension(320, 20));\r
            jComboBoxEventsType\r
                               .setToolTipText("<html>Select CreateEvents if the Module has an event that is waiting to be signaled.<br>"\r
                                               + "Select SignalEvents if the Module will signal all events in an event group.<br>"\r
                                               + "NOTE: Signal events are named by GUID.</html>");\r
        }\r
        return jComboBoxEventsType;\r
    }\r
\r
    /**\r
     * This method initializes jTextFieldC_Name\r
     * \r
     * @return javax.swing.JTextField jTextFieldC_Name\r
     * \r
     */\r
    private IComboBox getIComboBoxGuidC_Name() {\r
        if (iComboBoxGuidC_Name == null) {\r
            iComboBoxGuidC_Name = new IComboBox();\r
            iComboBoxGuidC_Name.setBounds(new java.awt.Rectangle(168, 37, 320, 20));\r
            iComboBoxGuidC_Name.setPreferredSize(new java.awt.Dimension(320, 20));\r
            iComboBoxGuidC_Name.setToolTipText("Select the GUID C Name of the Event");\r
        }\r
        return iComboBoxGuidC_Name;\r
    }\r
\r
    /**\r
     * This method initializes jComboBoxEventsType\r
     * \r
     * @return javax.swing.JComboBox\r
     */\r
    private JComboBox getJComboBoxEventGroup() {\r
        if (jComboBoxEventGroup == null) {\r
            jComboBoxEventGroup = new JComboBox();\r
            jComboBoxEventGroup.setBounds(new java.awt.Rectangle(168, 62, 320, 20));\r
            jComboBoxEventGroup.setPreferredSize(new java.awt.Dimension(320, 20));\r
            jComboBoxEventGroup.setToolTipText("Select Type of Event: Guid or Timer.");\r
\r
        }\r
        return jComboBoxEventGroup;\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(168, 87, 320, 20));\r
            jComboBoxUsage.setPreferredSize(new java.awt.Dimension(320, 20));\r
            jComboBoxUsage\r
                          .setToolTipText("<html><table>"\r
                                          + "<tr><td colspan=2 align=center><b>Create Events</b></td></tr>"\r
                                          + "<tr><td>ALWAYS_CONSUMED</td><td>Module registers a notification function and REQUIRES that it be<br>"\r
                                          + "executed for the module to fully function.</td></tr>"\r
                                          + "<tr><td>SOMETIMES_CONSUMED</td><td>Module registers a notification function and calls the function<br>"\r
                                          + "when it is signaled</td></tr><tr><td colspan=2 align=center><b>Signal Events</b></td></tr>"\r
                                          + "<tr><td>ALWAYS_PRODUCED</td><td>Module will Always signal the event</td></tr>"\r
                                          + "<tr><td>SOMETIMES_PRODUCED</td><td>Module will sometimes signal the event</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\r
     */\r
    private JTextField getJTextFieldFeatureFlag() {\r
        if (jTextFieldFeatureFlag == null) {\r
            jTextFieldFeatureFlag = new JTextField();\r
            jTextFieldFeatureFlag.setBounds(new java.awt.Rectangle(168, 182, 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 jTextAreaHelpText\r
     * \r
     * @return javax.swing.JTextArea\r
     * \r
     */\r
    private JTextArea getJTextAreaHelpText() {\r
        if (jTextAreaHelpText == null) {\r
            jTextAreaHelpText = new JTextArea();\r
            jTextAreaHelpText.setLineWrap(true);\r
            jTextAreaHelpText.setWrapStyleWord(true);\r
        }\r
        return jTextAreaHelpText;\r
    }\r
\r
    /**\r
     * This method initializes jScrollPaneHelpText\r
     * \r
     * @return javax.swing.JScrollPane\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, 112));\r
            jScrollPaneHelpText.setViewportView(getJTextAreaHelpText());\r
        }\r
        return jScrollPaneHelpText;\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, 212, 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, 212, 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, 280);\r
        this.setContentPane(getJScrollPane());\r
        this.setTitle("Events");\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 inEventsId\r
     * \r
     */\r
    private void init(EventsIdentification inEventsId, ModuleIdentification mid) {\r
        init();\r
        this.id = inEventsId;\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 event");\r
        }\r
        //\r
        // Init guids drop down list\r
        //\r
        Tools\r
             .generateComboBoxByVector(iComboBoxGuidC_Name,\r
                                       wt.getAllGuidDeclarationsFromPackages(vpid, EnumerationData.GUID_TYPE_EFI_EVENT));\r
        \r
        this.iComboBoxGuidC_Name.insertItemAt(DataType.EMPTY_SELECT_ITEM, 0);\r
        this.iComboBoxGuidC_Name.setSelectedIndex(0);\r
\r
        if (this.id != null) {\r
            String tmpName = id.getName();\r
            if (isEmpty(tmpName)) {\r
                tmpName = DataType.EMPTY_SELECT_ITEM;\r
            }\r
\r
            this.iComboBoxGuidC_Name.setSelectedItem(tmpName);\r
            this.jComboBoxEventsType.setSelectedItem(id.getType());\r
            this.jComboBoxUsage.setSelectedItem(id.getUsage());\r
            this.jTextAreaHelpText.setText(id.getHelp());\r
\r
            jTextFieldFeatureFlag.setText(id.getFeatureFlag());\r
            this.jArchCheckBox.setSelectedItems(id.getSupArchList());\r
            this.jComboBoxEventGroup.setSelectedItem(id.getGroup());\r
        }\r
    }\r
\r
    /**\r
     * This is the override edit constructor\r
     * \r
     * @param inEventsIdentification\r
     * @param iFrame\r
     * \r
     */\r
    public EventsDlg(EventsIdentification inEventsIdentification, IFrame iFrame, ModuleIdentification mid) {\r
        super(iFrame, true);\r
        init(inEventsIdentification, mid);\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.iComboBoxGuidC_Name.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, 12));\r
            jLabelEventType = new JLabel();\r
            jLabelEventType.setText("Select Event Type");\r
            jLabelEventType.setBounds(new java.awt.Rectangle(12, 12, 168, 20));\r
\r
            jStarLabel2 = new StarLabel();\r
            jStarLabel2.setLocation(new java.awt.Point(2, 37));\r
            jLabelC_Name = new JLabel();\r
            jLabelC_Name.setText("Guid C Name");\r
            jLabelC_Name.setBounds(new java.awt.Rectangle(12, 37, 168, 20));\r
\r
            jStarLabel3 = new StarLabel();\r
            jStarLabel3.setLocation(new java.awt.Point(2, 62));\r
            jLabelGroup = new JLabel();\r
            jLabelGroup.setText("Event Group Type");\r
            jLabelGroup.setBounds(new java.awt.Rectangle(12, 62, 168, 20));\r
\r
            jStarLabel4 = new StarLabel();\r
            jStarLabel4.setLocation(new java.awt.Point(2, 87));\r
            jLabelUsage = new JLabel();\r
            jLabelUsage.setText("Usage");\r
            jLabelUsage.setBounds(new java.awt.Rectangle(12, 87, 168, 20));\r
\r
            jLabelHelpText = new JLabel();\r
            jLabelHelpText.setBounds(new java.awt.Rectangle(12, 112, 168, 20));\r
            jLabelHelpText.setText("Help Text");\r
\r
            jLabelFeatureFlag = new JLabel();\r
            jLabelFeatureFlag.setBounds(new java.awt.Rectangle(12, 182, 168, 20));\r
            jLabelFeatureFlag.setText("Feature Flag Expression");\r
            jLabelFeatureFlag.setEnabled(false);\r
\r
            jLabelArch = new JLabel();\r
            jLabelArch.setBounds(new java.awt.Rectangle(12, 157, 168, 20));\r
            jLabelArch.setText("Supported Architectures");\r
            jArchCheckBox = new ArchCheckBox();\r
            jArchCheckBox.setBounds(new java.awt.Rectangle(168, 157, 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, 235));\r
\r
            jContentPane.add(jStarLabel1, null);\r
            jContentPane.add(jLabelEventType, null);\r
            jContentPane.add(getJComboBoxEventsType(), null);\r
            //jContentPane.add(jStarLabel2, null);\r
            jContentPane.add(jLabelC_Name, null);\r
            jContentPane.add(getIComboBoxGuidC_Name(), null);\r
            jContentPane.add(jStarLabel3, null);\r
            jContentPane.add(jLabelGroup, null);\r
            jContentPane.add(getJComboBoxEventGroup(), null);\r
            jContentPane.add(jStarLabel4, 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
        }\r
        return jContentPane;\r
    }\r
\r
    /**\r
     * This method initializes events groups and usage type\r
     * \r
     */\r
    private void initFrame() {\r
        Tools.generateComboBoxByVector(jComboBoxEventsType, ed.getVEventType());\r
        Tools.generateComboBoxByVector(jComboBoxEventGroup, ed.getVEventGroup());\r
        Tools.generateComboBoxByVector(jComboBoxUsage, ed.getVEventUsage());\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
                getCurrentEvents();\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
     * 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 Name\r
        //\r
        String tmpName = this.iComboBoxGuidC_Name.getSelectedItem().toString();\r
        if (!tmpName.equals(DataType.EMPTY_SELECT_ITEM) && isEmpty(tmpName)) {\r
            if (!DataValidation.isC_NameType(this.iComboBoxGuidC_Name.getSelectedItem().toString())) {\r
                Log.wrn("Update Events", "Incorrect data type for Event 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 Events", "Incorrect data type for Feature Flag");\r
                return false;\r
            }\r
        }\r
\r
        return true;\r
    }\r
\r
    private EventsIdentification getCurrentEvents() {\r
        String arg0 = this.iComboBoxGuidC_Name.getSelectedItem().toString();\r
        String arg1 = this.jComboBoxEventsType.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
        String arg6 = this.jComboBoxEventGroup.getSelectedItem().toString();\r
        id = new EventsIdentification(arg0, arg1, arg2, arg3, arg4, arg5, arg6);\r
        return id;\r
    }\r
\r
    public EventsIdentification getId() {\r
        return id;\r
    }\r
\r
    public void setId(EventsIdentification id) {\r
        this.id = id;\r
    }\r
}\r