org.olat.modules.cp
Class CPDisplayController

java.lang.Object
  org.olat.core.gui.control.DefaultController
      org.olat.core.gui.control.controller.BasicController
          org.olat.modules.cp.CPDisplayController

All Implemented Interfaces:

Controller, ControllerEventListener, Disposable

public class CPDisplayController
extends BasicController

Description:
shows the actual content package with or without a menu

Author:

Felix Jost

Method Summary

void	event(UserRequest ureq, Component source, Event event) abstract event method for subclasses.
void	externalNodeClicked(UserRequest ureq, TreeEvent te) Deprecated. @TODO To be deleted - does logging and would have to go via an event() method
java.lang.String	getInitialSelectedNodeId() to use with the option "external menu" only
java.lang.String	getNodeByUri(java.lang.String uri)
CPManifestTreeModel	getTreeModel()
void	selectTreeNode(UserRequest ureq, java.lang.String newUri) adjust the cp menu tree with the page selected with a link clicked in the content
void	switchToPage(UserRequest ureq, TreeEvent te)

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

Method Detail

event

public void event(UserRequest ureq,
                  Component source,
                  Event event)

Description copied from class: DefaultController

abstract event method for subclasses. the event received from the component we are listening to are always rerouted to this method here, except when the component has been disposed, in which case the events are simply ignored.

See Also:

DefaultController.event(org.olat.core.gui.UserRequest, org.olat.core.gui.components.Component, org.olat.core.gui.control.Event)

selectTreeNode

public void selectTreeNode(UserRequest ureq,
                           java.lang.String newUri)

adjust the cp menu tree with the page selected with a link clicked in the content

Parameters:

ureq -

newUri -

switchToPage

public void switchToPage(UserRequest ureq,
                         TreeEvent te)

Parameters:

ureq -

te -

getTreeModel

public CPManifestTreeModel getTreeModel()

Returns:

the treemodel. (for read-only usage) Useful if you would like to integrate the menu at some other place

externalNodeClicked

public void externalNodeClicked(UserRequest ureq,
                                TreeEvent te)

Deprecated. @TODO To be deleted - does logging and would have to go via an event() method

Parameters:

ureq -

te -

getInitialSelectedNodeId

public java.lang.String getInitialSelectedNodeId()

to use with the option "external menu" only

Returns:

getNodeByUri

public java.lang.String getNodeByUri(java.lang.String uri)