bundles/rcp/org.eclipse.e4.ui.workbench.perspectiveswitcher/src/org/eclipse/e4/ui/workbench/perspectiveswitcher/internal/dialogs/DelegatingLabelProviderWithTooltip.java

/*******************************************************************************
 * Copyright (c) 2010, 2018 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 Corporation - initial API and implementation
 *     Joseph Carroll <jdsalingerjr@gmail.com> - Updated for Eclipse4
 *     
 * SPDX-License-Identifier: EPL-1.0
 *******************************************************************************/
package org.eclipse.e4.ui.workbench.perspectiveswitcher.internal.dialogs;

import org.eclipse.jface.viewers.ColumnLabelProvider;
import org.eclipse.jface.viewers.ColumnViewer;
import org.eclipse.jface.viewers.ColumnViewerToolTipSupport;
import org.eclipse.jface.viewers.IColorProvider;
import org.eclipse.jface.viewers.IFontProvider;
import org.eclipse.jface.viewers.ILabelDecorator;
import org.eclipse.jface.viewers.ILabelProvider;
import org.eclipse.jface.viewers.ILabelProviderListener;
import org.eclipse.jface.viewers.LabelProviderChangedEvent;
import org.eclipse.jface.viewers.ViewerColumn;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.graphics.Image;

/**
 * @since 3.5
 *
 */
public abstract class DelegatingLabelProviderWithTooltip extends ColumnLabelProvider {
	/**
	 * 
	 */
	private final ILabelDecorator decorator;
	ILabelProvider wrappedLabelProvider;

	/**
	 * 
	 * @param wrappedLabelProvider
	 * @param decorator
	 */
	DelegatingLabelProviderWithTooltip(ILabelProvider wrappedLabelProvider, ILabelDecorator decorator) {
		this.wrappedLabelProvider = wrappedLabelProvider;
		this.decorator = decorator;
		wrappedLabelProvider.addListener(new ILabelProviderListener() {

			@Override
			public void labelProviderChanged(LabelProviderChangedEvent event) {
				fireLabelProviderChanged(event);
			}
		});
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see
	 * org.eclipse.jface.viewers.CellLabelProvider#initialize(org.eclipse.jface.
	 * viewers.ColumnViewer, org.eclipse.jface.viewers.ViewerColumn)
	 */
	@Override
	protected void initialize(ColumnViewer viewer, ViewerColumn column) {
		super.initialize(viewer, column);
		if (this.decorator != null) {
			ColumnViewerToolTipSupport.enableFor(viewer);
		}
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see
	 * org.eclipse.jface.viewers.BaseLabelProvider#fireLabelProviderChanged(org.
	 * eclipse.jface.viewers.LabelProviderChangedEvent)
	 */
	@Override
	protected void fireLabelProviderChanged(LabelProviderChangedEvent event) {
		super.fireLabelProviderChanged(event);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.jface.viewers.ColumnLabelProvider#getText(java.lang.Object)
	 */
	@Override
	public String getText(Object element) {
		return this.wrappedLabelProvider.getText(element);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.jface.viewers.ColumnLabelProvider#getImage(java.lang.Object)
	 */
	@Override
	public Image getImage(Object element) {
		return this.wrappedLabelProvider.getImage(element);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.jface.viewers.ColumnLabelProvider#getFont(java.lang.Object)
	 */
	@Override
	public Font getFont(Object element) {
		if (this.wrappedLabelProvider instanceof IFontProvider) {
			return ((IFontProvider) this.wrappedLabelProvider).getFont(element);
		}
		return null;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see
	 * org.eclipse.jface.viewers.ColumnLabelProvider#getForeground(java.lang.Object)
	 */
	@Override
	public Color getForeground(Object element) {
		if (this.wrappedLabelProvider instanceof IColorProvider) {
			return ((IColorProvider) this.wrappedLabelProvider).getForeground(element);
		}
		return null;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see
	 * org.eclipse.jface.viewers.ColumnLabelProvider#getBackground(java.lang.Object)
	 */
	@Override
	public Color getBackground(Object element) {
		if (this.wrappedLabelProvider instanceof IColorProvider) {
			return ((IColorProvider) this.wrappedLabelProvider).getBackground(element);
		}
		return null;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see
	 * org.eclipse.jface.viewers.CellLabelProvider#getToolTipText(java.lang.Object)
	 */
	@Override
	public String getToolTipText(Object element) {
		if (this.decorator == null) {
			return null;
		}
		String text = getText(element);
		element = unwrapElement(element);
		return this.decorator.decorateText(text, element);
	}

	/**
	 * Returns the element that will be used to determine the bundle id. In most
	 * cases, this method can just return the provided element. Sometimes, it might
	 * be necessary to return a nested object, or an IConfigurationElement.
	 * 
	 * @param element
	 * @return the element, or a client object wrapped by element, or an
	 *         IConfigurationElement
	 */
	protected abstract Object unwrapElement(Object element);

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.jface.viewers.BaseLabelProvider#dispose()
	 */
	@Override
	public void dispose() {
		this.wrappedLabelProvider.dispose();
		super.dispose();
	}
}