PageController.java

/**
 * <a href="http://www.openolat.org">
 * OpenOLAT - Online Learning and Training</a><br>
 * <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 the
 * <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache homepage</a>
 * <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>
 * Initial code contributed and copyrighted by<br>
 * frentix GmbH, http://www.frentix.com
 * <p>
 */
package org.olat.modules.portfolio.ui.editor;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.olat.core.gui.UserRequest;
import org.olat.core.gui.components.Component;
import org.olat.core.gui.components.velocity.VelocityContainer;
import org.olat.core.gui.control.Event;
import org.olat.core.gui.control.WindowControl;
import org.olat.core.gui.control.controller.BasicController;

/**
 * 
 * Initial date: 05.07.2016<br>
 * @author srosse, stephane.rosse@frentix.com, http://www.frentix.com
 *
 */
public class PageController extends BasicController {
	
	private List<PageFragment> fragments = new ArrayList<>();
	
	private int counter;
	private final PageProvider provider;
	private final VelocityContainer mainVC;
	
	private Map<String,PageElementHandler> handlerMap = new HashMap<>();
	
	public PageController(UserRequest ureq, WindowControl wControl, PageProvider provider) {
		super(ureq, wControl);
		this.provider = provider;
		
		for(PageElementHandler handler:provider.getAvailableHandlers()) {
			handlerMap.put(handler.getType(), handler);
		}
		mainVC = createVelocityContainer("page_run");
		putInitialPanel(mainVC);
	}

	@Override
	protected void event(UserRequest ureq, Component source, Event event) {
		//
	}

	@Override
	protected void doDispose() {
		//
	}
	
	public boolean validateElements(UserRequest ureq, List<ValidationMessage> messages) {
		boolean allOk = true;
		for(PageFragment fragment:fragments) {
			if(!fragment.validate(ureq, messages)) {
				allOk &= false;
			}
		}
		return allOk;
	}
	
	public void loadElements(UserRequest ureq) {
		List<? extends PageElement> elements = provider.getElements();
		List<PageFragment> newFragments = new ArrayList<>(elements.size());
		for(PageElement element:elements) {
			PageElementHandler handler = handlerMap.get(element.getType());
			if(handler != null) {
				PageRunElement runElement = handler.getContent(ureq, getWindowControl(), element);
				String cmpId = "cpt-" + (++counter);
				newFragments.add(new PageFragment(cmpId, runElement));
				mainVC.put(cmpId, runElement.getComponent());
			}
		}
		fragments = newFragments;
		mainVC.contextPut("fragments", fragments);
	}
	
	public static final class PageFragment {
		
		private final String componentName;
		private final PageRunElement runElement;
		
		public PageFragment(String componentName, PageRunElement runElement) {
			this.componentName = componentName;
			this.runElement = runElement;
		}
		
		public String getComponentName() {
			return componentName;
		}
		
		public Component getComponent() {
			return runElement.getComponent();
		}
		
		public PageRunElement getPageRunElement() {
			return runElement;
		}
		
		public boolean validate(UserRequest ureq, List<ValidationMessage> messages) {
			return runElement.validate(ureq, messages);
		}
	}
}