com.googlecode.blaisemath.util.MPanel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of firestarter Show documentation
Provides editors for various Java bean object types, and a generic, customizable PropertySheet.
There is a newer version: 2.0.2
/**
 * MPanel.java
 * Created on Jun 25, 2009
 */
package com.googlecode.blaisemath.util;

/*
 * #%L
 * Firestarter
 * --
 * Copyright (C) 2009 - 2015 Elisha Peterson
 * --
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Component;
import java.awt.Dimension;
import java.awt.Insets;
import java.awt.event.ActionEvent;
import java.awt.event.ComponentAdapter;
import java.awt.event.ComponentEvent;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.util.Arrays;
import javax.swing.AbstractAction;
import javax.swing.BorderFactory;
import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.JLabel;
import javax.swing.JPanel;

/**
 * 
 *   Adds a title bar onto another component, with text and a show/hide options.
 *   The component may be minimized or maximized depending upon the user's actions.
 *   The title bar defaults to a simple label, but the user may also alter that
 *   component directly for custom displays.
 * 
 *
 * @author Elisha Peterson
 */
public final class MPanel extends JPanel {

    /** The title bar */
    private final JPanel titleBar;
    /** The label displaying the title */
    private final JLabel titleLabel;

    /** Component within the panel */
    private Component component;
    /** Listen for changes to component size */
    private final PropertyChangeListener componentSizeListener;

    /** Whether panel is currently minimized */
    private boolean minimized;

    //
    // CONSTRUCTORS
    //

    public MPanel() {
        this("Title", new JLabel("Component"), false);
    }

    public MPanel(Component component) {
        this(component.toString(), component, false);
    }

    public MPanel(String title, Component component) {
        this(title, component, false);
    }

    public MPanel(JLabel label, Component component) {
        this(label, component, false);
    }

    public MPanel(Component component, boolean minimized) {
        this(component.toString(), component, minimized);
    }

    public MPanel(String title, Component component, boolean minimized) {
        this(new JLabel(title), component, minimized);
    }

    public MPanel(JLabel label, Component component, boolean minimized) {
        titleLabel = label;
        this.component = component;
        this.minimized = minimized;
        
        int titleHt = titleLabel.getPreferredSize().height;

        JButton rollupButton = new JButton(new ToggleHideAction());
        rollupButton.setMargin(new Insets(0, 0, 0, 0));
        Dimension square = new Dimension(titleHt, titleHt);
        rollupButton.setMinimumSize(square);
        rollupButton.setMaximumSize(square);
        rollupButton.setPreferredSize(square);
        rollupButton.setOpaque(false);

        titleBar = new JPanel();
        titleBar.setMinimumSize(new Dimension(component.getMinimumSize().width + 2, titleHt));
        titleBar.setMaximumSize(new Dimension(component.getMaximumSize().width + 2, titleHt));
        titleBar.setPreferredSize(new Dimension(component.getPreferredSize().width + 2, titleHt));
        titleBar.setBackground(new Color(192, 192, 216));

        titleBar.setLayout(new BorderLayout());
        titleLabel.setBorder(BorderFactory.createEmptyBorder(0, 3, 0, 0));
        titleBar.add(rollupButton, BorderLayout.WEST);
        titleBar.add(titleLabel, BorderLayout.CENTER);

        setBorder(BorderFactory.createLineBorder(titleBar.getBackground(), 2));
        setLayout(new BorderLayout());
        add(titleBar, BorderLayout.NORTH);
        
        componentSizeListener = new PropertyChangeListener(){
            @Override
            public void propertyChange(PropertyChangeEvent evt) {
                String prop = evt.getPropertyName();
                if ("size".equals(prop) || "minimumSize".equals(prop)
                        || "preferredSize".equals(prop) || "maximumSize".equals(prop)) {
                    updateSize();
                }
            }
        };
        setPrimaryComponent(component);

        addComponentListener(new ComponentAdapter(){
            @Override
            public void componentResized(ComponentEvent e) {
                updateSize();
            }
        });
        updateSize();
    }

    private void updateSize() {
        int height = 0;
        int minWidth = 0;
        int prefWidth = 0;
        if (minimized) {
            if (Arrays.asList(getComponents()).contains(component)) {
                remove(component);
            }
            height = titleBar.getPreferredSize().height + 4;
            minWidth = 20;
            prefWidth = 20;
        } else {
            if (!Arrays.asList(getComponents()).contains(component)) {
                add(component);
            }
            height = component.getPreferredSize().height + titleBar.getPreferredSize().height + 4;
            minWidth = component.getMinimumSize().width;
            prefWidth = component.getPreferredSize().width;
        }
        setMinimumSize(new Dimension(minWidth + 4, height));
        setMaximumSize(new Dimension(prefWidth + 4, height));
        setPreferredSize(new Dimension(component.getPreferredSize().width + 4, height));
        revalidate();
        repaint();
    }

    //
    // BEAN PATTERNS
    //

    /** 
     * Get title string
     * @return title 
     */
    public String getTitle() {
        return titleLabel.getText();
    }

    /** 
     * Sets title string
     * @param title
     */
    public void setTitle(String title) {
        titleLabel.setText(title);
    }

    /** 
     * Get component in this panel
     * @return the component active in this panel 
     */
    public Component getPrimaryComponent() {
        return component;
    }

    /** 
     * Sets main component
     * @param c 
     */
    public void setPrimaryComponent(Component c) {
        if (component != null) {
            component.removePropertyChangeListener(componentSizeListener);
            remove(component);
        }
        component = c;
        if (component instanceof JComponent) {
            ((JComponent) component).setBorder(null);
        }
        component.addPropertyChangeListener(componentSizeListener);

        add(component, BorderLayout.CENTER);
        updateSize();
    }


    /** Action to minimize or maximize the window. */
    public class ToggleHideAction extends AbstractAction {
        public ToggleHideAction() {
            super(minimized ? " + " : " - ");
            putValue(SHORT_DESCRIPTION, "Minimize/maximize panel");
        }
        @Override
        public void actionPerformed(ActionEvent e) {
            minimized = !minimized;
            putValue(NAME, minimized ? " + " : " - ");
            updateSize();
        }
    }
}