1 /**
2 * This file Copyright (c) 2010-2012 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 java.util.ArrayList;
37 import java.util.Collections;
38 import java.util.HashMap;
39 import java.util.List;
40 import java.util.Map;
41
42 import org.vaadin.openesignforms.ckeditor.CKEditorConfig;
43
44 import com.google.gson.Gson;
45
46 /**
47 * Extends CKEditorConfig by defining more
48 * coherent toolbar API and configuring custom plugins.
49 */
50 public class MagnoliaRichTextFieldConfig extends CKEditorConfig {
51
52 private static final long serialVersionUID = 9993500103615659L;
53 private List<String> events = new ArrayList<String>();
54 private Map<String, String> serverSidePlugins = new HashMap<String, String>();
55
56 public MagnoliaRichTextFieldConfig() {
57 addToRemovePlugins("elementspath");
58 }
59
60 /**
61 * Adds list of toolbar groups. Groups are placed in one
62 * row if space allows.
63 * @param toolbars
64 */
65 public void addToolbarLine(List<ToolbarGroup> toolbars) {
66 Gson gson = new Gson();
67 String json = gson.toJson(toolbars);
68 addCustomToolbarLine(json.substring(1, json.length()-1));
69 }
70
71 /**
72 * Add CKEditor event name that server side will listen.
73 * Only event names added to configuration will be listened.
74 * @param eventName This must match in client side. e.g: editor.fire('eventName')
75 */
76 public void addListenedEvent(String eventName) {
77 events.add(eventName);
78 }
79
80 String[] getListenedEvents() {
81 return events.toArray(new String[0]);
82 }
83
84 /**
85 * Bean class for toolbar group.
86 */
87 public static class ToolbarGroup {
88 @SuppressWarnings("unused")
89 private String name;
90 private List<String> items;
91
92 public ToolbarGroup(String groupname, String[] toolbarbuttons) {
93 this.name = groupname;
94 this.items = new ArrayList<String>();
95 for(String item: toolbarbuttons) {
96 this.items.add(item);
97 }
98 }
99 }
100
101 public void addPlugin(String pluginName, String source) {
102 addToExtraPlugins(pluginName);
103 this.serverSidePlugins.put(pluginName, source);
104 }
105
106 Map<String, String> getServerPlugins() {
107 return Collections.unmodifiableMap(this.serverSidePlugins);
108 }
109 }