Skip navigation links
A B C D E G H I M O P S T 

A

AbstractMacro<P> - Class in org.xwiki.rendering.macro
Helper to implement Macro, providing some default implementation.
AbstractMacro(String) - Constructor for class org.xwiki.rendering.macro.AbstractMacro
Creates a new Macro instance.
AbstractMacro(String, String) - Constructor for class org.xwiki.rendering.macro.AbstractMacro
Creates a new Macro instance.
AbstractMacro(String, String, ContentDescriptor) - Constructor for class org.xwiki.rendering.macro.AbstractMacro
Creates a new Macro instance.
AbstractMacro(String, String, Class<?>) - Constructor for class org.xwiki.rendering.macro.AbstractMacro
Creates a new Macro instance.
AbstractMacro(String, String, ContentDescriptor, Class<?>) - Constructor for class org.xwiki.rendering.macro.AbstractMacro
Creates a new Macro instance.
AbstractMacroDescriptor - Class in org.xwiki.rendering.macro.descriptor
Describe a macro.
AbstractMacroDescriptor(MacroId, String, String, ContentDescriptor, BeanDescriptor) - Constructor for class org.xwiki.rendering.macro.descriptor.AbstractMacroDescriptor
 
AbstractMacroDescriptor(String, String, ContentDescriptor, BeanDescriptor) - Constructor for class org.xwiki.rendering.macro.descriptor.AbstractMacroDescriptor
AbstractNoParameterMacro - Class in org.xwiki.rendering.macro
Base class for a macro which does not support any parameter.
AbstractNoParameterMacro(String) - Constructor for class org.xwiki.rendering.macro.AbstractNoParameterMacro
Create and initialize a descriptor with no parameters.
AbstractNoParameterMacro(String, String) - Constructor for class org.xwiki.rendering.macro.AbstractNoParameterMacro
Create and initialize a descriptor with no parameters.
AbstractNoParameterMacro(String, String, ContentDescriptor) - Constructor for class org.xwiki.rendering.macro.AbstractNoParameterMacro
Create and initialize a descriptor with no parameters.

B

beanManager - Variable in class org.xwiki.rendering.macro.AbstractMacro
The BeanManager component.

C

clone() - Method in class org.xwiki.rendering.transformation.MacroTransformationContext
 
compareTo(Macro<?>) - Method in class org.xwiki.rendering.macro.AbstractMacro
 
ContentDescriptor - Interface in org.xwiki.rendering.macro.descriptor
Define a macro content.
createMacroId(String) - Method in interface org.xwiki.rendering.macro.MacroIdFactory
 

D

DEFAULT_CATEGORY_CONTENT - Static variable in class org.xwiki.rendering.macro.AbstractMacro
"Content" default macro category.
DEFAULT_CATEGORY_DEVELOPMENT - Static variable in class org.xwiki.rendering.macro.AbstractMacro
"Development" default macro category.
DEFAULT_CATEGORY_FORMATTING - Static variable in class org.xwiki.rendering.macro.AbstractMacro
"Formatting" default macro category.
DEFAULT_CATEGORY_INTERNAL - Static variable in class org.xwiki.rendering.macro.AbstractMacro
"Internal" default macro category.
DEFAULT_CATEGORY_LAYOUT - Static variable in class org.xwiki.rendering.macro.AbstractMacro
"Layout" default macro category.
DEFAULT_CATEGORY_NAVIGATION - Static variable in class org.xwiki.rendering.macro.AbstractMacro
"Navigation" default macro category.
DEFAULT_CONTENT_TYPE - Static variable in class org.xwiki.rendering.macro.descriptor.DefaultContentDescriptor
Default content type of all content descriptors.
DEFAULT_PARAMETER_TYPE - Static variable in class org.xwiki.rendering.macro.descriptor.DefaultParameterDescriptor
Default content type of all content descriptors.
DefaultContentDescriptor - Class in org.xwiki.rendering.macro.descriptor
The default implementation of ContentDescriptor.
DefaultContentDescriptor() - Constructor for class org.xwiki.rendering.macro.descriptor.DefaultContentDescriptor
Default constructor.
DefaultContentDescriptor(String) - Constructor for class org.xwiki.rendering.macro.descriptor.DefaultContentDescriptor
 
DefaultContentDescriptor(boolean) - Constructor for class org.xwiki.rendering.macro.descriptor.DefaultContentDescriptor
 
DefaultContentDescriptor(String, boolean) - Constructor for class org.xwiki.rendering.macro.descriptor.DefaultContentDescriptor
 
DefaultContentDescriptor(String, boolean, Type) - Constructor for class org.xwiki.rendering.macro.descriptor.DefaultContentDescriptor
 
DefaultMacroDescriptor - Class in org.xwiki.rendering.macro.descriptor
Describe a macro with no parameters.
DefaultMacroDescriptor(MacroId, String) - Constructor for class org.xwiki.rendering.macro.descriptor.DefaultMacroDescriptor
 
DefaultMacroDescriptor(MacroId, String, String) - Constructor for class org.xwiki.rendering.macro.descriptor.DefaultMacroDescriptor
 
DefaultMacroDescriptor(MacroId, String, String, ContentDescriptor) - Constructor for class org.xwiki.rendering.macro.descriptor.DefaultMacroDescriptor
 
DefaultMacroDescriptor(MacroId, String, String, ContentDescriptor, BeanDescriptor) - Constructor for class org.xwiki.rendering.macro.descriptor.DefaultMacroDescriptor
 
DefaultParameterDescriptor - Class in org.xwiki.rendering.macro.descriptor
The default implementation of ParameterDescriptor.
DefaultParameterDescriptor(PropertyDescriptor) - Constructor for class org.xwiki.rendering.macro.descriptor.DefaultParameterDescriptor
Creates a new DefaultParameterDescriptor instance using the given PropertyDescriptor.

E

equals(Object) - Method in class org.xwiki.rendering.macro.MacroId
 
execute(P, String, MacroTransformationContext) - Method in interface org.xwiki.rendering.macro.Macro
Executes the macro.
exists(MacroId) - Method in interface org.xwiki.rendering.macro.MacroManager
 
extractParameterDescriptorMap() - Method in class org.xwiki.rendering.macro.descriptor.AbstractMacroDescriptor

G

getCategories() - Method in interface org.xwiki.rendering.transformation.macro.MacroTransformationConfiguration
 
getContentDescriptor() - Method in class org.xwiki.rendering.macro.descriptor.AbstractMacroDescriptor
 
getContentDescriptor() - Method in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor
 
getCurrentMacroBlock() - Method in class org.xwiki.rendering.transformation.MacroTransformationContext
 
getCurrentSyntax(MacroTransformationContext) - Method in interface org.xwiki.rendering.macro.MacroContentParser
Find the current syntax to use for macro supporting wiki content/parameters/whatever.
getDefaultCategory() - Method in class org.xwiki.rendering.macro.descriptor.AbstractMacroDescriptor
 
getDefaultCategory() - Method in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor
A macro can define a default classification category under which it falls.
getDefaultValue() - Method in class org.xwiki.rendering.macro.descriptor.DefaultParameterDescriptor
 
getDefaultValue() - Method in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor
 
getDescription() - Method in class org.xwiki.rendering.macro.descriptor.AbstractMacroDescriptor
 
getDescription() - Method in interface org.xwiki.rendering.macro.descriptor.ContentDescriptor
 
getDescription() - Method in class org.xwiki.rendering.macro.descriptor.DefaultContentDescriptor
 
getDescription() - Method in class org.xwiki.rendering.macro.descriptor.DefaultParameterDescriptor
 
getDescription() - Method in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor
 
getDescription() - Method in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor
 
getDescriptor() - Method in class org.xwiki.rendering.macro.AbstractMacro
 
getDescriptor() - Method in interface org.xwiki.rendering.macro.Macro
 
getDisplayType() - Method in class org.xwiki.rendering.macro.descriptor.DefaultParameterDescriptor
 
getDisplayType() - Method in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor
 
getGroupDescriptor() - Method in class org.xwiki.rendering.macro.descriptor.DefaultParameterDescriptor
 
getGroupDescriptor() - Method in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor
 
getId() - Method in class org.xwiki.rendering.macro.descriptor.AbstractMacroDescriptor
getId() - Method in class org.xwiki.rendering.macro.descriptor.DefaultParameterDescriptor
 
getId() - Method in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor
 
getId() - Method in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor
 
getId() - Method in class org.xwiki.rendering.macro.MacroId
 
getId() - Method in class org.xwiki.rendering.transformation.MacroTransformationContext
 
getMacro(MacroId) - Method in interface org.xwiki.rendering.macro.MacroManager
 
getMacroCategories() - Method in interface org.xwiki.rendering.macro.MacroCategoryManager
Returns all the macro categories currently available in the system.
getMacroCategories(Syntax) - Method in interface org.xwiki.rendering.macro.MacroCategoryManager
Returns all the macro categories currently available in the system for macros registered for a given syntax and for all syntaxes.
getMacroIds(String) - Method in interface org.xwiki.rendering.macro.MacroCategoryManager
 
getMacroIds(String, Syntax) - Method in interface org.xwiki.rendering.macro.MacroCategoryManager
 
getMacroIds() - Method in interface org.xwiki.rendering.macro.MacroManager
 
getMacroIds(Syntax) - Method in interface org.xwiki.rendering.macro.MacroManager
 
getName() - Method in class org.xwiki.rendering.macro.descriptor.AbstractMacroDescriptor
getName() - Method in class org.xwiki.rendering.macro.descriptor.DefaultParameterDescriptor
 
getName() - Method in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor
 
getName() - Method in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor
 
getNonGeneratedContentMetaData(ContentDescriptor) - Static method in class org.xwiki.rendering.macro.AbstractMacro
Helper to get the proper metadata for non generated content (i.e.
getNonGeneratedContentMetaData() - Method in class org.xwiki.rendering.macro.AbstractMacro
Helper to get the proper metadata for non generated content (i.e.
getNonGeneratedContentMetaData(Map<String, ParameterDescriptor>, String) - Static method in class org.xwiki.rendering.macro.AbstractMacro
Helper to get the proper metadata for non generated content (i.e.
getNonGeneratedContentMetaData(String) - Method in class org.xwiki.rendering.macro.AbstractMacro
Helper to get the proper metadata for non generated content (i.e.
getParameterDescriptorMap() - Method in class org.xwiki.rendering.macro.descriptor.AbstractMacroDescriptor
 
getParameterDescriptorMap() - Method in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor
Get all the parameters descriptors.
getParametersBeanClass() - Method in class org.xwiki.rendering.macro.descriptor.AbstractMacroDescriptor
 
getParametersBeanClass() - Method in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor
 
getParameterType() - Method in class org.xwiki.rendering.macro.descriptor.DefaultParameterDescriptor
 
getParameterType() - Method in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor
 
getPriority() - Method in class org.xwiki.rendering.macro.AbstractMacro
 
getPriority() - Method in interface org.xwiki.rendering.macro.Macro
The priority of execution relative to the other Macros.
getSyntax() - Method in class org.xwiki.rendering.macro.MacroId
 
getSyntax() - Method in class org.xwiki.rendering.transformation.MacroTransformationContext
 
getTransformation() - Method in class org.xwiki.rendering.transformation.MacroTransformationContext
 
getTransformationContext() - Method in class org.xwiki.rendering.transformation.MacroTransformationContext
 
getType() - Method in interface org.xwiki.rendering.macro.descriptor.ContentDescriptor
This method will return the type of the macro content.
getType() - Method in class org.xwiki.rendering.macro.descriptor.DefaultContentDescriptor
 
getType() - Method in class org.xwiki.rendering.macro.descriptor.DefaultParameterDescriptor
Deprecated.
getType() - Method in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor
Deprecated.
getXDOM() - Method in class org.xwiki.rendering.transformation.MacroTransformationContext
 

H

hashCode() - Method in class org.xwiki.rendering.macro.MacroId
 

I

initialize() - Method in class org.xwiki.rendering.macro.AbstractMacro
 
isAdvanced() - Method in class org.xwiki.rendering.macro.descriptor.DefaultParameterDescriptor
 
isAdvanced() - Method in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor
 
isDeprecated() - Method in class org.xwiki.rendering.macro.descriptor.DefaultParameterDescriptor
 
isDeprecated() - Method in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor
 
isInline() - Method in class org.xwiki.rendering.transformation.MacroTransformationContext
 
isMandatory() - Method in interface org.xwiki.rendering.macro.descriptor.ContentDescriptor
 
isMandatory() - Method in class org.xwiki.rendering.macro.descriptor.DefaultContentDescriptor
 
isMandatory() - Method in class org.xwiki.rendering.macro.descriptor.DefaultParameterDescriptor
 
isMandatory() - Method in interface org.xwiki.rendering.macro.descriptor.ParameterDescriptor
 

M

Macro<P> - Interface in org.xwiki.rendering.macro
Represents a Macro, ie a mechanism to generate Rendering Blocks, that we use as a way to either generate dynamic content or simply as a way to reuse Blocks in content.
MacroCategoryManager - Interface in org.xwiki.rendering.macro
Component interface for managing macro category information.
MacroContentParser - Interface in org.xwiki.rendering.macro
Parses content of a macro field (parameter, macro content) in a given syntax.
MacroDescriptor - Interface in org.xwiki.rendering.macro.descriptor
Describe a Macro (macro description and macro parameters description).
MacroExecutionException - Exception in org.xwiki.rendering.macro
Encapsulate a rendering error.
MacroExecutionException(String) - Constructor for exception org.xwiki.rendering.macro.MacroExecutionException
Constructs a new exception with the specified detail message.
MacroExecutionException(String, Throwable) - Constructor for exception org.xwiki.rendering.macro.MacroExecutionException
Constructs a new exception with the specified detail message and cause.
MacroId - Class in org.xwiki.rendering.macro
Represents a Macro identifier.
MacroId(String) - Constructor for class org.xwiki.rendering.macro.MacroId
Constructor for macros registered for all syntaxes.
MacroId(String, Syntax) - Constructor for class org.xwiki.rendering.macro.MacroId
Constructor for macros registered for a specific syntax only.
MacroIdFactory - Interface in org.xwiki.rendering.macro
Convert a string representing a macro id into a typed MacroId object.
MacroLookupException - Exception in org.xwiki.rendering.macro
Encapsulate macro lookup error.
MacroLookupException(String) - Constructor for exception org.xwiki.rendering.macro.MacroLookupException
 
MacroLookupException(String, Throwable) - Constructor for exception org.xwiki.rendering.macro.MacroLookupException
 
MacroManager - Interface in org.xwiki.rendering.macro
Allow retrieving and test the existence of macros.
MacroNotFoundException - Exception in org.xwiki.rendering.macro
Error to signify that the macro doesn't exist.
MacroNotFoundException(String) - Constructor for exception org.xwiki.rendering.macro.MacroNotFoundException
 
MacroNotFoundException(String, Throwable) - Constructor for exception org.xwiki.rendering.macro.MacroNotFoundException
 
MacroParameterException - Exception in org.xwiki.rendering.macro.parameter
Encapsulate macro parameter error.
MacroParameterException(String) - Constructor for exception org.xwiki.rendering.macro.parameter.MacroParameterException
Constructs a new exception with the specified detail message.
MacroParameterException(String, Throwable) - Constructor for exception org.xwiki.rendering.macro.parameter.MacroParameterException
Constructs a new exception with the specified detail message and cause.
MacroTransformationConfiguration - Interface in org.xwiki.rendering.transformation.macro
Configuration properties for the Macro Transformation module.
MacroTransformationContext - Class in org.xwiki.rendering.transformation
The context of the macro transformation process.
MacroTransformationContext() - Constructor for class org.xwiki.rendering.transformation.MacroTransformationContext
Constructor.
MacroTransformationContext(TransformationContext) - Constructor for class org.xwiki.rendering.transformation.MacroTransformationContext
Constructor.

O

org.xwiki.rendering.macro - package org.xwiki.rendering.macro
 
org.xwiki.rendering.macro.descriptor - package org.xwiki.rendering.macro.descriptor
 
org.xwiki.rendering.macro.parameter - package org.xwiki.rendering.macro.parameter
 
org.xwiki.rendering.transformation - package org.xwiki.rendering.transformation
 
org.xwiki.rendering.transformation.macro - package org.xwiki.rendering.transformation.macro
 

P

ParameterDescriptor - Interface in org.xwiki.rendering.macro.descriptor
Define a macro parameter.
ParameterValueTooHighException - Exception in org.xwiki.rendering.macro.parameter
Deprecated.
use Max instead
ParameterValueTooHighException(int) - Constructor for exception org.xwiki.rendering.macro.parameter.ParameterValueTooHighException
Deprecated.
 
ParameterValueTooLowException - Exception in org.xwiki.rendering.macro.parameter
Deprecated.
use Min instead
ParameterValueTooLowException(int) - Constructor for exception org.xwiki.rendering.macro.parameter.ParameterValueTooLowException
Deprecated.
 
parse(String, MacroTransformationContext, boolean, boolean) - Method in interface org.xwiki.rendering.macro.MacroContentParser
Parses content of a macro field (parameter, macro content) in a given syntax and optionally remove the top level paragraph.
parse(String, MacroTransformationContext, boolean, MetaData, boolean) - Method in interface org.xwiki.rendering.macro.MacroContentParser
Parses content of a macro field (parameter, macro content) in a given syntax and optionally remove the top level paragraph.

S

setCurrentMacroBlock(MacroBlock) - Method in class org.xwiki.rendering.transformation.MacroTransformationContext
 
setDefaultCategory(String) - Method in class org.xwiki.rendering.macro.AbstractMacro
Allows sub classes to set the default macro category.
setDefaultCategory(String) - Method in class org.xwiki.rendering.macro.descriptor.AbstractMacroDescriptor
 
setDescriptor(MacroDescriptor) - Method in class org.xwiki.rendering.macro.AbstractMacro
Allows macro classes extending other macro classes to override the macro descriptor with their own.
setId(String) - Method in class org.xwiki.rendering.transformation.MacroTransformationContext
 
setInline(boolean) - Method in class org.xwiki.rendering.transformation.MacroTransformationContext
 
setPriority(int) - Method in class org.xwiki.rendering.macro.AbstractMacro
 
setSupportsInlineMode(boolean) - Method in class org.xwiki.rendering.macro.descriptor.AbstractMacroDescriptor
 
setSyntax(Syntax) - Method in class org.xwiki.rendering.transformation.MacroTransformationContext
 
setTransformation(Transformation) - Method in class org.xwiki.rendering.transformation.MacroTransformationContext
 
setXDOM(XDOM) - Method in class org.xwiki.rendering.transformation.MacroTransformationContext
 
supportsInlineMode() - Method in class org.xwiki.rendering.macro.descriptor.AbstractMacroDescriptor
 
supportsInlineMode() - Method in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor
 
supportsInlineMode() - Method in interface org.xwiki.rendering.macro.Macro
 

T

toString() - Method in class org.xwiki.rendering.macro.MacroId
 
A B C D E G H I M O P S T 
Skip navigation links

Copyright © 2004–2019 XWiki. All rights reserved.