Eclipse Platform
Release 3.2

org.eclipse.ui.navigator
Interface ICommonLabelProvider

All Superinterfaces:
IBaseLabelProvider, IDescriptionProvider, ILabelProvider, IMementoAware
All Known Implementing Classes:
SynchronizationLabelProvider

public interface ICommonLabelProvider
extends ILabelProvider, IMementoAware, IDescriptionProvider

A custom interface for Common Navigator extensions that either (1) require more information about the specific CommonViewer they are associated with, or (2) would like to return a custom description for use in the Status Bar. Clients may choose to implement this interface for the labelProvider attribute of the org.eclipse.ui.navigator.navigatorContent extension point.

Clients need not implement this interface if there is no cause to do so. ILabelProvider is respected by the Common Navigator.

EXPERIMENTAL. This class or interface has been added as part of a work in progress. There is a guarantee neither that this API will work nor that it will remain the same. Please do not use this API without consulting with the Platform/UI team.

Clients may implement this interface.

Since:
3.2

Method Summary
 void init(IExtensionStateModel aStateModel, ITreeContentProvider aContentProvider)
           Provides the state model for any initialization.
 
Methods inherited from interface org.eclipse.jface.viewers.ILabelProvider
getImage, getText
 
Methods inherited from interface org.eclipse.jface.viewers.IBaseLabelProvider
addListener, dispose, isLabelProperty, removeListener
 
Methods inherited from interface org.eclipse.ui.navigator.IMementoAware
restoreState, saveState
 
Methods inherited from interface org.eclipse.ui.navigator.IDescriptionProvider
getDescription
 

Method Detail

init

public void init(IExtensionStateModel aStateModel,
                 ITreeContentProvider aContentProvider)

Provides the state model for any initialization.

Parameters:
aStateModel - The state model associated with this logical extension.
aContentProvider - The associated content provider for this label provider.
See Also:
ICommonContentProvider

Eclipse Platform
Release 3.2

Guidelines for using Eclipse APIs.

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