org.eclipse.lsp4j

Class SignatureHelpContext

java.lang.Object

org.eclipse.lsp4j.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 Summary

Constructors

Constructor and Description
SignatureHelpContext()
SignatureHelpContext(SignatureHelpTriggerKind triggerKind, boolean isRetrigger)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
SignatureHelp	getActiveSignatureHelp() The currently active SignatureHelp.
java.lang.String	getTriggerCharacter() Character that caused signature help to be triggered.
SignatureHelpTriggerKind	getTriggerKind() Action that caused signature help to be triggered.
int	hashCode()
boolean	isRetrigger() true if signature help was already showing when it was triggered.
void	setActiveSignatureHelp(SignatureHelp activeSignatureHelp) The currently active SignatureHelp.
void	setIsRetrigger(boolean isRetrigger) true if signature help was already showing when it was triggered.
void	setTriggerCharacter(java.lang.String triggerCharacter) Character that caused signature help to be triggered.
void	setTriggerKind(SignatureHelpTriggerKind triggerKind) Action that caused signature help to be triggered.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SignatureHelpContext

public SignatureHelpContext()

SignatureHelpContext

public SignatureHelpContext(SignatureHelpTriggerKind triggerKind,
                            boolean isRetrigger)

Method Detail

getTriggerKind

@Pure
public SignatureHelpTriggerKind getTriggerKind()

Action that caused signature help to be triggered.

setTriggerKind

public void setTriggerKind(SignatureHelpTriggerKind triggerKind)

Action that caused signature help to be triggered.

getTriggerCharacter

@Pure
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

@Pure
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

@Pure
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

@Pure
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

@Pure
public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

@Pure
public int hashCode()

Overrides:

hashCode in class java.lang.Object