oracle.javatools.ui.breadcrumbs
Interface BreadcrumbsListener

public interface BreadcrumbsListener

Method Summary

void	breadcrumbClicked(Breadcrumb crumb) Indicates the user has clicked on a breadcrumb.
void	breadcrumbContextClicked(Breadcrumb crumb, java.awt.Point p) Indicates the user has context clicked on a breadcrumb (e.g.
void	hideBreadcrumbPeek() Hide any currently showing breadcrumb peek.
void	separatorClicked(Breadcrumb crumb, java.awt.Rectangle separatorBounds) Indicates a click on a breadcrumb separator.
void	showBreadcrumbPeek(Breadcrumb crumb, java.awt.Rectangle peekLocation) Indicates the breadcrumb should show a peek of the breadcrumb origin of the crumb is at the given point.

Method Detail

breadcrumbClicked

void breadcrumbClicked(Breadcrumb crumb)

Indicates the user has clicked on a breadcrumb. This usually triggers a navigation to the crumb start offset in the code editor.

Parameters:

crumb -

breadcrumbContextClicked

void breadcrumbContextClicked(Breadcrumb crumb,
                              java.awt.Point p)

Indicates the user has context clicked on a breadcrumb (e.g. a right click in Microsoft Windows).

Parameters:

crumb - the crumb over which the click occurred

p - the point (in JBreadcrumbs coordinates) where the click occured

showBreadcrumbPeek

void showBreadcrumbPeek(Breadcrumb crumb,
                        java.awt.Rectangle peekLocation)

Indicates the breadcrumb should show a peek of the breadcrumb origin of the crumb is at the given point. The peek can be a tooltip, a popup window, or can be ignored. The method also can indicate to hide any visible peek by passing a null crumb and position.

Parameters:

crumb - The crumb to peek or null to hide any visible peek

peekLocation - The bounding rectangle of the breadcrumb in JBreadcrumbs coordinates.

hideBreadcrumbPeek

void hideBreadcrumbPeek()

Hide any currently showing breadcrumb peek.

separatorClicked

void separatorClicked(Breadcrumb crumb,
                      java.awt.Rectangle separatorBounds)

Indicates a click on a breadcrumb separator. The breadcrumb separator is the [now badly named] component that indicates that a breadcrumb has peers from which to choose. Standard behaviour on clicking on this component is to prompt the user to choose from a selection of peer breadcrumbs which are all tt the same level as the breadcrumb that contained the peer component.

Parameters:

crumb - the crumb to which this separator is attached.

separatorBounds - the bounds of the peer component (in JBreadcrumbs co-ordingates)