/*******************************************************************************
 * Copyright (c) 2000, 2003 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.ui.internal.misc;

import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.ImageData;
import org.eclipse.swt.program.Program;
import org.eclipse.ui.ISharedImages;
import org.eclipse.ui.internal.WorkbenchImages;

/**
 * The external program image descriptor is the descriptor used to
 * handle images that are from a Program.
 */
public class ExternalProgramImageDescriptor extends ImageDescriptor {
	
	public Program program;
/**
 * Creates a new ImageDescriptor. The image is loaded 
 * from a file with the given name <code>name</code>.
 */
public ExternalProgramImageDescriptor(Program program) {
	this.program = program;
}
/**
 * @see Object#equals
 */
public boolean equals(Object o) {
	if (!(o instanceof ExternalProgramImageDescriptor)) {
		return false;
	}
	ExternalProgramImageDescriptor other = (ExternalProgramImageDescriptor) o;

	//See if there is a name - compare it if so and compare the programs if not
	String otherName = other.program.getName();
	if (otherName == null)
		return other.program.equals(program);
	else {
		return otherName.equals(program.getName());
	}
}
/**
 * Returns an SWT Image that is described by the information
 * in this descriptor.  Each call returns a new Image.
 */
public Image getImage() {
	return createImage();
}
/**
 * Returns an SWT Image that is described by the information
 * in this descriptor.  Each call returns a new Image.
 */
public ImageData getImageData() {
	ImageData data = null;
	ImageData defaultImage = WorkbenchImages.getImageDescriptor(ISharedImages.IMG_OBJ_FILE).getImageData();
	if(defaultImage == null)
		return null;
		
	if (program == null || ((data = program.getImageData()) == null))
		return defaultImage;

	//The images in GNOME are too big. Scaling them does not give nice result so return defaultImage;
	if(data.height > defaultImage.height || data.width > defaultImage.width)
		return defaultImage;
		
	return data;
}
/**
 * @see Object#hashCode
 */
public int hashCode() {
	String programName = program.getName();
	if(programName == null)
		return program.hashCode();
	else
		return programName.hashCode();
}
}