org.xwiki.rendering.macro.descriptor

Interface MacroDescriptor

All Known Implementing Classes:

AbstractMacroDescriptor, DefaultMacroDescriptor

public interface MacroDescriptor

Describe a Macro (macro description and macro parameters description).

Since:

1.6M1

Version:

$Id: e7a58e24e68b0c724a014fc551909de15433b926 $

Method Summary

Modifier and Type	Method and Description
ContentDescriptor	getContentDescriptor()
String	getDefaultCategory() A macro can define a default classification category under which it falls.
String	getDescription()
MacroId	getId()
String	getName()
Map<String,ParameterDescriptor>	getParameterDescriptorMap() Get all the parameters descriptors.
Class<?>	getParametersBeanClass()
default boolean	supportsInlineMode()

Method Detail

getId

MacroId getId()

Returns:

the id of the macro

Since:

2.3M1

getName

String getName()

Returns:

the human-readable name of the macro (eg "Table Of Contents" for the TOC macro).

Since:

2.0M3

getDescription

String getDescription()

Returns:

the description of the macro.

getParametersBeanClass

Class<?> getParametersBeanClass()

Returns:

the class of the JAVA bean containing macro parameters.

getContentDescriptor

ContentDescriptor getContentDescriptor()

Returns:

describe the macro content. If null the macro does not support content.

Since:

1.9M1

getParameterDescriptorMap

Map<String,ParameterDescriptor> getParameterDescriptorMap()

Get all the parameters descriptors.

The Map key is lower case. ParameterDescriptor.getId() can be used to access the source parameter identifier (with the source case).

Returns:

a Map containing the ParameterDescriptor for each parameter (the keys are lower cased).

Since:

1.7M2

getDefaultCategory

String getDefaultCategory()

A macro can define a default classification category under which it falls. For an example, the "skype" macro would fall under the "Communication" category of macros. However, a wiki administrator has the ability to override the default category for a given macro in order to organize categories as he sees fit. Thus this default category is only an indication from the macro author about what category the macro should fall.

Returns:

the default category under which this macro should be listed or null if the macro doesn't have a default category defined

Since:

2.0M3

supportsInlineMode

default boolean supportsInlineMode()

Returns:

true if the macro can be inserted in some existing content such as a paragraph, a list item etc. For example if I have == hello {{velocity}}world{{/velocity}} then the Velocity macro must support the inline mode and not generate a paragraph.

Since:

10.10RC1