com.atlassian.confluence.plugins.doctheme
Class SpaceJumpMacro

java.lang.Object
  extended by com.atlassian.renderer.v2.macro.BaseMacro
      extended by com.atlassian.confluence.plugins.doctheme.SpaceJumpMacro
All Implemented Interfaces:
com.atlassian.renderer.v2.macro.Macro

public class SpaceJumpMacro
extends com.atlassian.renderer.v2.macro.BaseMacro
implements Macro

The space-jump macro allows you to refer to the current page within a different space. This helps to navigate between different versions (spaces) of documentation. Example: {spacejump:SPACEKEY|alias=LINK_TITLE}


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.atlassian.confluence.macro.Macro
Macro.BodyType, Macro.OutputType
 
Field Summary
 
Fields inherited from interface com.atlassian.renderer.v2.macro.Macro
RAW_PARAMS_KEY
 
Constructor Summary
SpaceJumpMacro(XhtmlContent xhtmlContent)
           
 
Method Summary
 String execute(Map<String,String> parameters, String body, ConversionContext conversionContext)
           
 String execute(Map parameters, String string, com.atlassian.renderer.RenderContext renderContext)
           
 com.atlassian.renderer.v2.RenderMode getBodyRenderMode()
           
 Macro.BodyType getBodyType()
          The type of body that this macro has, this is used to infer the migration task if no custom one is provided.
 Macro.OutputType getOutputType()
           
 com.atlassian.renderer.TokenType getTokenType(Map parameters, String body, com.atlassian.renderer.RenderContext context)
           
 boolean hasBody()
           
 
Methods inherited from class com.atlassian.renderer.v2.macro.BaseMacro
getWysiwygBodyType, isInline, suppressMacroRenderingDuringWysiwyg, suppressSurroundingTagDuringWysiwygRendering
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SpaceJumpMacro

public SpaceJumpMacro(XhtmlContent xhtmlContent)
Method Detail

getTokenType

public com.atlassian.renderer.TokenType getTokenType(Map parameters,
                                                     String body,
                                                     com.atlassian.renderer.RenderContext context)
Specified by:
getTokenType in interface com.atlassian.renderer.v2.macro.Macro
Overrides:
getTokenType in class com.atlassian.renderer.v2.macro.BaseMacro

hasBody

public boolean hasBody()
Specified by:
hasBody in interface com.atlassian.renderer.v2.macro.Macro

getBodyRenderMode

public com.atlassian.renderer.v2.RenderMode getBodyRenderMode()
Specified by:
getBodyRenderMode in interface com.atlassian.renderer.v2.macro.Macro

execute

public String execute(Map parameters,
                      String string,
                      com.atlassian.renderer.RenderContext renderContext)
               throws com.atlassian.renderer.v2.macro.MacroException
Specified by:
execute in interface com.atlassian.renderer.v2.macro.Macro
Throws:
com.atlassian.renderer.v2.macro.MacroException

getBodyType

public Macro.BodyType getBodyType()
Description copied from interface: Macro
The type of body that this macro has, this is used to infer the migration task if no custom one is provided.

Returns:
The type of body this macro has.

getOutputType

public Macro.OutputType getOutputType()

execute

public String execute(Map<String,String> parameters,
                      String body,
                      ConversionContext conversionContext)
               throws MacroExecutionException
Throws:
MacroExecutionException


Copyright © 2003-2013 Atlassian. All Rights Reserved.