org.eclipse.scout.rt.ui.rap.util.RwtIconLocator.java Source code

Introduction

Here is the source code for org.eclipse.scout.rt.ui.rap.util.RwtIconLocator.java

Source

/*******************************************************************************
 * Copyright (c) 2011 BSI Business Systems Integration AG.
 * 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:
 *     BSI Business Systems Integration AG - initial API and implementation
 *******************************************************************************/
package org.eclipse.scout.rt.ui.rap.util;

import java.io.ByteArrayInputStream;
import java.util.HashSet;
import java.util.Set;

import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.resource.ImageRegistry;
import org.eclipse.scout.commons.logger.IScoutLogger;
import org.eclipse.scout.commons.logger.ScoutLogManager;
import org.eclipse.scout.rt.client.services.common.icon.IconSpec;
import org.eclipse.scout.rt.client.ui.IIconLocator;
import org.eclipse.scout.rt.shared.AbstractIcons;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.ImageData;
import org.eclipse.swt.widgets.Display;

/**
 * Looks for icons in the resources/icons folder of bundles
 */
public class RwtIconLocator {
    private static final IScoutLogger LOG = ScoutLogManager.getLogger(RwtIconLocator.class);

    private final ImageRegistry imageRegistry;
    private final Set<String> m_missingImages = new HashSet<String>();

    private final IIconLocator m_iconLocator;

    public RwtIconLocator(IIconLocator iconLocator) {
        m_iconLocator = iconLocator;
        imageRegistry = new ImageRegistry();
    }

    public ImageDescriptor getImageDescriptor(String name) {
        if (name == null) {
            return null;
        }
        if (m_missingImages.contains(name)) {
            return null;
        }
        ImageDescriptor desc = imageRegistry.getDescriptor(name);
        if (desc == null) {
            desc = createImageDescriptor(name);
            if (desc == null) {
                m_missingImages.add(name);
            } else {
                imageRegistry.put(name, desc);
            }
        }
        return desc;
    }

    /**
     * Find icon in plugin dependency path starting with root bundle {@link Platform#getProduct#getDefiningBundle}
     */
    public Image getIcon(String name) {
        if (name == null || AbstractIcons.Null.equals(name)) {
            return null;
        }
        if (m_missingImages.contains(name)) {
            return null;
        }

        Image image = imageRegistry.get(name);
        if (image != null && image.isDisposed()) {
            imageRegistry.remove(name);
        }
        if (image == null || image.isDisposed()) {
            Image desc = createImage(name);
            if (desc != null) {
                imageRegistry.put(name, desc);
                image = desc;
                if (LOG.isDebugEnabled()) {
                    LOG.debug("image found '" + name + "'.");
                }
            }

            else {
                LOG.warn("image '" + name + "' could not be found!");
                m_missingImages.add(name);
            }
        }
        return image;
    }

    protected Image createImage(String name) {
        IconSpec spec = m_iconLocator.getIconSpec(name);
        if (spec != null) {
            if (LOG.isDebugEnabled()) {
                LOG.debug("image found '" + name + "'.");
            }
            return new Image(Display.getCurrent(), new ByteArrayInputStream(spec.getContent()));
        }
        LOG.warn("image '" + name + "' could not be found!");
        m_missingImages.add(name);
        return null;
    }

    protected ImageDescriptor createImageDescriptor(String name) {
        ImageDescriptor desc = null;
        IconSpec spec = m_iconLocator.getIconSpec(name);
        if (spec != null) {
            desc = ImageDescriptor.createFromImageData(new ImageData(new ByteArrayInputStream(spec.getContent())));
            if (LOG.isDebugEnabled()) {
                LOG.debug("image found '" + name + "'.");
            }
        } else {
            LOG.warn("image '" + name + "' could not be found!");
            m_missingImages.add(name);
        }
        return desc;
    }

    public void dispose() {
        imageRegistry.dispose();
    }
}