org.uberfire.ext.widgets.common.client.breadcrumbs

Class UberfireBreadcrumbs

java.lang.Object

org.uberfire.ext.widgets.common.client.breadcrumbs.UberfireBreadcrumbs

public class UberfireBreadcrumbs
extends Object

A breadcrumb navigation system. Allows the application to navigate into any displayable thing: a WorkbenchPerspective, a WorkbenchScreen a WorkbenchEditor, or the editor associated with a VFS file located at a particular Path through a PathPlaceRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UberfireBreadcrumbs.View

Field Summary

Fields

Modifier and Type	Field and Description
static double	SIZE

Constructor Summary

Constructors

Constructor and Description
UberfireBreadcrumbs(org.uberfire.client.workbench.docks.UberfireDocksContainer uberfireDocksContainer, org.jboss.errai.ioc.client.api.ManagedInstance<BreadcrumbsPresenter> breadcrumbsPresenters, org.uberfire.client.mvp.PlaceManager placeManager, UberfireBreadcrumbs.View view)

Method Summary

Modifier and Type	Method and Description
void	createRoot(String associatedPerspective, String breadCrumbLabel, DefaultPlaceRequest associatedPlaceRequest) Creates a root breadcrumb associated with a perspective.
void	createRoot(String associatedPerspective, String breadCrumbLabel, DefaultPlaceRequest associatedPlaceRequest, boolean goToPlaceRequest) Creates a root breadcrumb associated with a perspective and makes a placeManager.goTo to the associated Place Request.
void	navigateTo(String breadCrumbLabel, DefaultPlaceRequest associatedPlaceRequest) Navigates to an associated place request.
void	navigateTo(String breadCrumbLabel, DefaultPlaceRequest associatedPlaceRequest, com.google.gwt.user.client.ui.HasWidgets addTo) Navigates to an associated place request and add it to a specific content area.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SIZE

public static final double SIZE

See Also:

Constant Field Values

Constructor Detail

UberfireBreadcrumbs

@Inject
public UberfireBreadcrumbs(org.uberfire.client.workbench.docks.UberfireDocksContainer uberfireDocksContainer,
                                   org.jboss.errai.ioc.client.api.ManagedInstance<BreadcrumbsPresenter> breadcrumbsPresenters,
                                   org.uberfire.client.mvp.PlaceManager placeManager,
                                   UberfireBreadcrumbs.View view)

Method Detail

createRoot

public void createRoot(String associatedPerspective,
                       String breadCrumbLabel,
                       DefaultPlaceRequest associatedPlaceRequest)

Creates a root breadcrumb associated with a perspective.

Parameters:

associatedPerspective - perspective associated with the root breadcrumb

breadCrumbLabel - label of the root breadcrumb

associatedPlaceRequest - place request associated with the root breadcrumb

createRoot

public void createRoot(String associatedPerspective,
                       String breadCrumbLabel,
                       DefaultPlaceRequest associatedPlaceRequest,
                       boolean goToPlaceRequest)

Creates a root breadcrumb associated with a perspective and makes a placeManager.goTo to the associated Place Request.

Parameters:

associatedPerspective - perspective associated with the root breadcrumb

breadCrumbLabel - label of the root breadcrumb

associatedPlaceRequest - place request associated with the root breadcrumb

goToPlaceRequest - should I do make a goto call after creating the root breacrumb?

navigateTo

public void navigateTo(String breadCrumbLabel,
                       DefaultPlaceRequest associatedPlaceRequest)

Navigates to an associated place request. Also, if it isn't the most recent breadcrumbs, automatically remove the most recent and try to close the place request associated with it.

Parameters:

breadCrumbLabel - label of the root breadcrumb

associatedPlaceRequest - place request associated with the breadcrumb

navigateTo

public void navigateTo(String breadCrumbLabel,
                       DefaultPlaceRequest associatedPlaceRequest,
                       com.google.gwt.user.client.ui.HasWidgets addTo)

Navigates to an associated place request and add it to a specific content area. Also, if it isn't the most recent breadcrumbs, automatically remove the most recent and close the place request associated with it.

Parameters:

breadCrumbLabel - label of the root breadcrumb

associatedPlaceRequest - place request associated with the breadcrumb

addTo - target content panel of the place request