Package org.eclipse.lsp4j

Class InlayHintLabelPart

  • public class InlayHintLabelPart
extends java.lang.Object
    An inlay hint label part allows for interactive and composite labels of inlay hints.

    Since 3.17.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      Command getCommand()
      An optional command for this label part.
      Location getLocation()
      An optional source code location that represents this label part.
      org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,​MarkupContent> getTooltip()
      The tooltip text when you hover over this label part.
      java.lang.String getValue()
      The value of this label part.
      int hashCode()  
      void setCommand​(Command command)
      An optional command for this label part.
      void setLocation​(Location location)
      An optional source code location that represents this label part.
      void setTooltip​(java.lang.String tooltip)  
      void setTooltip​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,​MarkupContent> tooltip)
      The tooltip text when you hover over this label part.
      void setTooltip​(MarkupContent tooltip)  
      void setValue​(java.lang.String value)
      The value of this label part.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • InlayHintLabelPart

        public InlayHintLabelPart()

      • InlayHintLabelPart

        public InlayHintLabelPart​(java.lang.String value)

    • Method Detail

      • getValue

        public java.lang.String getValue()
        The value of this label part.

      • setValue

        public void setValue​(java.lang.String value)
        The value of this label part.

      • getTooltip

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,​MarkupContent> getTooltip()
        The tooltip text when you hover over this label part. Depending on the client capability InlayHintCapabilities.resolveSupport clients might resolve this property late using the resolve request.

      • setTooltip

        public void setTooltip​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,​MarkupContent> tooltip)
        The tooltip text when you hover over this label part. Depending on the client capability InlayHintCapabilities.resolveSupport clients might resolve this property late using the resolve request.

      • setTooltip

        public void setTooltip​(java.lang.String tooltip)

      • getLocation

        public Location getLocation()
        An optional source code location that represents this label part.

        The editor will use this location for the hover and for code navigation features: This part will become a clickable link that resolves to the definition of the symbol at the given location (not necessarily the location itself), it shows the hover that shows at the given location, and it shows a context menu with further code navigation commands.

        Depending on the client capability InlayHintCapabilities.resolveSupport clients might resolve this property late using the resolve request.

      • setLocation

        public void setLocation​(Location location)
        An optional source code location that represents this label part.

        The editor will use this location for the hover and for code navigation features: This part will become a clickable link that resolves to the definition of the symbol at the given location (not necessarily the location itself), it shows the hover that shows at the given location, and it shows a context menu with further code navigation commands.

        Depending on the client capability InlayHintCapabilities.resolveSupport clients might resolve this property late using the resolve request.

      • getCommand

        public Command getCommand()
        An optional command for this label part.

        Depending on the client capability InlayHintCapabilities.resolveSupport clients might resolve this property late using the resolve request.

      • setCommand

        public void setCommand​(Command command)
        An optional command for this label part.

        Depending on the client capability InlayHintCapabilities.resolveSupport clients might resolve this property late using the resolve request.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object