Eclipse Platform
Release 3.1

org.eclipse.jface.viewers
Interface IViewerLabelProvider

All Superinterfaces:
IBaseLabelProvider
All Known Implementing Classes:
DecoratingLabelProvider

public interface IViewerLabelProvider
extends IBaseLabelProvider

Extends IBaseLabelProvider with the methods to update the label for a given element. The label is represented by a ViewerLabel. Unlike ILabelProvider, this allows the text and image to be set in the same request, rather than via separate requests.

It also allows the current values for the text and image to be considered by the label provider, allowing for potential optimizations. For example, decorating label providers that run in the background can hold off applying an update to a previously populated label until the decoration is ready, thereby reducing flicker.

Since:
3.0
See Also:
IDelayedLabelDecorator

Method Summary
 void updateLabel(ViewerLabel label, Object element)
          Updates the label for the given element.
 
Methods inherited from interface org.eclipse.jface.viewers.IBaseLabelProvider
addListener, dispose, isLabelProperty, removeListener
 

Method Detail

updateLabel

public void updateLabel(ViewerLabel label,
                        Object element)
Updates the label for the given element.

Parameters:
label - the label to update
element - the element

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.