org.olat.core.gui.control.generic.layout
Interface MainLayout3ColumnsController

All Superinterfaces:

Controller, CustomCSSProvider, Disposable, MainLayoutController

All Known Implementing Classes:

LayoutMain3ColsBackController, LayoutMain3ColsController, LayoutMain3ColsPreviewController

public interface MainLayout3ColumnsController
extends MainLayoutController

Method Summary

void	addCssClassToMain(java.lang.String cssClass) Add a css class to the #b_main wrapper div, e.g.
void	addDisposableChildController(Controller toBedisposedControllerOnDispose) Add a controller to this layout controller that should be cleaned up when this layout controller is diposed.
void	hideCol1(boolean hide) Temporarily hide the column 1 withour removing the component
void	hideCol2(boolean hide) Temporarily hide the column 2 withour removing the component
void	hideCol3(boolean hide) Temporarily hide the column 3 withour removing the component
void	removeCssClassFromMain(java.lang.String cssClass) Remove a CSS class from the #b_main wrapper div
void	setCol1(Component col1Component) Set a new component to this column or null to not use this column
void	setCol2(Component col2Component) Set a new component to this column or null to not use this column
void	setCol3(Component col3Component) Set a new component to this column or null to not use this column

Methods inherited from interface org.olat.core.gui.control.generic.layout.MainLayoutController

setCustomCSS

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.components.htmlheader.jscss.CustomCSSProvider

getCustomCSS

Method Detail

addDisposableChildController

void addDisposableChildController(Controller toBedisposedControllerOnDispose)

Add a controller to this layout controller that should be cleaned up when this layout controller is diposed. In most scenarios you should hold a reference to the content controllers that controll the col1, col2 or col3, but in rare cases this is not the case and you have no local reference to your controller. You can then use this method to add your controller. At the dispose time of the layout controller your controller will be disposed as well.

Parameters:

toBedisposedControllerOnDispose -

addCssClassToMain

void addCssClassToMain(java.lang.String cssClass)

Add a css class to the #b_main wrapper div, e.g. for special background formatting

Parameters:

cssClass -

removeCssClassFromMain

void removeCssClassFromMain(java.lang.String cssClass)

Remove a CSS class from the #b_main wrapper div

Parameters:

cssClass -

hideCol1

void hideCol1(boolean hide)

Temporarily hide the column 1 withour removing the component

Parameters:

hide - The column to hide

hideCol2

void hideCol2(boolean hide)

Temporarily hide the column 2 withour removing the component

Parameters:

hide - The column to hide

hideCol3

void hideCol3(boolean hide)

Temporarily hide the column 3 withour removing the component

Parameters:

hide - The column to hide

setCol1

void setCol1(Component col1Component)

Set a new component to this column or null to not use this column

Parameters:

col1Component -

setCol2

void setCol2(Component col2Component)

Set a new component to this column or null to not use this column

Parameters:

col2Component -

setCol3

void setCol3(Component col3Component)

Set a new component to this column or null to not use this column

Parameters:

col3Component -