sirius.web.controller

Class AutocompleteHelper.Completion

java.lang.Object

sirius.web.controller.AutocompleteHelper.Completion

Enclosing class:

AutocompleteHelper

public static class AutocompleteHelper.Completion
extends Object

Represents a suggestion or completion of a given keyword

Constructor Summary

Constructors

Constructor and Description
Completion(String value) Generates a new suggestion
Completion(String value, String label) Generates a new suggestion
Completion(String value, String label, String description) Generates a new suggestion

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the description of the suggestion
String	getLabel() Returns the label shown to the user
String	getValue() Returns the effective value of the suggestion
AutocompleteHelper.Completion	setDescription(String description) Sets the description for the suggestion
AutocompleteHelper.Completion	setDisabled(boolean disabled) Sets if the suggestion should be disabled Uses standard select2 functionality to have entries in the select, that can't be selected.
AutocompleteHelper.Completion	setLabel(String label) Sets the label for the suggestion
AutocompleteHelper.Completion	setValue(String value) Sets the value for the suggestion

Methods inherited from class java.lang.Object

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

Constructor Detail

Completion

public Completion(String value)

Generates a new suggestion

Parameters:

value - the effective value to fill into the field

Completion

public Completion(String value,
                  String label)

Generates a new suggestion

Parameters:

value - the effective value to fill into the field

label - the text to display to the user

Completion

public Completion(String value,
                  String label,
                  @Nullable
                  String description)

Generates a new suggestion

Parameters:

value - the effective value to fill into the field

label - the text to display to the user

description - the text shown in the autocomplete-dropdown

Method Detail

setLabel

public AutocompleteHelper.Completion setLabel(String label)

Sets the label for the suggestion

Parameters:

label - the label shown to the user

Returns:

the completion itself for fluent method calls

setValue

public AutocompleteHelper.Completion setValue(String value)

Sets the value for the suggestion

Parameters:

value - the value used in the entry field

Returns:

the completion itself for fluent method calls

getValue

public String getValue()

Returns the effective value of the suggestion

Returns:

the effective value

getLabel

public String getLabel()

Returns the label shown to the user

Returns:

the label of the suggestion

getDescription

public String getDescription()

Returns the description of the suggestion

Returns:

the description to show to the user

setDescription

public AutocompleteHelper.Completion setDescription(String description)

Sets the description for the suggestion

Parameters:

description - the description to show to the user

Returns:

the completion itself for fluent method calls

setDisabled

public AutocompleteHelper.Completion setDisabled(boolean disabled)

Sets if the suggestion should be disabled

Uses standard select2 functionality to have entries in the select, that can't be selected.

Parameters:

disabled - true if the suggestion is disabled, false otherwise

Returns:

the completion itself for fluent method calls