Class VersionSpecificDocumentationBean
- java.lang.Object
-
- com.atlassian.confluence.util.i18n.VersionSpecificDocumentationBean
-
- All Implemented Interfaces:
DocumentationBean
public class VersionSpecificDocumentationBean extends Object implements DocumentationBean
Constructs a version specific link to Confluence's documentation.
-
-
Constructor Summary
Constructors Constructor Description VersionSpecificDocumentationBean(String versionNumber, I18NBean i18NBean)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
exists(String docLink)
Returnstrue
if the documentation link exists, otherwisefalse
.String
getAlt(String docLink)
Retrieves the alt text for images associated with the link to help documentationString
getLink(String key)
Constructs a link to help documentationString
getTitle(String docLink)
Retrieves the title for the link to help documentationboolean
isLocal(String docLink)
Retrieves the location of the help documentation
-
-
-
Method Detail
-
getLink
public String getLink(String key)
Description copied from interface:DocumentationBean
Constructs a link to help documentation- Specified by:
getLink
in interfaceDocumentationBean
- Parameters:
key
- the page title- Returns:
- link to help documentation
-
exists
public boolean exists(String docLink)
Description copied from interface:DocumentationBean
Returnstrue
if the documentation link exists, otherwisefalse
.- Specified by:
exists
in interfaceDocumentationBean
-
getTitle
public String getTitle(String docLink)
Description copied from interface:DocumentationBean
Retrieves the title for the link to help documentation- Specified by:
getTitle
in interfaceDocumentationBean
- Parameters:
docLink
- the page title- Returns:
- title for the link
-
getAlt
public String getAlt(String docLink)
Description copied from interface:DocumentationBean
Retrieves the alt text for images associated with the link to help documentation- Specified by:
getAlt
in interfaceDocumentationBean
- Parameters:
docLink
- the page title- Returns:
- alt text for images that may be used as or with the link
-
isLocal
public boolean isLocal(String docLink)
Description copied from interface:DocumentationBean
Retrieves the location of the help documentation- Specified by:
isLocal
in interfaceDocumentationBean
- Parameters:
docLink
- the page title- Returns:
- true if the documentation is local to the instance, false if it is external
-
-