org.eclipse.cdt.managedbuilder.ui.properties.ToolListLabelProvider.java Source code

Introduction

Here is the source code for org.eclipse.cdt.managedbuilder.ui.properties.ToolListLabelProvider.java

Source

/*******************************************************************************
 * Copyright (c) 2002, 2010 IBM Corporation 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 Rational Software - Initial API and implementation
 *******************************************************************************/
package org.eclipse.cdt.managedbuilder.ui.properties;

import java.net.URL;

import org.eclipse.cdt.managedbuilder.core.IOptionCategory;
import org.eclipse.cdt.managedbuilder.core.ITool;
import org.eclipse.cdt.managedbuilder.internal.ui.Messages;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.resource.JFaceResources;
import org.eclipse.jface.resource.ResourceManager;
import org.eclipse.core.runtime.Assert;
import org.eclipse.jface.viewers.LabelProvider;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.widgets.Display;

/**
 * @noextend This class is not intended to be subclassed by clients.
 * @noinstantiate This class is not intended to be instantiated by clients.
 */
public class ToolListLabelProvider extends LabelProvider {
    private final Image IMG_TOOL = ManagedBuilderUIImages.get(ManagedBuilderUIImages.IMG_BUILD_TOOL);
    private final Image IMG_CAT = ManagedBuilderUIImages.get(ManagedBuilderUIImages.IMG_BUILD_CAT);

    private ImageDescriptor descriptor = null;
    private ResourceManager manager = null;

    /* (non-Javadoc)
     * Returns the Image associated with the icon information retrieved out of OptionCategory.
     */
    private Image getIconFromOptionCategory(IOptionCategory cat) {

        Image img = null;
        URL url = cat.getIconPath();

        // Get the image from the URL. 
        if (url != null) {
            descriptor = ImageDescriptor.createFromURL(url);
            manager = JFaceResources.getResources(Display.getCurrent());
            Assert.isNotNull(manager);
            img = manager.createImageWithDefault(descriptor);
            if (img == null) {
                // Report error by displaying a warning message
                System.err.println(
                        "Couldn't create image from URL \"" + url + "\", to display icon for Tool Options."); //$NON-NLS-1$ //$NON-NLS-2$
            }
        }
        return img;
    }

    @Override
    public Image getImage(Object element) {
        if (!(element instanceof ToolListElement)) {
            throw unknownElement(element);
        }
        Image defaultImage = IMG_CAT;
        ToolListElement toolListElement = (ToolListElement) element;
        IOptionCategory cat = toolListElement.getOptionCategory();

        if (cat == null) {
            defaultImage = IMG_TOOL;
            cat = (IOptionCategory) toolListElement.getTool();
        }

        if (cat != null) {
            // Return a OptionCategory image for an OptionCategory reference
            Image img = getIconFromOptionCategory(cat);

            if (img != null) {
                return img;
            }
        }
        // Use default icon for display 
        return defaultImage;
    }

    /* (non-Javadoc)
     * @see org.eclipse.jface.viewers.ILabelProvider#getText(Object)
     */
    @Override
    public String getText(Object element) {
        if (!(element instanceof ToolListElement)) {
            throw unknownElement(element);
        }
        ToolListElement toolListElement = (ToolListElement) element;
        IOptionCategory cat = toolListElement.getOptionCategory();

        if (cat == null) {
            ITool tool = toolListElement.getTool();
            return tool.getUniqueRealName();
        } else {
            return cat.getName();
        }
    }

    protected RuntimeException unknownElement(Object element) {
        return new RuntimeException(
                NLS.bind(Messages.BuildPropertyPage_error_Unknown_tree_element, element.getClass().getName()));
    }

    /**
     * Disposing any images that were allocated for it.
     * 
     * @since 3.0
     */
    @Override
    public void dispose() {
        if (descriptor != null && manager != null) {
            manager.destroyImage(descriptor);
        }
    }
}