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 container for breadcrumbs and a toolbar area. Allows the applications to add breadcrumbs to 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. Also has a toolbar area, placed in the right side of bread, that allows applications to add Element to Uberfire Breadcrumbs.

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	addBreadCrumb(String associatedPerspective, String breadCrumbLabel, DefaultPlaceRequest associatedPlaceRequest) Creates a breadcrumb associated with a perspective and Place Request.
void	addBreadCrumb(String associatedPerspective, String breadCrumbLabel, DefaultPlaceRequest associatedPlaceRequest, Command command) Creates a breadcrumb associated with a perspective and Place Request.
void	addBreadCrumb(String associatedPerspective, String breadCrumbLabel, DefaultPlaceRequest associatedPlaceRequest, com.google.gwt.user.client.ui.HasWidgets addTo) Creates a breadcrumb associated with a perspective a Place Request and a target panel.
void	addBreadCrumb(String associatedPerspective, String breadCrumbLabel, DefaultPlaceRequest associatedPlaceRequest, com.google.gwt.user.client.ui.HasWidgets addTo, Command command) Creates a breadcrumb associated with a perspective a Place Request and a target panel.
void	addToolbar(String associatedPerspective, org.jboss.errai.common.client.dom.Element toolbar) Add a toolbar to a a perspective.
void	clearBreadCrumbsAndToolBars(String associatedPerspective) Clear the breadcrumbs and toolbars associated with a perspective.

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

clearBreadCrumbsAndToolBars

public void clearBreadCrumbsAndToolBars(String associatedPerspective)

Clear the breadcrumbs and toolbars associated with a perspective.

Parameters:

associatedPerspective - perspective associated with the breadcrumb

addBreadCrumb

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

Creates a breadcrumb associated with a perspective and Place Request.

Parameters:

associatedPerspective - perspective associated with the breadcrumb

breadCrumbLabel - label of the breadcrumb

associatedPlaceRequest - place request associated with the breadcrumb

addBreadCrumb

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

Creates a breadcrumb associated with a perspective a Place Request and a target panel.

Parameters:

associatedPerspective - perspective associated with the breadcrumb

breadCrumbLabel - label of the breadcrumb

associatedPlaceRequest - place request associated with the breadcrumb

addTo - target content panel of the place request

addBreadCrumb

public void addBreadCrumb(String associatedPerspective,
                          String breadCrumbLabel,
                          DefaultPlaceRequest associatedPlaceRequest,
                          Command command)

Creates a breadcrumb associated with a perspective and Place Request.

Parameters:

associatedPerspective - perspective associated with the breadcrumb

breadCrumbLabel - label of the breadcrumb

associatedPlaceRequest - place request associated with the breadcrumb

command - command to be executed after the associated place request is accessed

addBreadCrumb

public void addBreadCrumb(String associatedPerspective,
                          String breadCrumbLabel,
                          DefaultPlaceRequest associatedPlaceRequest,
                          com.google.gwt.user.client.ui.HasWidgets addTo,
                          Command command)

Creates a breadcrumb associated with a perspective a Place Request and a target panel.

Parameters:

associatedPerspective - perspective associated with the breadcrumb

breadCrumbLabel - label of the breadcrumb

associatedPlaceRequest - place request associated with the breadcrumb

addTo - target content panel of the place request

command - command to be executed after the associated place request is accessed

addToolbar

public void addToolbar(String associatedPerspective,
                       org.jboss.errai.common.client.dom.Element toolbar)

Add a toolbar to a a perspective. Toolbar is placed in the right side of breadcrumbs area.

Parameters:

associatedPerspective - perspective associated with the toolbar

toolbar - toolbar that will be added