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.vaadin.richtext;
35
36 import info.magnolia.ui.vaadin.ckeditor.MagnoliaCKEditorConfig.ToolbarGroup;
37
38 import java.util.ArrayList;
39 import java.util.HashMap;
40 import java.util.List;
41 import java.util.Map;
42
43 import org.vaadin.openesignforms.ckeditor.CKEditorConfig;
44
45 import com.google.gson.Gson;
46
47 /**
48 * Magnolia5 / Vaadin7 compatibility class. Extends CKEditorConfig by defining more
49 * coherent toolbar API and configuring custom plugins.
50 */
51 public class MagnoliaRichTextFieldConfig extends CKEditorConfig {
52 private List<String> events = new ArrayList<>();
53
54 private Map<String, String> externalPlugins = new HashMap<>();
55
56 /**
57 * Adds list of toolbar groups. Groups are placed in one
58 * row if space allows.
59 */
60 public void addToolbarLine(List<ToolbarGroup> toolbars) {
61 Gson gson = new Gson();
62 String json = gson.toJson(toolbars);
63 addCustomToolbarLine(json.substring(1, json.length() - 1));
64 }
65
66 /**
67 * Add CKEditor event name that server side will listen.
68 * Only event names added to configuration will be listened.
69 *
70 * @param eventName This must match in client side. e.g: editor.fire('eventName')
71 */
72 public void addListenedEvent(String eventName) {
73 events.add(eventName);
74 }
75
76 public String[] getListenedEvents() {
77 return events.toArray(new String[0]);
78 }
79
80 public void addExternalPlugin(String pluginName, String source) {
81 externalPlugins.put(pluginName, source);
82 }
83
84 public Map<String, String> getExternalPlugins() {
85 return externalPlugins;
86 }
87 }