de.iwes.widgets.resource.widget.dropdown.ValueResourceDropdown Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of widget-extended Show documentation
The newest version!
/**
 * Copyright 2014-2018 Fraunhofer-Gesellschaft zur Förderung der angewandten Wissenschaften e.V.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package de.iwes.widgets.resource.widget.dropdown;

import java.util.ArrayList;
import java.util.List;
import java.util.Locale;

import org.ogema.core.model.simple.IntegerResource;
import org.ogema.core.model.simple.SingleValueResource;
import org.ogema.core.model.simple.StringResource;
import org.ogema.tools.resource.util.ValueResourceUtils;

import de.iwes.widgets.api.widgets.OgemaWidget;
import de.iwes.widgets.api.widgets.WidgetPage;
import de.iwes.widgets.api.widgets.sessionmanagement.OgemaHttpRequest;
import de.iwes.widgets.html.form.dropdown.Dropdown;
import de.iwes.widgets.html.form.dropdown.DropdownData;
import de.iwes.widgets.html.form.dropdown.TemplateDropdown;

/**
 * A {@link Dropdown} that is used to display the value of a {@link SingleValueResource}, such as a 
 * {@link StringResource} or a {@link IntegerResource}, and allows to edit it.

 * 
 * Note: Only predefined values (the so-called displayValues) are offered by the dropdown
 * and only these values can be selected. IntegerResources in the standard case are
 * expected to provide the index within the displayValues list (starting at index zero).
 * This can be changed via {@link #setDefaultIntegerValuesToUse(List)}
 * 
 * @param 
 */
public class ValueResourceDropdown extends TemplateDropdown {

	private static final long serialVersionUID = 1L;
	private V defaultResource = null;
	protected List defaultDisplayedValues = null;
	protected List defaultValuesToSet = null;
	public static List naList = new ArrayList<>();
	static {
		naList.add("n/a");
	}

	public ValueResourceDropdown(WidgetPage page, String id) {
		this(page, id, null, null);
	}
	
	public ValueResourceDropdown(WidgetPage page, String id, V valueResource,
			List displayedValues) {
		super(page, id);
		this.defaultResource = valueResource;
		this.defaultDisplayedValues = displayedValues;
	}
	
	public ValueResourceDropdown(OgemaWidget parent, String id, OgemaHttpRequest req) {
		super(parent, id, req);
	}

	public ValueResourceDropdown(OgemaWidget parent, String id, V valueResource,
			List displayedValues, OgemaHttpRequest req) {
		super(parent, id, req);
		selectDefaultItem(valueResource);
		setDefaultDisplayedValues(displayedValues);
	}
	
	@Override
	public ValueResourceDropdownData createNewSession() {
		return new ValueResourceDropdownData<>(this, defaultResource, defaultDisplayedValues);
	}
	
	protected void setDefaultValues(DropdownData opt) {
		super.setDefaultValues(opt);
		@SuppressWarnings("unchecked")
		ValueResourceDropdownData opt2 = (ValueResourceDropdownData) opt;
		opt2.setSelectedResource(defaultResource);
	}

	public void selectDefaultItem(V resource) {
		this.defaultResource = resource;
	}
	@SuppressWarnings("unchecked")
	public void selectItem(V resource, OgemaHttpRequest req) {
		((ValueResourceDropdownData)getData(req)).setSelectedResource(resource);
	}
	@SuppressWarnings("unchecked")
	public V getSelectedResource(OgemaHttpRequest req) {
		return ((ValueResourceDropdownData)getData(req)).getSelectedResource();
	}
	public void setDefaultDisplayedValues(List displayedValues) {
		this.defaultDisplayedValues = displayedValues;
	}
	@SuppressWarnings("unchecked")
	public void setDisplayedValues(List displayedValues, OgemaHttpRequest req) {
		((ValueResourceDropdownData)getData(req)).setDisplayedValues(displayedValues);
	}
	
	/** Only relevant if the dropdown is typed for IntegerResource
	 * In this case not the index of the selected displayed value is used when a
	 * value is written, but the respective indexed value of defaultValuesToSet. So
	 * the size of defaultValuesToSet must be the same as the size of displayedValues.
	 * */
	public void setDefaultIntegerValuesToUse(List defaultValuesToSet) {
		this.defaultValuesToSet = defaultValuesToSet;
	}

	/** override this if required*/
	public String getSelection(V resource, Locale locale, List displayedValues) {
		if (resource instanceof IntegerResource)  {
			int val = ((IntegerResource)resource).getValue();
			if(defaultValuesToSet != null) {
				boolean found = false;
				for(int index=1; index val) {
						val = index-1;
						found = true;
						break;
					}
				}
				if(!found)
					val = displayedValues.size()-1;
			}
			if(val <= 0) {
				return displayedValues.get(0);
			} else if(val >= displayedValues.size()) {
				return displayedValues.get(displayedValues.size()-1);
			} else {
				return displayedValues.get(val);
			}
		}
		else
			return ValueResourceUtils.getValue(resource);	
	}

	/** override this if required*/
	protected void setResourceValue(V resource, String value, List displayedValues) {
		//if(!(resource instanceof StringResource)) {
		//	value = value.replaceAll("[^\\d.,-]", "");
		//}
		// may throw different kinds of exceptions
		int i = 0;
		if (resource instanceof IntegerResource)  {
			for(String s: displayedValues) {
				if(s.equals(value)) {
					if(defaultValuesToSet != null)
						((IntegerResource) resource).setValue(defaultValuesToSet.get(i));					
					else
						((IntegerResource) resource).setValue(i);					
				}
				i++;
			}
		}
		else
			ValueResourceUtils.setValue(resource, value);		
	}
}