public class InfoTipHover
extends java.lang.Object
implements oracle.ide.hover.Hover
To Use: Register a Hoverable
with the HoverableRegistry
(or declare the hover via extension.xml) and when the Hoverable is called back by the registry, create and return an InfoTipHover. The hoverable should ofnIbe unregistered when no longer needed.
The look of the content should follow the guidelines for an InfoTip and should use the given InfoTipStyles to retrieve and set how the content looks.
Constructor and Description |
---|
InfoTipHover(Template template, InfoTipStyles style, javax.swing.JComponent parent, java.awt.Point location, oracle.ide.hover.HoverFlavor flavor)
Create an InfoTipHover.
|
InfoTipHover(Template template, InfoTipStyles style, javax.swing.JComponent parent, java.awt.Rectangle location, oracle.ide.hover.HoverFlavor flavor)
Create an InfoTipHover.
|
Modifier and Type | Method and Description |
---|---|
void |
addHoverListener(oracle.ide.hover.HoverListener hoverListener) |
void |
ensureVisible()
Ensure the InfoTip is fully visible.
|
oracle.ide.hover.HoverFlavor |
getFlavor() |
InfoTip |
getInfoTip() |
java.awt.Rectangle |
getLocation() |
InfoTipOrientation |
getOrientation() |
void |
hideHover()
Remove the InfoTip from display.
|
boolean |
isPointWithinHover(java.awt.Point p) |
void |
removeHoverListener(oracle.ide.hover.HoverListener hoverListener) |
void |
setContent(Template template)
Set the content of the infoTip.
|
void |
setLocation(java.awt.Rectangle location)
Set the bounding area relative to the parent component around which the infotip will appear.
|
void |
setOrientation(InfoTipOrientation orientation)
Describe how the InfoTip should be placed next to the location it points to.
|
boolean |
shouldHideHover(java.awt.event.KeyEvent event) |
void |
showHover()
Display the InfoTip on screen.
|
public InfoTipHover(Template template, InfoTipStyles style, javax.swing.JComponent parent, java.awt.Point location, oracle.ide.hover.HoverFlavor flavor)
template
- the content to appear in the hover. (may be null if content is set later)style
- the look of the InfoTipparent
- the component that the InfoTip will point to.location
- The specific location within the parent to point to.flavor
- the type of HoverFlavor this Hover responds to.public InfoTipHover(Template template, InfoTipStyles style, javax.swing.JComponent parent, java.awt.Rectangle location, oracle.ide.hover.HoverFlavor flavor)
template
- the content to appear in the hover (may be null if content is set later)style
- the look of the InfoTipparent
- the component that the InfoTip will point to.location
- The specific location rectangle within the parent to point to. The InfoTip will point to the nearest side of the rectangle, but not within it.flavor
- the type of HoverFlavor this Hover responds to.public void setContent(Template template)
template
-public InfoTip getInfoTip()
public void showHover()
showHover
in interface oracle.ide.hover.Hover
public void hideHover()
hideHover
in interface oracle.ide.hover.Hover
public oracle.ide.hover.HoverFlavor getFlavor()
getFlavor
in interface oracle.ide.hover.Hover
public void addHoverListener(oracle.ide.hover.HoverListener hoverListener)
addHoverListener
in interface oracle.ide.hover.Hover
public void removeHoverListener(oracle.ide.hover.HoverListener hoverListener)
removeHoverListener
in interface oracle.ide.hover.Hover
public boolean isPointWithinHover(java.awt.Point p)
isPointWithinHover
in interface oracle.ide.hover.Hover
public boolean shouldHideHover(java.awt.event.KeyEvent event)
shouldHideHover
in interface oracle.ide.hover.Hover
public InfoTipOrientation getOrientation()
public void setOrientation(InfoTipOrientation orientation)
orientation
-public void ensureVisible()
public void setLocation(java.awt.Rectangle location)
location
-public java.awt.Rectangle getLocation()