org.olat.core.gui.control.generic.breadcrumb
Interface CrumbController

All Superinterfaces:

Controller, ControllerEventListener, Disposable

All Known Implementing Classes:

CrumbBasicController, CrumbFormBasicController

public interface CrumbController
extends Controller, ControllerEventListener

Method Summary

void	activateAndListenToChildCrumbController(CrumbController childCrumbController) Use this method to put another crumb on the bread crumb stack.
void	deactivateAndDisposeChildCrumbController() De-activate a child crumb that has been activated using activateAndListenToChildCrumbController().
CrumbController	getChildCrumbController()
java.lang.String	getCrumbLinkHooverText()
java.lang.String	getCrumbLinkText()
void	removeFromBreadCrumbPathAndDispose() This method can be used to de-activate the current crumb controller itself.
void	resetCrumbTexts() Force the bread crumb path to reload each label on the path
void	setBreadCrumbController(BreadCrumbController breadCrumbCtr) Set the bread crumb navigation.

Methods inherited from interface org.olat.core.gui.control.Controller

addControllerListener, dispatchEvent, dispose, getInitialComponent, getUserActivityLogger, getWindowControlForDebug, isDisposed

Methods inherited from interface org.olat.core.gui.control.ControllerEventListener

dispatchEvent

Method Detail

getCrumbLinkText

java.lang.String getCrumbLinkText()

Returns:

the translated text that should appear in the bread crumb path

getCrumbLinkHooverText

java.lang.String getCrumbLinkHooverText()

Returns:

the translated hoover text that should appear in the bread crumb path when hoovering over the link text

resetCrumbTexts

void resetCrumbTexts()

Force the bread crumb path to reload each label on the path

getChildCrumbController

CrumbController getChildCrumbController()

Returns:

The current child crumb controller

setBreadCrumbController

void setBreadCrumbController(BreadCrumbController breadCrumbCtr)

Set the bread crumb navigation.

Parameters:

breadCrumbCtr -

activateAndListenToChildCrumbController

void activateAndListenToChildCrumbController(CrumbController childCrumbController)

Use this method to put another crumb on the bread crumb stack. This will register the child crumb within the bread crumb navigation and activate it. As as side effect, it will attach the current class as listener, so you don't have to do this yourself.

Parameters:

childCrumbController -

deactivateAndDisposeChildCrumbController

void deactivateAndDisposeChildCrumbController()

De-activate a child crumb that has been activated using activateAndListenToChildCrumbController(). The method will also remove the crumb as listener from this class and dispose the crumb.

removeFromBreadCrumbPathAndDispose

void removeFromBreadCrumbPathAndDispose()

This method can be used to de-activate the current crumb controller itself. It will remove the crumb from the bread crumb navigation and execute the necessary child crumb de-activation and disposal code