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 /**
37 * Magnolia/CKEditor text field events interface.
38 */
39 public interface MagnoliaCKEditorTextFieldEvents {
40
41 /**
42 * Event is transmitted from server to client when a link has been selected.
43 */
44 String EVENT_SEND_MAGNOLIA_LINK = "mgnlLinkSelected";
45
46 /**
47 * Event is transmitted from server to client when a link dialog has been
48 * canceled or an exception has occurred. In case of exception
49 * the event will carry the error message.
50 */
51 String EVENT_CANCEL_LINK = "mgnlLinkCancel";
52
53 /**
54 * Event is transmitted from client to server when a user requests a link dialog.
55 * Event carries an optional link that should be treated as default link value.
56 */
57 String EVENT_GET_MAGNOLIA_LINK = "mgnlGetLink";
58
59 /**
60 * Send event to CKEditor instance.
61 *
62 * @param event Event name that plugin can attach with: editor.on('event', function(e) {...});
63 * @param value Additional event data. Plugin can access this by e.data
64 */
65 void firePluginEvent(String event, String value);
66
67 /**
68 * Send event to CKEditor instance. Only event. No additional event data.
69 */
70 default void firePluginEvent(String event) {
71 firePluginEvent(event, "");
72 }
73
74 /**
75 * Event handler listener for plugin connectivity.
76 */
77 interface PluginListener {
78 void onPluginEvent(String eventName, String value);
79 }
80
81 void addListener(PluginListener listener);
82 }