TPTP 4.6.0 Platform Project
Internal API Specification

org.eclipse.hyades.ui.internal.provider
Class LabelProviderPicker

java.lang.Object
  extended by org.eclipse.hyades.ui.internal.provider.LabelProviderPicker
All Implemented Interfaces:
org.eclipse.hyades.ui.util.ILabelAndDescriptionProvider, org.eclipse.jface.viewers.IBaseLabelProvider, org.eclipse.jface.viewers.ILabelProvider

public class LabelProviderPicker
extends java.lang.Object
implements org.eclipse.hyades.ui.util.ILabelAndDescriptionProvider

This label provider is a type of label provider decorator that allows clients to select a provider to handle the requests.

Listeners added or removed to this label provider are automatically added or removed to all the providers that were added.


Constructor Summary
LabelProviderPicker()
          Constructor for LabelProviderPicker
 
Method Summary
 void addListener(org.eclipse.jface.viewers.ILabelProviderListener listener)
           
 void addProvider(org.eclipse.jface.viewers.ILabelProvider provider)
          Adds a provider.
 void clearProviders()
          Removes all the providers.
 void dispose()
           
 org.eclipse.jface.viewers.ILabelProvider getCurrentProvider()
          Returns the current provider
 int getCurrentProviderIndex()
          Returns the index of the current provider.
 java.lang.String getDescription(java.lang.Object element)
           
 org.eclipse.swt.graphics.Image getImage(java.lang.Object element)
           
 java.lang.String getText(java.lang.Object element)
           
 boolean isLabelProperty(java.lang.Object element, java.lang.String property)
           
 void removeListener(org.eclipse.jface.viewers.ILabelProviderListener listener)
           
 void removeProvider(int index)
          Removes the provider associated with a given index.
 boolean setCurrentProvider(int index)
          Sets the current provider.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LabelProviderPicker

public LabelProviderPicker()
Constructor for LabelProviderPicker

Method Detail

dispose

public void dispose()
Specified by:
dispose in interface org.eclipse.jface.viewers.IBaseLabelProvider
See Also:
IBaseLabelProvider.dispose()

addProvider

public void addProvider(org.eclipse.jface.viewers.ILabelProvider provider)
Adds a provider. The provider are kept in the order they are added.

This method sets the specified provider as the current if no other provider is already defined as current.

Parameters:
provider -

clearProviders

public void clearProviders()
Removes all the providers.


removeProvider

public void removeProvider(int index)
Removes the provider associated with a given index. The first provider added to this picker has index 0.

This method removes from the label provider identified by the index all the listeners.

Parameters:
index -

setCurrentProvider

public boolean setCurrentProvider(int index)
Sets the current provider. If the index is not in used the current selection is kept,

Parameters:
index -
Returns:
true if the current provider was set or false otherwise.

getCurrentProvider

public org.eclipse.jface.viewers.ILabelProvider getCurrentProvider()
Returns the current provider

Returns:
ILabelProvider

getCurrentProviderIndex

public int getCurrentProviderIndex()
Returns the index of the current provider.

Returns:
int

addListener

public void addListener(org.eclipse.jface.viewers.ILabelProviderListener listener)
Specified by:
addListener in interface org.eclipse.jface.viewers.IBaseLabelProvider
See Also:
IBaseLabelProvider.addListener(org.eclipse.jface.viewers.ILabelProviderListener)

removeListener

public void removeListener(org.eclipse.jface.viewers.ILabelProviderListener listener)
Specified by:
removeListener in interface org.eclipse.jface.viewers.IBaseLabelProvider
See Also:
IBaseLabelProvider.removeListener(org.eclipse.jface.viewers.ILabelProviderListener)

getDescription

public java.lang.String getDescription(java.lang.Object element)
Specified by:
getDescription in interface org.eclipse.hyades.ui.util.ILabelAndDescriptionProvider
See Also:
ILabelAndDescriptionProvider.getDescription(java.lang.Object)

getImage

public org.eclipse.swt.graphics.Image getImage(java.lang.Object element)
Specified by:
getImage in interface org.eclipse.jface.viewers.ILabelProvider
See Also:
ILabelProvider.getImage(java.lang.Object)

getText

public java.lang.String getText(java.lang.Object element)
Specified by:
getText in interface org.eclipse.jface.viewers.ILabelProvider
See Also:
ILabelProvider.getText(java.lang.Object)

isLabelProperty

public boolean isLabelProperty(java.lang.Object element,
                               java.lang.String property)
Specified by:
isLabelProperty in interface org.eclipse.jface.viewers.IBaseLabelProvider
See Also:
IBaseLabelProvider.isLabelProperty(java.lang.Object, java.lang.String)

TPTP 4.6.0 Platform Project
Internal API Specification