com.atlassian.confluence.plugin.editor
Interface Editor

All Known Implementing Classes:

TinyMceEditor

public interface Editor

This interface allows Wysiwyg editors to be plugged in to Confluence.

Method Summary

java.lang.String	escapeHtml(java.lang.String html) Perform any necessary escaping of the HTML rendered by Confluence.
java.lang.String	getDivContentsTemplate() Returns the div contents to display the editor itself.
java.lang.String	getEditorSpecificCss() Deprecated. since 2.8.
java.lang.String	getJavascriptTemplate() Deprecated. Since 2.10. Resources are now loading with getResourcesKey()
java.lang.String	getResourcesKey() Returns the complete module key of the editor's web resources to be included.
boolean	supportedUserAgent(java.lang.String userAgent) Return true if the user agent string indicates a browser which is supported by this editor

Method Detail

getJavascriptTemplate

java.lang.String getJavascriptTemplate()

Deprecated. Since 2.10. Resources are now loading with getResourcesKey()

getResourcesKey

java.lang.String getResourcesKey()

Returns the complete module key of the editor's web resources to be included.

One of the web resources must return some javascript that allows Confluence to interface with the editor. The Javascript returned must define the folowing functions under the namespace AJS.Editor.Adapter: onShowEditor() -- this is called just after the DIV containing the editor is made visible. It is a hook where you can place any special code needed at this point. onHideEditor() -- this is called just before the DIV containing the editor is hidden. It is a hook where you can place any special code needed at this point. setEditorValue(newValue) -- put the text in newValue into the editor. This is called when the editor needs new content -- it is *not* called to set the initial content. That should be done either by providing the editor with the content as part of the initial HTML, or by calling javascript from editorOnLoad(). allowModeChange() -- return true if the editor is in a state where changes from rich text to markup and vice versa are allowed. getEditorHTML() -- return the current HTML contents of the editor. This *must* return a JavaScript string, not a JavaObject wrapping a java.lang.String! editorOnLoad() -- called in the page's onLoad handler, place any initialization needed at this point here. editorHasContentChanged() -- return true if the contents of the editor has been modified by the user since the last time editorResetContentChanged(). editorResetContentChanged() -- called to reset the contents change indicator

getDivContentsTemplate

java.lang.String getDivContentsTemplate()

Returns the div contents to display the editor itself.

Returns:

a String containing a velocity template

supportedUserAgent

boolean supportedUserAgent(java.lang.String userAgent)

Return true if the user agent string indicates a browser which is supported by this editor

Returns:

true if this editor is supported

escapeHtml

java.lang.String escapeHtml(java.lang.String html)

Perform any necessary escaping of the HTML rendered by Confluence. The AbstractPreviewPageAction.getWysiwygContent() method uses this method to escape the rendered HTML.

getEditorSpecificCss

java.lang.String getEditorSpecificCss()

Deprecated. since 2.8.

Return a string of CSS which will be appended to the standard stylesheet if it is requested from /styles/wysiwyg-action Note that it is up to the editor implementation to retrieve this stylesheet and apply it to the editor contents -- the page containing the editor is styled with the normal stylesheet.