/*
* Copyright (c) 2011, the Dart project authors.
*
* Licensed under the Eclipse Public License v1.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.eclipse.org/legal/epl-v10.html
*
* 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 com.google.dart.tools.ui.dialogs;
import org.eclipse.jface.resource.ImageDescriptor;
/**
* A special image descriptor provider for {@link ITypeInfoRequestor}.
* <p>
* The interface should be implemented by clients wishing to provide special images inside the type
* selection dialog.
* </p>
* Provisional API: This class/interface is part of an interim API that is still under development
* and expected to change significantly before reaching stability. It is being made available at
* this early stage to solicit feedback from pioneering adopters on the understanding that any code
* that uses this API will almost certainly be broken (repeatedly) as the API evolves.
*/
public interface ITypeInfoImageProvider {
/**
* Returns the image descriptor for the type represented by the given {@link ITypeInfoRequestor}.
* <p>
* Note, that this method may be called from non UI threads.
* </p>
*
* @param typeInfoRequestor the {@link ITypeInfoRequestor} to access information for the type
* under inspection
* @return the image descriptor or <code>null</code> to use the default image
*/
public ImageDescriptor getImageDescriptor(ITypeInfoRequestor typeInfoRequestor);
}