Eclipse Platform
2.0

org.eclipse.jface.text
Class AbstractHoverInformationControlManager

java.lang.Object
  |
  +--org.eclipse.jface.text.AbstractInformationControlManager
        |
        +--org.eclipse.jface.text.AbstractHoverInformationControlManager

public abstract class AbstractHoverInformationControlManager
extends AbstractInformationControlManager

An information control manager that shows information on mouse hover events. The mouse hover events are caught by registering a MouseTrackListener on the manager's subject control. The manager has by default an information control closer that closes the information control as soon as the mouse pointer leaves the subject area, the user presses a key, or the subject control is resized, moved, or deactivated.

When being activated by a mouse hover event, the manager disables itself, until the mouse leaves the subject area. Thus, the manager is usually still disabled, when the information control has already been closed by the closer.

Since:
2.0
See Also:
MouseTrackListener

Nested Class Summary
 
Nested classes inherited from class org.eclipse.jface.text.AbstractInformationControlManager
AbstractInformationControlManager.Anchor, AbstractInformationControlManager.IInformationControlCloser
 
Field Summary
 
Fields inherited from class org.eclipse.jface.text.AbstractInformationControlManager
ANCHOR_BOTTOM, ANCHOR_LEFT, ANCHOR_RIGHT, ANCHOR_TOP
 
Constructor Summary
protected AbstractHoverInformationControlManager(IInformationControlCreator creator)
          Creates a new hover information control manager using the given information control creator.
 
Method Summary
protected  Point getHoverEventLocation()
          Returns the location at which the most recent mouse hover event has been issued.
protected  void presentInformation()
          Presents the information in the information control or hides the information control if no information should be presented.
 void setEnabled(boolean enabled)
          Sets the enable state of this manager.
 
Methods inherited from class org.eclipse.jface.text.AbstractInformationControlManager
computeInformation, computeInformationControlLocation, computeLocation, computeSizeConstraints, dispose, disposeInformationControl, doShowInformation, getInformationControl, getNextFallbackAnchor, getSubjectArea, getSubjectControl, handleInformationControlDisposed, handleSubjectControlDisposed, hideInformationControl, install, isEnabled, setAnchor, setCloser, setFallbackAnchors, setInformation, setMargins, setSizeConstraints, showInformation, showInformationControl, takesFocusWhenVisible, updateLocation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractHoverInformationControlManager

protected AbstractHoverInformationControlManager(IInformationControlCreator creator)
Creates a new hover information control manager using the given information control creator. By default a Closer instance is set as this manager's closer.

Parameters:
creator - the information control creator
Method Detail

presentInformation

protected void presentInformation()
Description copied from class: AbstractInformationControlManager
Presents the information in the information control or hides the information control if no information should be presented. The information has previously been set using setInformation.

Overrides:
presentInformation in class AbstractInformationControlManager

setEnabled

public void setEnabled(boolean enabled)
Description copied from class: AbstractInformationControlManager
Sets the enable state of this manager.

Overrides:
setEnabled in class AbstractInformationControlManager
Parameters:
enabled - the enable state

getHoverEventLocation

protected Point getHoverEventLocation()
Returns the location at which the most recent mouse hover event has been issued.

Returns:
the location of the most recent mouse hover event

Eclipse Platform
2.0

Copyright (c) IBM Corp. and others 2000, 2002. All Rights Reserved.