IImageFigure.java

/*******************************************************************************
 * Copyright (c) 2010, 2012 IBM Corporation, Gerhardt Informatics Kft. and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Gerhardt Informatics Kft. - GEFGWT port
 *******************************************************************************/

package org.eclipse.draw2d;

import org.eclipse.swt.graphics.Image;

/**
 * Interface for image figures
 * 
 * <P>
 * WARNING: This interface is not intended to be implemented by clients. Extend
 * {@link AbstractImageFigure} instead.
 * 
 * @noimplement
 * @since 3.6
 */
public interface IImageFigure extends IFigure {

	/**
	 * Returns the SWT Image contained by the figure
	 * 
	 * @return the Image contained by the figure
	 * @since 3.6
	 */
	public Image getImage();

	/**
	 * Attaches <code>ImageChangedListener</code> to the figure
	 * 
	 * @param listener
	 * @since 3.6
	 */
	public void addImageChangedListener(ImageChangedListener listener);

	/**
	 * Detaches <code>ImageChangedListener</code> from the figure
	 * 
	 * @param listener
	 * @since 3.6
	 */
	public void removeImageChangedListener(ImageChangedListener listener);

	/**
	 * Listener to the image figure to track changes to the containede SWT Image
	 * 
	 * @since 3.6
	 */
	public interface ImageChangedListener {

		/**
		 * Notifies about a change to SWT Image contained by the
		 * <code>IIMageFigure</code>
		 * 
		 * @since 3.6
		 */
		public void imageChanged();

	}

}