com.atlassian.confluence.macro

Interface ImagePlaceholder

All Known Implementing Classes:

DefaultImagePlaceholder

public interface ImagePlaceholder

Since:

4.0

Method Summary

Modifier and Type	Method and Description
boolean	applyPlaceholderChrome() Returns true if the image should have the macro placeholder chrome applied to it.
Dimensions	getDimensions() Deprecated. since 7.2. Use getImageDimensions() instead.
default ImageDimensions	getImageDimensions() Returns the dimensions that the image is to be rendered as.
String	getUrl() Returns the url to the image to render, relative to the Confluence base url.

Method Detail

getUrl

String getUrl()

Returns the url to the image to render, relative to the Confluence base url.

Returns:

The url relative to the Confluence base url.

getDimensions

@Deprecated
Dimensions getDimensions()

Deprecated. since 7.2. Use getImageDimensions() instead.

Returns the dimensions that the image is to be rendered as. Returning null will render the image at its default size.

Returns:

An instance of Dimensions representing the image dimensions.

getImageDimensions

default ImageDimensions getImageDimensions()

Returns the dimensions that the image is to be rendered as. Returning null will render the image at its default size.

Returns:

An instance of ImageDimensions representing the image dimensions.

Since:

7.2

applyPlaceholderChrome

boolean applyPlaceholderChrome()

Returns true if the image should have the macro placeholder chrome applied to it.

Returns:

True if placeholder chrome is to be applied.