oracle.javatools.ui.overview

Interface OverviewTipProvider<M extends OverviewMark>

Type Parameters:

M -

public interface OverviewTipProvider<M extends OverviewMark>

Allows clients to create content for tips that are displayed when the mouse hovers over a mark or marks in an Overview.

Implementors should register the provider with the Overview

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OverviewTipProvider.Orientation

Method Summary

Methods

Modifier and Type	Method and Description
OverviewTipProvider.Orientation	getOrientation()
javax.swing.JComponent	getTipContent(java.util.Collection<M> marks, oracle.ide.hover.Hover hover) Create the content of a tip to be displayed when the mouse hovers over one or more marks in an Overview.

Method Detail

getTipContent

javax.swing.JComponent getTipContent(java.util.Collection<M> marks,
                                   oracle.ide.hover.Hover hover)

Create the content of a tip to be displayed when the mouse hovers over one or more marks in an Overview.

The content will be added to the tip automatically. The Hover parameter is provided as a convenience for the provider to hold onto should it wish to control the life cycle of the tip later: e.g. force it to hide is a certain situation.

Parameters:

marks - the marks present at the hover location

hover - the hover containing the tip

Returns:

the content to be added to the tip.

getOrientation

OverviewTipProvider.Orientation getOrientation()

Returns:

the preferred orientation for where the tip should appear in relation to the OverviewMarks