oracle.javatools.ui.breadcrumbs
Interface BreadcrumbsModel

All Known Implementing Classes:

WebAppBreadcrumbsModel

public interface BreadcrumbsModel

Model to represent the structure of a document from current caret position up to the document root. The document may have a number of significant defined levels which can be recognised as 'stops' or 'breadcrumbs' in a breadcrumb bar (see JBreadcrumbs)

Method Summary

void	addBreadcrumbsModelListener(BreadcrumbsModelListener l)
Breadcrumb	getBreadcrumb(int crumb)
int	getBreadcrumbCount()
boolean	hasChildren(Breadcrumb breadcrumb) The breadcrumb visualization has the ability to display a popup list of possible child breadcrumbs or significant locations for a breadcrumb.
void	removeBreadcrumbsModelListener(BreadcrumbsModelListener l)

Method Detail

getBreadcrumbCount

int getBreadcrumbCount()

Returns:

the number of breadcrumbs currently visible

getBreadcrumb

Breadcrumb getBreadcrumb(int crumb)

Parameters:

crumb - the 0-based index of the breadcrumb to receive. 0 being the top-most level.

Returns:

the Breadcrumb at that index

hasChildren

boolean hasChildren(Breadcrumb breadcrumb)

The breadcrumb visualization has the ability to display a popup list of possible child breadcrumbs or significant locations for a breadcrumb. If the given breadcrumb object wants to be able to display this list then return true

Parameters:

breadcrumb -

Returns:

whether the breadcrumb wants to display a popup list of children

addBreadcrumbsModelListener

void addBreadcrumbsModelListener(BreadcrumbsModelListener l)

removeBreadcrumbsModelListener

void removeBreadcrumbsModelListener(BreadcrumbsModelListener l)