EGF Engine
Release 0.1.0

org.eclipse.egf.common.ui.viewers
Class AbstractTooltipLabelProvider

java.lang.Object
  extended by CellLabelProvider
      extended by org.eclipse.egf.common.ui.viewers.AbstractTooltipLabelProvider
Direct Known Subclasses:
CustomTooltipLabelProvider, PatternStructureLabelProviderWithTooltip

public abstract class AbstractTooltipLabelProvider
extends CellLabelProvider

Base class to implement label providers with tooltip support to use in JFace viewers.


Field Summary
protected static int DISPLAY_DELAY_TIME
          The time in milliseconds until the tool tip is displayed.
protected static int TOOLTIP_TIME_DISPLAYED
          The time in milliseconds the tool tip is shown for.
 
Constructor Summary
protected AbstractTooltipLabelProvider(ILabelProvider labelProvider_p)
          Constructor.
protected AbstractTooltipLabelProvider(ILabelProvider labelProvider_p, int tooltipTimeDisplayed_p, int tooltipDisplayDelayTime_p)
          Constructor.
 
Method Summary
 void addListener(ILabelProviderListener listener_p)
           
 void dispose()
           
 Image getImage(Object element_p)
           
 String getText(Object element_p)
           
 int getToolTipDisplayDelayTime(Object object_p)
           
 Point getToolTipShift(Object object_p)
           
abstract  String getToolTipText(Object element_p)
           
 int getToolTipTimeDisplayed(Object object_p)
           
 boolean isLabelProperty(Object element_p, String property_p)
           
 void removeListener(ILabelProviderListener listener_p)
           
 void update(ViewerCell viewer_p)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TOOLTIP_TIME_DISPLAYED

protected static final int TOOLTIP_TIME_DISPLAYED
The time in milliseconds the tool tip is shown for.

See Also:
Constant Field Values

DISPLAY_DELAY_TIME

protected static final int DISPLAY_DELAY_TIME
The time in milliseconds until the tool tip is displayed.

See Also:
Constant Field Values
Constructor Detail

AbstractTooltipLabelProvider

protected AbstractTooltipLabelProvider(ILabelProvider labelProvider_p,
                                       int tooltipTimeDisplayed_p,
                                       int tooltipDisplayDelayTime_p)
Constructor.

Parameters:
labelProvider_p - label provider that provides the text and the image for given element.
tooltipTimeDisplayed_p - time in milliseconds the tool tip is shown for.
tooltipDisplayDelayTime_p - time in milliseconds until the tool tip is displayed.

AbstractTooltipLabelProvider

protected AbstractTooltipLabelProvider(ILabelProvider labelProvider_p)
Constructor.

Parameters:
labelProvider_p - label provider that provides the text and the image for given element.
tooltipTimeDisplayed_p - time in milliseconds the tool tip is shown for.
tooltipDisplayDelayTime_p - time in milliseconds until the tool tip is displayed.
Method Detail

getToolTipText

public abstract String getToolTipText(Object element_p)
See Also:
org.eclipse.jface.viewers.CellLabelProvider#getToolTipText(java.lang.Object)

getToolTipShift

public Point getToolTipShift(Object object_p)
See Also:
org.eclipse.jface.viewers.CellLabelProvider#getToolTipShift(java.lang.Object)

getToolTipDisplayDelayTime

public int getToolTipDisplayDelayTime(Object object_p)
See Also:
org.eclipse.jface.viewers.CellLabelProvider#getToolTipDisplayDelayTime(java.lang.Object)

getToolTipTimeDisplayed

public int getToolTipTimeDisplayed(Object object_p)
See Also:
org.eclipse.jface.viewers.CellLabelProvider#getToolTipTimeDisplayed(java.lang.Object)

update

public void update(ViewerCell viewer_p)
See Also:
org.eclipse.jface.viewers.CellLabelProvider#update(org.eclipse.jface.viewers.ViewerCell)

getImage

public Image getImage(Object element_p)
See Also:
org.eclipse.jface.viewers.ILabelProvider#getImage(java.lang.Object)

getText

public String getText(Object element_p)
See Also:
org.eclipse.jface.viewers.ILabelProvider#getText(java.lang.Object)

addListener

public void addListener(ILabelProviderListener listener_p)
See Also:
org.eclipse.jface.viewers.IBaseLabelProvider#addListener(org.eclipse.jface.viewers.ILabelProviderListener)

dispose

public void dispose()
See Also:
org.eclipse.jface.viewers.IBaseLabelProvider#dispose()

isLabelProperty

public boolean isLabelProperty(Object element_p,
                               String property_p)
See Also:
org.eclipse.jface.viewers.IBaseLabelProvider#isLabelProperty(java.lang.Object, java.lang.String)

removeListener

public void removeListener(ILabelProviderListener listener_p)
See Also:
org.eclipse.jface.viewers.IBaseLabelProvider#removeListener(org.eclipse.jface.viewers.ILabelProviderListener)

EGF Engine
Release 0.1.0

Copyright (c) Thales Corporate Services S.A.S, 2009.

This page is made available under license. For full details see the LEGAL in the documentation book that contains this page.