EPCollectStepForm00.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.artefacts.collect;

import java.util.Date;
import java.util.List;

import org.olat.core.gui.UserRequest;
import org.olat.core.gui.components.form.flexible.FormItemContainer;
import org.olat.core.gui.components.form.flexible.elements.RichTextElement;
import org.olat.core.gui.components.form.flexible.elements.StaticTextElement;
import org.olat.core.gui.components.form.flexible.elements.TextElement;
import org.olat.core.gui.components.form.flexible.impl.Form;
import org.olat.core.gui.components.form.flexible.impl.FormBasicController;
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.control.generic.wizard.StepFormBasicController;
import org.olat.core.gui.control.generic.wizard.StepsEvent;
import org.olat.core.gui.control.generic.wizard.StepsRunContext;
import org.olat.core.gui.translator.Translator;
import org.olat.core.id.context.BusinessControlFactory;
import org.olat.core.id.context.ContextEntry;
import org.olat.core.util.Formatter;
import org.olat.core.util.StringHelper;
import org.olat.core.util.Util;
import org.olat.portfolio.model.artefacts.AbstractArtefact;
import org.olat.portfolio.ui.artefacts.view.EPArtefactViewController;

/**
 * Description:<br>
 * first collection step, collecting title and description of an artefact
 * 
 * <P>
 * Initial Date:  01.11.2010 <br>
 * @author Roman Haag, roman.haag@frentix.com, http://www.frentix.com
 */
public class EPCollectStepForm00 extends StepFormBasicController {

	private TextElement title;
	private RichTextElement descript;
	private AbstractArtefact artefact;
	private boolean simpleMode = false;

	public EPCollectStepForm00(UserRequest ureq, WindowControl wControl, Form rootForm, StepsRunContext runContext, int layout,
			String customLayoutPageName, AbstractArtefact artefact) {
		super(ureq, wControl, rootForm, runContext, layout, customLayoutPageName);
		// set fallback translator to re-use given strings
		Translator pt = Util.createPackageTranslator(EPArtefactViewController.class, ureq.getLocale(), getTranslator());
		flc.setTranslator(pt);
		this.artefact = artefact;
		initForm(flc, this, ureq);
	}

	// this constructor is used when editing an artefact, therefore the form doesn't show all fields!
	public EPCollectStepForm00(UserRequest ureq, WindowControl wControl, AbstractArtefact artefact) {
		super(ureq, wControl, FormBasicController.LAYOUT_VERTICAL);
		// set fallback translator to re-use given strings
		Translator pt = Util.createPackageTranslator(EPArtefactViewController.class, ureq.getLocale(), getTranslator());
		this.flc.setTranslator(pt);
		this.artefact = artefact;
		this.simpleMode = true;
		initForm(ureq);		
	}

	@Override
	protected void initForm(FormItemContainer formLayout, Controller listener, UserRequest ureq) {
		title = uifactory.addTextElement("title", "artefact.title", 500, artefact.getTitle(), formLayout);
		title.setElementCssClass("o_sel_ep_artefact_metadata_title");
		title.setMandatory(true);
		title.setNotEmptyCheck("artefact.title.not.empty");
		title.setNotLongerThanCheck(512, "artefact.title.too.long");
		title.setVisible(!simpleMode);
		descript = uifactory.addRichTextElementForStringDataMinimalistic("description", "artefact.description", artefact.getDescription(), 7,
				-1, formLayout, getWindowControl());
		descript.setMaxLength(4000);
		descript.setNotLongerThanCheck(4000, "artefact.description.too.long");

		String artSource = artefact.getSource();
		if (StringHelper.containsNonWhitespace(artSource) && !simpleMode) {
			uifactory.addStaticTextElement("artefact.source", artSource, formLayout);
		}
		Date artDate = artefact.getCreationDate();
		if (artDate == null) artDate = new Date();
		StaticTextElement date = uifactory.addStaticTextElement("artefact.date", Formatter.getInstance(getLocale()).formatDateAndTime(artDate), formLayout);
		date.setVisible(!simpleMode);

		String busPath = artefact.getBusinessPath();
		if (StringHelper.containsNonWhitespace(busPath) && !simpleMode) {
			BusinessControlFactory bCF = BusinessControlFactory.getInstance(); 
			List<ContextEntry> ceList = bCF.createCEListFromString(busPath);
			String busLink = bCF.getAsURIString(ceList, true); 
			if (StringHelper.containsNonWhitespace(busLink)){
				String finalPath = "<a href=\"" + busLink + "\">" + busLink + "</a>";
				uifactory.addStaticTextElement("artefact.link", finalPath, formLayout);
			}
		}

		if (!isUsedInStepWizzard()) {
			// add form buttons
			uifactory.addFormSubmitButton("stepform.submit", formLayout);
		}
	}

	@Override
	protected void doDispose() {
		// nothing
	}

	@Override
	protected void formOK(UserRequest ureq) {
		artefact.setTitle(title.getValue());
		artefact.setDescription(descript.getValue());

		// either save values to runContext or do persist them
		// directly, if form is used outside step-context
		if (isUsedInStepWizzard()) {
			addToRunContext("artefact", artefact);
			if (artefact.getFileSourceContainer() != null){
				addToRunContext("tempArtFolder", artefact.getFileSourceContainer());
			}
			
			fireEvent(ureq, StepsEvent.ACTIVATE_NEXT);
		} else {
			fireEvent(ureq, Event.DONE_EVENT);
		}
	}

}