/**
* 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) 2009 frentix GmbH<br>
* http://www.frentix.com<br>
* <p>
*/
package org.olat.course.editor;
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.RichTextElement;
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.components.form.flexible.impl.FormLayoutContainer;
import org.olat.core.gui.control.Controller;
import org.olat.core.gui.control.Event;
import org.olat.core.gui.control.WindowControl;
/**
* Provides a controller using FlexiForms which allows entering a text which
* gets displayed as an explanation when the user has no permission to access a
* ressource.
*
* @author twuersch
*
*/
public class NoAccessExplanationFormController extends FormBasicController {
/**
* The text input form.
*/
private RichTextElement noAccessExplanationInput;
/**
* Remembers whether the constructor was used to initialize the form.
*/
private boolean constructorInitCall;
/**
* The message.
*/
private String noAccessString;
/**
* Initializes this controller.
*
* @param ureq The user request.
* @param wControl The window control.
* @param noAccessString
*/
public NoAccessExplanationFormController(UserRequest ureq, WindowControl wControl, String noAccessString) {
super(ureq, wControl, FormBasicController.LAYOUT_DEFAULT);
this.noAccessString = noAccessString;
constructorInitCall = true;
initForm(ureq);
}
/**
* @see org.olat.core.gui.components.form.flexible.impl.FormBasicController#doDispose()
*/
@Override
protected void doDispose() {
// Don't dispose anything
}
/**
* @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) {
super.formInnerEvent(ureq, source, event);
}
/**
* @see org.olat.core.gui.components.form.flexible.impl.FormBasicController#formOK(org.olat.core.gui.UserRequest)
*/
@Override
protected void formOK(UserRequest ureq) {
fireEvent(ureq, Event.DONE_EVENT);
}
/**
* @see org.olat.core.gui.components.form.flexible.impl.FormBasicController#formNOK(org.olat.core.gui.UserRequest)
*/
@Override
protected void formNOK(UserRequest ureq) {
fireEvent(ureq, Event.FAILED_EVENT);
}
/**
* @see org.olat.core.gui.components.form.flexible.impl.FormBasicController#initForm(org.olat.core.gui.components.form.flexible.FormItemContainer,
* org.olat.core.gui.control.Controller, org.olat.core.gui.UserRequest)
*/
@Override
protected void initForm(FormItemContainer formLayout, Controller listener, UserRequest ureq) {
// Add the rich text element
noAccessExplanationInput = uifactory.addRichTextElementForStringDataMinimalistic("form.noAccessExplanation", "form.noAccessExplanation",
(noAccessString == null ? "" : noAccessString), 10, -1, false, formLayout, ureq.getUserSession(), getWindowControl());
if (constructorInitCall) {
// Create submit button
final FormLayoutContainer buttonLayout = FormLayoutContainer.createButtonLayout("buttonLayout", getTranslator());
formLayout.add(buttonLayout);
uifactory.addFormSubmitButton("save", buttonLayout);
constructorInitCall = false;
}
}
/**
* Gets the message string for the no access explanation.
*
* @return String The noAccessExplenation
*/
public String getNoAccessExplanation() {
if (noAccessExplanationInput != null) return noAccessExplanationInput.getValue();
else return null;
}
/**
* Gets the message string for the no access explanation.
*
* @param message The message
*/
public void setNoAccessExplanation(String message) {
if (noAccessExplanationInput != null) {
noAccessExplanationInput.setValue(message);
}
}
/**
* @see org.olat.core.gui.components.form.flexible.impl.FormBasicController#validateFormLogic(org.olat.core.gui.UserRequest)
*/
@Override
protected boolean validateFormLogic(UserRequest ureq) {
boolean formOK = true;
if (noAccessExplanationInput.getValue().length() > 4000) {
formOK = false;
noAccessExplanationInput.setErrorKey("input.toolong", new String[] {});
}
if (formOK && super.validateFormLogic(ureq)) {
noAccessExplanationInput.clearError();
return true;
} else {
return false;
}
}
}