| org.radeox.api.macro.Macro
| execute | | public void execute(Writer writer, MacroParameter params) throws IllegalArgumentException, IOException(Code) | | Execute the macro. This method is called by MacroFilter to handle macros.
Parameters:
writer - A write where the macro should write its output to
Parameters:
params - Macro parameters with the parameters the macro is called with |
| getDescription | | public String getDescription()(Code) | | Get a description of the macro. This description explains in a short way
what the macro does
description A string describing the macro |
| getName | | public String getName()(Code) | | 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.
name Name of the Macro |
| getParamDescription | | public String[] getParamDescription()(Code) | | Get a description of the paramters of the macro. The method returns an
array with an String entry for every parameter. The format is {"1:
description", ...} where 1 is the position of the parameter.
description Array describing the parameters of the macro |
|
|