1. Add help for ToolChainConfig

[mirror_edk2.git] / Tools / Source / FrameworkWizard / src / org / tianocore / frameworkwizard / ToolChainConfigHelp.java

package org.tianocore.frameworkwizard;\r
\r
import java.awt.event.ActionEvent;\r
import java.awt.event.ActionListener;\r
\r
import javax.swing.JFrame;\r
import javax.swing.JPanel;\r
import javax.swing.JTextPane;\r
\r
import org.tianocore.frameworkwizard.common.DataType;\r
import javax.swing.JButton;\r
\r
\r
public class ToolChainConfigHelp extends JFrame implements ActionListener {\r
\r
    ///\r
    ///\r
    ///\r
    private static final long serialVersionUID = -6315081029366587222L;\r
\r
    private JPanel jContentPane = null;\r
\r
    private String helpContent = "";\r
\r
    private JTextPane jTextPane = null;\r
\r
    private JButton jButtonClose = null;\r
\r
    /**\r
     * This method initializes jTextPane	\r
     * 	\r
     * @return javax.swing.JTextPane	\r
     */\r
    private JTextPane getJTextPane() {\r
        if (jTextPane == null) {\r
            jTextPane = new JTextPane();\r
            jTextPane.setBounds(new java.awt.Rectangle(10,10,600,420));\r
            jTextPane.setBackground(new java.awt.Color(238,238,238));\r
            jTextPane.setEditable(false);\r
            helpContent = helpContent\r
            + "The coding forthe Property is: TARGET_TAGNAME_ARCH_COMMAND_ATTR" + DataType.UNIX_LINE_SEPARATOR\r
            + "The Value, is either afull path, full path and filename or a reserved word." + DataType.UNIX_LINE_SEPARATOR\r
            + DataType.UNIX_LINE_SEPARATOR\r
            + DataType.UNIX_LINE_SEPARATOR\r
            + "TARGET  - DEBUG and RELEASE are predefined, however the user may define one or more of their own TARGET types in this file." + DataType.UNIX_LINE_SEPARATOR\r
            + DataType.UNIX_LINE_SEPARATOR\r
            + "TAGNAME - HOST, MSFT, GCC, INTC are predefined, however the user may define one or more of their own TAGNAME keywords in this file." + DataType.UNIX_LINE_SEPARATOR\r
            + DataType.UNIX_LINE_SEPARATOR\r
            + "ARCH    - EDK II supports IA32, X64, IPF and EBC at this time." + DataType.UNIX_LINE_SEPARATOR\r
            + DataType.UNIX_LINE_SEPARATOR\r
            + "COMMAND - Predefined command codes are listed in the tools_def.txt file, however the user can specify additional command codes for their one, non-standard tools." + DataType.UNIX_LINE_SEPARATOR\r
            + DataType.UNIX_LINE_SEPARATOR\r
            + "ATTR    - Predefined Attributes are listed in the tools_def.txt file." + DataType.UNIX_LINE_SEPARATOR\r
            + DataType.UNIX_LINE_SEPARATOR\r
            + "NOTE: The TAGNAME: HOST is reserved and MUST be defined in order to build the included Tiano tools from their C source files.  These tools have been built and tested using both Microsoft and GCC tool chains." + DataType.UNIX_LINE_SEPARATOR\r
            + DataType.UNIX_LINE_SEPARATOR\r
            + "NOTE: The \"*\" symbol may be used as a wildcard character in most of these fields, refer to the tools_def.txt and the \"EDK II Build and Packaging Architecture Specification\" for more details." + DataType.UNIX_LINE_SEPARATOR\r
            + DataType.UNIX_LINE_SEPARATOR;\r
            \r
            \r
            jTextPane.setText(helpContent);\r
        }\r
        return jTextPane;\r
    }\r
\r
    /**\r
     * This method initializes jButtonClose	\r
     * 	\r
     * @return javax.swing.JButton	\r
     */\r
    private JButton getJButtonClose() {\r
        if (jButtonClose == null) {\r
            jButtonClose = new JButton();\r
            jButtonClose.setBounds(new java.awt.Rectangle(480,450,80,20));\r
            jButtonClose.setText("Close");\r
            jButtonClose.addActionListener(this);\r
        }\r
        return jButtonClose;\r
    }\r
\r
    /**\r
     \r
     @param args\r
     \r
     **/\r
    public static void main(String[] args) {\r
        ToolChainConfigHelp tcch = new ToolChainConfigHelp();\r
        tcch.setVisible(true);\r
    }\r
\r
    /**\r
     * This is the default constructor\r
     */\r
    public ToolChainConfigHelp() {\r
        super();\r
        initialize();\r
    }\r
\r
    /**\r
     * This method initializes this\r
     * \r
     * @return void\r
     */\r
    private void initialize() {\r
        this.setSize(625, 520);\r
        this.setTitle("How to Setup Tool Chain Configuration");\r
        this.setContentPane(getJContentPane());\r
    }\r
\r
    /**\r
     * This method initializes jContentPane\r
     * \r
     * @return javax.swing.JPanel\r
     */\r
    private JPanel getJContentPane() {\r
        if (jContentPane == null) {\r
            jContentPane = new JPanel();\r
            jContentPane.setLayout(null);\r
            jContentPane.add(getJTextPane(), null);\r
            jContentPane.add(getJButtonClose(), null);\r
        }\r
        return jContentPane;\r
    }\r
\r
    public void actionPerformed(ActionEvent arg0) {\r
        if (arg0.getSource() == jButtonClose) {\r
            this.dispose();\r
        }\r
        \r
    }\r
\r
}\r