1 /**
2 * This file Copyright (c) 2013-2015 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.factory;
35
36
37 import info.magnolia.context.MgnlContext;
38 import info.magnolia.ui.form.field.definition.BasicTextCodeFieldDefinition;
39
40 import org.slf4j.Logger;
41 import org.slf4j.LoggerFactory;
42 import org.vaadin.aceeditor.AceEditor;
43
44 import com.vaadin.data.Item;
45 import com.vaadin.event.FieldEvents.TextChangeEvent;
46 import com.vaadin.event.FieldEvents.TextChangeListener;
47 import com.vaadin.ui.Field;
48
49 /**
50 * Creates and initializes an Text code field definition.
51 *
52 * @param <D> type of definition
53 */
54 public class BasicTextCodeFieldFactory<D extends BasicTextCodeFieldDefinition> extends AbstractFieldFactory<D, String> {
55
56 private static final Logger log = LoggerFactory.getLogger(BasicTextCodeFieldFactory.class);
57
58 public static final String FREEMARKER_LANGUAGE = "freemarker";
59
60 public static final String ACE_EDITOR_FTL_ID = "ftl";
61
62 public static final String ACE_EDITOR_RESOURCES = "/.resources/ace/";
63
64 private AceEditor field;
65
66 public BasicTextCodeFieldFactory(D definition, Item relatedFieldItem) {
67 super(definition, relatedFieldItem);
68 }
69
70 @Override
71 protected Field<String> createFieldComponent() {
72 field = newAceEditor();
73 // Add a TextChange Listener. This is needed as the current AceEditor implementation do not update the
74 // linked datasource in case of text change.
75 field.addTextChangeListener(createTextChangeListener(field));
76 // Set style
77 field.setStyleName("textcodefield");
78 field.setUseWorker(false);
79
80 return field;
81 }
82
83 /**
84 * @return newly constructed {@link AceEditor}.
85 */
86 protected AceEditor newAceEditor() {
87 final AceEditor aceEditor = new AceEditor();
88 if (MgnlContext.isWebContext()) {
89 String aceEditorResourcePath = MgnlContext.getContextPath() + ACE_EDITOR_RESOURCES;
90 aceEditor.setModePath(aceEditorResourcePath);
91 aceEditor.setWorkerPath(aceEditorResourcePath);
92 aceEditor.setThemePath(aceEditorResourcePath);
93 }
94 aceEditor.setMode(getModeType(definition.getLanguage()));
95 return aceEditor;
96 }
97
98 /**
99 * Set {@link AceEditor} mode.
100 */
101 protected void setAceEditorMode() {
102 field.setMode(getModeType(definition.getLanguage()));
103 }
104
105 /**
106 * @return current {@link AceEditor} field.
107 */
108 protected AceEditor getField() {
109 return field;
110 }
111
112 /**
113 * Create a {@link TextChangeListener} in order to populate the typed text in the
114 * related property datasource.
115 */
116 private TextChangeListener createTextChangeListener(final AceEditor field) {
117 return new TextChangeListener() {
118
119 @SuppressWarnings("unchecked")
120 @Override
121 public void textChange(TextChangeEvent event) {
122 field.getPropertyDataSource().setValue(event.getText());
123 }
124 };
125 }
126
127 /**
128 * Get Ace-editor compliant mode type name for a language.
129 *
130 * TODO: currently only 'freemarker' -> 'ftl' case is handled, otherwise the method returns the string from definition.
131 * If needed we could craft our own mapping from human-readable language names into the Ace editor mode identifiers.
132 */
133 private String getModeType(String language) {
134 return FREEMARKER_LANGUAGE.equals(language) ? ACE_EDITOR_FTL_ID : language;
135 }
136
137 }