public interface

EmbeddedImage

implements StandardTag
com.atlassian.confluence.xhtml.api.EmbeddedImage
Known Indirect Subclasses

Class Overview

Represents an embedded resource.

Summary

Public Methods
String getAlignment()
String getAlternativeText()
String getExtraQueryParameters()
String getHeight()
String getHspace()
String getMimeType()
ResourceIdentifier getResourceIdentifier()
String getSource()
String getVspace()
String getWidth()
boolean isBorder()
boolean isThumbnail()
[Expand]
Inherited Methods
From interface com.atlassian.confluence.xhtml.api.StandardTag

Public Methods

public String getAlignment ()

Returns
  • the value for the alignment of the image - none, center, left or right

public String getAlternativeText ()

Returns
  • An alternate text for an image

public String getExtraQueryParameters ()

Returns
  • any extra query parameters added by the client. Could potentially be used for servlet filters.

public String getHeight ()

Returns
  • the height of the image either in pixels or percent. e.g. may be purely numeric, or something like nnpx or nn%

public String getHspace ()

Returns
  • the amount of whitespace to be inserted to the left and right of the image (in pixels)

public String getMimeType ()

public ResourceIdentifier getResourceIdentifier ()

public String getSource ()

Returns
  • the url for the source of the image. This only applies to external embedded images so may be null if the image is a Confluence attachment.

public String getVspace ()

Returns
  • the amount of whitespace to be inserted above and below the image (in pixels)

public String getWidth ()

Returns
  • the width of the image either in pixels or percent. e.g. may be purely numeric, or something like nnpx or nn%

public boolean isBorder ()

Returns
  • true if the image should have a border

public boolean isThumbnail ()

Returns
  • true if the image should be shown as a thumbnail.