io.jmix.ui.component.autocomplete

Class Suggestion

java.lang.Object

io.jmix.ui.component.autocomplete.Suggestion

public class Suggestion
extends java.lang.Object

Class for single suggestion for an AutoCompleteSupport field.
Single suggestion has three attributes:

• Suggestion value itself. If user selects this suggestion this value will be inserted to text field.
• Display value that is presented inside the suggestion box.
• Cursor positions (start and end) for the replacement.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	displayText
protected int	endPosition
protected int	startPosition
protected java.lang.String	valueSuffix
protected java.lang.String	valueText

Constructor Summary

Constructors

Constructor and Description
Suggestion(AutoCompleteSupport component, java.lang.String displayText, java.lang.String valueText, java.lang.String valueSuffix, int startPosition, int endPosition) Create new suggestion.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayText()
int	getEndPosition()
int	getStartPosition()
java.lang.String	getValueSuffix()
java.lang.String	getValueText()

Methods inherited from class java.lang.Object

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

Field Detail

displayText

protected java.lang.String displayText

valueText

protected java.lang.String valueText

valueSuffix

protected java.lang.String valueSuffix

startPosition

protected int startPosition

endPosition

protected int endPosition

Constructor Detail

Suggestion

public Suggestion(AutoCompleteSupport component,
                  java.lang.String displayText,
                  java.lang.String valueText,
                  java.lang.String valueSuffix,
                  int startPosition,
                  int endPosition)

Create new suggestion.

Parameters:

displayText - Text to display in the suggestion box

valueText - Value to be inserted into text field if this suggestion is selected.

valueSuffix - The part of the value that is located after the current cursor position. This is used by the client-side filtering method.

startPosition - Start position of the replacement. Must be positive and below length of text in textfield. If negative number is given the current cursor position is used.

endPosition - End position of the replacement. Must be positive and below length of text in textfield. If negative number is given the current cursor position is used.

Method Detail

getValueSuffix

public java.lang.String getValueSuffix()

getDisplayText

public java.lang.String getDisplayText()

getValueText

public java.lang.String getValueText()

getStartPosition

public int getStartPosition()

getEndPosition

public int getEndPosition()