com.globalmentor.swing.BooleanPanel 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.*;

import com.globalmentor.awt.BasicGridBagLayout;

/**
 * A panel that allows selection of a boolean choice, with radio buttons representing true and false.
 * @author Garret Wilson
 */
public class BooleanPanel extends ModifiablePanel implements SwingConstants {

	private final ButtonGroup buttonGroup;
	private final JRadioButton trueRadioButton;
	private final JRadioButton falseRadioButton;

	/**
	 * The layout of the radio buttons, either SwingConstants.HORIZONTAL or SwingConstants.VERTICAL.
	 */
	private final int orientation;

	/**
	 * @return The layout of the radio buttons, either HORIZONTAL or VERTICAL.
	 */
	public int getOrientation() {
		return orientation;
	}

	/**
	 * @return Boolean.TRUE or Boolean.TRUE, depending on the selected radio button, or null if neither is selected.
	 */
	public Boolean getValue() {
		final ButtonModel selectedButtonModel = buttonGroup.getSelection(); //get the selected button model
		if(selectedButtonModel == trueRadioButton.getModel())
			return Boolean.TRUE;
		else if(selectedButtonModel == falseRadioButton.getModel())
			return Boolean.FALSE;
		else
			//if neither button is selected
			return null; //show that there is no selection
	}

	/**
	 * Sets the selected value.
	 * @param value Boolean.TRUE or Boolean.TRUE.
	 */
	public void setValue(final Boolean value) {
		trueRadioButton.setSelected(value.booleanValue() == true);
		falseRadioButton.setSelected(value.booleanValue() == false);
	}

	/** Default constructor with vertical orientation. */
	public BooleanPanel() {
		this(HORIZONTAL); //construct a horizontal boolean panel
	}

	/**
	 * Orientation constructor.
	 * @param orientation The layout of the radio buttons, either HORIZONTAL or VERTICAL.
	 * @see SwingConstants#HORIZONTAL
	 * @see SwingConstants#VERTICAL
	 */
	public BooleanPanel(final int orientation) {
		super(new BasicGridBagLayout(), false); //construct the parent class but don't initialize it
		this.orientation = orientation; //save the orientation
		buttonGroup = new ButtonGroup();
		trueRadioButton = new JRadioButton();
		falseRadioButton = new JRadioButton();
		initialize(); //initialize the panel
		setDefaultFocusComponent(trueRadioButton);
	}

	/** Initialize the user interface. */
	protected void initializeUI() {
		super.initializeUI(); //do the default UI initialization
		buttonGroup.add(trueRadioButton);
		buttonGroup.add(falseRadioButton);
		trueRadioButton.setText("True"); //TODO i18n
		falseRadioButton.setText("False"); //TODO i18n
		final int axis; //determine the axis to use
		switch(getOrientation()) { //see which orientation we're using
			case HORIZONTAL:
				axis = BasicGridBagLayout.X_AXIS;
				break;
			case VERTICAL:
				axis = BasicGridBagLayout.Y_AXIS;
				break;
			default:
				throw new AssertionError("Unrecognized orientation: " + getOrientation());
		}
		trueRadioButton.addItemListener(getModifyItemListener());
		falseRadioButton.addItemListener(getModifyItemListener());
		add(trueRadioButton, ((BasicGridBagLayout)getLayout()).createNextBoxConstraints(axis)); //add the true button
		add(falseRadioButton, ((BasicGridBagLayout)getLayout()).createNextBoxConstraints(axis)); //add the false button
	}

	/**
	 * Updates the states of the actions, including enabled/disabled status, proxied actions, etc.
	 */
	public void updateStatus() {
		super.updateStatus(); //do the default updating
		final boolean isEnabled = isEnabled(); //see if we're enabled
		trueRadioButton.setEnabled(isEnabled); //enable or disable the true radio button
		falseRadioButton.setEnabled(isEnabled); //enable or disable the false radio button
	}

}