View Javadoc
1   /**
2    * This file Copyright (c) 2013-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.ui.form.field.transformer.basic.NotNullInitialStringValueTransformer;
37  
38  /**
39   * Field definition for a rich code editor.
40   *
41   * @deprecated since 6.2 - use {@link info.magnolia.ui.field.CodeFieldDefinition} instead.
42   *
43   * @see <a href="https://documentation.magnolia-cms.com/display/DOCS62/Upgrading+to+Magnolia+6.2.x">Upgrading to Magnolia 6.2.x</a>
44   */
45  @Deprecated
46  public class CodeFieldDefinition extends ConfiguredFieldDefinition {
47  
48      private String language;
49      private String fileNameProperty;
50  
51      private int height = 300;
52  
53      public CodeFieldDefinition() {
54          setTransformerClass(NotNullInitialStringValueTransformer.class);
55      }
56  
57      /**
58       * Defines the programming language to use for syntax highlighting.
59       * <p>
60       * See the {@link org.vaadin.v7.aceeditor.AceMode AceMode} enum for possible values, <code>"freemarker"</code> is also supported.
61       *
62       * @see org.vaadin.v7.aceeditor.AceMode
63       */
64      public String getLanguage() {
65          return language;
66      }
67  
68      public void setLanguage(String language) {
69          this.language = language;
70      }
71  
72      /**
73       * Defines the Vaadin propertyId under which file name is exposed by the current form {@link com.vaadin.data.Item Item}.
74       */
75      public String getFileNameProperty() {
76          return fileNameProperty;
77      }
78  
79      public void setFileNameProperty(String fileNameProperty) {
80          this.fileNameProperty = fileNameProperty;
81      }
82  
83      /**
84       * Defines the height of this code field, in pixels. Default value is <code>300</code>.
85       */
86      public int getHeight() {
87          return height;
88      }
89  
90      public void setHeight(int height) {
91          this.height = height;
92      }
93  
94  }