A C F G H I M O R S U V W

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

C

containsWikiMacro(DocumentReference) - Method in interface org.xwiki.rendering.macro.wikibridge.WikiMacroFactory

Searches the given document for a wiki macro definition.

createWikiMacro(DocumentReference) - Method in interface org.xwiki.rendering.macro.wikibridge.WikiMacroFactory

Tries to build a WikiMacro if a definition is found on the given document.

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.

getContentDescriptor() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor

getDefaultCategory() - 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

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

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.

getParametersBeanClass() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor

getParameterType() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroParameterDescriptor

getType() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroParameterDescriptor

getVisibility() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor

H

hasWikiMacro(DocumentReference) - Method in interface org.xwiki.rendering.macro.wikibridge.WikiMacroManager

Utility method for querying WikiMacroManager to see if there is a WikiMacro already registered for the given document.

I

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 InsufficientPrivilegesException with the given error message.

isMandatory() - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroParameterDescriptor

M

matches(Object) - Method in class org.xwiki.rendering.macro.wikibridge.AbstractWikiMacroExecutionEvent

O

org.xwiki.rendering.macro.wikibridge - package org.xwiki.rendering.macro.wikibridge

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 WikiMacro against the ComponentManager matching the Wiki Macro visibility defined (Current User, Current Wiki, Global).

S

set(String, Object) - Method in class org.xwiki.rendering.macro.wikibridge.WikiMacroParameters

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).

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.

W

WikiMacro - Interface in org.xwiki.rendering.macro.wikibridge

Interface for defining wiki content based xwiki rendering macros.

WikiMacroDescriptor - Class in org.xwiki.rendering.macro.wikibridge

A MacroDescriptor for describing wiki macros.

WikiMacroDescriptor(MacroId, String, String, String, WikiMacroVisibility, ContentDescriptor, List<WikiMacroParameterDescriptor>) - Constructor for class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor

Creates a new WikiMacroDescriptor instance.

WikiMacroDescriptor(String, String, String, WikiMacroVisibility, ContentDescriptor, List<WikiMacroParameterDescriptor>) - Constructor for class org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor

Deprecated. since 2.3M1 use WikiMacroDescriptor(MacroId, String, String, String, WikiMacroVisibility, ContentDescriptor, List) instead

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 WikiMacroException with the given error message.

WikiMacroException(String, Throwable) - Constructor for exception org.xwiki.rendering.macro.wikibridge.WikiMacroException

Builds a new WikiMacroException with 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

ParameterDescriptor for describing wiki macro parameters.

WikiMacroParameterDescriptor(String, String, boolean) - Constructor for class org.xwiki.rendering.macro.wikibridge.WikiMacroParameterDescriptor

Creates a new WikiMacroParameterDescriptor instance.

WikiMacroParameterDescriptor(String, String, boolean, Object) - Constructor for class org.xwiki.rendering.macro.wikibridge.WikiMacroParameterDescriptor

Creates a new WikiMacroParameterDescriptor instance.

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

Creates a new WikiMacroParameters instance.

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.

A C F G H I M O R S U V W