Java tutorial
/* This file is part of Wicket-Contrib-TinyMce. See <http://http://wicketstuff.org/confluence/display/STUFFWIKI/wicket-contrib-tinymce> Wicket-Contrib-TinyMce is free software: you can redistribute it and/ or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Wicket-Contrib-TinyMce is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with Wicket-Contrib-TinyMce. If not, see <http://www.gnu.org/licenses/>. */ package wicket.contrib.tinymce.settings; import java.io.Serializable; import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; import java.util.HashMap; import java.util.HashSet; import java.util.Iterator; import java.util.LinkedList; import java.util.List; import java.util.Map; import java.util.Set; import org.apache.commons.collections4.CollectionUtils; import org.apache.commons.collections4.Predicate; import org.apache.commons.collections4.set.ListOrderedSet; import org.apache.wicket.Component; import org.apache.wicket.Session; import org.apache.wicket.request.cycle.RequestCycle; import org.apache.wicket.request.resource.JavaScriptResourceReference; import org.apache.wicket.request.resource.ResourceReference; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import wicket.contrib.tinymce.InPlaceEditBehavior; /** * Settings class for TinyMCE editor. User can add/remove buttons, enable/disable resizing, change * positions, orientation, alignment and much more. * * @author Iulian-Corneliu Costan (iulian.costan@gmail.com) * @author Frank Bille Jensen (fbille@avaleo.net) * @see Plugin * @see Button */ public class TinyMCESettings implements Serializable { private static final long serialVersionUID = 3L; private static final Logger LOG = LoggerFactory.getLogger(TinyMCESettings.class); public static final ResourceReference REFERENCE = new JavaScriptResourceReference(InPlaceEditBehavior.class, "tiny_mce/tiny_mce_src.js"); public static final ResourceReference REFERENCE_MIN = new JavaScriptResourceReference(InPlaceEditBehavior.class, "tiny_mce/tiny_mce.js"); public static final Set<Language> languages = new HashSet<Language>(Arrays.asList(Language.values())); private Theme theme; private Location toolbarLocation; private Location statusbarLocation; private Align toolbarAlign; private Language language; private EntityEncoding entityEncoding; private boolean resizing = false; private boolean horizontalResizing = true; private boolean resizingUseCookie = true; @Deprecated private boolean autoResize = false;; private boolean readOnly = false; private Set<Plugin> plugins = new ListOrderedSet(); private List<Control> controls = new LinkedList<Control>(); private Set<Button> disabledButtons = new ListOrderedSet(); private Map<Toolbar, List<Button>> toolbarButtons; private Boolean convertUrls = null; private Boolean removeScriptHost = null; private Boolean relativeUrls = null; private String blockFormats = null; private ResourceReference contentCss = null; private String documentBaseUrl; private List<String> customSettings; public TinyMCESettings() { this(Theme.simple); } public TinyMCESettings(Theme theme) { this(theme, selectLang()); } public TinyMCESettings(Theme theme, Language lang) { this.theme = theme; language = lang; } private static Language selectLang() { try { return Language.valueOf(Session.get().getLocale().getLanguage()); } catch (IllegalArgumentException e) { return null; } } public Theme getTheme() { return theme; } public Language getLanguage() { return language; } public String getDocumentBaseUrl() { return documentBaseUrl; } public void setDocumentBaseUrl(String documentBaseUrl) { this.documentBaseUrl = documentBaseUrl; } public void addCustomSetting(String customSetting) { if (customSettings == null) customSettings = new ArrayList<String>(); customSettings.add(customSetting); } public String[] getCustomSettings() { return customSettings.toArray(new String[customSettings.size()]); } public ResourceReference getContentCss() { return contentCss; } public void setContentCss(ResourceReference contentCss) { this.contentCss = contentCss; } @Deprecated public boolean getAutoResize() { return autoResize; } /** * Obsolete feature; replaced by {@link AutoResizePlugin} in TinyMCE v.3.2.5 * * @param auto_resize */ @Deprecated public void setAutoResize(boolean auto_resize) { autoResize = auto_resize; } public String getBlockFormats() { return blockFormats; } public void setBlockFormats(String blockFormats) { this.blockFormats = blockFormats; } public void setToolbarLocation(Location toolbarLocation) { this.toolbarLocation = toolbarLocation; } public Location getToolbarLocation() { return toolbarLocation; } public void setStatusbarLocation(Location statusbarLocation) { this.statusbarLocation = statusbarLocation; } public Location getStatusbarLocation() { return statusbarLocation; } public void setToolbarAlign(Align toolbarAlign) { this.toolbarAlign = toolbarAlign; } public Align getToolbarAlign() { return toolbarAlign; } public void setEntityEncoding(EntityEncoding entityEncoding) { this.entityEncoding = entityEncoding; } public EntityEncoding getEntityEncoding() { return entityEncoding; } public void setReadOnly(boolean readOnly) { this.readOnly = readOnly; } public boolean isReadOnly() { return readOnly; } public void setResizing(boolean resizing) { this.resizing = resizing; } public boolean getResizing() { return resizing; } public void setHorizontalResizing(boolean horizontalResizing) { this.horizontalResizing = horizontalResizing; } public boolean getHorizontalResizing() { return horizontalResizing; } public boolean getResizingUseCookie() { return resizingUseCookie; } public void setResizingUseCookie(boolean resizingUseCookie) { this.resizingUseCookie = resizingUseCookie; } /** * This option enables you to control if TinyMCE is to be clever and restore urls to their * original values. URLs are auto converted/messed up by default since the built in browser * logic works this way, there is no way to get the real URL unless you store it away. If you * set this option to false it will try to keep these URLs intact. This option is set to true by * default that means URLs will be forced absolute or relative depending on the state of * relative_urls. * * @param convertUrls */ public void setConvertUrls(boolean convertUrls) { this.convertUrls = convertUrls; } public Boolean getConvertUrls() { return convertUrls; } /** * If this option is enabled the protocol and host part of the URLs returned from the * MCFileManager will be removed. This option is only used if the relative_urls option is set to * false. This option is set to true by default. * * URL:s will be returned in this format: "/somedir/somefile.htm" instead of the default mode: * "http://www.somesite.com/somedir/somefile.htm". * * @param removeScriptHost */ public void setRemoveScriptHost(Boolean removeScriptHost) { this.removeScriptHost = removeScriptHost; } public Boolean getRemoveScriptHost() { return removeScriptHost; } /** * If this option is set to true, all URLs returned from the MCFileManager will be relative from * the specified document_base_url. If it's set to false all URLs will be converted to absolute * URLs. This option is set to true by default. * * @param relativeUrls */ public void setRelativeUrls(Boolean relativeUrls) { this.relativeUrls = relativeUrls; } public Boolean getRelativeUrls() { return relativeUrls; } /** * Add a default button to tinymce editor. These plugins are defined by tinymce editor and are * ready to use. * * TODO: I'm not sure this works for anything except the fourth toolbar. TODO: Why doesn't it * interact with the 'toolbars' variable? * * @param button * - button to be added * @param toolbar * - the toolbar where to add this button to * @param position * - position of this button */ public void add(Button button, Toolbar toolbar, Position position) { if (button instanceof PluginButton) register(((PluginButton) button).getPlugin()); controls.add(new Control(button, toolbar, position)); } /** * Disable specific button in advanced theme mode. * * @param button * button to be disabled */ public void disableButton(Button button) { disabledButtons.add(button); } /** * This option can only be used when theme is set to advanced and when the * theme_advanced_layout_manager option is set to the default value of "SimpleLayout". * * TODO: Does this fail for the fourth toolbar? Seems like it will. * * @param toolbar * the toolbar to define buttons for * @param buttons * A list of buttons to show as that toolbar. An empty list will remove (make * invisible) the toolbar in tinymce. Passing null will remove the setting for the * toolbar. */ public void setToolbarButtons(Toolbar toolbar, List<Button> buttons) { if (!Theme.advanced.equals(theme)) throw new IllegalArgumentException("setToolbarButtons is only applicable for advanced theme"); if (toolbarButtons == null) toolbarButtons = new HashMap<Toolbar, List<Button>>(); if (buttons == null) toolbarButtons.remove(toolbar); else toolbarButtons.put(toolbar, buttons); } /** * @param toolbar * The toolbar to return the defined buttons for * @return The buttons that should be shown for that toolbar (empty list for invisible toolbar, * null for no settings for that toolbar) */ public List<Button> getToolbarButtons(Toolbar toolbar) { List<Button> result = null; if (toolbarButtons != null) result = toolbarButtons.get(toolbar); return result; } /** * Register a tinymce plugin. In order to reuse a existing plugin it has to be registered * before. Usually plugins are registered automatically when a plugin button is added, but there * are some plugins that contains no buttons. This method is used to register those plugins. (eg * AutoSave) * * @param plugin */ public void register(Plugin plugin) { plugins.add(plugin); } // used in testing Set<Plugin> getPlugins() { return plugins; } /** * Generates the initialisation script. Internal API, do not call. */ public final String toJavaScript(Mode mode, Collection<Component> components) { StringBuffer buffer = new StringBuffer(); // mode buffer.append("\n\t").append("mode : \"" + mode.getName() + "\""); if (Mode.exact.equals(mode)) addElements(components, buffer); // language if (language != null) buffer.append(",\n\t").append("language : ").append("\"").append(language.toString()).append("\""); // theme buffer.append(",\n\t").append("theme : ").append("\"").append(theme.getName()).append("\""); // other settings buffer.append(toJavaScript()); return buffer.toString(); } String toJavaScript() { StringBuffer buffer = new StringBuffer(); if (convertUrls != null) buffer.append(",\n\t").append("convert_urls : ").append(convertUrls); if (relativeUrls != null) buffer.append(",\n\t").append("relative_urls : ").append(relativeUrls); if (removeScriptHost != null) buffer.append(",\n\t").append("remove_script_host : ").append(removeScriptHost); if (autoResize) buffer.append(",\n\tauto_resize : true"); if (readOnly) buffer.append(",\n\treadonly : true"); // Per Online Doc if (contentCss != null) buffer.append(",\n\t").append("content_css : \"").append(RequestCycle.get().urlFor(contentCss, null)) .append("\""); if (documentBaseUrl != null) buffer.append(",\n\t").append("document_base_url : \"").append(documentBaseUrl).append("\""); if (entityEncoding != null) buffer.append(",\n\t").append("entity_encoding : \"").append(entityEncoding).append("\""); if (Theme.advanced.equals(theme)) appendAdvancedSettings(buffer); appendPluginSettings(buffer); appendCustomSettings(buffer); return buffer.toString(); } private void appendCustomSettings(StringBuffer buffer) { if (customSettings != null) for (String line : customSettings) buffer.append(",\n\t").append(line); } private void addElements(Collection<Component> components, StringBuffer buffer) { if (components.size() > 0) { buffer.append(",\n\telements : \""); Iterator<Component> iterator = components.iterator(); while (iterator.hasNext()) { Component component = iterator.next(); buffer.append(component.getMarkupId()); if (iterator.hasNext()) buffer.append(", "); } buffer.append("\""); } else LOG.warn("tinymce is set to \"exact\" mode but there are no components attached"); } private void appendPluginSettings(StringBuffer buffer) { if (plugins.size() > 0) { Iterator<Plugin> iterator = plugins.iterator(); while (iterator.hasNext()) { Plugin plugin = iterator.next(); plugin.definePluginSettings(buffer); } } } public String getLoadPluginJavaScript() { StringBuffer loadPluginJavaScript = new StringBuffer(); if (plugins.size() > 0) { Iterator<Plugin> iterator = plugins.iterator(); while (iterator.hasNext()) { Plugin plugin = iterator.next(); String pluginPath = plugin.getPluginPath(); if (pluginPath != null && pluginPath.equals("") == false) { loadPluginJavaScript.append("tinymce.PluginManager.load('"); loadPluginJavaScript.append(plugin.getName()); loadPluginJavaScript.append("','"); loadPluginJavaScript.append(pluginPath); loadPluginJavaScript.append("');\n"); } } } return loadPluginJavaScript.toString(); } /** * Get additional javascript from the plugins. * * @return The different plugins additional javascript. */ public String getAdditionalPluginJavaScript() { StringBuffer buffer = new StringBuffer(); if (plugins.size() > 0) { Iterator<Plugin> iterator = plugins.iterator(); while (iterator.hasNext()) { Plugin plugin = iterator.next(); plugin.definePluginExtensions(buffer); } } return buffer.toString(); } private void appendAdvancedSettings(StringBuffer buffer) { // disable buttons addDisabledButtons(buffer); // plugins addPlugins(buffer); // add additional controls addButtons(buffer); addButtons1_Before(buffer); addButtons1_After(buffer); addButtons2_Before(buffer); addButtons2_After(buffer); addButtons3_Before(buffer); addButtons3_After(buffer); addButtons4(buffer); // toolbar, statusbar addToolbarLocation(buffer); addStatusbarLocation(buffer); addToolbarAlign(buffer); // resizing addResizing(buffer); // other addBlockFormats(buffer); } void addPlugins(StringBuffer buffer) { if (plugins.size() > 0) { buffer.append(",\n\t").append("plugins : ").append("\""); Iterator<Plugin> iterator = plugins.iterator(); int count = 0; while (iterator.hasNext()) { Plugin plugin = iterator.next(); if (count > 0) buffer.append(", "); // if the plugin has a plugin path set, assume it's external // and will be loaded by tinymce.PluginManager.load String pluginPath = plugin.getPluginPath(); if (pluginPath != null && !pluginPath.equals("")) { buffer.append("-"); // do not load twice! } buffer.append(plugin.getName()); count++; } buffer.append("\""); } } private void addButtons(StringBuffer buffer) { if (toolbarButtons != null) for (int i = 1; i <= 3; ++i) { Toolbar toolbar = getToolbar(i); List<Button> buttons = toolbarButtons.get(toolbar); if (buttons != null) buffer.append(",\n\ttheme_advanced_buttons").append(i).append(" : \"") .append(enumAsString(buttons)).append("\""); } } private Toolbar getToolbar(int index) { if (index == 1) return Toolbar.first; else if (index == 2) return Toolbar.second; else if (index == 3) return Toolbar.third; else if (index == 4) return Toolbar.fourth; throw new IllegalArgumentException("Not a valid toolbar index: " + index); } private void addButtons1_Before(StringBuffer buffer) { ControlPredicate predicate = new ControlPredicate(Toolbar.first, Position.before); Collection<Control> result = CollectionUtils.select(controls, predicate); if (result.size() > 0) { buffer.append(",\n\t").append("theme_advanced_buttons1_add_before : ").append("\"") .append(controlsAsString(result)).append("\""); } } private void addButtons1_After(StringBuffer buffer) { ControlPredicate predicate = new ControlPredicate(Toolbar.first, Position.after); Collection result = CollectionUtils.select(controls, predicate); if (result.size() > 0) { buffer.append(",\n\t").append("theme_advanced_buttons1_add : ").append("\"") .append(controlsAsString(result)).append("\""); } } private void addButtons2_Before(StringBuffer buffer) { ControlPredicate predicate = new ControlPredicate(Toolbar.second, Position.before); Collection result = CollectionUtils.select(controls, predicate); if (result.size() > 0) { buffer.append(",\n\t").append("theme_advanced_buttons2_add_before: ").append("\"") .append(controlsAsString(result)).append("\""); } } private void addButtons2_After(StringBuffer buffer) { ControlPredicate predicate = new ControlPredicate(Toolbar.second, Position.after); Collection result = CollectionUtils.select(controls, predicate); if (result.size() > 0) { buffer.append(",\n\t").append("theme_advanced_buttons2_add : ").append("\"") .append(controlsAsString(result)).append("\""); } } private void addButtons3_Before(StringBuffer buffer) { ControlPredicate predicate = new ControlPredicate(Toolbar.third, Position.before); Collection<?> result = CollectionUtils.select(controls, predicate); if (result.size() > 0) { buffer.append(",\n\t").append("theme_advanced_buttons3_add_before : ").append("\"") .append(controlsAsString(result)).append("\""); } } private void addButtons3_After(StringBuffer buffer) { ControlPredicate predicate = new ControlPredicate(Toolbar.third, Position.after); Collection<?> result = CollectionUtils.select(controls, predicate); if (result.size() > 0) { buffer.append(",\n\t").append("theme_advanced_buttons3_add : ").append("\"") .append(controlsAsString(result)).append("\""); } } private void addButtons4(StringBuffer buffer) { ControlPredicate predicate = new ControlPredicate(Toolbar.fourth, Position.before); Collection result = CollectionUtils.select(controls, predicate); if (result.size() > 0) { buffer.append(",\n\t").append("theme_advanced_buttons4 : ").append("\"") .append(controlsAsString(result)).append("\""); } predicate = new ControlPredicate(Toolbar.fourth, Position.after); result = CollectionUtils.select(controls, predicate); if (result.size() > 0) { buffer.append(",\n\t").append("theme_advanced_buttons4 : ").append("\"") .append(controlsAsString(result)).append("\""); } } void addDisabledButtons(StringBuffer buffer) { if (disabledButtons.size() > 0) { String value = enumAsString(disabledButtons); buffer.append(",\n\t").append("theme_advanced_disable : ").append("\"").append(value).append("\""); } } private String controlsAsString(Collection controls) { List buttons = new ArrayList(); Iterator iterator = controls.iterator(); while (iterator.hasNext()) { Control control = (Control) iterator.next(); buttons.add(control.getButton()); } return enumAsString(buttons); } private String enumAsString(Collection enums) { StringBuffer buffer = new StringBuffer(); Iterator iterator = enums.iterator(); while (iterator.hasNext()) { wicket.contrib.tinymce.settings.Enum enumObject = (Enum) iterator.next(); if (buffer.length() > 0) { buffer.append(","); } buffer.append(enumObject.getName()); } return buffer.toString(); } void addResizing(StringBuffer buffer) { if (resizing) { buffer.append(",\n\ttheme_advanced_resizing : true"); addHorizontalResizing(buffer); addResizingUseCookie(buffer); } } private void addHorizontalResizing(StringBuffer buffer) { if (!horizontalResizing) buffer.append(",\n\ttheme_advanced_resize_horizontal : false"); } private void addResizingUseCookie(StringBuffer buffer) { if (!resizingUseCookie) buffer.append(",\n\ttheme_advanced_resizing_use_cookie : false"); } void addBlockFormats(StringBuffer buffer) { if (blockFormats != null) buffer.append(",\n\ttheme_advanced_blockformats : \"").append(blockFormats).append("\""); } void addToolbarAlign(StringBuffer buffer) { if (toolbarAlign != null) { buffer.append(",\n\t").append("theme_advanced_toolbar_align : ").append("\"") .append(toolbarAlign.getName()).append("\""); } } void addToolbarLocation(StringBuffer buffer) { if (toolbarLocation != null) { buffer.append(",\n\t").append("theme_advanced_toolbar_location : ").append("\"") .append(toolbarLocation.getName()).append("\""); } } void addStatusbarLocation(StringBuffer buffer) { if (statusbarLocation != null) { buffer.append(",\n\t").append("theme_advanced_statusbar_location : ").append("\"") .append(statusbarLocation.getName()).append("\""); } } private class ControlPredicate implements Predicate { private Toolbar toolbar; private Position position; public ControlPredicate(Toolbar toolbar, Position position) { this.toolbar = toolbar; this.position = position; } public boolean evaluate(Object object) { Control control = (Control) object; return toolbar.equals(control.getToolbar()) && position.equals(control.getPosition()); } } /** * This class specifies how elements is to be converted into TinyMCE WYSIWYG editor instances. * This option can be set to any of the values below: * <ul> * <li>textareas - converts all textarea elements to editors when the page loads.</li> * <li>exact - exact - Converts only explicit elements, these are listed in the elements option. * </li> * <li>specific_textares - Converts all textarea elements with the a textarea_trigger attribute * set to "true".</li> * </ul> * At this moment, only <b>textareas</b> and <b>exacat</b> modes are supported. */ public static class Mode extends Enum { private static final long serialVersionUID = 1L; public static final Mode none = new Mode("none"); public static final Mode exact = new Mode("exact"); private Mode(String name) { super(name); } } /** * Language enum */ public static enum Language { ar, bg, bs, ca, ch, cs, da, de, el, en, es, et, fa, fi, fr, gl, he, hr, hu, ia, ii, is, it, ja, ko, lt, lv, mk, ms, nb, nl, nn, pl, pt, ro, ru, sc, se, si, sk, sl, sr, sv, tr, tt, tw, uk, vi, zh } /** * This class enables you to specify what theme to use when rendering the TinyMCE WYSIWYG editor * instances. Two themes are supported: * <ul> * <li>simple - This is the most simple theme for TinyMCE it contains only the basic functions.</li> * <li>advanced - This theme enables users to add/remove buttons and panels .</li> * </ul> */ public static class Theme extends Enum { private static final long serialVersionUID = 1L; public static final Theme simple = new Theme("simple"); public static final Theme advanced = new Theme("advanced"); private Theme(String name) { super(name); } } /** * This option enables you to specify where the toolbar should be located. This value can be top * or bottom. */ public static class Location extends Enum { private static final long serialVersionUID = 1L; public static final Location top = new Location("top"); public static final Location bottom = new Location("bottom"); private Location(String name) { super(name); } } /** * This class enables you to specify the alignment of the controls. This value can be left, * right or center the default value is center. */ public static class Align extends Enum { private static final long serialVersionUID = 1L; public static final Align left = new Align("left"); public static final Align center = new Align("center"); public static final Align right = new Align("right"); private Align(String name) { super(name); } } /** * This class specifies the position of new added control. It can be before or after existing * elements. */ public static class Position extends Enum { private static final long serialVersionUID = 1L; public static final Position before = new Position("before"); public static final Position after = new Position("after"); public Position(String name) { super(name); } } /** * This class specifices the toolbar to add specific control to. TinyMCE editor defines three * toolbars named: first, second, third. */ public static class Toolbar extends Enum { private static final long serialVersionUID = 1L; public static final Toolbar first = new Toolbar("first"); public static final Toolbar second = new Toolbar("second"); public static final Toolbar third = new Toolbar("third"); public static final Toolbar fourth = new Toolbar("fourth"); public Toolbar(String name) { super(name); } } /** * Controls how entities/characters get processed by TinyMCE. * * <a href= "http://tinymce.moxiecode.com/wiki.php/Configuration:entity_encoding" * >http://tinymce.moxiecode.com/wiki.php/Configuration:entity_encoding</a> * * @author jbrookover * */ public static class EntityEncoding extends Enum { private static final long serialVersionUID = 1L; public static final EntityEncoding named = new EntityEncoding("named"); public static final EntityEncoding numeric = new EntityEncoding("numeric"); public static final EntityEncoding raw = new EntityEncoding("raw"); protected EntityEncoding(String name) { super(name); } } }