com.atlassian.confluence.xhtml.api
Interface Link

All Known Implementing Classes:
CreatePageLink, DefaultLink, EmptyLink, NotPermittedLink, UnresolvedLink

public interface Link

Represents a link.

Since:
4.0

Method Summary
 java.lang.String getAnchor()
           
 LinkBody<?> getBody()
           
 ResourceIdentifier getDestinationResourceIdentifier()
           
 java.lang.String getTooltip()
           
 Link updateDestination(ResourceIdentifier destinationResourceIdentifier)
          Returns a new instance of this link with an updated destination.
 

Method Detail

getDestinationResourceIdentifier

ResourceIdentifier getDestinationResourceIdentifier()
Returns:
a resource identifier to the destination. If null then the link is a self reference.
See Also:
ResourceIdentifier

getBody

LinkBody<?> getBody()
Returns:
the body of the link (this may be text or an image)

getTooltip

java.lang.String getTooltip()
Returns:
tooltip

getAnchor

java.lang.String getAnchor()
Returns:
link anchor

updateDestination

Link updateDestination(ResourceIdentifier destinationResourceIdentifier)
Returns a new instance of this link with an updated destination.

Parameters:
destinationResourceIdentifier - the updated destination
Returns:
a new instance with the updated destination.


Copyright © 2003-2014 Atlassian. All Rights Reserved.