Interface Link
-
- All Known Implementing Classes:
CreatePageLink
,DefaultLink
,EmptyLink
,NotPermittedLink
,UnresolvedLink
public interface Link
Represents a link.- Since:
- 4.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getAnchor()
LinkBody<?>
getBody()
ResourceIdentifier
getDestinationResourceIdentifier()
Optional<String>
getTarget()
Returns the target attribute for the link.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
String getTooltip()
- Returns:
- tooltip
-
getAnchor
String getAnchor()
- Returns:
- link anchor
-
getTarget
Optional<String> getTarget()
Returns the target attribute for the link. Only "_blank" is supported.- Returns:
- target attribute
-
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.
-
-