FormLayouter.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.  
* <p>
*/
package org.olat.core.gui.components.form.flexible;

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

/**
 * Description:<br>
 * TODO: patrickb Class Description for FormLayouter
 * 
 * <P>
 * Initial Date:  31.01.2007 <br>
 * @author patrickb
 */
public interface FormLayouter {
	/**
	 * add a component named <code>name</code> to the form layout
	 * @param name
	 * @param component
	 */
	public void put(String name, Component component);
	
	/**
	 * removes a component from the container.
	 * @param component
	 */
	public void remove(Component component);
	
	/**
	 * @param name
	 * @return component named <code>name</code>
	 */
	public Component getComponent(String name);
	
	/**
	 * add a variable which can be accessed within the form layout
	 * @param name
	 * @param component
	 */
	public void contextPut(String key, Object value);
	
	/**
	 * the layouter as component for the component tree
	 * @return
	 */
	public Component getComponent();
	
	/**
	 * mark formlayouter as dirty, e.g. gets rendered in next render process
	 * @param dirty
	 */
	public void setDirty(boolean dirty);
}