com.globalmentor.swing.Menus Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of globalmentor-swing Show documentation
GlobalMentor Java Swing library.
The newest version!
/*
 * Copyright © 1996-2009 GlobalMentor, Inc. 
 *
 * 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.
 */

package com.globalmentor.swing;

import javax.swing.*;

/**
 * Tools for working with Swing menus.
 * @author Garret Wilson
 */
public class Menus {

	/**
	 * Retrieves the first menu element that represents the given action. This method first checks to see if the given menu element represents the action. Then,
	 * each submenu present is recursively checked to see if one represents the action.
	 * @param menuElement The menu element hierarchy to check.
	 * @param action The action for which a menu element should be returned.
	 * @return The menu element, such as a menu item, that represents the given action, or null if no menu element represents the given action.
	 */
	public static MenuElement getMenuElement(final MenuElement menuElement, final Action action) {
		if(menuElement instanceof AbstractButton) { //if the given menu element is a button
			if(action.equals(((AbstractButton)menuElement).getAction())) { //if the menu element represents the action
				return menuElement; //return the menu element
			}
		}
		final MenuElement[] subElements = menuElement.getSubElements(); //get the subelements, if any, of the menu element
		for(int i = 0; i < subElements.length; ++i) { //look at each subelement
			final MenuElement actionMenuElement = getMenuElement(subElements[i], action); //see if we can find the menu element from this subelement
			if(actionMenuElement != null) { //if we found the menu element
				return actionMenuElement; //return the menu element
			}
		}
		return null; //show that we couldn't find a menu element for the action
	}
}