org.eclipse.jface.viewers.ITableLabelProvider Maven / Gradle / Ivy
The newest version!
/*******************************************************************************
* 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 each column of a given element.
* Used by table viewers.
*
* @see TableViewer
*/
public interface ITableLabelProvider extends IBaseLabelProvider {
/**
* Returns the label image for the given column of the given element.
*
* @param element the object representing the entire row, or
* null indicating that no input object is set
* in the viewer
* @param columnIndex the zero-based index of the column in which
* the label appears
* @return Image or null if there is no image for the
* given object at columnIndex
*/
public Image getColumnImage(Object element, int columnIndex);
/**
* Returns the label text for the given column of the given element.
*
* @param element the object representing the entire row, or
* null indicating that no input object is set
* in the viewer
* @param columnIndex the zero-based index of the column in which the label appears
* @return String or or null if there is no text for the
* given object at columnIndex
*/
public String getColumnText(Object element, int columnIndex);
}