Package org.radeox.macro

Class LocalePreserved

java.lang.Object

org.radeox.macro.BaseMacro

org.radeox.macro.Preserved

org.radeox.macro.LocalePreserved

All Implemented Interfaces:

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

Direct Known Subclasses:

CodeMacro, FilePathMacro, MailToMacro, QuoteMacro

public abstract class LocalePreserved
extends Preserved
implements LocaleMacro

Field Summary

Fields inherited from class org.radeox.macro.BaseMacro

description, initialContext, paramDescription

Constructor Summary

Constructors

Constructor	Description
LocalePreserved()

Method Summary

Modifier and Type	Method	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.Preserved

addSpecial, addSpecial, replace

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

LocalePreserved

public LocalePreserved()

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