|
 |
|
| |
org.eclipse.jface.text
Class AbstractHoverInformationControlManager
java.lang.Object
org.eclipse.jface.text.AbstractInformationControlManager
org.eclipse.jface.text.AbstractHoverInformationControlManager
-
Direct Known Subclasses:
-
AnnotationBarHoverManager
-
public abstract class AbstractHoverInformationControlManager
- extends
AbstractInformationControlManager
An information control manager that shows information in response to 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
|
Fields inherited from class org.eclipse.jface.text.
AbstractInformationControlManager
|
ANCHOR_BOTTOM,
ANCHOR_GLOBAL,
ANCHOR_LEFT,
ANCHOR_RIGHT,
ANCHOR_TOP,
DEBUG,
fDisposed,
fInformationControl,
fInformationControlCloser,
fInformationControlCreator,
STORE_LOCATION_X,
STORE_LOCATION_Y,
STORE_SIZE_HEIGHT,
STORE_SIZE_WIDTH
|
|
Method Summary
|
void
|
dispose
()
Disposes this manager's information control. |
protected
MouseEvent
|
getHoverEvent
()
Returns the most recent mouse hover event. |
protected
Point
|
getHoverEventLocation
()
Returns the location at which the most recent mouse hover event
has been issued. |
protected int
|
getHoverEventStateMask
()
Returns the SWT event state of the most recent mouse hover event. |
org.eclipse.jface.internal.text.InternalAccessor
|
getInternalAccessor
()
Returns an adapter that gives access to internal methods. |
protected void
|
hideInformationControl
()
Hides the information control and stops the information control closer. |
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)
Deprecated. visibility will be changed to protected
|
|
Methods inherited from class org.eclipse.jface.text.
AbstractInformationControlManager
|
computeAvailableArea,
computeInformation,
computeInformationControlLocation,
computeLocation,
computeSizeConstraints,
computeSizeConstraints,
disposeInformationControl,
doShowInformation,
getInformationControl,
getNextFallbackAnchor,
getSubjectArea,
getSubjectControl,
handleInformationControlDisposed,
handleSubjectControlDisposed,
install,
isEnabled,
restoreInformationControlBounds,
setAnchor,
setCloser,
setCustomInformationControlCreator,
setFallbackAnchors,
setInformation,
setInformation,
setMargins,
setRestoreInformationControlBounds,
setSizeConstraints,
showInformation,
showInformationControl,
storeInformationControlBounds,
takesFocusWhenVisible,
updateLocation
|
|
Methods inherited from class java.lang.
Object
|
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
|
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
hideInformationControl
protected void hideInformationControl()
-
Description copied from class:
AbstractInformationControlManager
- Hides the information control and stops the information control closer.
-
-
Overrides:
-
hideInformationControl
in class
AbstractInformationControlManager
-
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.
This method should only be called from overriding methods or from setInformation.
-
-
Overrides:
-
presentInformation
in class
AbstractInformationControlManager
-
setEnabled
public void setEnabled(boolean enabled)
-
Deprecated. visibility will be changed to protected
- Sets the enable state of this manager.
-
-
Overrides:
-
setEnabled
in class
AbstractInformationControlManager
-
-
Parameters:
-
enabled - the enable state
dispose
public void dispose()
- Disposes this manager's information control.
-
-
Overrides:
-
dispose
in class
AbstractInformationControlManager
-
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
getHoverEvent
protected
MouseEvent getHoverEvent()
- Returns the most recent mouse hover event.
-
-
Returns:
- the most recent mouse hover event or
null
-
Since:
- 3.0
getHoverEventStateMask
protected int getHoverEventStateMask()
- Returns the SWT event state of the most recent mouse hover event.
-
-
Returns:
- the SWT event state of the most recent mouse hover event
getInternalAccessor
public org.eclipse.jface.internal.text.InternalAccessor getInternalAccessor()
- Returns an adapter that gives access to internal methods.
Note: This method is not intended to be referenced or overridden by clients.
-
-
Overrides:
-
getInternalAccessor
in class
AbstractInformationControlManager
-
-
Returns:
- the replaceable information control accessor
-
Since:
- 3.4
-
Restriction:
- This method is not intended to be referenced by clients.
-
Restriction:
- This method is not intended to be re-implemented or extended by clients.
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
|
|
|
