com.atlassian.confluence.content.render.xhtml.view.embed

Class DefaultAttachedImageResourceMarshaller

java.lang.Object

com.atlassian.confluence.content.render.xhtml.view.embed.DefaultAttachedImageResourceMarshaller

All Implemented Interfaces:

AttachedImageMarshaller

public class DefaultAttachedImageResourceMarshaller
extends Object
implements AttachedImageMarshaller

Class to Marshall an image attachment.

Constructor Summary

Constructors

Constructor and Description

DefaultAttachedImageResourceMarshaller(AttachmentResourceIdentifierResolver attachmentResourceIdentifierResolver, ThumbnailManager thumbnailManager, StaxStreamMarshaller<Attachment> attachmentStaxStreamMarshaller, EmbeddedImageTagWriter embeddedImageWriter, UnidentifiedAttachmentMarshaller unidentifiedAttachmentPlaceholderWriter, AttachmentResourceIdentifierOnlyUriResolver attachmentResourceIdentifierOnlyUriResolver, ImageDetailsManager imageDetailsManager, DarkFeaturesManager darkFeaturesManager, AttachedImageRenderHelper attachedImageRenderHelper, EmbeddedImageUtils embeddedImageUtils) Creates an instance with the supplied parameters.

Method Summary

Modifier and Type	Method and Description
boolean	canMarshal(EmbeddedImage embeddedImage, AttachmentResourceIdentifier attachmentResourceIdentifier, ConversionContext conversionContext) This method checks whether the marshaller implementation can handle the image passed to it.
Streamable	marshal(XmlStreamWriterTemplate xmlStreamWriterTemplate, EmbeddedImage embeddedImage, AttachmentResourceIdentifier attachmentResourceIdentifier, ConversionContext conversionContext) Marshals an Attached image into an tag for display on the page.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultAttachedImageResourceMarshaller

public DefaultAttachedImageResourceMarshaller(AttachmentResourceIdentifierResolver attachmentResourceIdentifierResolver,
                                              ThumbnailManager thumbnailManager,
                                              StaxStreamMarshaller<Attachment> attachmentStaxStreamMarshaller,
                                              EmbeddedImageTagWriter embeddedImageWriter,
                                              UnidentifiedAttachmentMarshaller unidentifiedAttachmentPlaceholderWriter,
                                              AttachmentResourceIdentifierOnlyUriResolver attachmentResourceIdentifierOnlyUriResolver,
                                              ImageDetailsManager imageDetailsManager,
                                              DarkFeaturesManager darkFeaturesManager,
                                              AttachedImageRenderHelper attachedImageRenderHelper,
                                              EmbeddedImageUtils embeddedImageUtils)

Creates an instance with the supplied parameters.

Method Detail

marshal

public Streamable marshal(XmlStreamWriterTemplate xmlStreamWriterTemplate,
                          EmbeddedImage embeddedImage,
                          AttachmentResourceIdentifier attachmentResourceIdentifier,
                          ConversionContext conversionContext)
                   throws XhtmlException

Description copied from interface: AttachedImageMarshaller

Marshals an Attached image into an tag for display on the page.

Specified by:

marshal in interface AttachedImageMarshaller

Parameters:

xmlStreamWriterTemplate - The XML writer that writes the tag

embeddedImage - The image to marshall

attachmentResourceIdentifier - Identifier of the attachment

conversionContext - The output context to render for

Returns:

A Streamable object representing the HTML form of the attached image ready to be written to the page.

Throws:

XhtmlException

canMarshal

public boolean canMarshal(EmbeddedImage embeddedImage,
                          AttachmentResourceIdentifier attachmentResourceIdentifier,
                          ConversionContext conversionContext)

Description copied from interface: AttachedImageMarshaller

This method checks whether the marshaller implementation can handle the image passed to it.

Specified by:

canMarshal in interface AttachedImageMarshaller

Parameters:

embeddedImage - The image to marshall

attachmentResourceIdentifier - Identifier of the attachment

conversionContext - The output context to render for

Returns:

true iff the implementation of the AttachedImageMarshaller can marshal the attachment given.