1 /** 2 * This file Copyright (c) 2019 Magnolia International 3 * Ltd. (http://www.magnolia-cms.com). All rights reserved. 4 * 5 * 6 * This file is dual-licensed under both the Magnolia 7 * Network Agreement and the GNU General Public License. 8 * You may elect to use one or the other of these licenses. 9 * 10 * This file is distributed in the hope that it will be 11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the 12 * implied warranty of MERCHANTABILITY or FITNESS FOR A 13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT. 14 * Redistribution, except as permitted by whichever of the GPL 15 * or MNA you select, is prohibited. 16 * 17 * 1. For the GPL license (GPL), you can redistribute and/or 18 * modify this file under the terms of the GNU General 19 * Public License, Version 3, as published by the Free Software 20 * Foundation. You should have received a copy of the GNU 21 * General Public License, Version 3 along with this program; 22 * if not, write to the Free Software Foundation, Inc., 51 23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 24 * 25 * 2. For the Magnolia Network Agreement (MNA), this file 26 * and the accompanying materials are made available under the 27 * terms of the MNA which accompanies this distribution, and 28 * is available at http://www.magnolia-cms.com/mna.html 29 * 30 * Any modifications to this file must keep this entire header 31 * intact. 32 * 33 */ 34 package info.magnolia.ui.field; 35 36 import info.magnolia.ui.datasource.optionlist.Option; 37 38 import com.vaadin.data.Converter; 39 import com.vaadin.data.provider.DataProvider; 40 import com.vaadin.ui.IconGenerator; 41 import com.vaadin.ui.ItemCaptionGenerator; 42 43 /** 44 * Datasource component which provides pluggable delegates required by typical 45 * Vaadin select components. 46 */ 47 public interface SelectFieldSupport<T> { 48 49 DataProvider<T, ?> getDataProvider(); 50 51 ItemCaptionGenerator<T> getItemCaptionGenerator(); 52 53 IconGenerator<T> getIconGenerator(); 54 55 /** 56 * Default converter which is used to convert value from datasource into String representation. 57 * e.g. From Node to identifier in case of {@link info.magnolia.ui.datasource.jcr.JcrDatasourceDefinition} 58 * or from Option to {@link Option#getValue()} in case of {@link info.magnolia.ui.datasource.optionlist.OptionListDefinition} 59 * 60 * If {@link FieldDefinition#getConverterClass()} is set then defaultConverter is ignored - e.g. for case when 61 * field model {@link FieldDefinition#getType()} is not String type. 62 */ 63 Converter<T, String> defaultConverter(); 64 }