1. Restructure module description on main UI

[mirror_edk2.git] / Tools / Source / FrameworkWizard / src / org / tianocore / frameworkwizard / common / ui / IInternalFrame.java

/** @file\r
 \r
 The file is used to override JInternalFrame to provides customized interfaces \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.common.ui;\r
\r
import java.awt.Component;\r
import java.awt.event.ActionEvent;\r
import java.awt.event.ActionListener;\r
import java.awt.event.ComponentEvent;\r
import java.awt.event.ComponentListener;\r
import java.awt.event.FocusEvent;\r
import java.awt.event.FocusListener;\r
import java.awt.event.ItemEvent;\r
import java.awt.event.ItemListener;\r
import java.awt.event.MouseEvent;\r
import java.awt.event.MouseListener;\r
\r
import javax.swing.JDesktopPane;\r
import javax.swing.JFrame;\r
import javax.swing.JInternalFrame;\r
import javax.swing.JPanel;\r
import javax.swing.event.ListSelectionEvent;\r
import javax.swing.event.ListSelectionListener;\r
import javax.swing.event.TableModelEvent;\r
import javax.swing.event.TableModelListener;\r
\r
/**\r
 * The class is used to override JInternalFrame to provides customized\r
 * interfaces It extends JInternalFrame implements ActionListener\r
 * \r
 *\r
 * \r
 */\r
public class IInternalFrame extends JInternalFrame implements ActionListener, ComponentListener, ItemListener,\r
                                                  FocusListener, ListSelectionListener, TableModelListener, MouseListener {\r
\r
    // /\r
    // / Define class Serial Version UID\r
    // /\r
    private static final long serialVersionUID = -609841772384875886L;\r
\r
    //\r
    // Define class members\r
    //\r
    private boolean isEdited = false;\r
\r
    /**\r
     * Main class, used for test\r
     * \r
     * @param args\r
     * \r
     */\r
    public static void main(String[] args) {\r
        JFrame jf = new JFrame();\r
        JPanel jp = new JPanel();\r
        JDesktopPane jdp = new JDesktopPane();\r
        IInternalFrame itf = new IInternalFrame();\r
        jdp.add(itf, 1);\r
        jf.setContentPane(jp);\r
        jf.setVisible(true);\r
    }\r
\r
    /**\r
     * This is the default constructor\r
     * \r
     */\r
    public IInternalFrame() {\r
        super();\r
        initialize();\r
    }\r
\r
    /**\r
     * This method initializes this\r
     * \r
     */\r
    private void initialize() {\r
        this.setBounds(new java.awt.Rectangle(0, 0, 520, 545));\r
        this.setMinimumSize(new java.awt.Dimension(520, 545));\r
        this.addComponentListener(this);\r
    }\r
\r
    /**\r
     * Get if the InternalFrame has been edited\r
     * \r
     * @retval true - The InternalFrame has been edited\r
     * @retval false - The InternalFrame hasn't been edited\r
     * \r
     */\r
    public boolean isEdited() {\r
        return isEdited;\r
    }\r
\r
    /**\r
     * Set if the InternalFrame has been edited\r
     * \r
     * @param isEdited\r
     *            The input data which identify if the InternalFrame has been\r
     *            edited\r
     * \r
     */\r
    public void setEdited(boolean isEdited) {\r
        this.isEdited = isEdited;\r
    }\r
\r
    /**\r
     * Check the input data is empty or not\r
     * \r
     * @param strValue\r
     *            The input data which need be checked\r
     * \r
     * @retval true - The input data is empty\r
     * @retval fals - The input data is not empty\r
     * \r
     */\r
    public boolean isEmpty(String strValue) {\r
        if (strValue.length() > 0) {\r
            return false;\r
        }\r
        return true;\r
    }\r
\r
    public void actionPerformed(ActionEvent arg0) {\r
        // TODO Auto-generated method stub\r
    }\r
\r
    public void componentHidden(ComponentEvent arg0) {\r
        // TODO Auto-generated method stub\r
\r
    }\r
\r
    public void componentMoved(ComponentEvent arg0) {\r
        // TODO Auto-generated method stub\r
\r
    }\r
\r
    public void componentResized(ComponentEvent arg0) {\r
        // TODO Auto-generated method stub\r
    }\r
\r
    public void componentShown(ComponentEvent arg0) {\r
        // TODO Auto-generated method stub\r
\r
    }\r
\r
    /**\r
     * To reset the width of input component via container width\r
     * \r
     * @param c\r
     * @param containerWidth\r
     * \r
     */\r
    public void resizeComponentWidth(Component c, int containerWidth, int preferredWidth) {\r
        int newWidth = c.getPreferredSize().width + (containerWidth - preferredWidth);\r
        if (newWidth < c.getPreferredSize().width) {\r
            newWidth = c.getPreferredSize().width;\r
        }\r
        c.setSize(new java.awt.Dimension(newWidth, c.getHeight()));\r
        c.validate();\r
    }\r
\r
    /**\r
     * To reset the height of input component via container height\r
     * \r
     * @param c\r
     * @param containerHeight\r
     * \r
     */\r
    public void resizeComponentHeight(Component c, int containerHeight, int preferredHeight) {\r
        int newHeight = c.getPreferredSize().height + (containerHeight - preferredHeight);\r
        if (newHeight < c.getPreferredSize().height) {\r
            newHeight = c.getPreferredSize().height;\r
        }\r
        c.setSize(new java.awt.Dimension(c.getWidth(), newHeight));\r
        c.validate();\r
    }\r
\r
    /**\r
     * To reset the size of input component via container size\r
     * \r
     * @param c\r
     * @param containerWidth\r
     * @param containerHeight\r
     * \r
     */\r
    public void resizeComponent(Component c, int containerWidth, int containerHeight, int preferredWidth,\r
                                int preferredHeight) {\r
        resizeComponentWidth(c, containerWidth, preferredWidth);\r
        resizeComponentHeight(c, containerHeight, preferredHeight);\r
    }\r
\r
    /**\r
     * To relocate the input component\r
     * \r
     * @param c\r
     * @param containerWidth\r
     * @param spaceToRight\r
     * \r
     */\r
    public void relocateComponentX(Component c, int containerWidth, int preferredWidth, int spaceToRight) {\r
        int intGapToRight = spaceToRight + c.getPreferredSize().width;\r
        int newLocationX = containerWidth - intGapToRight;\r
        if (newLocationX < preferredWidth - intGapToRight) {\r
            newLocationX = preferredWidth - intGapToRight;\r
        }\r
        c.setLocation(newLocationX, c.getLocation().y);\r
        c.validate();\r
    }\r
\r
    /**\r
     * To relocate the input component\r
     * \r
     * @param c\r
     * @param containerHeight\r
     * @param spaceToBottom\r
     * \r
     */\r
    public void relocateComponentY(Component c, int containerHeight, int preferredHeight, int spaceToBottom) {\r
        int intGapToBottom = spaceToBottom + c.getPreferredSize().height;\r
        int newLocationY = containerHeight - intGapToBottom;\r
        if (newLocationY < preferredHeight - spaceToBottom) {\r
            newLocationY = preferredHeight - spaceToBottom;\r
        }\r
        c.setLocation(c.getLocation().x, newLocationY);\r
        c.validate();\r
    }\r
\r
    /**\r
     * To relocate the input component\r
     * \r
     * @param c\r
     * @param containerWidth\r
     * @param containerHeight\r
     * @param spaceToBottom\r
     * @param spaceToRight\r
     * \r
     */\r
    public void relocateComponent(Component c, int containerWidth, int containerHeight, int preferredWidht,\r
                                  int preferredHeight, int spaceToRight, int spaceToBottom) {\r
        relocateComponentX(c, containerWidth, preferredWidht, spaceToRight);\r
        relocateComponentY(c, containerHeight, preferredHeight, spaceToBottom);\r
    }\r
\r
    public void showStandard() {\r
\r
    }\r
\r
    public void showAdvanced() {\r
\r
    }\r
\r
    public void showXML() {\r
\r
    }\r
\r
    public void itemStateChanged(ItemEvent arg0) {\r
        // TODO Auto-generated method stub\r
\r
    }\r
\r
    public void focusGained(FocusEvent arg0) {\r
        // TODO Auto-generated method stub\r
\r
    }\r
\r
    public void focusLost(FocusEvent arg0) {\r
        // TODO Auto-generated method stub\r
\r
    }\r
\r
    public void valueChanged(ListSelectionEvent arg0) {\r
        // TODO Auto-generated method stub\r
\r
    }\r
\r
    public void tableChanged(TableModelEvent arg0) {\r
        // TODO Auto-generated method stub\r
\r
    }\r
\r
    public void mouseClicked(MouseEvent arg0) {\r
        // TODO Auto-generated method stub\r
        \r
    }\r
\r
    public void mouseEntered(MouseEvent arg0) {\r
        // TODO Auto-generated method stub\r
        \r
    }\r
\r
    public void mouseExited(MouseEvent arg0) {\r
        // TODO Auto-generated method stub\r
        \r
    }\r
\r
    public void mousePressed(MouseEvent arg0) {\r
        // TODO Auto-generated method stub\r
        \r
    }\r
\r
    public void mouseReleased(MouseEvent arg0) {\r
        // TODO Auto-generated method stub\r
        \r
    }\r
}\r