DateChooserController.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.core.commons.services.notifications.ui;

import java.util.Date;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import org.olat.NewControllerFactory;
import org.olat.core.commons.services.notifications.Subscriber;
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.DateChooser;
import org.olat.core.gui.components.form.flexible.elements.FormLink;
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.util.StringHelper;


/**
 * Description:<br>
 * This controller provides a simple date chooser
 * <p>
 * Events fired by this controller:
 * <ul>
 * <li>Event.CHANGED_EVENT whenever the date has been changed</li>
 * </ul>
 * <P>
 * Initial Date: 22.12.2009 <br>
 * 
 * @author gnaegi
 */
 
public class DateChooserController extends FormBasicController {
	private DateChooser dateChooser;
	private Date initDate;
	private FormLink link;
	
	private SingleSelection typeSelection;
	private String[] typeKeys;
	private String[] typeValues;

	public DateChooserController(UserRequest ureq, WindowControl wControl, Date initDate) {
		super(ureq, wControl);
		this.initDate = initDate;
		
		typeKeys = new String[]{"all"};
		typeValues = new String[]{translate("news.type.all")};
		
		initForm(ureq);
	}

	/**
	 * @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) {
		dateChooser = uifactory.addDateChooser("news.since", null, formLayout);
		//FIXME: Can't use time format for now, only date format due to bug OLAT-4736
		// dateChooser.setDateChooserTimeEnabled(true);
		dateChooser.setDate(initDate);
		dateChooser.addActionListener(FormEvent.ONCHANGE);
		
		typeSelection = uifactory.addDropdownSingleselect("news.type", "news.type", formLayout, typeKeys, typeValues, null);
		typeSelection.addActionListener(FormEvent.ONCHANGE);
		typeSelection.select("all", true);
		
		//link = uifactory.addFormLink("news.since.link", formLayout);
	}
	
	/**
	 * @see org.olat.core.gui.components.form.flexible.impl.FormBasicController#formOK(org.olat.core.gui.UserRequest)
	 */
	@Override
	protected void formOK(UserRequest ureq) {
		// nothing to do here
	}

	@Override
	protected boolean validateFormLogic(UserRequest ureq) {
		boolean isInputValid = true;
		if (dateChooser.hasError() || dateChooser.getDate() == null) {
			dateChooser.setErrorKey("error.date", new String[0]);
			return false;
		}
		return isInputValid;			
	}

	/**
	 * @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 == link && !dateChooser.hasError()) {
			flc.getRootForm().submit(ureq);
			fireEvent(ureq, Event.CHANGED_EVENT);
		} else if (source == dateChooser && !dateChooser.hasError()) {
			fireEvent(ureq, Event.CHANGED_EVENT);
		} else if (source == typeSelection) {
			fireEvent(ureq, Event.CHANGED_EVENT);
		}
	}
	
	/**
	 * Get the date that has been chosen 
	 * @return
	 */
	public Date getChoosenDate() {
		return dateChooser.getDate();
	}
	
	public void setDate(Date date) {
		dateChooser.setDate(date);
	}
	
	public String getType() {
		if(typeSelection.isSelected(0) || !typeSelection.isOneSelected()) {
			return null;
		}
		return typeSelection.getSelectedKey();
	}
	
	public void setType(String type) {
		if(StringHelper.containsNonWhitespace(type)) {
			for(String typeKey:typeKeys) {
				if(type.equals(typeKey)) {
					typeSelection.select(type, true);
					break;
				}
			}
		} else {
			typeSelection.select("all", true);
		}
	}
	
	public void setSubscribers(List<Subscriber> subscribers) {
		String selectedKey = typeSelection.isOneSelected() ? typeSelection.getSelectedKey() : null;
		
		Set<String> types = new HashSet<String>();
		for(Subscriber subscriber:subscribers) {
			String type = subscriber.getPublisher().getType();
			types.add(type);
		}
		
		typeKeys = new String[types.size() + 1];
		typeValues = new String[types.size() + 1];
		
		typeKeys[0] = "all";
		typeValues[0] = translate("news.type.all");
		
		int count = 1;
		for(String type:types) {
			String typeName = NewControllerFactory.translateResourceableTypeName(type, getLocale());
			typeKeys[count] = type;
			typeValues[count++] = typeName;
		}
		
		typeSelection.setKeysAndValues(typeKeys, typeValues, null);
		
		if(selectedKey != null) {
			//select the current key but check if it still exists
			for(String typeKey:typeKeys) {
				if(typeKey.equals(selectedKey)) {
					typeSelection.select(selectedKey, true);
					break;
				}
			}
		}
		
		if(!typeSelection.isOneSelected()) {
			typeSelection.select("all", true);
		}
	}

	/**
	 * @see org.olat.core.gui.control.DefaultController#doDispose()
	 */
	@Override
	protected void doDispose() {
		// nothing to dispose
	}

}