Package com.intellij.codeInsight.hints

Class HintWidthAdjustment

java.lang.Object

com.intellij.codeInsight.hints.HintWidthAdjustment

public class HintWidthAdjustment
extends java.lang.Object

Defines the adjustment to inlay hint's width. This supports the scenario when existing hint is replaced with some text (and possibly other hint), and we want to avoid shifting the following text. This is implemented by introducing an additional spacing at a given offset in hint's text (InlayInfo#getText()) to make hint's width equal to width of given editor text plus optionally a width of a hint with another text. If matching widths would require decreasing hint's width, no adjustment is performed.

See Also:

InlayParameterHintsProvider.getParameterHints(PsiElement), InlayInfo

Constructor Summary

Constructors

Constructor and Description
HintWidthAdjustment(java.lang.String editorTextToMatch, java.lang.String hintTextToMatch, int adjustmentOffset)

Method Summary

Modifier and Type	Method and Description
int	getAdjustmentPosition() Position in hint's text where the additional spacing should be inserted
java.lang.String	getEditorTextToMatch() Editor text, which width should be matched
java.lang.String	getHintTextToMatch() Text of hint, which width should be added to editor text width for matching

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HintWidthAdjustment

public HintWidthAdjustment(java.lang.String editorTextToMatch,
                           java.lang.String hintTextToMatch,
                           int adjustmentOffset)

Method Detail

getEditorTextToMatch

public java.lang.String getEditorTextToMatch()

Editor text, which width should be matched

getHintTextToMatch

public java.lang.String getHintTextToMatch()

Text of hint, which width should be added to editor text width for matching

getAdjustmentPosition

public int getAdjustmentPosition()

Position in hint's text where the additional spacing should be inserted