EPStructureTreeAndDetailsEditController.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.portfolio.ui.structel.edit;

import java.util.List;

import org.olat.core.gui.UserRequest;
import org.olat.core.gui.components.form.flexible.FormItem;
import org.olat.core.gui.components.form.flexible.FormItemContainer;
import org.olat.core.gui.components.form.flexible.elements.SingleSelection;
import org.olat.core.gui.components.form.flexible.impl.FormBasicController;
import org.olat.core.gui.components.form.flexible.impl.FormEvent;
import org.olat.core.gui.control.Controller;
import org.olat.core.gui.control.Event;
import org.olat.core.gui.control.WindowControl;
import org.olat.core.gui.translator.Translator;
import org.olat.core.util.StringHelper;
import org.olat.core.util.Util;
import org.olat.portfolio.EPSecurityCallback;
import org.olat.portfolio.PortfolioModule;
import org.olat.portfolio.manager.EPFrontendManager;
import org.olat.portfolio.model.structel.EPStructureElement;
import org.olat.portfolio.model.structel.EPStructuredMapTemplate;
import org.olat.portfolio.model.structel.PortfolioStructure;
import org.olat.portfolio.model.structel.PortfolioStructureMap;
import org.olat.portfolio.ui.structel.EPArtefactClicked;
import org.olat.portfolio.ui.structel.EPMapViewController;
import org.olat.portfolio.ui.structel.EPStructureChangeEvent;
import org.olat.portfolio.ui.structel.EPStructureEvent;
import org.springframework.beans.factory.annotation.Autowired;

/**
 * Description:<br>
 * parent controller for toc- and structure-editing
 * 
 * <P>
 * Initial Date:  07.10.2010 <br>
 * @author Roman Haag, roman.haag@frentix.com, http://www.frentix.com
 */
public class EPStructureTreeAndDetailsEditController extends FormBasicController {

	@Autowired
	private EPFrontendManager ePFMgr;
	@Autowired
	private PortfolioModule portfolioModule;
	private PortfolioStructureMap rootStructure;
	private PortfolioStructure selectedStructure;
	private final EPSecurityCallback secCallback;
	
	private EPTOCController tocCtrl;
	private EPStructureDetailsController editCtrl;
	private SingleSelection mapStyle;


	public EPStructureTreeAndDetailsEditController(UserRequest ureq, WindowControl wControl, PortfolioStructure selectedStructure,
			PortfolioStructureMap rootStructure, EPSecurityCallback secCallback) {
		super(ureq, wControl, "editor");
		this.secCallback = secCallback;
		this.rootStructure = rootStructure;
		this.selectedStructure = selectedStructure;
		
		Translator pt = Util.createPackageTranslator(EPMapViewController.class, ureq.getLocale(), getTranslator());
		setTranslator(pt);

		initForm(ureq);
		selectedStructure = null;//consume it
	}
	
	public PortfolioStructure getSelectedStructure() {
		return selectedStructure;
	}

	@Override
	protected void initForm(FormItemContainer formLayout, Controller listener, UserRequest ureq) {
		List<String> allStyles = portfolioModule.getAvailableMapStyles();
		int amount = allStyles.size();
		String[] theKeys = new String[amount];
		String[] theValues = new String[amount];
		String[] theCssClasses = new String[amount];
		int i=0;
		if (amount > 1){ // if no themes than default configured, no selection at all
			for (String style : allStyles) {
				theKeys[i] = style;
				theValues[i] = translate("map.style." + style);
				theCssClasses[i] = style + "_icon";
				i++;
			}		
			mapStyle = uifactory.addDropdownSingleselect("map.style", formLayout, theKeys, theValues, theCssClasses);
			mapStyle.addActionListener(FormEvent.ONCHANGE);
			String givenStyle = ((EPStructureElement)rootStructure).getStyle();
			if (StringHelper.containsNonWhitespace(givenStyle)){
				mapStyle.select(givenStyle, true);
				mapStyle.setUserObject(givenStyle);
			}
		}
		
		flc.contextPut("template-help", new Boolean(rootStructure instanceof EPStructuredMapTemplate));
		
		initOrUpdateToc(ureq);
		initOrUpdateDetailsEditor(ureq);
	}
	
	/**
	 * @see org.olat.core.gui.components.form.flexible.impl.FormBasicController#formInnerEvent(org.olat.core.gui.UserRequest, org.olat.core.gui.components.form.flexible.FormItem, org.olat.core.gui.components.form.flexible.impl.FormEvent)
	 */
	@Override
	protected void formInnerEvent(UserRequest ureq, FormItem source, FormEvent event) {
		if (source == mapStyle){
			if (!mapStyle.getSelectedKey().equals(mapStyle.getUserObject())){
				String newStyle = mapStyle.getSelectedKey();
				rootStructure = (PortfolioStructureMap)ePFMgr.reloadPortfolioStructure(rootStructure);
				((EPStructureElement)rootStructure).setStyle(newStyle);
				ePFMgr.savePortfolioStructure(rootStructure);
				fireEvent(ureq, Event.CHANGED_EVENT);
			}
		}
	}

	private void initOrUpdateToc(UserRequest ureq) {
		removeAsListenerAndDispose(tocCtrl);
		// with new links (pages, sub-elements or artefacts) to map, map gets a new version, therefore needs a refresh!
		rootStructure = (PortfolioStructureMap)ePFMgr.reloadPortfolioStructure(rootStructure);
		tocCtrl = new EPTOCController(ureq, getWindowControl(), selectedStructure, rootStructure, secCallback);
		listenTo(tocCtrl);
		flc.put("tocCtrl", tocCtrl.getInitialComponent());
	}
	
	private void initOrUpdateDetailsEditor(UserRequest ureq) {	
		removeAsListenerAndDispose(editCtrl);
		editCtrl = new EPStructureDetailsController(ureq, getWindowControl(), mainForm, rootStructure);
		if(selectedStructure != null) {
			editCtrl.setNewStructure(ureq, selectedStructure);
		}
		listenTo(editCtrl);
		flc.add("editCtrl", editCtrl.getInitialFormItem());
	}
	
	/**
	 * @see org.olat.core.gui.control.DefaultController#doDispose()
	 */
	@Override
	protected void doDispose() {
		// nothing to dispose
	}

	@Override
	public FormItem getInitialFormItem() {
		return flc;
	}
	
	@Override
	protected void formOK(UserRequest ureq) {
		//
	}

	/**
	 * @see org.olat.core.gui.control.DefaultController#event(org.olat.core.gui.UserRequest, org.olat.core.gui.control.Controller, org.olat.core.gui.control.Event)
	 */
	@Override
	protected void event(UserRequest ureq, Controller source, Event event) {
		super.event(ureq, source, event);
		if (source == tocCtrl){
			if (event.getCommand().equals(EPTOCController.ARTEFACT_NODE_CLICKED)) {
				editCtrl.setNoStructure();
				if(event instanceof EPArtefactClicked) {
					selectedStructure = ((EPArtefactClicked)event).getStructure();
				}
			} else if (event instanceof EPStructureChangeEvent && event.getCommand().equals(EPStructureChangeEvent.SELECTED)){
				EPStructureChangeEvent selEv = (EPStructureChangeEvent) event;
				selectedStructure = selEv.getPortfolioStructure();
				if (selectedStructure != null) {
					editCtrl.setNewStructure(ureq, selectedStructure);
				}
			}	else if (event instanceof EPMoveEvent) {
				tocCtrl.refreshTree(rootStructure); 
			} else if (event instanceof EPStructureChangeEvent && event.getCommand().equals(EPStructureChangeEvent.ADDED)) {
				// always reload to be on the save side!
				selectedStructure = ePFMgr.reloadPortfolioStructure(((EPStructureChangeEvent)event).getPortfolioStructure());
				initOrUpdateToc(ureq);
				initOrUpdateDetailsEditor(ureq);				
			}	else if (event.equals(Event.CHANGED_EVENT)){
				// something got deleted
				initOrUpdateToc(ureq);
				// renew details controller
				selectedStructure = null;
				initOrUpdateDetailsEditor(ureq);				
				editCtrl.setNoStructure();
				// refresh map on deletion:
				fireEvent(ureq, Event.CHANGED_EVENT);
			}
		} else if (source == editCtrl && event instanceof EPStructureEvent){
			EPStructureEvent structureEvent = (EPStructureEvent)event;
			if(EPStructureEvent.CHANGE.equals(structureEvent.getCommand())) {
				PortfolioStructure structure = structureEvent.getStructure();
				if(rootStructure.equals(structure)) {
					rootStructure = (PortfolioStructureMap)ePFMgr.reloadPortfolioStructure(rootStructure);
				}
				// refresh the tree on changes!
				tocCtrl.update(ureq, structure);
			}
			fireEvent(ureq, structureEvent);
		}
	}
}