View Javadoc
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.vaadin.ckeditor;
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.alump.ckeditor.CKEditorConfig;
43  
44  import com.google.gson.Gson;
45  
46  /**
47   * Magnolia 6 - Vaadin 8 extension of CKEditorConfig in order to define a more
48   * coherent toolbar API and configure custom plugins.
49   */
50  public class MagnoliaCKEditorConfig extends CKEditorConfig {
51  
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  
88      @Override
89      public void addExtraConfig(String extraConfigName, String extraConfigValue) {
90          super.addExtraConfig(extraConfigName, extraConfigValue);
91      }
92  
93      @Override
94      public synchronized void addToRemovePlugins(String pluginName) {
95          super.addToRemovePlugins(pluginName);
96      }
97  
98      @Override
99      public synchronized void addToExtraPlugins(String pluginName) {
100         super.addToExtraPlugins(pluginName);
101     }
102 
103     @Override
104     public void setBaseFloatZIndex(int zIndex) {
105         super.setBaseFloatZIndex(zIndex);
106     }
107 
108     @Override
109     public void setResizeEnabled(boolean enabled) {
110         super.setResizeEnabled(enabled);
111     }
112 
113     /**
114      * Represents a CKEditor toolbar.
115      */
116     public static class ToolbarGroup {
117 
118         private String name;
119 
120         private List<String> items = new ArrayList<>();
121 
122         public ToolbarGroup(String groupname, String... toolbarbuttons) {
123             this.name = groupname;
124             Collections.addAll(items, toolbarbuttons);
125         }
126 
127         public String getName() {
128             return name;
129         }
130 
131         public void addItem(String item) {
132             items.add(item);
133         }
134     }
135 
136     public static List<ToolbarGroup> defaultToolbar() {
137         List<ToolbarGroup> toolbars = new ArrayList<>();
138         toolbars.add(new ToolbarGroup("basicstyles", "Bold", "Italic", "Underline", "SpecialChar"));
139         toolbars.add(new ToolbarGroup("paragraph", "NumberedList", "BulletedList", "JustifyLeft", "JustifyCenter", "JustifyRight", "JustifyBlock", "Image", "Table"));
140         toolbars.add(new ToolbarGroup("links", "Link", "InternalLink", "DamLink", "Unlink"));
141         toolbars.add(new ToolbarGroup("styles", "Font", "FontSize", "TextColor"));
142         toolbars.add(new ToolbarGroup("clipboard", "Cut", "Copy", "Paste", "PasteText", "PasteFromWord"));
143         toolbars.add(new ToolbarGroup("undo", "Undo", "Redo"));
144         toolbars.add(new ToolbarGroup("tools", "Source"));
145         return toolbars;
146     }
147 }