org.radeox.macro

Class BaseLocaleMacro

java.lang.Object

org.radeox.macro.BaseMacro

org.radeox.macro.BaseLocaleMacro

All Implemented Interfaces:

Comparable, org.radeox.api.macro.Macro, LocaleMacro

Direct Known Subclasses:

ApiDocMacro, ApiMacro, AsinMacro, InterWikiMacro, IsbnMacro, LinkMacro, MacroListMacro, RfcMacro, TableMacro, XrefMacro

public abstract class BaseLocaleMacro
extends BaseMacro
implements LocaleMacro

Field Summary

Fields inherited from class org.radeox.macro.BaseMacro

description, initialContext, paramDescription

Constructor Summary

Constructors

Constructor and Description
BaseLocaleMacro()

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Get the name of the macro.
void	setInitialContext(org.radeox.api.engine.context.InitialRenderContext context)

Methods inherited from class org.radeox.macro.BaseMacro

compareTo, execute, getDescription, getParamDescription, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.radeox.macro.LocaleMacro

getLocaleKey

Constructor Detail

BaseLocaleMacro

public BaseLocaleMacro()

Method Detail

getName

public String getName()

Description copied from class: BaseMacro

Get the name of the macro. This is used to map a macro in the input to the macro which should be called. The method has to be implemented by subclassing classes.

Specified by:

getName in interface org.radeox.api.macro.Macro

Specified by:

getName in class BaseMacro

Returns:

name Name of the Macro

setInitialContext

public void setInitialContext(org.radeox.api.engine.context.InitialRenderContext context)

Specified by:

setInitialContext in interface org.radeox.api.macro.Macro

Overrides:

setInitialContext in class BaseMacro