xdev.ui.ColorFormularComponent Maven / Gradle / Ivy

Go to download
/*
 * XDEV Application Framework - XDEV Application Framework
 * Copyright © 2003 XDEV Software (https://xdev.software)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 */
package xdev.ui;


import java.awt.Color;

import javax.swing.JComponent;


/**
 * An extended {@link FormularComponent} which can edit and display colors.
 * 
 * @author XDEV Software
 * 
 * @param 
 *            type of the implementing {@link JComponent}
 * 
 * @since 4.0
 */
public interface ColorFormularComponent extends FormularComponent
{
	/**
	 * Returns the color of this {@link ColorFormularComponent}.
	 * 
	 * @return a new {@link Color} including the color of this
	 *         {@link ColorFormularComponent}; if the color is null
	 *         , null is returned
	 */
	public Color getColor();
	
	
	/**
	 * Sets a {@link Color} color to be displayed by this
	 * {@link ColorFormularComponent}.
	 * 
	 * @param color
	 *            {@link Color} to be displayed
	 */
	public void setColor(Color color);
}