com.atlassian.confluence.xhtml.api
Interface MacroDefinitionReplacer


public interface MacroDefinitionReplacer

Replacer of MacroDefinitions in storage format with other content. See XhtmlContent.replaceMacroDefinitionsWithString(java.lang.String, com.atlassian.confluence.content.render.xhtml.ConversionContext, com.atlassian.confluence.xhtml.api.MacroDefinitionReplacer) for more detail.


Method Summary
 java.lang.String replace(MacroDefinition macroDefinition)
          Called each time a macro definition is found in the content, so that each definition may be replaced different content.
 

Method Detail

replace

java.lang.String replace(MacroDefinition macroDefinition)
                         throws XhtmlException
Called each time a macro definition is found in the content, so that each definition may be replaced different content.

Parameters:
macroDefinition - of the macro found in the content.
Returns:
a String to be placed in the resulting content, in place of the original definition and its body. A null indicates that the macro should be removed.
Throws:
XhtmlException - if there is a problem creating the modified fragment.


Copyright © 2003-2014 Atlassian. All Rights Reserved.