com.atlassian.sal.api.message

Interface HelpPath

All Known Implementing Classes:

DefaultHelpPath

public interface HelpPath

Link to product specific help displayed in the UI.

Since:

2.4

Method Summary

Modifier and Type	Method and Description
String	getAlt() Alternate text for the help icon.
String	getKey() The key to the help item.
String	getTitle() Title attribute on the help link (the tooltip).
String	getUrl() The full URL to the help content for this link.
boolean	isLocal() Flag to indicate this is a local URL, A local path is within the application context.

Method Detail

getKey

String getKey()

The key to the help item. This method should never return null. If there is no URL for a key or the key is null then the HelpPathResolver should return null from the getHelpPath() method.

Returns:

The key to the help item.

getUrl

String getUrl()

The full URL to the help content for this link. This should never return null. If there is no URL for a key then the HelpPathResolver should return null from the getHelpPath() method.

Returns:

The full URL to the help content for this link.

getTitle

String getTitle()

Title attribute on the help link (the tooltip).

Returns:

Title attribute on the help link or null if there is none provided.

getAlt

String getAlt()

Alternate text for the help icon.

Returns:

Alternate text for the help icon or null if there is none provided.

isLocal

boolean isLocal()

Flag to indicate this is a local URL, A local path is within the application context. Clients may display local help links differently, especially for help that is generated dynamically.

Returns:

true for local help links.