com.globalmentor.swing.ToolBars 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 java.awt.*;
import javax.swing.*;

/**
 * Various convenience methods for working with Swing toolbars.
 * @author Garret Wilson
 */
public class ToolBars {

	/**
	 * Creates a toolbar separator of default size, with an orientation appropriate for the given toolbar. The default size is determined by the current look and
	 * feel.
	 * @param toolBar The toolbar for which a separator should be created.
	 * @param orientation The orientation of the separator, either JSeparator.HORIZONTAL or JSeparator.VERTICAL. The separator should
	 *          usually be the opposite orientation of the toolbar within which it will be placed.
	 * @return The created toolbar separator.
	 */
	public static JToolBar.Separator createToolBarSeparator(final JToolBar toolBar) {
		return createToolBarSeparator(toolBar, null); //create a separator of the default size
	}

	/**
	 * Creates a toolbar separator of a specified size, with an orientation appropriate for the given toolbar.
	 * @param toolBar The toolbar for which a separator should be created.
	 * @param size The size of the separator, or null if the default size determined by the current look and feel should be used.
	 */
	public static JToolBar.Separator createToolBarSeparator(final JToolBar toolBar, final Dimension size) {
		final int orientation; //decide which orientation to use, depending on the toolbar's orientation
		switch(toolBar.getOrientation()) { //see which orientation the toolbar has
			case JToolBar.HORIZONTAL: //if we have a horizontal toolbar
				orientation = JSeparator.VERTICAL; //create a vertical separator
				break;
			case JToolBar.VERTICAL: //if we have a vertical toolbar
				orientation = JSeparator.HORIZONTAL; //create a horizontal separator
				break;
			default: //if we don't recotnize the orientation of the toolbar
				throw new IllegalArgumentException("Unrecognized toolbar orientation: " + toolBar.getOrientation());
		}
		return createToolBarSeparator(orientation, size); //create the toolbar separator with the orientation we decided on
	}

	/**
	 * Creates a toolbar separator of default size. The default size is determined by the current look and feel.
	 * @param orientation The orientation of the separator, either JSeparator.HORIZONTAL or JSeparator.VERTICAL. The separator should
	 *          usually be the opposite orientation of the toolbar within which it will be placed.
	 * @return The created toolbar separator.
	 */
	public static JToolBar.Separator createToolBarSeparator(final int orientation) {
		return createToolBarSeparator(orientation, null); //create a separator of default size
	}

	/**
	 * Creates a toolbar separator of a specified size.
	 * @param orientation The orientation of the separator, either JSeparator.HORIZONTAL or JSeparator.VERTICAL. The separator should
	 *          usually be the opposite orientation of the toolbar within which it will be placed.
	 * @param size The size of the separator, or null if the default size determined by the current look and feel should be used.
	 */
	public static JToolBar.Separator createToolBarSeparator(final int orientation, final Dimension size) {
		final JToolBar.Separator separator = new JToolBar.Separator(size); //create a new separator
		separator.setOrientation(orientation); //set the orientation of the separator
		return separator; //return the separator we created
	}
}