com.atlassian.confluence.util.i18n
Class VersionSpecificDocumentationBean

java.lang.Object
  extended by 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
VersionSpecificDocumentationBean(String versionNumber, I18NBean i18NBean)
           
 
Method Summary
 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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VersionSpecificDocumentationBean

public VersionSpecificDocumentationBean(String versionNumber,
                                        I18NBean i18NBean)
Method Detail

getLink

public String getLink(String docLink)
Description copied from interface: DocumentationBean
Constructs a link to help documentation

Specified by:
getLink in interface DocumentationBean
Parameters:
docLink - the page title
Returns:
link to help documentation

exists

public boolean exists(String docLink)
Description copied from interface: DocumentationBean
Returns true if the documentation link exists, otherwise false.

Specified by:
exists in interface DocumentationBean

getTitle

public String getTitle(String docLink)
Description copied from interface: DocumentationBean
Retrieves the title for the link to help documentation

Specified by:
getTitle in interface DocumentationBean
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 interface DocumentationBean
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 interface DocumentationBean
Parameters:
docLink - the page title
Returns:
true if the documentation is local to the instance, false if it is external


Copyright © 2003-2013 Atlassian. All Rights Reserved.