public interface ContentUiSupport<T extends ConfluenceEntityObject>
Modifier and Type | Method and Description |
---|---|
String |
getContentCssClass(String contentType,
String contentPluginKey)
Get the CSS class that can be applied to add an icon to some inline element describing the given content.
|
String |
getContentCssClass(T content)
Get the CSS class that can be applied to some inline element describing the given content
|
String |
getContentTypeI18NKey(SearchResult result)
Get the I18N key for the content that is being referred to by this search result
|
String |
getContentTypeI18NKey(T content)
Get the I18N key for the name of the given content.
|
String |
getIconCssClass(SearchResult result)
Get the CSS class that can be applied to add an icon to some inline element describing the given result.
|
String |
getIconCssClass(T content)
Get the CSS class that can be applied to add an icon to some inline element describing the given content.
|
String |
getIconFilePath(T content,
int size)
Get the URL path to the icon for the gtiven piece of content, without prepending context or web static hashes.
|
String |
getIconPath(T content,
int size)
Get the URL path to the icon for the given piece of content.
|
String |
getLegacyIconPath(String contentType,
int size)
Get the URL path to the icon for the given type of content.
|
String getIconFilePath(T content, int size)
DataSourceFactory
, which
does not handle context and web static hashes in the url.content
- the content to find an icon forsize
- the size. Currently, only 16 is supported, and thus this parameter is ignored.String getIconPath(T content, int size)
All icons are square. If no icon is available at the requested size, the implementation should use the following priority to determine what to return:
In general you can only assume a 16x16 icon will be available, but this may change in the future.
content
- the content to find an icon forsize
- the intended width/height at which the icon will be displayed in pixelsString getLegacyIconPath(String contentType, int size)
getIconPath(com.atlassian.confluence.core.ConfluenceEntityObject, int)
Icon size selection follows the same rule as its sister method.
contentType
- the type of content to find an icon for as would be returned from
ContentEntityObject.getType()
size
- the intended width/height at which the icon will be displayed in pixelsString getIconCssClass(T content)
content
- the content to find an icon forString getContentCssClass(T content)
content
- the content to find the css forString getContentCssClass(String contentType, String contentPluginKey)
contentType
- the content to find an icon forcontentPluginKey
- the plugin key for the content it it is a ContentType pluginString getIconCssClass(SearchResult result)
result
- the search result to find an icon forString getContentTypeI18NKey(T content)
content
- the content to get the name ofString getContentTypeI18NKey(SearchResult result)
result
- the search result being displayedCopyright © 2003–2020 Atlassian. All rights reserved.