io.github.jonestimd.swing.component.MenuActionPanel Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swing-extensions Show documentation

Extensions for Java Swing

There is a newer version: 1.4.5

// Copyright (c) 2016 Timothy D. Jones
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
package io.github.jonestimd.swing.component;

import javax.swing.JDialog;
import javax.swing.JFrame;
import javax.swing.JMenuBar;
import javax.swing.JPanel;
import javax.swing.RootPaneContainer;

/**
 * A panel that adds actions to the menu bar of a {@link JFrame} or {@link JDialog}.
 */
public abstract class MenuActionPanel extends JPanel {
    /**
     * Overridden to find the ancestor {@link RootPaneContainer} and add items to its menu bar.
     */
    public void addNotify() {
        super.addNotify();
        RootPaneContainer window = (RootPaneContainer) getTopLevelAncestor();
        JMenuBar menuBar = window.getRootPane().getJMenuBar();
        if (menuBar == null) { // for JDialog
            menuBar = new JMenuBar();
            window.getRootPane().setJMenuBar(menuBar);
        }
        initializeMenu(menuBar);
    }

    /**
     * Override to add items to the frame's menu bar.
     * @param menuBar the frame's menu bar
     */
    protected abstract void initializeMenu(JMenuBar menuBar);
}