Uses of Class
com.atlassian.confluence.xhtml.api.MacroDefinition

Packages that use MacroDefinition

Package	Description
com.atlassian.confluence.content.render.xhtml
com.atlassian.confluence.content.render.xhtml.editor.macro
com.atlassian.confluence.content.render.xhtml.macro
com.atlassian.confluence.content.render.xhtml.migration
com.atlassian.confluence.content.render.xhtml.storage
com.atlassian.confluence.content.render.xhtml.storage.macro
com.atlassian.confluence.content.render.xhtml.view.macro
com.atlassian.confluence.diff.marshallers
com.atlassian.confluence.impl.content.render.xhtml.editor.macro
com.atlassian.confluence.impl.macro.schema
com.atlassian.confluence.internal.diagnostics
com.atlassian.confluence.macro
com.atlassian.confluence.macro.count
com.atlassian.confluence.macro.xhtml
com.atlassian.confluence.util
com.atlassian.confluence.xhtml.api

Uses of MacroDefinition in com.atlassian.confluence.content.render.xhtml

Methods in com.atlassian.confluence.content.render.xhtml that return MacroDefinition

Modifier and Type	Method	Description
MacroDefinition	DefaultEditorFormatService.convertEditToMacroDefinition(String editFragment, ConversionContext context)

Methods in com.atlassian.confluence.content.render.xhtml with parameters of type MacroDefinition

Modifier and Type	Method	Description
String	DefaultEditorFormatService.convertMacroDefinitionToEdit(MacroDefinition macroDefinition, ConversionContext context)
String	DefaultXhtmlContent.convertMacroDefinitionToStorage(MacroDefinition macroDefinition, ConversionContext context)
String	DefaultXhtmlContent.convertMacroDefinitionToView(MacroDefinition macroDefinition, ConversionContext context)

Constructor parameters in com.atlassian.confluence.content.render.xhtml with type arguments of type MacroDefinition

Constructor	Description
DefaultEditorFormatService(Marshaller<MacroDefinition> editorMacroMarshaller, Marshaller<Link> editorLinkMarshaller, Marshaller<EmbeddedImage> editorEmbeddedImageMarshaller, Unmarshaller<MacroDefinition> editorMacroUnmarshaller, Unmarshaller<Link> editorLinkUnmarshaller, Unmarshaller<EmbeddedImage> editorEmbeddedImageUnmarshaller, FragmentTransformer editorToStorageFragmentTransformer, FragmentTransformer storageToEditorFragmentTransformer, XmlEventReaderFactory xmlEventReaderFactory, ExceptionThrowingMigrator wikiToEditorHtmlMigrator)
DefaultEditorFormatService(Marshaller<MacroDefinition> editorMacroMarshaller, Marshaller<Link> editorLinkMarshaller, Marshaller<EmbeddedImage> editorEmbeddedImageMarshaller, Unmarshaller<MacroDefinition> editorMacroUnmarshaller, Unmarshaller<Link> editorLinkUnmarshaller, Unmarshaller<EmbeddedImage> editorEmbeddedImageUnmarshaller, FragmentTransformer editorToStorageFragmentTransformer, FragmentTransformer storageToEditorFragmentTransformer, XmlEventReaderFactory xmlEventReaderFactory, ExceptionThrowingMigrator wikiToEditorHtmlMigrator)
DefaultXhtmlContent(Marshaller<MacroDefinition> viewMacroMarshaller, Marshaller<MacroDefinition> storageMacroMarshaller, Marshaller<Link> viewLinkMarshaller, Marshaller<Link> storageLinkMarshaller, Marshaller<EmbeddedImage> viewEmbeddedImageMarshaller, Marshaller<EmbeddedImage> storageEmbeddedImageMarshaller, Marshaller<InlineTaskList> viewInlineTaskMarshaller, Marshaller<InlineTaskList> storageInlineTaskMarshaller, Renderer viewRenderer, XmlEventReaderFactory xmlEventReaderFactory, ContentTransformerFactory contentTransformerFactory, ExceptionTolerantMigrator wikiToXhtmlMigrator)

Uses of MacroDefinition in com.atlassian.confluence.content.render.xhtml.editor.macro

Methods in com.atlassian.confluence.content.render.xhtml.editor.macro that return MacroDefinition

Modifier and Type	Method	Description
MacroDefinition	EditorMacroUnmarshaller.unmarshal(XMLEventReader reader, FragmentTransformer mainFragmentTransformer, ConversionContext conversionContext)

Methods in com.atlassian.confluence.content.render.xhtml.editor.macro with parameters of type MacroDefinition

Modifier and Type	Method	Description
protected String	EditorBodilessMacroMarshaller.getCssClass(MacroDefinition definition)
protected String	EditorBodyMacroMarshaller.getCssClass(MacroDefinition definition)
protected String	EditorBodilessMacroMarshaller.getImageSource(MacroDefinition definition)
protected String	EditorBodyMacroMarshaller.getImageSource(MacroDefinition definition)
String	DefaultPlaceholderUrlFactory.getUrlForMacro(MacroDefinition macroDefinition)
String	PlaceholderUrlFactory.getUrlForMacro(MacroDefinition macroDefinition)
String	DefaultPlaceholderUrlFactory.getUrlForMacroHeading(MacroDefinition macroDefinition)
String	PlaceholderUrlFactory.getUrlForMacroHeading(MacroDefinition macroDefinition)
Streamable	CustomImageEditorMacroMarshaller.marshal(Macro macro, MacroDefinition macroDefinition, ConversionContext conversionContext)
Streamable	CustomPlaceholderEditorMarshaller.marshal(Macro macro, MacroDefinition macroDefinition, ConversionContext conversionContext)
Streamable	EditorBodilessMacroMarshaller.marshal(Macro macro, MacroDefinition macroDefinition, ConversionContext conversionContext)
Streamable	EditorBodyMacroMarshaller.marshal(Macro macro, MacroDefinition macroDefinition, ConversionContext conversionContext)
Streamable	EditorMacroMarshaller.marshal(MacroDefinition macroDefinition, ConversionContext conversionContext)
Streamable	ImprovedEditorUnknownMacroMarshaller.marshal(Macro macro, MacroDefinition macroDefinition, ConversionContext conversionContext)
Streamable	MacroMarshaller.marshal(Macro macro, MacroDefinition macroDefinition, ConversionContext conversionContext)	Marshall the supplied macro.
void	CommonMacroAttributeWriter.writeCommonAttributes(MacroDefinition macroDefinition, XMLStreamWriter writer)

Uses of MacroDefinition in com.atlassian.confluence.content.render.xhtml.macro

Methods in com.atlassian.confluence.content.render.xhtml.macro that return types with arguments of type MacroDefinition

Modifier and Type	Method	Description
Marshaller<MacroDefinition>	MacroMarshallingFactoryImpl.getEditorMarshaller()
Unmarshaller<MacroDefinition>	MacroMarshallingFactoryImpl.getEditorUnmarshaller()
Marshaller<MacroDefinition>	MacroMarshallingFactoryImpl.getStorageMarshaller()
Unmarshaller<MacroDefinition>	MacroMarshallingFactoryImpl.getStorageUnmarshaller()
Marshaller<MacroDefinition>	MacroMarshallingFactoryImpl.getViewMarshaller()

Constructor parameters in com.atlassian.confluence.content.render.xhtml.macro with type arguments of type MacroDefinition

Constructor	Description
MacroMarshallingFactoryImpl(Marshaller<MacroDefinition> viewMarshaller, Marshaller<MacroDefinition> editorMarshaller, Marshaller<MacroDefinition> storageMarshaller, Unmarshaller<MacroDefinition> editorUnmarshaller, Unmarshaller<MacroDefinition> storageUnmarshaller)
MacroMarshallingFactoryImpl(Marshaller<MacroDefinition> viewMarshaller, Marshaller<MacroDefinition> editorMarshaller, Marshaller<MacroDefinition> storageMarshaller, Unmarshaller<MacroDefinition> editorUnmarshaller, Unmarshaller<MacroDefinition> storageUnmarshaller)

Uses of MacroDefinition in com.atlassian.confluence.content.render.xhtml.migration

Methods in com.atlassian.confluence.content.render.xhtml.migration with parameters of type MacroDefinition

Modifier and Type	Method	Description
String	ColorMacroReplacementRenderer.render(MacroDefinition macro, com.atlassian.renderer.RenderContext renderContext)
String	ColumnMacroReplacementRenderer.render(MacroDefinition macro, com.atlassian.renderer.RenderContext renderContext)
String	MacroReplacementRenderer.render(MacroDefinition macro, com.atlassian.renderer.RenderContext renderContext)
String	NolinkMacroReplacementRenderer.render(MacroDefinition macro, com.atlassian.renderer.RenderContext renderContext)
String	QuoteMacroReplacementRenderer.render(MacroDefinition macro, com.atlassian.renderer.RenderContext renderContext)
String	SectionMacroReplacementRenderer.render(MacroDefinition macro, com.atlassian.renderer.RenderContext renderContext)

Constructor parameters in com.atlassian.confluence.content.render.xhtml.migration with type arguments of type MacroDefinition

Constructor	Description
ErrorReportingV2Renderer(List<com.atlassian.renderer.v2.components.RendererComponent> components, Marshaller<MacroDefinition> wikiMarkupMacroMarshaller)
XhtmlEmbeddedRendererComponent(Marshaller<MacroDefinition> wikiMarkupMacroMarshaller, MacroParameterTypeParser macroParameterTypeParser)
XhtmlMacroRendererComponent(com.atlassian.renderer.v2.macro.MacroManager v2MacroManager, MacroMigrationManager macroMigrationManager, Marshaller<MacroDefinition> macroMarshaller, MacroReplacementRendererRepository replacementRepository, MacroDefinitionDeserializer macroDefinitionWikiMarkupDeserializer)

Uses of MacroDefinition in com.atlassian.confluence.content.render.xhtml.storage

Constructor parameters in com.atlassian.confluence.content.render.xhtml.storage with type arguments of type MacroDefinition

Constructor	Description
DefaultContentTransformerFactory(Unmarshaller<MacroDefinition> macroDefinitionUnmarshaller, Marshaller<MacroDefinition> macroDefinitionMarshaller, XmlEventReaderFactory xmlEventReaderFactory, XmlOutputFactory xmlOutputFactory, com.atlassian.event.api.EventPublisher eventPublisher)
DefaultContentTransformerFactory(Unmarshaller<MacroDefinition> macroDefinitionUnmarshaller, Marshaller<MacroDefinition> macroDefinitionMarshaller, XmlEventReaderFactory xmlEventReaderFactory, XmlOutputFactory xmlOutputFactory, com.atlassian.event.api.EventPublisher eventPublisher)

Uses of MacroDefinition in com.atlassian.confluence.content.render.xhtml.storage.macro

Methods in com.atlassian.confluence.content.render.xhtml.storage.macro that return MacroDefinition

Modifier and Type	Method	Description
MacroDefinition	DelegatingStorageMacroUnmarshaller.unmarshal(XMLEventReader reader, FragmentTransformer mainFragmentTransformer, ConversionContext conversionContext)
MacroDefinition	StorageMacroV1Unmarshaller.unmarshal(XMLEventReader reader, FragmentTransformer mainFragmentTransformer, ConversionContext conversionContext)
MacroDefinition	StorageMacroV2Unmarshaller.unmarshal(XMLEventReader reader, FragmentTransformer mainFragmentTransformer, ConversionContext conversionContext)

Methods in com.atlassian.confluence.content.render.xhtml.storage.macro with parameters of type MacroDefinition

Modifier and Type	Method	Description
Streamable	DelegatingStorageMacroMarshaller.marshal(MacroDefinition macroDefinition, ConversionContext conversionContext)	Marshals the supplied MacroDefinition using either V1 or V2 macro storage format.
Streamable	StorageMacroV1Marshaller.marshal(MacroDefinition macroDefinition, ConversionContext conversionContext)
Streamable	StorageMacroV2Marshaller.marshal(MacroDefinition originalMacroDefinition, ConversionContext conversionContext)

Uses of MacroDefinition in com.atlassian.confluence.content.render.xhtml.view.macro

Methods in com.atlassian.confluence.content.render.xhtml.view.macro that return types with arguments of type MacroDefinition

Modifier and Type	Method	Description
Marshaller<MacroDefinition>	ViewMacroMarshallerFactory.newMacroMarshaller()	Get a new instance of the default view macro Marshaller.
Marshaller<MacroDefinition>	ViewMacroMarshallerFactory.newMacroMarshaller(MacroManager macroManager, Marshaller<MacroDefinition> unknownMacroMarshaller, ViewMacroErrorPlaceholder viewMacroErrorPlaceholder)	Get a new instance of a macro Marshaller which uses the supplied MacroManager, unknown macro Marshaller and ViewMacroErrorPlaceholder.
Marshaller<MacroDefinition>	ViewMacroMarshallerFactoryImpl.newMacroMarshaller()
Marshaller<MacroDefinition>	ViewMacroMarshallerFactoryImpl.newMacroMarshaller(MacroManager macroManager, Marshaller<MacroDefinition> unknownMacroMarshaller, ViewMacroErrorPlaceholder viewMacroErrorPlaceholder)
Marshaller<MacroDefinition>	ViewMacroMarshallerFactory.newUnknownMacroMarshaller()
Marshaller<MacroDefinition>	ViewMacroMarshallerFactoryImpl.newUnknownMacroMarshaller()

Methods in com.atlassian.confluence.content.render.xhtml.view.macro with parameters of type MacroDefinition

Modifier and Type	Method	Description
String	ViewMacroErrorPlaceholder.create(MacroDefinition macroDefinition, String errorMessage)
String	ViewMacroErrorPlaceholderImpl.create(MacroDefinition macroDefinition, String errorMessage)
boolean	MacroAsyncRenderWhitelist.isAsyncRenderSafe(MacroDefinition macroDefinition, Class<? extends Macro> macroClass)
Streamable	ViewMacroMarshaller.marshal(MacroDefinition macroDefinition, ConversionContext conversionContext)
Streamable	ViewUnknownMacroMarshaller.marshal(MacroDefinition macroDefinition, ConversionContext conversionContext)
String	DefaultViewMacroWrapper.wrap(ConversionContext context, Macro.OutputType outputType, String macroBody, MacroDefinition macroDefinition)
String	ViewMacroWrapper.wrap(ConversionContext context, Macro.OutputType outputType, String macroBody, MacroDefinition macroDefinition)	Execute macro wrapping.
default String	ViewMacroWrapper.wrap(ConversionContext context, Macro.OutputType outputType, String macroBody, MacroDefinition macroDefinition, boolean wrap)	Deprecated. since 8.3.0, use ViewMacroWrapper.wrap(ConversionContext, Macro.OutputType, String, MacroDefinition)

Method parameters in com.atlassian.confluence.content.render.xhtml.view.macro with type arguments of type MacroDefinition

Modifier and Type	Method	Description
Marshaller<MacroDefinition>	ViewMacroMarshallerFactory.newMacroMarshaller(MacroManager macroManager, Marshaller<MacroDefinition> unknownMacroMarshaller, ViewMacroErrorPlaceholder viewMacroErrorPlaceholder)	Get a new instance of a macro Marshaller which uses the supplied MacroManager, unknown macro Marshaller and ViewMacroErrorPlaceholder.
Marshaller<MacroDefinition>	ViewMacroMarshallerFactoryImpl.newMacroMarshaller(MacroManager macroManager, Marshaller<MacroDefinition> unknownMacroMarshaller, ViewMacroErrorPlaceholder viewMacroErrorPlaceholder)

Constructor parameters in com.atlassian.confluence.content.render.xhtml.view.macro with type arguments of type MacroDefinition

Constructor

Description

ViewMacroMarshaller(MacroManager macroManager, Marshaller<MacroDefinition> unknownMacroMarshaller, ViewMacroErrorPlaceholder viewMacroErrorPlaceholder, LegacyV2RendererContextInitialiser legacyV2RendererConfigurationPropertySetter, com.atlassian.event.api.EventPublisher eventPublisher, ConfluenceMonitoring monitoring, MacroAsyncRenderWhitelist macroAsyncRenderWhitelist, MacroMetadataManager macroMetadataManager, MacroSchemaMigrator macroSchemaMigrator, ViewMacroWrapper viewMacroWrapper, MacroRenderingMonitor macroRenderingMonitor)

Uses of MacroDefinition in com.atlassian.confluence.diff.marshallers

Methods in com.atlassian.confluence.diff.marshallers with parameters of type MacroDefinition

Modifier and Type	Method	Description
Streamable	DiffMacroMarshaller.marshal(MacroDefinition macroDefinition, ConversionContext conversionContext)

Uses of MacroDefinition in com.atlassian.confluence.impl.content.render.xhtml.editor.macro

Methods in com.atlassian.confluence.impl.content.render.xhtml.editor.macro with parameters of type MacroDefinition

Modifier and Type	Method	Description
Streamable	DelegatingEditorMacroMarshaller.marshal(MacroDefinition macroDefinition, ConversionContext conversionContext)

Uses of MacroDefinition in com.atlassian.confluence.impl.macro.schema

Methods in com.atlassian.confluence.impl.macro.schema that return MacroDefinition

Modifier and Type	Method	Description
MacroDefinition	DefaultMacroSchemaMigrator.migrateSchemaIfNecessary(MacroDefinition macroDefinition, ConversionContext context)
MacroDefinition	MacroSchemaMigrator.migrateSchemaIfNecessary(MacroDefinition macroDefinition, ConversionContext context)	Migrates the macro definition to the latest version of it's macro schema.

Methods in com.atlassian.confluence.impl.macro.schema with parameters of type MacroDefinition

Modifier and Type	Method	Description
MacroDefinition	DefaultMacroSchemaMigrator.migrateSchemaIfNecessary(MacroDefinition macroDefinition, ConversionContext context)
MacroDefinition	MacroSchemaMigrator.migrateSchemaIfNecessary(MacroDefinition macroDefinition, ConversionContext context)	Migrates the macro definition to the latest version of it's macro schema.

Uses of MacroDefinition in com.atlassian.confluence.internal.diagnostics

Constructors in com.atlassian.confluence.internal.diagnostics with parameters of type MacroDefinition

Constructor	Description
MacroRendering(ConversionContext conversionContext, MacroDefinition macroDefinition, Macro macro)

Uses of MacroDefinition in com.atlassian.confluence.macro

Methods in com.atlassian.confluence.macro that return MacroDefinition

Modifier and Type	Method	Description
MacroDefinition	MacroDefinitionDeserializer.deserialize(String serializedValue)
MacroDefinition	MacroDefinitionRequestDeserializer.deserialize(String serializedValue)
MacroDefinition	MacroDefinitionWikiMarkupDeserializer.deserialize(String serializedValue)
MacroDefinition	MacroDefinitionDeserializer.deserializeWithTypedParameters(String serializedValue, ConversionContext conversionContext)
MacroDefinition	MacroDefinitionRequestDeserializer.deserializeWithTypedParameters(String serializedValue, ConversionContext conversionContext)
MacroDefinition	MacroDefinitionWikiMarkupDeserializer.deserializeWithTypedParameters(String serializedValue, ConversionContext conversionContext)

Methods in com.atlassian.confluence.macro with parameters of type MacroDefinition

Modifier and Type	Method	Description
String	MacroDefinitionRequestSerializer.serialize(MacroDefinition macroDefinition)
String	MacroDefinitionSerializer.serialize(MacroDefinition macroDefinition)
String	MacroDefinitionWikiMarkupSerializer.serialize(MacroDefinition macroDefinition)

Uses of MacroDefinition in com.atlassian.confluence.macro.count

Methods in com.atlassian.confluence.macro.count with parameters of type MacroDefinition

Modifier and Type	Method	Description
void	DefaultMacroCounter.addMacroUsage(MacroDefinition macroDefinition, @Nullable Macro macro)
void	MacroCounter.addMacroUsage(MacroDefinition macroDefinition, @Nullable Macro macro)	Record a single usage of the given macro.
static @NonNull MacroMetricsKey	MacroMetricsKey.createFrom(MacroDefinition macroDefinition, @Nullable Macro macro)

Uses of MacroDefinition in com.atlassian.confluence.macro.xhtml

Methods in com.atlassian.confluence.macro.xhtml that return MacroDefinition

Modifier and Type	Method	Description
MacroDefinition	MacroMigration.migrate(MacroDefinition macro, ConversionContext context)	Migrates a wiki-markup representation of a macro to XHTML
MacroDefinition	PlainTextMacroMigration.migrate(MacroDefinition macro, ConversionContext context)
MacroDefinition	RichTextMacroMigration.migrate(MacroDefinition macroDefinition, ConversionContext conversionContext)
MacroDefinition	V2MacroToUnmigratedWikiMarkupMacroMigration.migrate(MacroDefinition macroDefinition, ConversionContext conversionContext)

Methods in com.atlassian.confluence.macro.xhtml with parameters of type MacroDefinition

Modifier and Type	Method	Description
MacroDefinition	MacroMigration.migrate(MacroDefinition macro, ConversionContext context)	Migrates a wiki-markup representation of a macro to XHTML
MacroDefinition	PlainTextMacroMigration.migrate(MacroDefinition macro, ConversionContext context)
MacroDefinition	RichTextMacroMigration.migrate(MacroDefinition macroDefinition, ConversionContext conversionContext)
MacroDefinition	V2MacroToUnmigratedWikiMarkupMacroMigration.migrate(MacroDefinition macroDefinition, ConversionContext conversionContext)

Uses of MacroDefinition in com.atlassian.confluence.util

Methods in com.atlassian.confluence.util that return MacroDefinition

Modifier and Type	Method	Description
MacroDefinition	ExcerptHelper.getMacroDefinition(ContentEntityObject contentEntityObject, String macroName)	Gets the first MacroDefinition in the supplied (@code contentEntityObject}.

Uses of MacroDefinition in com.atlassian.confluence.xhtml.api

Methods in com.atlassian.confluence.xhtml.api that return MacroDefinition

Modifier and Type	Method	Description
MacroDefinition	MacroDefinitionBuilder.build()
MacroDefinition	EditorFormatService.convertEditToMacroDefinition(String editFragment, ConversionContext context)	Returns a MacroDefinition from the supplied editFragment.
MacroDefinition	MacroDefinitionUpdater.update(MacroDefinition macroDefinition)	Called each time a macro definition is found in the content so that each definition may be modified or replaced by another definition.

Methods in com.atlassian.confluence.xhtml.api with parameters of type MacroDefinition

Modifier and Type	Method	Description
String	EditorFormatService.convertMacroDefinitionToEdit(MacroDefinition macroDefinition, ConversionContext context)	Returns an edit format fragment for the supplied macroDefinition.
String	XhtmlContent.convertMacroDefinitionToStorage(MacroDefinition macroDefinition, ConversionContext context)	Returns an storage format fragment for the supplied macroDefinition.
String	XhtmlContent.convertMacroDefinitionToView(MacroDefinition macroDefinition, ConversionContext context)	Returns a view format fragment for the supplied macroDefinition.
void	MacroDefinitionHandler.handle(MacroDefinition macroDefinition)	Called each time a macro definition is found in the content.
abstract Streamable	MacroDefinitionMarshallingStrategy.marshal(MacroDefinition macroDefinition, ConversionContext conversionContext, Marshaller<MacroDefinition> macroDefinitionMarshaller)	Convert the MacroDefinition to a string.
String	MacroDefinitionReplacer.replace(MacroDefinition macroDefinition)	Called each time a macro definition is found in the content, so that each definition may be replaced different content.
MacroDefinition	MacroDefinitionUpdater.update(MacroDefinition macroDefinition)	Called each time a macro definition is found in the content so that each definition may be modified or replaced by another definition.

Method parameters in com.atlassian.confluence.xhtml.api with type arguments of type MacroDefinition

Modifier and Type	Method	Description
abstract Streamable	MacroDefinitionMarshallingStrategy.marshal(MacroDefinition macroDefinition, ConversionContext conversionContext, Marshaller<MacroDefinition> macroDefinitionMarshaller)	Convert the MacroDefinition to a string.

Constructors in com.atlassian.confluence.xhtml.api with parameters of type MacroDefinition

Constructor	Description
MacroDefinition(MacroDefinition macroDefinition)	Copy constructor.