org.olat.core.gui.control.generic.breadcrumb
Class BreadCrumbController

java.lang.Object
  org.olat.core.gui.control.DefaultController
      org.olat.core.gui.control.controller.BasicController
          org.olat.core.gui.control.generic.breadcrumb.BreadCrumbController

All Implemented Interfaces:

Controller, ControllerEventListener, Disposable

public class BreadCrumbController
extends BasicController

Description:

The BreadCrumbController implements a simple bred crumb navigation. This type of navigation is useful when users can launch loosely coupled work-flows that don't span up in a new tab and that are not modal.

Don't use it to implement wizard like work-flows. Use the StepsController for this, the StepsController offers a modal wizard infrastructure.

When a controller in the bread crumb path is re-activated by the user, the child crumb controller of the activated crumb is disposed.

Initial Date: 08.09.2008

Author:

Florian Gnaegi, frentix GmbH, http://www.frentix.com

Field Summary

static Event

CRUMB_VIEW_ACTIVATED

Constructor Summary

BreadCrumbController(UserRequest ureq, WindowControl control)
Constructor to create a bread crumb navigation controller.

Method Summary

void	activateFirstCrumbController(CrumbController firstCrumbController) Add the first crumb controller to the crumb stack.
void	resetCrumbTexts() Reset all texts on the crumb path

Methods inherited from class org.olat.core.gui.control.DefaultController

addControllerListener, addLoggingResourceable, dispatchEvent, dispatchEvent, dispose, getControllerCount, getInitialComponent, getUserActivityLogger, getWindowControlForDebug, isDisposed, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CRUMB_VIEW_ACTIVATED

public static final Event CRUMB_VIEW_ACTIVATED

Constructor Detail

BreadCrumbController

public BreadCrumbController(UserRequest ureq,
                            WindowControl control)

Constructor to create a bread crumb navigation controller. Use the activateFirstCrumbController() method to add the first crumb controller to the crumb stack

Parameters:

ureq -

control -

Method Detail

activateFirstCrumbController

public void activateFirstCrumbController(CrumbController firstCrumbController)

Add the first crumb controller to the crumb stack. To add followup crumbs to the stack you must use the crumbController.activateAndListenToChildCrumbController() method

Parameters:

firstCrumbController - The crumb controller that serves as the home crumb

resetCrumbTexts

public void resetCrumbTexts()

Reset all texts on the crumb path