Package org.eclipse.lsp4j

Class SignatureHelpContext

  • public class SignatureHelpContext
extends java.lang.Object
    Additional information about the context in which a signature help request was triggered.

    Since 3.15.0

    • Constructor Detail

      • SignatureHelpContext

        public SignatureHelpContext()

    • Method Detail

      • setTriggerKind

        public void setTriggerKind​(SignatureHelpTriggerKind triggerKind)
        Action that caused signature help to be triggered.

      • getTriggerCharacter

        public java.lang.String getTriggerCharacter()
        Character that caused signature help to be triggered.

        This is undefined when triggerKind is not SignatureHelpTriggerKind.TriggerCharacter

      • setTriggerCharacter

        public void setTriggerCharacter​(java.lang.String triggerCharacter)
        Character that caused signature help to be triggered.

        This is undefined when triggerKind is not SignatureHelpTriggerKind.TriggerCharacter

      • isRetrigger

        public boolean isRetrigger()
        true if signature help was already showing when it was triggered.

        Retriggers occur when the signature help is already active and can be caused by actions such as typing a trigger character, a cursor move, or document content changes.

      • setIsRetrigger

        public void setIsRetrigger​(boolean isRetrigger)
        true if signature help was already showing when it was triggered.

        Retriggers occur when the signature help is already active and can be caused by actions such as typing a trigger character, a cursor move, or document content changes.

      • getActiveSignatureHelp

        public SignatureHelp getActiveSignatureHelp()
        The currently active SignatureHelp.

        The `activeSignatureHelp` has its SignatureHelp.activeSignature field updated based on the user navigating through available signatures.

      • setActiveSignatureHelp

        public void setActiveSignatureHelp​(SignatureHelp activeSignatureHelp)
        The currently active SignatureHelp.

        The `activeSignatureHelp` has its SignatureHelp.activeSignature field updated based on the user navigating through available signatures.

      • 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