org.netbeans.spi.lsp

Interface HoverProvider

@MimeLocation(subfolderName="HoverProviders")
public interface HoverProvider

Interface for resolving hover information at a given document position. Implementations of the interface should be registered in MimeLookup.

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

Since:

1.2

Method Summary

Modifier and Type	Method and Description
CompletableFuture<String>	getHoverContent(Document doc, int offset) Resolves a hover information at the given document offset and returns its content.

Method Detail

getHoverContent

@NonNull
CompletableFuture<String> getHoverContent(@NonNull
                                                   Document doc,
                                                   int offset)

Resolves a hover information at the given document offset and returns its content.

Parameters:

doc - document on which to operate.

offset - offset within document

Returns:

a HTML formatted content

Since:

1.2