com.atlassian.renderer.v2.components.phrase
Class PhraseRendererComponent

java.lang.Object
  com.atlassian.renderer.v2.components.phrase.PhraseRendererComponent

All Implemented Interfaces:

RendererComponent

public class PhraseRendererComponent
extends java.lang.Object
implements RendererComponent

Field Summary

static java.lang.String	VALID_END
static java.lang.String	VALID_START

Constructor Summary

PhraseRendererComponent(java.lang.String delimiter, java.lang.String tagName)

PhraseRendererComponent(java.lang.String startDelimiter, java.lang.String endDelimiter, java.lang.String tagName)

PhraseRendererComponent(java.lang.String startDelimiter, java.lang.String endDelimiter, java.lang.String startTag, java.lang.String endTag)

Method Summary

static PhraseRendererComponent	getDefaultRenderer(java.lang.String name)
java.lang.String	render(java.lang.String wiki, RenderContext context) Render this piece of wiki text.
boolean	shouldRender(RenderMode renderMode) Whether or not this render component is required given the current render mode.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VALID_START

public static final java.lang.String VALID_START

See Also:

Constant Field Values

VALID_END

public static final java.lang.String VALID_END

See Also:

Constant Field Values

Constructor Detail

PhraseRendererComponent

public PhraseRendererComponent(java.lang.String delimiter,
                               java.lang.String tagName)

PhraseRendererComponent

public PhraseRendererComponent(java.lang.String startDelimiter,
                               java.lang.String endDelimiter,
                               java.lang.String tagName)

PhraseRendererComponent

public PhraseRendererComponent(java.lang.String startDelimiter,
                               java.lang.String endDelimiter,
                               java.lang.String startTag,
                               java.lang.String endTag)

Method Detail

getDefaultRenderer

public static PhraseRendererComponent getDefaultRenderer(java.lang.String name)

render

public java.lang.String render(java.lang.String wiki,
                               RenderContext context)

Description copied from interface: RendererComponent

Render this piece of wiki text.

Specified by:

render in interface RendererComponent

shouldRender

public boolean shouldRender(RenderMode renderMode)

Description copied from interface: RendererComponent

Whether or not this render component is required given the current render mode.

Specified by:

shouldRender in interface RendererComponent