org.netbeans.spi.lsp

Interface HyperlinkLocationProvider

@MimeLocation(subfolderName="HyperlinkLocationProviders")
public interface HyperlinkLocationProvider

Interface for resolving hyperlink locations. Implementations of the interface should be registered in MimeLookup.

   @MimeRegistration(mimeType = "text/foo", service = HyperlinkLocationProvider.class)
   public class FooHyperlinkLocationProvider implements HyperlinkLocationProvider {
     ...
   }
  
 

Since:

1.0

Method Summary

Modifier and Type	Method and Description
static HyperlinkLocation	createHyperlinkLocation(FileObject fileObject, int startOffset, int endOffset) Creates HyperlinkLocation instances.
CompletableFuture<HyperlinkLocation>	getHyperlinkLocation(Document doc, int offset) Resolves a hyperlink at the given document offset and returns its target location.

Method Detail

getHyperlinkLocation

CompletableFuture<HyperlinkLocation> getHyperlinkLocation(@NonNull
                                                          Document doc,
                                                          int offset)

Resolves a hyperlink at the given document offset and returns its target location.

Parameters:

doc - document on which to operate.

offset - offset within document

Returns:

target location

Since:

1.0

createHyperlinkLocation

static HyperlinkLocation createHyperlinkLocation(@NonNull
                                                 FileObject fileObject,
                                                 int startOffset,
                                                 int endOffset)

Creates HyperlinkLocation instances.

Parameters:

fileObject - target file object of the hyperlink

startOffset - start offset of the hyperlink's target range

endOffset - end offset of the hyperlink's target range

Returns:

new created instance

Since:

1.0