1 /** 2 * This file Copyright (c) 2012-2018 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.form.field.definition; 35 36 import info.magnolia.annotation.deprecation.MgnlDeprecated; 37 38 import info.magnolia.i18nsystem.I18nText; 39 import info.magnolia.i18nsystem.I18nable; 40 import info.magnolia.ui.field.EditorPropertyDefinition; 41 import info.magnolia.ui.form.field.transformer.Transformer; 42 import info.magnolia.ui.form.validator.definition.FieldValidatorDefinition; 43 44 import java.util.List; 45 46 /** 47 * Defines a field within a dialog. 48 * 49 * @see FieldDefinition 50 * @see FieldValidatorDefinition 51 * 52 * @deprecated since 6.2 - use {@link info.magnolia.ui.field.FieldDefinition} instead. 53 * 54 * @see <a href="https://documentation.magnolia-cms.com/display/DOCS62/Upgrading+to+Magnolia+6.2.x">Upgrading to Magnolia 6.2.x</a> 55 */ 56 @Deprecated 57 @I18nable(keyGenerator = FieldDefinitionKeyGenerator.class) 58 @MgnlDeprecated(since = "6.2", description = "Use new framework and info.magnolia.ui.field.FieldDefinition instead.") 59 public interface FieldDefinition extends EditorPropertyDefinition { 60 61 /** 62 * Determines the name of the data property where the value entered by the user is stored. 63 */ 64 String getName(); 65 66 /** 67 * Makes the field mandatory. 68 */ 69 boolean isRequired(); 70 71 /** 72 * Error message text displayed in case of required = true. 73 */ 74 @I18nText 75 String getRequiredErrorMessage(); 76 77 /** 78 * The type of this field when stored in a JCR repository expressed as a JCR property type name. 79 * 80 * @see javax.jcr.PropertyType 81 */ 82 String getType(); 83 84 /** 85 * Message bundle for localized field labels. 86 */ 87 String getI18nBasename(); 88 89 /** 90 * Pre-filled value displayed in the field. The value can be overwritten by the user. 91 */ 92 String getDefaultValue(); 93 94 /** 95 * Determines if a Field Property can be changed. 96 */ 97 boolean isReadOnly(); 98 99 /** 100 * Define a specific Field styleName. This style definition will be added to the Field Style by calling 101 * AbstractComponent.addStyleName. 102 */ 103 String getStyleName(); 104 105 List<FieldValidatorDefinition> getValidators(); 106 107 Class<? extends Transformer<?>> getTransformerClass(); 108 109 Class<?> getConverterClass(); 110 }