wicket.contrib.tinymce.settings
Class Plugin

java.lang.Object
  extended by wicket.contrib.tinymce.settings.Enum
      extended by wicket.contrib.tinymce.settings.Plugin
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
AutoResizePlugin, AutoSavePlugin, ContextMenuPlugin, DateTimePlugin, DirectionalityPlugin, EmotionsPlugin, FullScreenPlugin, IESpellPlugin, ImageUploadPlugin, InlinepopupsPlugin, MediaPlugin, NoneditablePlugin, PastePlugin, PreviewPlugin, PrintPlugin, SavePlugin, SearchReplacePlugin, SpellCheckPlugin, StylePlugin, TabFocusPlugin, TablePlugin, WicketSavePlugin

public abstract class Plugin
extends Enum

Base class for all TinyMCE plugins.

Note: Only basic functionality is implemented, more work is needed.

Author:
Iulian-Corneliu Costan (iulian.costan@gmail.com), Frank Bille Jensen (fbille@avaleo.net)
See Also:
Serialized Form

Constructor Summary
protected Plugin(String name)
           
protected Plugin(String name, String pluginPath)
           
 
Method Summary
protected  void define(StringBuffer buffer, String key, String value)
           
protected  void definePluginExtensions(StringBuffer buffer)
          Override this in specific plugins if the plugin needs to be able to add something to the javascript.
protected  void definePluginSettings(StringBuffer buffer)
          Define configuration settings for this plugin.
 String getPluginPath()
           
 void setPluginPath(String pluginPath)
           
 
Methods inherited from class wicket.contrib.tinymce.settings.Enum
equals, getName, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Plugin

protected Plugin(String name)

Plugin

protected Plugin(String name,
                 String pluginPath)
Method Detail

getPluginPath

public String getPluginPath()
Returns:
the path to custom plugin

definePluginExtensions

protected void definePluginExtensions(StringBuffer buffer)
Override this in specific plugins if the plugin needs to be able to add something to the javascript. Use this to define the javascript callback functions if the plugin requires this (i.e. "paste_callback".

NOTE: This should NOT be used to configure settings for the plugin. The output is added AFTER the tinyMCE.init().

Parameters:
buffer - The output buffer which the plugin should append to, if they have some additional javascript.

definePluginSettings

protected void definePluginSettings(StringBuffer buffer)
Define configuration settings for this plugin.

I.e. the "paste" plugin can be configured with different settings such as: "paste_callback" etc.

Parameters:
buffer - buffer to append to
settingKey - The setting to set. I.e. "paste_callback"
value - The value to set on the setting. I.e. "myCallbackFunction"

define

protected void define(StringBuffer buffer,
                      String key,
                      String value)

setPluginPath

public void setPluginPath(String pluginPath)


Copyright © 2004-2011. All Rights Reserved.