A B C D F G H I M N O P R S U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractWikiMacroExecutionEvent - Class in org.xwiki.rendering.macro.wikibridge
-
Base class for all wiki macro execution related events.
- AbstractWikiMacroExecutionEvent() - Constructor for class org.xwiki.rendering.macro.wikibridge.AbstractWikiMacroExecutionEvent
B
- build() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor.Builder
- Builder() - Constructor for class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor.Builder
-
Default constructor.
C
- containsWikiMacro(DocumentReference) - Method in interface org.xwiki.rendering.macro.wikibridge.WikiMacroFactory
-
Searches the given document for a wiki macro definition.
- contentDescriptor(ContentDescriptor) - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor.Builder
- createWikiMacro(DocumentReference) - Method in interface org.xwiki.rendering.macro.wikibridge.WikiMacroFactory
-
Tries to build a
WikiMacroif a definition is found on the given document.
D
- defaultCategories(Collection<String>) - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor.Builder
- description(String) - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor.Builder
F
- fromString(String) - Static method in enum org.xwiki.rendering.macro.wikibridge.WikiMacroVisibility
-
Convert between a string representation of a Macro visibility and its matching enum.
G
- get(String) - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroParameters
-
Returns the parameter value associated with the propertyName provided.
- getAuthorReference() - Method in interface org.xwiki.rendering.macro.wikibridge.WikiMacro
- getContent() - Method in class org.xwiki.rendering.macro.wikibridge.binding.WikiMacroBinding
- getContentDescriptor() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor
- getContext() - Method in class org.xwiki.rendering.macro.wikibridge.binding.WikiMacroBinding
- getDefaultCategories() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor
- getDefaultValue() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroParameterDescriptor
- getDescription() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor
- getDescription() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroParameterDescriptor
- getDescriptor() - Method in class org.xwiki.rendering.macro.wikibridge.binding.WikiMacroBinding
- getDocumentReference() - Method in interface org.xwiki.rendering.macro.wikibridge.WikiMacro
- getId() - Method in interface org.xwiki.rendering.macro.wikibridge.WikiMacro
-
Deprecated.since 2.3M1, use
MacroDescriptor.getId()instead - getId() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor
- getId() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroParameterDescriptor
- getName() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor
- getName() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroParameterDescriptor
- getName() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroParameterMacroParameters
- getParameterDescriptorMap() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor
- getParameterNames() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroParameters
-
Returns the set of parameter names provided by user.
- getParameters() - Method in class org.xwiki.rendering.macro.wikibridge.binding.WikiMacroBinding
- getParametersBeanClass() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor
- getParameterType() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroParameterDescriptor
- getResult() - Method in class org.xwiki.rendering.macro.wikibridge.binding.WikiMacroBinding
- getType() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroParameterDescriptor
-
Deprecated.
- getVisibility() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor
- GLOBAL - org.xwiki.rendering.macro.wikibridge.WikiMacroVisibility
-
Macro visible for all wikis in a farm.
H
- hasWikiMacro(DocumentReference) - Method in interface org.xwiki.rendering.macro.wikibridge.WikiMacroManager
-
Utility method for querying
WikiMacroManagerto see if there is aWikiMacroalready registered for the given document.
I
- id(MacroId) - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor.Builder
- initialize(WikiMacro, WikiMacroParameters, String, MacroTransformationContext, Map<String, Object>) - Method in interface org.xwiki.rendering.macro.wikibridge.WikiMacroBindingInitializer
-
Deprecated.Initialize the binding provided to the script macros.
- initialize(WikiMacro, WikiMacroParameters, String, MacroTransformationContext, WikiMacroBinding) - Method in interface org.xwiki.rendering.macro.wikibridge.binding.WikiMacroBindingInitializer
-
Initialize the binding provided to the script macros.
- installOrUpgradeWikiMacroClasses() - Method in interface org.xwiki.rendering.macro.wikibridge.WikiMacroInitializer
-
Installs or upgrades xwiki classes required for defining wiki macros.
- InsufficientPrivilegesException - Exception in org.xwiki.rendering.macro.wikibridge
-
Indicate that a Wiki Macro operation is refused because of insufficient user privileges.
- InsufficientPrivilegesException(String) - Constructor for exception org.xwiki.rendering.macro.wikibridge.InsufficientPrivilegesException
-
Builds a new
InsufficientPrivilegesExceptionwith the given error message. - isAllowed(DocumentReference, WikiMacroVisibility) - Method in interface org.xwiki.rendering.macro.wikibridge.WikiMacroFactory
- isMandatory() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroParameterDescriptor
M
- matches(Object) - Method in class org.xwiki.rendering.macro.wikibridge.AbstractWikiMacroExecutionEvent
N
- name(String) - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor.Builder
O
- org.xwiki.rendering.macro.wikibridge - package org.xwiki.rendering.macro.wikibridge
- org.xwiki.rendering.macro.wikibridge.binding - package org.xwiki.rendering.macro.wikibridge.binding
P
- parameterDescriptors(List<WikiMacroParameterDescriptor>) - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor.Builder
R
- registerExistingWikiMacros() - Method in interface org.xwiki.rendering.macro.wikibridge.WikiMacroInitializer
-
Searches for all the wiki macro definitions on the system and registers them against the macro manager.
- registerExistingWikiMacros(String) - Method in interface org.xwiki.rendering.macro.wikibridge.WikiMacroInitializer
-
Searches for all the wiki macro definitions in the specified wiki and registers them against the macro manager.
- registerWikiMacro(DocumentReference, WikiMacro) - Method in interface org.xwiki.rendering.macro.wikibridge.WikiMacroManager
-
Registers the given
WikiMacroagainst the ComponentManager matching the Wiki Macro visibility defined (Current User, Current Wiki, Global). - replaceAll(WikiMacroBinding) - Method in class org.xwiki.rendering.macro.wikibridge.binding.WikiMacroBinding
-
Replace all the content of the current binding with the given binding.
S
- set(String, Object) - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroParameters
- setContent(String) - Method in class org.xwiki.rendering.macro.wikibridge.binding.WikiMacroBinding
- setContext(MacroTransformationContext) - Method in class org.xwiki.rendering.macro.wikibridge.binding.WikiMacroBinding
- setDescriptor(MacroDescriptor) - Method in class org.xwiki.rendering.macro.wikibridge.binding.WikiMacroBinding
- setName(String) - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroParameterMacroParameters
-
Set the name...
- setParameters(WikiMacroParameters) - Method in class org.xwiki.rendering.macro.wikibridge.binding.WikiMacroBinding
- setResult(Object) - Method in class org.xwiki.rendering.macro.wikibridge.binding.WikiMacroBinding
-
Allows to set a result during the execution of the macro, which can be retrieved with
WikiMacroBinding.getResult(). - supportsInlineMode() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor
- supportsInlineMode(boolean) - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor.Builder
U
- unregisterWikiMacro(DocumentReference) - Method in interface org.xwiki.rendering.macro.wikibridge.WikiMacroManager
-
Unregisters the wiki macro defined on the given document (if there is one).
- USER - org.xwiki.rendering.macro.wikibridge.WikiMacroVisibility
-
Macro visible only by the current user.
V
- valueOf(String) - Static method in enum org.xwiki.rendering.macro.wikibridge.WikiMacroVisibility
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.xwiki.rendering.macro.wikibridge.WikiMacroVisibility
-
Returns an array containing the constants of this enum type, in the order they are declared.
- visibility(WikiMacroVisibility) - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor.Builder
W
- WIKI - org.xwiki.rendering.macro.wikibridge.WikiMacroVisibility
-
Macro visible only for the current wiki.
- WikiMacro - Interface in org.xwiki.rendering.macro.wikibridge
-
Interface for defining wiki content based xwiki rendering macros.
- WikiMacroBinding - Class in org.xwiki.rendering.macro.wikibridge.binding
-
Binding representation for the wikimacros.
- WikiMacroBinding(MacroDescriptor, WikiMacroParameters, String, MacroTransformationContext) - Constructor for class org.xwiki.rendering.macro.wikibridge.binding.WikiMacroBinding
-
Default constructor.
- WikiMacroBindingInitializer - Interface in org.xwiki.rendering.macro.wikibridge.binding
-
Initialize the binding provided to the script macros.
- WikiMacroBindingInitializer - Interface in org.xwiki.rendering.macro.wikibridge
-
Deprecated.Since 11.6RC1, 10.11.9, 11.3.2. Use
WikiMacroBindingInitializerinstead. - WikiMacroDescriptor - Class in org.xwiki.rendering.macro.wikibridge
-
A
MacroDescriptorfor describing wiki macros. - WikiMacroDescriptor.Builder - Class in org.xwiki.rendering.macro.wikibridge
-
Use this to build instance of
WikiMacroDescriptor. - WikiMacroException - Exception in org.xwiki.rendering.macro.wikibridge
-
Indicate a problem when using the Wiki Macro API.
- WikiMacroException(String) - Constructor for exception org.xwiki.rendering.macro.wikibridge.WikiMacroException
-
Builds a new
WikiMacroExceptionwith the given error message. - WikiMacroException(String, Throwable) - Constructor for exception org.xwiki.rendering.macro.wikibridge.WikiMacroException
-
Builds a new
WikiMacroExceptionwith the given error message and cause. - WikiMacroExecutionFinishedEvent - Class in org.xwiki.rendering.macro.wikibridge
-
Sent when a wiki macro finished execution.
- WikiMacroExecutionFinishedEvent() - Constructor for class org.xwiki.rendering.macro.wikibridge.WikiMacroExecutionFinishedEvent
- WikiMacroExecutionStartsEvent - Class in org.xwiki.rendering.macro.wikibridge
-
Sent before a wiki macro starts execution.
- WikiMacroExecutionStartsEvent() - Constructor for class org.xwiki.rendering.macro.wikibridge.WikiMacroExecutionStartsEvent
- WikiMacroFactory - Interface in org.xwiki.rendering.macro.wikibridge
-
Create a Wiki Macro object by gathering the Macro metadata from a document.
- WikiMacroInitializer - Interface in org.xwiki.rendering.macro.wikibridge
-
Responsible for registering wiki macros against the ComponentManager at XE startup.
- WikiMacroManager - Interface in org.xwiki.rendering.macro.wikibridge
-
Component interface responsible for managing wiki macro instances.
- WikiMacroParameterDescriptor - Class in org.xwiki.rendering.macro.wikibridge
-
ParameterDescriptorfor describing wiki macro parameters. - WikiMacroParameterDescriptor(String, String, boolean) - Constructor for class org.xwiki.rendering.macro.wikibridge.WikiMacroParameterDescriptor
-
Creates a new
WikiMacroParameterDescriptorinstance. - WikiMacroParameterDescriptor(String, String, boolean, Object) - Constructor for class org.xwiki.rendering.macro.wikibridge.WikiMacroParameterDescriptor
-
Creates a new
WikiMacroParameterDescriptorinstance. - WikiMacroParameterDescriptor(String, String, boolean, Object, Type) - Constructor for class org.xwiki.rendering.macro.wikibridge.WikiMacroParameterDescriptor
-
Creates a new
WikiMacroParameterDescriptorinstance. - WikiMacroParameterMacroParameters - Class in org.xwiki.rendering.macro.wikibridge
-
Parameters for wikimacroparameter macro.
- WikiMacroParameterMacroParameters() - Constructor for class org.xwiki.rendering.macro.wikibridge.WikiMacroParameterMacroParameters
- WikiMacroParameters - Class in org.xwiki.rendering.macro.wikibridge
-
Generic parameters class for all wiki macros.
- WikiMacroParameters() - Constructor for class org.xwiki.rendering.macro.wikibridge.WikiMacroParameters
- WikiMacroVisibility - Enum in org.xwiki.rendering.macro.wikibridge
-
The visibility of a Wiki Macro, ie whether it's visible to the current user only, to the current wiki only or globally.
All Classes All Packages