Package com.atlassian.confluence.content.render.xhtml.model.resource

Class DefaultEmbeddedImage

java.lang.Object

com.atlassian.confluence.content.render.xhtml.model.DefaultStandardTag

com.atlassian.confluence.content.render.xhtml.model.resource.DefaultEmbeddedImage

All Implemented Interfaces:

EmbeddedImage, StandardTag

public class DefaultEmbeddedImage
extends DefaultStandardTag
implements EmbeddedImage

Field Summary

Fields inherited from class com.atlassian.confluence.content.render.xhtml.model.DefaultStandardTag

htmlClass, id, style, title

Constructor Summary

Constructors

Constructor	Description
DefaultEmbeddedImage(NamedResourceIdentifier resourceIdentifier)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getAlignment()
String	getAlternativeText()
String	getExtraQueryParameters()
String	getHeight()
String	getHspace()
String	getMimeType()
ResourceIdentifier	getResourceIdentifier()
String	getSource()
String	getVspace()
String	getWidth()
int	hashCode()
boolean	isBorder()
boolean	isThumbnail()
void	setAlignment(String alignment)
void	setAlternativeText(String alternativeText)
void	setBorder(boolean border)
void	setExtraQueryParameters(String queryParams)
void	setHeight(String height)
void	setHspace(String hspace)
void	setSource(String source)
void	setThumbnail(boolean thumbnail)
void	setVspace(String vspace)
void	setWidth(String width)
String	toString()

Methods inherited from class com.atlassian.confluence.content.render.xhtml.model.DefaultStandardTag

getHtmlClass, getId, getStyle, getTitle, setHtmlClass, setId, setStyle, setTitle

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.confluence.xhtml.api.StandardTag

getHtmlClass, getId, getStyle, getTitle

Constructor Detail

DefaultEmbeddedImage

public DefaultEmbeddedImage(NamedResourceIdentifier resourceIdentifier)

Method Detail

getResourceIdentifier

public ResourceIdentifier getResourceIdentifier()

Specified by:

getResourceIdentifier in interface EmbeddedImage

getMimeType

public String getMimeType()

Specified by:

getMimeType in interface EmbeddedImage

getAlternativeText

public String getAlternativeText()

Specified by:

getAlternativeText in interface EmbeddedImage

Returns:

An alternate text for an image

getHeight

public String getHeight()

Specified by:

getHeight in interface EmbeddedImage

Returns:

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

getSource

public String getSource()

Specified by:

getSource in interface EmbeddedImage

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.

isThumbnail

public boolean isThumbnail()

Specified by:

isThumbnail in interface EmbeddedImage

Returns:

true if the image should be shown as a thumbnail.

getWidth

public String getWidth()

Specified by:

getWidth in interface EmbeddedImage

Returns:

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

setSource

public void setSource(String source)

setAlternativeText

public void setAlternativeText(String alternativeText)

setHeight

public void setHeight(String height)

setWidth

public void setWidth(String width)

setThumbnail

public void setThumbnail(boolean thumbnail)

isBorder

public boolean isBorder()

Specified by:

isBorder in interface EmbeddedImage

Returns:

true if the image should have a border

setBorder

public void setBorder(boolean border)

getAlignment

public String getAlignment()

Specified by:

getAlignment in interface EmbeddedImage

Returns:

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

setAlignment

public void setAlignment(String alignment)

getHspace

public String getHspace()

Specified by:

getHspace in interface EmbeddedImage

Returns:

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

getVspace

public String getVspace()

Specified by:

getVspace in interface EmbeddedImage

Returns:

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

setHspace

public void setHspace(String hspace)

setVspace

public void setVspace(String vspace)

toString

public String toString()

Overrides:

toString in class DefaultStandardTag

getExtraQueryParameters

public String getExtraQueryParameters()

Specified by:

getExtraQueryParameters in interface EmbeddedImage

Returns:

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

setExtraQueryParameters

public void setExtraQueryParameters(String queryParams)

equals

public boolean equals(Object o)

Overrides:

equals in class DefaultStandardTag

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultStandardTag