• Home
• org.eclipse.platform
• org.eclipse.jface
• 3.35.0
• source code
• ILabelProvider.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.eclipse.jface.viewers.ILabelProvider Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (c) 2000, 2015 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jface.viewers;

import org.eclipse.swt.graphics.Image;

/**
 * Extends IBaseLabelProvider with the methods
 * to provide the text and/or image for the label of a given element.
 * Used by most structured viewers, except table viewers.
 */
public interface ILabelProvider extends IBaseLabelProvider {
	/**
	 * Returns the image for the label of the given element.  The image
	 * is owned by the label provider and must not be disposed directly.
	 * Instead, dispose the label provider when no longer needed.
	 *
	 * @param element the element for which to provide the label image
	 * @return the image used to label the element, or null
	 *   if there is no image for the given object
	 */
	public Image getImage(Object element);

	/**
	 * Returns the text for the label of the given element.
	 *
	 * @param element the element for which to provide the label text
	 * @return the text string used to label the element, or null
	 *   if there is no text label for the given object
	 */
	public String getText(Object element);
}