xdev.ui.ImageFormularComponent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xapi Show documentation

XDEV Application Framework

There is a newer version: 6.0.2

package xdev.ui;

/*-
 * #%L
 * XDEV Application Framework
 * %%
 * Copyright (C) 2003 - 2020 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 General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */


import javax.swing.JComponent;


/**
 * An extended {@link FormularComponent} which can edit and display images.
 * 
 * @author XDEV Software
 * 
 * @param 
 *            type of the implementing {@link JComponent}
 * 
 * @since 3.1
 */
public interface ImageFormularComponent extends FormularComponent
{
	/**
	 * Returns the image of this {@link ImageFormularComponent}.
	 * 
	 * @return a new {@link XdevImage} including the image of this
	 *         {@link ImageFormularComponent}; if the image is null
	 *         , null is returned
	 */
	public XdevImage getImage();
	

	/**
	 * Sets a {@link XdevImage} image to be displayed by this
	 * {@link ImageFormularComponent}.
	 * 
	 * @param image
	 *            {@link XdevImage} to be displayed
	 */
	public void setImage(XdevImage image);
}