MainLayout3ColumnsController.java

/**
* OLAT - Online Learning and Training<br>
* http://www.olat.org
* <p>
* Licensed under the Apache License, Version 2.0 (the "License"); <br>
* you may not use this file except in compliance with the License.<br>
* You may obtain a copy of the License at
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing,<br>
* software distributed under the License is distributed on an "AS IS" BASIS, <br>
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <br>
* See the License for the specific language governing permissions and <br>
* limitations under the License.
* <p>
* Copyright (c) since 2004 at Multimedia- & E-Learning Services (MELS),<br>
* University of Zurich, Switzerland.
* <hr>
* <a href="http://www.openolat.org">
* OpenOLAT - Online Learning and Training</a><br>
* This file has been modified by the OpenOLAT community. Changes are licensed
* under the Apache 2.0 license as the original file.
*/
package org.olat.core.gui.control.generic.layout;

import org.olat.core.gui.components.Component;
import org.olat.core.gui.control.Controller;

public interface MainLayout3ColumnsController extends MainLayoutController {

	/**
	 * 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.
	 * 
	 * @param toBedisposedControllerOnDispose
	 */
	public void addDisposableChildController(Controller toBedisposedControllerOnDispose);

	/**
	 * Add a css class to the #o_main wrapper div, e.g. for special background
	 * formatting
	 * 
	 * @param cssClass
	 */
	public void addCssClassToMain(String cssClass);

	/**
	 * Remove a CSS class from the #o_main wrapper div
	 * @param cssClass
	 */
	public void removeCssClassFromMain(String cssClass);

	/**
	 * Temporarily hide the column 1 withour removing the component
	 * @param hide The column to hide
	 */
	public void hideCol1(boolean hide);

	/**
	 * Temporarily hide the column 2 withour removing the component
	 * @param hide The column to hide
	 */
	public void hideCol2(boolean hide);

	/**
	 * Temporarily hide the column 3 withour removing the component
	 * @param hide The column to hide
	 */
	public void hideCol3(boolean hide);

	/**
	 * Set a new component to this column or null to not use this column
	 * @param col1Component
	 */
	public void setCol1(Component col1Component);

	/**
	 * Set a new component to this column or null to not use this column
	 * @param col2Component
	 */
	public void setCol2(Component col2Component);

	/**
	 * Set a new component to this column or null to not use this column
	 * @param col3Component
	 */
	public void setCol3(Component col3Component);

}