@Role
public interface WikiMacroFactory
Modifier and Type | Method and Description |
---|---|
boolean |
containsWikiMacro(org.xwiki.model.reference.DocumentReference documentReference)
Searches the given document for a wiki macro definition.
|
WikiMacro |
createWikiMacro(org.xwiki.model.reference.DocumentReference documentReference)
Tries to build a
WikiMacro if a definition is found on the given document. |
boolean |
isAllowed(org.xwiki.model.reference.DocumentReference documentReference,
WikiMacroVisibility visibility) |
boolean containsWikiMacro(org.xwiki.model.reference.DocumentReference documentReference)
documentReference
- name of the document to search for a wiki macro definition.WikiMacro createWikiMacro(org.xwiki.model.reference.DocumentReference documentReference) throws WikiMacroException
WikiMacro
if a definition is found on the given document.documentReference
- name of the document on which the macro is defined.WikiMacro
corresponding to the macro definition found.WikiMacroException
- if no macro definition is found or if an error is encountered while building
the macro.boolean isAllowed(org.xwiki.model.reference.DocumentReference documentReference, WikiMacroVisibility visibility)
documentReference
- the name of the document containing the wiki macro definitionvisibility
- the visibility requiredCopyright © 2004–2019 XWiki. All rights reserved.