HoverProvider

All Known Implementing Classes:: ghidra.app.plugin.core.hover.AbstractHoverProvider, DecompilerHoverProvider, ListingHoverProvider

public interface HoverProvider

Method Summary

Modifier and Type

Method

Description

void

closeHover()

Hide this service's popup window if visible

boolean

isShowing()

Returns true if this service's popup window is currently visible

void

mouseHovered(FieldLocation fieldLocation, Field field, Rectangle fieldBounds, MouseEvent event)

Notify this service that the mouse is hovering over a specific field within a field viewer.

void

scroll(int amount)

If this service's window supports scrolling, scroll by the specified amount.

Method Details
- isShowing
  
  boolean isShowing()
  
  Returns true if this service's popup window is currently visible
  
  Returns:
  
  true if this service's popup window is currently visible
- closeHover
  
  void closeHover()
  
  Hide this service's popup window if visible
- mouseHovered
  
  void mouseHovered(FieldLocation fieldLocation, Field field, Rectangle fieldBounds, MouseEvent event)
  
  Notify this service that the mouse is hovering over a specific field within a field viewer.
  
  Parameters:
  
  fieldLocation - the precise mouse location within the field viewer
  
  field - the field over which the mouse is hovering
  
  fieldBounds - the rectangle containing the bounds of the given field.
  
  event - the last mouse motion event over the field viewer component (i.e., FieldPanel).
- scroll
  
  void scroll(int amount)
  
  If this service's window supports scrolling, scroll by the specified amount. The value will be negative when scrolling should move up.
  
  Parameters:
  
  amount - the amount by which to scroll