com.atlassian.sal.api.message
Class DefaultHelpPath

java.lang.Object
  com.atlassian.sal.api.message.DefaultHelpPath

All Implemented Interfaces:

HelpPath

public class DefaultHelpPath
extends Object
implements HelpPath

Default immutable implementation of HelpPath.

Since:

2.4

Constructor Summary

DefaultHelpPath(String key, String url, String title, String alt, boolean local)

Method Summary

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHelpPath

public DefaultHelpPath(String key,
                       String url,
                       String title,
                       String alt,
                       boolean local)

Method Detail

getKey

public String getKey()

Description copied from interface: HelpPath

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.

Specified by:

getKey in interface HelpPath

Returns:

The key to the help item.

getUrl

public String getUrl()

Description copied from interface: HelpPath

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.

Specified by:

getUrl in interface HelpPath

Returns:

The full URL to the help content for this link.

getTitle

public String getTitle()

Description copied from interface: HelpPath

Title attribute on the help link (the tooltip).

Specified by:

getTitle in interface HelpPath

Returns:

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

getAlt

public String getAlt()

Description copied from interface: HelpPath

Alternate text for the help icon.

Specified by:

getAlt in interface HelpPath

Returns:

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

isLocal

public boolean isLocal()

Description copied from interface: HelpPath

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.

Specified by:

isLocal in interface HelpPath

Returns:

true for local help links.