com.atlassian.confluence.content.render.xhtml.editor.inline
Interface EmoticonDisplayMapper

All Known Implementing Classes:

SimpleEmoticonDisplayMapper

public interface EmoticonDisplayMapper

Describes a component responsible for mapping an emoticon to data suitable for display.

Method Summary

String	getAbsoluteImageUrl(Emoticon emoticon) Get an absolute URL for the emoticon (this will include the servers configured baseURL).
String	getImageName(Emoticon emoticon)
String	getRelativeImageUrl(Emoticon emoticon) Get a relative URL for the emoticon.

Method Detail

getRelativeImageUrl

String getRelativeImageUrl(Emoticon emoticon)

Get a relative URL for the emoticon. The relative URL will include context path but no server information.

Parameters:

emoticon - the emoticon for which an image URL is required.

Returns:

the URL for the image matching the supplied emoticon or null if there is none found.

getAbsoluteImageUrl

String getAbsoluteImageUrl(Emoticon emoticon)

Get an absolute URL for the emoticon (this will include the servers configured baseURL).

Parameters:

emoticon - the emoticon for which an image URL is required.

Returns:

the URL for the image matching the supplied emoticon or null if there is none found.

getImageName

String getImageName(Emoticon emoticon)

Parameters:

emoticon - the emoticon for which an image name is required.

Returns:

the image name (no extension) for the supplied emoticon or null if there is none found.