1 /**
2 * This file Copyright (c) 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.field;
35
36 import lombok.Data;
37 import lombok.EqualsAndHashCode;
38
39 /**
40 * Field definition for a rich code editor.
41 */
42 @Data
43 @EqualsAndHashCode(callSuper = true)
44 public class CodeFieldDefinition extends ConfiguredFieldDefinition<String> {
45
46 /**
47 * Defines the programming language to use for syntax highlighting.
48 * <p>
49 * See the {@link org.vaadin.aceeditor.AceMode AceMode} enum for possible values, <code>"freemarker"</code> is also supported.
50 *
51 * @see org.vaadin.aceeditor.AceMode
52 */
53 private String language;
54
55 /**
56 * Defines the Vaadin propertyId under which file name is exposed by the current form item.
57 */
58 private String fileNameProperty;
59
60 /**
61 * Defines the height of this code field, in pixels. Default value is <code>300</code>.
62 */
63 private int height = 300;
64
65 public CodeFieldDefinition() {
66 super();
67 setType(String.class);
68 }
69 }