public class

XhtmlMacroModuleDescriptor

extends AbstractModuleDescriptor<T>
implements MacroMetadataSource
java.lang.Object
   ↳ com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
     ↳ com.atlassian.confluence.plugin.descriptor.XhtmlMacroModuleDescriptor

Summary

[Expand]
Inherited Fields
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
Public Constructors
XhtmlMacroModuleDescriptor(ModuleFactory moduleFactory, MacroMetadataParser metadataParser)
Public Methods
void disabled()
void enabled()
ResourceDescriptor getHelpDescriptor()
Returns the macro help descriptor, or null if there is no help.
String getHelpSection()
Returns the section of notation guide in which the macro help appears.
MacroMetadata getMacroMetadata()
Macro getModule()
boolean hasHelp()
Returns true if the macro has help, otherwise false.
void init(Plugin plugin, Element element)
[Expand]
Inherited Methods
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
From class java.lang.Object
From interface com.atlassian.confluence.macro.browser.MacroMetadataSource
From interface com.atlassian.plugin.ModuleDescriptor
From interface com.atlassian.plugin.Resourced
From interface com.atlassian.plugin.StateAware

Public Constructors

public XhtmlMacroModuleDescriptor (ModuleFactory moduleFactory, MacroMetadataParser metadataParser)

Public Methods

public void disabled ()

public void enabled ()

public ResourceDescriptor getHelpDescriptor ()

Returns the macro help descriptor, or null if there is no help. The help is defined as a resource with type "velocity" and name "help" inside the macro descriptor. The resource tag can have a location attribute, referring to a file within the plugin, or a body.

public String getHelpSection ()

Returns the section of notation guide in which the macro help appears. Should be one of the values defined in NotationHelpAction#SECTION_KEYS.

Throws
IllegalStateException if this is called when #hasHelp() is false

public MacroMetadata getMacroMetadata ()

public Macro getModule ()

public boolean hasHelp ()

Returns true if the macro has help, otherwise false. Help can be provided by defining a resource inside the macro descriptor in the plugin XML descriptor file. The help resource has a type of "velocity" and a name of "help". It can have either a body or a "location" attribute with a reference to a Velocity file within the plugin.

public void init (Plugin plugin, Element element)

Throws
PluginParseException