Package 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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UberfireBreadcrumbs.View

Constructor Summary

Constructors

Constructor	Description
UberfireBreadcrumbs(UberfireBreadcrumbsContainer uberfireBreadcrumbsContainer, org.jboss.errai.ioc.client.api.ManagedInstance<DefaultBreadcrumbsPresenter> breadcrumbsPresenters, org.uberfire.client.mvp.PlaceManager placeManager, UberfireBreadcrumbs.View view)

Method Summary

Modifier and Type	Method	Description
void	addBreadCrumb(String associatedPerspective, String breadCrumbLabel, org.uberfire.mvp.Command command)	Creates a breadcrumb associated with a perspective.
void	addBreadCrumb(String associatedPerspective, String breadCrumbLabel, org.uberfire.mvp.Command command, boolean removeDeepLevelBreadcrumbsAfterActivation)	Creates a breadcrumb associated with a perspective.
void	addBreadCrumb(String associatedPerspective, String breadCrumbLabel, org.uberfire.mvp.PlaceRequest associatedPlaceRequest)	Creates a breadcrumb associated with a perspective and Place Request.
void	addBreadCrumb(String associatedPerspective, String breadCrumbLabel, org.uberfire.mvp.PlaceRequest associatedPlaceRequest, org.uberfire.mvp.Command command)	Creates a breadcrumb associated with a perspective and Place Request.
void	addBreadCrumb(String associatedPerspective, String breadCrumbLabel, org.uberfire.mvp.PlaceRequest associatedPlaceRequest, org.uberfire.mvp.Command command, boolean removeDeepLevelBreadcrumbsAfterActivation)	Creates a breadcrumb associated with a perspective a Place Request and a target panel.
void	addBreadCrumb(String associatedPerspective, BreadcrumbPresenter breadCrumbPresenter)
void	addToolbar(String associatedPerspective, org.jboss.errai.common.client.dom.Element toolbar)	Adds a toolbar to a perspective.
void	clearBreadcrumbs(String associatedPerspective)	Clears the breadcrumbs associated with a perspective.
void	clearBreadcrumbsAndToolBars(String associatedPerspective)	Clears the breadcrumbs and toolbars associated with a perspective.
void	createBreadcrumbs()

Methods inherited from class java.lang.Object

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

Constructor Detail

UberfireBreadcrumbs

@Inject
public UberfireBreadcrumbs(UberfireBreadcrumbsContainer uberfireBreadcrumbsContainer,
                           org.jboss.errai.ioc.client.api.ManagedInstance<DefaultBreadcrumbsPresenter> breadcrumbsPresenters,
                           org.uberfire.client.mvp.PlaceManager placeManager,
                           UberfireBreadcrumbs.View view)

Method Detail

createBreadcrumbs

@PostConstruct
public void createBreadcrumbs()

clearBreadcrumbs

public void clearBreadcrumbs(String associatedPerspective)

Clears the breadcrumbs associated with a perspective.

Parameters:

associatedPerspective - perspective associated with the breadcrumb

clearBreadcrumbsAndToolBars

public void clearBreadcrumbsAndToolBars(String associatedPerspective)

Clears the breadcrumbs and toolbars associated with a perspective.

Parameters:

associatedPerspective - perspective associated with the breadcrumb

addBreadCrumb

public void addBreadCrumb(String associatedPerspective,
                          String breadCrumbLabel,
                          org.uberfire.mvp.Command command)

Creates a breadcrumb associated with a perspective.

Parameters:

associatedPerspective - perspective associated with the breadcrumb

breadCrumbLabel - label of the breadcrumb

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

addBreadCrumb

public void addBreadCrumb(String associatedPerspective,
                          String breadCrumbLabel,
                          org.uberfire.mvp.Command command,
                          boolean removeDeepLevelBreadcrumbsAfterActivation)

Creates a breadcrumb associated with a perspective.

Parameters:

associatedPerspective - perspective associated with the breadcrumb

breadCrumbLabel - label of the breadcrumb

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

removeDeepLevelBreadcrumbsAfterActivation - defines if the deep level breadcrumbs should be removed after the breadcrumb is activated

addBreadCrumb

public void addBreadCrumb(String associatedPerspective,
                          String breadCrumbLabel,
                          org.uberfire.mvp.PlaceRequest 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,
                          org.uberfire.mvp.PlaceRequest associatedPlaceRequest,
                          org.uberfire.mvp.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,
                          org.uberfire.mvp.PlaceRequest associatedPlaceRequest,
                          org.uberfire.mvp.Command command,
                          boolean removeDeepLevelBreadcrumbsAfterActivation)

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

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

removeDeepLevelBreadcrumbsAfterActivation - defines if the deep level breadcrumbs should be removed after the breadcrumb is activated

addBreadCrumb

public void addBreadCrumb(String associatedPerspective,
                          BreadcrumbPresenter breadCrumbPresenter)

addToolbar

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

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

Parameters:

associatedPerspective - perspective associated with the toolbar

toolbar - toolbar that will be added