Interface EmbeddedImage
-
- All Superinterfaces:
StandardTag
- All Known Implementing Classes:
DefaultEmbeddedImage
public interface EmbeddedImage extends StandardTag
Represents an embedded resource.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetAlignment()StringgetAlternativeText()StringgetExtraQueryParameters()StringgetHeight()StringgetHspace()StringgetMimeType()ResourceIdentifiergetResourceIdentifier()StringgetSource()StringgetVspace()StringgetWidth()booleanisBorder()booleanisThumbnail()-
Methods inherited from interface com.atlassian.confluence.xhtml.api.StandardTag
getHtmlClass, getId, getStyle, getTitle
-
-
-
-
Method Detail
-
getResourceIdentifier
ResourceIdentifier getResourceIdentifier()
-
getMimeType
String getMimeType()
-
getSource
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.
-
getAlternativeText
String getAlternativeText()
- Returns:
- An alternate text for an image
-
getHeight
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%
-
getWidth
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%
-
isThumbnail
boolean isThumbnail()
- Returns:
- true if the image should be shown as a thumbnail.
-
isBorder
boolean isBorder()
- Returns:
- true if the image should have a border
-
getAlignment
String getAlignment()
- Returns:
- the value for the alignment of the image - none, center, left or right
-
getHspace
String getHspace()
- Returns:
- the amount of whitespace to be inserted to the left and right of the image (in pixels)
-
getVspace
String getVspace()
- Returns:
- the amount of whitespace to be inserted above and below the image (in pixels)
-
getExtraQueryParameters
String getExtraQueryParameters()
- Returns:
- any extra query parameters added by the client. Could potentially be used for servlet filters.
-
-