org.xwiki.rendering.macro.descriptor

Class DefaultMacroDescriptor

java.lang.Object

org.xwiki.rendering.macro.descriptor.AbstractMacroDescriptor

org.xwiki.rendering.macro.descriptor.DefaultMacroDescriptor

All Implemented Interfaces:

MacroDescriptor

public class DefaultMacroDescriptor
extends AbstractMacroDescriptor

Describe a macro with no parameters.

Since:

1.6M1

Version:

$Id: c3b43bb8618ca0a4b265407d59e7eca92a2aaf3b $

Constructor Summary

Constructors

Constructor and Description
DefaultMacroDescriptor(MacroId id, String name)
DefaultMacroDescriptor(MacroId id, String name, String description)
DefaultMacroDescriptor(MacroId id, String name, String description, ContentDescriptor contentDescriptor)
DefaultMacroDescriptor(MacroId id, String name, String description, ContentDescriptor contentDescriptor, org.xwiki.properties.BeanDescriptor parametersBeanDescriptor)

Method Summary

Methods inherited from class org.xwiki.rendering.macro.descriptor.AbstractMacroDescriptor

extractParameterDescriptorMap, getContentDescriptor, getDefaultCategory, getDescription, getId, getName, getParameterDescriptorMap, getParametersBeanClass, setDefaultCategory

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMacroDescriptor

public DefaultMacroDescriptor(MacroId id,
                              String name)

Parameters:

id - the id of the macro

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

Since:

2.3M1

DefaultMacroDescriptor

public DefaultMacroDescriptor(MacroId id,
                              String name,
                              String description)

Parameters:

id - the id of the macro

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

description - the description of the macro.

Since:

2.3M1

DefaultMacroDescriptor

public DefaultMacroDescriptor(MacroId id,
                              String name,
                              String description,
                              ContentDescriptor contentDescriptor)

Parameters:

id - the id of the macro

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

description - the description of the macro.

contentDescriptor - description of the macro content.

Since:

2.3M1

DefaultMacroDescriptor

public DefaultMacroDescriptor(MacroId id,
                              String name,
                              String description,
                              ContentDescriptor contentDescriptor,
                              org.xwiki.properties.BeanDescriptor parametersBeanDescriptor)

Parameters:

id - the id of the macro

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

description - the description of the macro.

contentDescriptor - the description of the macro content. null indicate macro does not support content.

parametersBeanDescriptor - the description of the parameters bean.

Since:

2.3M1