1 /** 2 * This file Copyright (c) 2012-2013 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.ui.form.validator.definition.FieldValidatorDefinition; 37 38 import java.util.List; 39 40 /** 41 * Defines a field within a dialog. 42 * 43 * @see FieldDefinition 44 * @see FieldValidatorDefinition 45 */ 46 public interface FieldDefinition { 47 48 /** 49 * Determines the name of the data property where the value entered by the user is stored. 50 */ 51 String getName(); 52 53 /** 54 * Makes the field mandatory. 55 */ 56 boolean isRequired(); 57 58 /** 59 * Error message text displayed in case of required = true. 60 */ 61 String getRequiredErrorMessage(); 62 63 /** 64 * The type of this field when stored in a JCR repository expressed as a JCR property type name. 65 * 66 * @see javax.jcr.PropertyType 67 */ 68 String getType(); 69 70 /** 71 * Text displayed as field label. 72 */ 73 String getLabel(); 74 75 /** 76 * Message bundle for localized field labels. 77 */ 78 String getI18nBasename(); 79 80 /** 81 * Description displayed to the user when clicking on the Info Button. 82 */ 83 String getDescription(); 84 85 /** 86 * Pre-filled value displayed in the field. The value can be overwritten by the user. 87 */ 88 String getDefaultValue(); 89 90 /** 91 * Determines if a Field Property can be changed. 92 */ 93 boolean isReadOnly(); 94 95 /** 96 * Enables i18n authoring support. 97 * This allows authors to write foreign language or regionally targeted content. 98 * A two-letter language identifier (en, ge, fr etc.) is displayed on controls 99 * where i18n is set to true. 100 */ 101 boolean isI18n(); 102 103 /** 104 * Define a specific Field styleName. This style definition will be added to the Field Style by calling 105 * AbstractComponent.addStyleName. 106 */ 107 String getStyleName(); 108 109 List<FieldValidatorDefinition> getValidators(); 110 111 }