io.guise.framework.component.CheckControl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of guise-framework Show documentation
Guise™ Internet application framework.
There is a newer version: 0.5.3
/*
 * Copyright © 2005-2008 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 io.guise.framework.component;

import java.net.URI;

import io.guise.framework.model.*;
import io.guise.framework.prototype.ValuePrototype;
import io.guise.framework.validator.ValueRequiredValidator;

import static com.globalmentor.java.Classes.*;

/**
 * Control accepting boolean input rendered as a check, either a checked square or a circle.
 * 
 * If no check type is specified, the check type will automatically determined dynamically. If there is a {@link MutualExclusionPolicyModelGroup} value
 * listener, indicating that this is a mutual exclusion control, a {@link CheckType#ELLIPSE} check type will be used. Otherwise, a {@link CheckType#RECTANGLE}
 * check type will be used.
 * 
 * 
 * The default model used by a check control defaults to a value of {@link Boolean#FALSE}, as a check control does not have the capability of indicating
 * null.
 * 
 * 
 * A check control automatically installs a {@link ValueRequiredValidator}, as a check control does not have the capability of indicating null.
 * 
 * @author Garret Wilson
 */
public class CheckControl extends AbstractEditValueControl {

	/** The check type bound property. */
	public static final String CHECK_TYPE_PROPERTY = getPropertyName(CheckControl.class, "checkType");

	/** The type of check area to present to the user. */
	public enum CheckType {
		/** A four-cornered check box, such as a square. */
		RECTANGLE,

		/** A round fill-in oval, such as a circle. */
		ELLIPSE;
	}

	/** The type of check area presented to the user, or null if the check type should be determined automatically. */
	private CheckType checkType = null;

	/** @return The type of check area presented to the user, or null if the check type should be determined automatically. */
	public CheckType getCheckType() {
		return checkType;
	}

	/**
	 * Sets the type of check area to present to the user. This is a bound property.
	 * @param newCheckType The type of check area to use, or null if the check type should be determined automatically.
	 * @see #CHECK_TYPE_PROPERTY
	 */
	public void setCheckType(final CheckType newCheckType) {
		if(checkType != newCheckType) { //if the value is really changing
			final CheckType oldCheckType = checkType; //get the old value
			checkType = newCheckType; //actually change the value
			firePropertyChange(CHECK_TYPE_PROPERTY, oldCheckType, newCheckType); //indicate that the value changed
		}
	}

	/** Default constructor with a default info model and a default value model. */
	public CheckControl() {
		this(new DefaultValueModel(Boolean.class, Boolean.FALSE)); //construct the class with a value model
	}

	/**
	 * Check type constructor with a default info model and value model.
	 * @param checkType The type of check area presented to the user, or null if the check type should be determined automatically.
	 */
	public CheckControl(final CheckType checkType) {
		this(new DefaultValueModel(Boolean.class, Boolean.FALSE), checkType); //construct the class with a default value model
	}

	/**
	 * Label constructor.
	 * @param label The text of the label, or null if there should be no label.
	 */
	public CheckControl(final String label) {
		this(label, null); //construct the info model with no icon		
	}

	/**
	 * Label and icon constructor.
	 * @param label The text of the label, or null if there should be no label.
	 * @param icon The icon URI, which may be a resource URI, or null if there is no icon URI.
	 */
	public CheckControl(final String label, final URI icon) {
		this(new DefaultInfoModel(label, icon)); //construct the class, indicating that a default value model should be used
	}

	/**
	 * Info model constructor.
	 * @param infoModel The component info model.
	 * @throws NullPointerException if the given info model is null.
	 */
	public CheckControl(final InfoModel infoModel) {
		this(infoModel, new DefaultValueModel(Boolean.class, Boolean.FALSE)); //construct the class, indicating that a default value model should be used
	}

	/**
	 * Info model and value model constructor.
	 * @param infoModel The component info model.
	 * @param valueModel The component value model.
	 * @throws NullPointerException if the given info model and/or value model is null.
	 */
	public CheckControl(final InfoModel infoModel, final ValueModel valueModel) {
		this(infoModel, valueModel, null); //construct the class, indicating that the default check type should be used
	}

	/**
	 * Value model constructor.
	 * @param valueModel The component value model.
	 * @throws NullPointerException if the given value model is null.
	 */
	public CheckControl(final ValueModel valueModel) {
		this(valueModel, null); //construct the class with no specified check type
	}

	/**
	 * Value model and check type constructor.
	 * @param valueModel The component value model.
	 * @param checkType The type of check area presented to the user, or null if the check type should be determined automatically.
	 * @throws NullPointerException if the given value model is null.
	 */
	public CheckControl(final ValueModel valueModel, final CheckType checkType) {
		this(new DefaultInfoModel(), valueModel, checkType); //construct the class with a default info model
	}

	/**
	 * Info model, value model and check type constructor.
	 * @param infoModel The component info model.
	 * @param valueModel The component value model.
	 * @param checkType The type of check area presented to the user, or null if the check type should be determined automatically.
	 * @throws NullPointerException if the given value model, and/or info model is null.
	 */
	public CheckControl(final InfoModel infoModel, final ValueModel valueModel, final CheckType checkType) {
		this(infoModel, valueModel, new DefaultEnableable(), checkType); //construct the class with default enableable support
	}

	/**
	 * Info model, value model, enableable object, and check type constructor.
	 * @param infoModel The component info model.
	 * @param valueModel The component value model.
	 * @param enableable The enableable object in which to store enabled status.
	 * @param checkType The type of check area presented to the user, or null if the check type should be determined automatically.
	 * @throws NullPointerException if the given value model and/or info model is null.
	 */
	public CheckControl(final InfoModel infoModel, final ValueModel valueModel, final Enableable enableable, final CheckType checkType) {
		super(infoModel, valueModel, enableable); //construct the parent class
		this.checkType = checkType; //save the check type
		setValidator(new ValueRequiredValidator()); //require a value, as a check control cannot indicate the absence of a value
	}

	/**
	 * Prototype constructor.
	 * @param valuePrototype The prototype on which this component should be based.
	 * @throws NullPointerException if the given prototype is null.
	 */
	public CheckControl(final ValuePrototype valuePrototype) {
		this(valuePrototype, valuePrototype, valuePrototype, null); //use the value prototype as every needed model, using an automatic check type
	}

}