public class WikiMacroDescriptor extends Object implements org.xwiki.rendering.macro.descriptor.MacroDescriptor
MacroDescriptor
for describing wiki macros.Modifier and Type | Class and Description |
---|---|
static class |
WikiMacroDescriptor.Builder
Use this to build instance of
WikiMacroDescriptor . |
Constructor and Description |
---|
WikiMacroDescriptor(org.xwiki.rendering.macro.MacroId id,
String name,
String description,
String defaultCategory,
WikiMacroVisibility visibility,
org.xwiki.rendering.macro.descriptor.ContentDescriptor contentDescriptor,
List<WikiMacroParameterDescriptor> parameterDescriptors)
Deprecated.
since 10.10RC1 use the
WikiMacroDescriptor.Builder instead |
WikiMacroDescriptor(String name,
String description,
String defaultCategory,
WikiMacroVisibility visibility,
org.xwiki.rendering.macro.descriptor.ContentDescriptor contentDescriptor,
List<WikiMacroParameterDescriptor> parameterDescriptors)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
org.xwiki.rendering.macro.descriptor.ContentDescriptor |
getContentDescriptor() |
String |
getDefaultCategory() |
String |
getDescription() |
org.xwiki.rendering.macro.MacroId |
getId() |
String |
getName() |
Map<String,org.xwiki.rendering.macro.descriptor.ParameterDescriptor> |
getParameterDescriptorMap() |
Class<?> |
getParametersBeanClass() |
WikiMacroVisibility |
getVisibility() |
boolean |
supportsInlineMode() |
@Deprecated public WikiMacroDescriptor(org.xwiki.rendering.macro.MacroId id, String name, String description, String defaultCategory, WikiMacroVisibility visibility, org.xwiki.rendering.macro.descriptor.ContentDescriptor contentDescriptor, List<WikiMacroParameterDescriptor> parameterDescriptors)
WikiMacroDescriptor.Builder
insteadWikiMacroDescriptor
instance.id
- the macro idname
- the macro namedescription
- macro descriptiondefaultCategory
- default category under which this macro should be listed.visibility
- the macro visibility (only visible in the current wiki, for the current user or global)contentDescriptor
- macro content description.parameterDescriptors
- parameter descriptors.@Deprecated public WikiMacroDescriptor(String name, String description, String defaultCategory, WikiMacroVisibility visibility, org.xwiki.rendering.macro.descriptor.ContentDescriptor contentDescriptor, List<WikiMacroParameterDescriptor> parameterDescriptors)
WikiMacroDescriptor(MacroId, String, String, String, WikiMacroVisibility, ContentDescriptor, List)
insteadWikiMacroDescriptor
instance.name
- the macro namedescription
- macro descriptiondefaultCategory
- default category under which this macro should be listed.visibility
- the macro visibility (only visible in the current wiki, for the current user or global)contentDescriptor
- macro content description.parameterDescriptors
- parameter descriptors.public org.xwiki.rendering.macro.MacroId getId()
getId
in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor
public String getName()
getName
in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor
public String getDescription()
getDescription
in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor
public org.xwiki.rendering.macro.descriptor.ContentDescriptor getContentDescriptor()
getContentDescriptor
in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor
public Class<?> getParametersBeanClass()
getParametersBeanClass
in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor
public Map<String,org.xwiki.rendering.macro.descriptor.ParameterDescriptor> getParameterDescriptorMap()
getParameterDescriptorMap
in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor
public String getDefaultCategory()
getDefaultCategory
in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor
public WikiMacroVisibility getVisibility()
public boolean supportsInlineMode()
supportsInlineMode
in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor
Copyright © 2004–2021 XWiki. All rights reserved.