public class

VersionSpecificDocumentationBean

extends Object
implements DocumentationBean
java.lang.Object
   ↳ com.atlassian.confluence.util.i18n.VersionSpecificDocumentationBean

Class Overview

Constructs a version specific link to Confluence's documentation.

Summary

Public Constructors
VersionSpecificDocumentationBean(SystemInformationService systemInformationService, I18NBean i18NBean)
Public Methods
boolean exists(String docLink)
Returns true if the documentation link exists, otherwise false.
String getAlt(String docLink)
Retrieves the alt text for images associated with the link to help documentation
String getLink(String docLink)
Constructs a link to help documentation
String getTitle(String docLink)
Retrieves the title for the link to help documentation
boolean isLocal(String docLink)
Retrieves the location of the help documentation
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.confluence.util.i18n.DocumentationBean

Public Constructors

public VersionSpecificDocumentationBean (SystemInformationService systemInformationService, I18NBean i18NBean)

Public Methods

public boolean exists (String docLink)

Returns true if the documentation link exists, otherwise false.

public String getAlt (String docLink)

Retrieves the alt text for images associated with the link to help documentation

Parameters
docLink the page title
Returns
  • alt text for images that may be used as or with the link

public String getLink (String docLink)

Constructs a link to help documentation

Parameters
docLink the page title
Returns
  • link to help documentation

public String getTitle (String docLink)

Retrieves the title for the link to help documentation

Parameters
docLink the page title
Returns
  • title for the link

public boolean isLocal (String docLink)

Retrieves the location of the help documentation

Parameters
docLink the page title
Returns
  • true if the documentation is local to the instance, false if it is external