com.atlassian.confluence.macro
Interface CustomHtmlEditorPlaceholder

public interface CustomHtmlEditorPlaceholder

An interface implemented by a Macro that wishes to provide its own HTML placeholder to the Confluence Editor.

It should be noted that current implementation restrictions on the editor mean that the custom placeholder must be a single non-editable HTML element. It should be either an IMG tag or an OBJECT tag.

Since:

4.0

Nested Class Summary

static class

CustomHtmlEditorPlaceholder.PlaceholderGenerationException An exception thrown if there is a problem in generating the custom placeholder.

Method Summary

java.lang.String

getCustomPlaceholder(java.util.Map<java.lang.String,java.lang.String> parameters, java.lang.String body, ConversionContext context)

Method Detail

getCustomPlaceholder

java.lang.String getCustomPlaceholder(java.util.Map<java.lang.String,java.lang.String> parameters,
                                      java.lang.String body,
                                      ConversionContext context)
                                      throws CustomHtmlEditorPlaceholder.PlaceholderGenerationException

Parameters:

parameters - the parameters that are set on the macro. This may be empty or null.

body - the body of the macro if any. It may be null.

context - the context for the macro instance.

Returns:

a String containing HTML to be used in the editor to represent a macro.

Throws:

CustomHtmlEditorPlaceholder.PlaceholderGenerationException - on any error during generation of the custom placeholder.