public class AttachmentUiSupport extends Object implements ContentUiSupport<Attachment>
Modifier and Type | Class and Description |
---|---|
static class |
AttachmentUiSupport.AttachmentInfo
Deprecated.
Since 4.3. This class is only public because it is used by ContentTypesDisplayMapper. Avoid using
this class directly and use a ContentUiSupport object instead. This class will be made private when
ContentTypesDisplayMapper is removed. |
Constructor and Description |
---|
AttachmentUiSupport(com.atlassian.plugin.webresource.WebResourceUrlProvider webResourceUrlProvider) |
Modifier and Type | Method and Description |
---|---|
static AttachmentUiSupport.AttachmentInfo |
getAttachmentInfo(String mimeType,
String fileExtension)
Deprecated.
Since 4.3 This method is only public because it is used by ContentTypesDisplayMapper. Avoid using
this method directly and use a ContentUiSupport object instead. This method will be made private when
ContentTypesDisplayMapper is removed.
TODO Undeprecate and make this private when ContentTypesDisplayMapper is removed. |
String |
getContentCssClass(Attachment content)
Get the CSS class that can be applied to some inline element describing the given content
|
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 |
getContentTypeI18NKey(Attachment content)
Get the I18N key for the name of the given content.
|
String |
getContentTypeI18NKey(SearchResult result)
Get the I18N key for the content that is being referred to by this search result
|
String |
getIconCssClass(Attachment content)
Get the CSS class that can be applied to add an icon to some inline element describing 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 |
getIconFilePath(Attachment 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(Attachment 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.
|
public AttachmentUiSupport(com.atlassian.plugin.webresource.WebResourceUrlProvider webResourceUrlProvider)
public String getIconFilePath(Attachment content, int size)
ContentUiSupport
DataSourceFactory
, which
does not handle context and web static hashes in the url.getIconFilePath
in interface ContentUiSupport<Attachment>
content
- the content to find an icon forsize
- the size. Currently, only 16 is supported, and thus this parameter is ignored.public String getIconPath(Attachment content, int size)
ContentUiSupport
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.
getIconPath
in interface ContentUiSupport<Attachment>
content
- the content to find an icon forsize
- the intended width/height at which the icon will be displayed in pixelspublic String getLegacyIconPath(String contentType, int size)
ContentUiSupport
ContentUiSupport.getIconPath(com.atlassian.confluence.core.ConfluenceEntityObject, int)
Icon size selection follows the same rule as its sister method.
getLegacyIconPath
in interface ContentUiSupport<Attachment>
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 pixelspublic String getIconCssClass(Attachment content)
ContentUiSupport
getIconCssClass
in interface ContentUiSupport<Attachment>
content
- the content to find an icon forpublic String getContentCssClass(String contentType, String contentPluginKey)
ContentUiSupport
getContentCssClass
in interface ContentUiSupport<Attachment>
contentType
- the content to find an icon forcontentPluginKey
- the plugin key for the content it it is a ContentType pluginpublic String getContentCssClass(Attachment content)
ContentUiSupport
getContentCssClass
in interface ContentUiSupport<Attachment>
content
- the content to find the css forpublic String getIconCssClass(SearchResult result)
ContentUiSupport
getIconCssClass
in interface ContentUiSupport<Attachment>
result
- the search result to find an icon forpublic String getContentTypeI18NKey(Attachment content)
ContentUiSupport
getContentTypeI18NKey
in interface ContentUiSupport<Attachment>
content
- the content to get the name ofpublic String getContentTypeI18NKey(SearchResult result)
ContentUiSupport
getContentTypeI18NKey
in interface ContentUiSupport<Attachment>
result
- the search result being displayed@Deprecated public static AttachmentUiSupport.AttachmentInfo getAttachmentInfo(String mimeType, String fileExtension)
ContentTypesDisplayMapper
is removed.
TODO Undeprecate and make this private when ContentTypesDisplayMapper is removed.
AttachmentUiSupport.AttachmentInfo.UNKNOWN
. Never returns null.mimeType
- The mime type of the attachmentfileExtension
- The filename of the attachmentAttachmentUiSupport.AttachmentInfo.UNKNOWN
if none were found.Copyright © 2003–2020 Atlassian. All rights reserved.