Package io.jmix.flowui.kit.component.codeeditor.autocomplete

Class Suggestion

java.lang.Object

io.jmix.flowui.kit.component.codeeditor.autocomplete.Suggestion

All Implemented Interfaces:

Serializable

public class Suggestion
extends Object
implements Serializable

Class for single suggestion from Suggester for JmixCodeEditor component.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	descriptionText
protected String	displayText
protected String	suggestionText

Constructor Summary

Constructors

Constructor	Description
Suggestion(String displayText, String suggestionText)
Suggestion(String displayText, String suggestionText, String descriptionText)

Method Summary

Modifier and Type	Method	Description
String	getDescriptionText()
String	getDisplayText()
String	getSuggestionText()

Methods inherited from class java.lang.Object

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

Field Details

displayText

protected String displayText

suggestionText

protected String suggestionText

descriptionText

protected String descriptionText

Constructor Details

Suggestion

public Suggestion(String displayText,
 String suggestionText)

Parameters:

displayText - text displayed in the popup window for suggestions

suggestionText - the value inserted into the editor if the suggestion is selected

Suggestion

public Suggestion(String displayText,
 String suggestionText,
 @Nullable
 String descriptionText)

Parameters:

displayText - text displayed in the popup window for suggestions

suggestionText - the value inserted into the editor if the suggestion is selected

descriptionText - the hint text that appears next to the displayText in the popup window for suggestions

Method Details

getDisplayText

public String getDisplayText()

Returns:

text displayed in the popup window for suggestions

getSuggestionText

public String getSuggestionText()

Returns:

the value inserted into the editor if the suggestion is selected

getDescriptionText

public String getDescriptionText()

Returns:

the hint text that appears next to the displayText in the popup window for suggestions