Dali Provisional API
Release 3.2

org.eclipse.jpt.common.ui.jface
Interface ItemExtendedLabelProvider

All Superinterfaces:
ItemLabelProvider
All Known Implementing Classes:
ItemExtendedLabelProvider.Null

public interface ItemExtendedLabelProvider
extends ItemLabelProvider

Implementations of this interface can be used to maintain the label (image and text) and description of a specific item. The implementation will monitor the item for any changes that affect the description and forward them appropriately to the ItemExtendedLabelProvider.Manager.

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

See Also:
ILabelProvider, IDescriptionProvider

Nested Class Summary
static interface ItemExtendedLabelProvider.Manager
          An item extended label provider's manager is notified whenever the item's description has changed.
static class ItemExtendedLabelProvider.Null
          A null item extended label provider that returns a null image, a null text string, and a null description string.
 
Method Summary
 String getDescription()
          Return the description for the provider's item.
 
Methods inherited from interface org.eclipse.jpt.common.ui.jface.ItemLabelProvider
dispose, getImage, getText
 

Method Detail

getDescription

String getDescription()
Return the description for the provider's item.

See Also:
IDescriptionProvider.getDescription(Object)

Dali Provisional API
Release 3.2

Copyright (c) 2012 Oracle. All rights reserved.