com.atlassian.confluence.content.ui

Class PageUiSupport

java.lang.Object

com.atlassian.confluence.content.ui.PageUiSupport

All Implemented Interfaces:

ContentUiSupport<Page>

public class PageUiSupport
extends Object
implements ContentUiSupport<Page>

Constructor Summary

Constructors

Constructor and Description
PageUiSupport(com.atlassian.plugin.webresource.WebResourceUrlProvider webResourceUrlProvider)

Method Summary

Modifier and Type	Method and Description
String	getContentCssClass(Page 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(Page 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(Page 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(Page 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(Page 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PageUiSupport

public PageUiSupport(com.atlassian.plugin.webresource.WebResourceUrlProvider webResourceUrlProvider)

Method Detail

getIconFilePath

public String getIconFilePath(Page content,
                              int size)

Description copied from interface: ContentUiSupport

Get the URL path to the icon for the gtiven piece of content, without prepending context or web static hashes. This method is usedful in conjunction with the DataSourceFactory, which does not handle context and web static hashes in the url.

Specified by:

getIconFilePath in interface ContentUiSupport<Page>

Parameters:

content - the content to find an icon for

size - the size. Currently, only 16 is supported, and thus this parameter is ignored.

Returns:

a URL for the icon.

getIconPath

public String getIconPath(Page content,
                          int size)

Description copied from interface: ContentUiSupport

Get the URL path to the icon for the given piece of content. Paths are relative to the site root, and will already have the context path prepended to them.

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:

1. The smallest icon with width larger than the requested size
2. If no icon is larger than the requested size, return the largest icon available

In general you can only assume a 16x16 icon will be available, but this may change in the future.

Specified by:

getIconPath in interface ContentUiSupport<Page>

Parameters:

content - the content to find an icon for

size - the intended width/height at which the icon will be displayed in pixels

Returns:

the path to the icon that best suits the requested size

getLegacyIconPath

public String getLegacyIconPath(String contentType,
                                int size)

Description copied from interface: ContentUiSupport

Get the URL path to the icon for the given type of content. Paths are relative to the site root, and will already have the context path prepended to them. This method will always return the generic icon for the given content: if you want to inspect the content and return different icons based on its state, use ContentUiSupport.getIconPath(com.atlassian.confluence.core.ConfluenceEntityObject, int)

Icon size selection follows the same rule as its sister method.

Specified by:

getLegacyIconPath in interface ContentUiSupport<Page>

Parameters:

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 pixels

Returns:

the path to the icon that best suits the requested size

getIconCssClass

public String getIconCssClass(SearchResult result)

Description copied from interface: ContentUiSupport

Get the CSS class that can be applied to add an icon to some inline element describing the given result.

Specified by:

getIconCssClass in interface ContentUiSupport<Page>

Parameters:

result - the search result to find an icon for

Returns:

the CSS class to add that icon to the element

getContentTypeI18NKey

public String getContentTypeI18NKey(SearchResult result)

Description copied from interface: ContentUiSupport

Get the I18N key for the content that is being referred to by this search result

Specified by:

getContentTypeI18NKey in interface ContentUiSupport<Page>

Parameters:

result - the search result being displayed

Returns:

the I18N key that can be used to name that content

getIconCssClass

public String getIconCssClass(Page content)

Description copied from interface: ContentUiSupport

Get the CSS class that can be applied to add an icon to some inline element describing the given content.

Specified by:

getIconCssClass in interface ContentUiSupport<Page>

Parameters:

content - the content to find an icon for

Returns:

the CSS class to add that icon to the element

getContentCssClass

public String getContentCssClass(String contentType,
                                 String contentPluginKey)

Description copied from interface: ContentUiSupport

Get the CSS class that can be applied to add an icon to some inline element describing the given content. The existence of both IconCssClass (used in the velocity macros) and ContentCssClass (used by the ContentTypesDisplayMapper) is redundant and confusing, and should be reconciled somehow.

Specified by:

getContentCssClass in interface ContentUiSupport<Page>

Parameters:

contentType - the content to find an icon for

contentPluginKey - the plugin key for the content it it is a ContentType plugin

Returns:

the CSS class to add that icon to the element

getContentCssClass

public String getContentCssClass(Page content)

Description copied from interface: ContentUiSupport

Get the CSS class that can be applied to some inline element describing the given content

Specified by:

getContentCssClass in interface ContentUiSupport<Page>

Parameters:

content - the content to find the css for

Returns:

the CSS class for this content

getContentTypeI18NKey

public String getContentTypeI18NKey(Page content)

Description copied from interface: ContentUiSupport

Get the I18N key for the name of the given content.

Specified by:

getContentTypeI18NKey in interface ContentUiSupport<Page>

Parameters:

content - the content to get the name of

Returns:

the I18N key that can be used to name that content