io.guise.framework.component.ValuedComponent 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-2012 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.beans.PropertyVetoException;

import com.globalmentor.model.MutableValued;

/**
 * A component that can be initialized with a value and allows a value to be retrieved. This component is useful for editing complex values (such as contact
 * information).
 * @param  The type of value displayed within the component.
 * @author Garret Wilson
 */
public interface ValuedComponent extends Component, MutableValued {

	/** @return The class representing the type of value displayed in the component. */
	public Class getValueClass();

	/** @return The current value displayed in the component, or null if there is no value. */
	public V getValue();

	/**
	 * Sets the new value to be displayed in the component.
	 * @param newValue The new value.
	 * @throws PropertyVetoException if the provided value is not valid or the change has otherwise been vetoed.
	 */
	public void setValue(final V newValue) throws PropertyVetoException;

}