Package org.teamapps.ux.component.field.combobox

Class TagComboBox<RECORD>

java.lang.Object

org.teamapps.ux.component.AbstractComponent

org.teamapps.ux.component.field.AbstractField<List<RECORD>>

org.teamapps.ux.component.field.combobox.AbstractComboBox<RECORD,List<RECORD>>

org.teamapps.ux.component.field.combobox.TagComboBox<RECORD>

All Implemented Interfaces:

ClientObject, Component, TextInputHandlingField

public class TagComboBox<RECORD>
extends AbstractComboBox<RECORD,List<RECORD>>

Field Summary

Fields

Modifier and Type	Field	Description
final Event<String>	onFreeTextEntered
final Event<String>	onFreeTextRemoved

Fields inherited from class org.teamapps.ux.component.field.combobox.AbstractComboBox

freeTextRecordFactory, onSpecialKeyPressed, onTextInput, recordCache

Fields inherited from class org.teamapps.ux.component.field.AbstractField

onBlur, onFocus, onValueChanged, onVisibilityChanged

Fields inherited from class org.teamapps.ux.component.AbstractComponent

DELETED_ATTRIBUTE, onRendered

Constructor Summary

Constructors

Constructor	Description
TagComboBox()
TagComboBox(Template template)
TagComboBox(ComboBoxModel<RECORD> model)

Method Summary

Modifier and Type	Method	Description
List<RECORD>	convertUiValueToUxValue(Object value)
Object	convertUxValueToUiValue(List<RECORD> uxValue)	Converts a server-side value to a client-side field-specific value.
static <ENUM extends Enum> TagComboBox<ENUM>	createForEnum(Class<ENUM> enumClass)
static <R> TagComboBox<R>	createForList(List<R> staticData)
static <R> TagComboBox<R>	createForList(List<R> staticData, Template template)
static <R> TagComboBox<R>	createForList(List<R> staticData, TreeNodeInfoExtractor<R> treeNodeInfoExtractor)
UiField	createUiComponent()
List<String>	getFreeTextEntries()
int	getMaxEntries()
protected Set<RECORD>	getSelectedRecords()
TagBoxWrappingMode	getWrappingMode()
boolean	isDistinct()
protected boolean	isEmptyValue(List<RECORD> records)	Whether this value be regarded as empty / "no user input".
boolean	isTwoStepDeletion()
void	setDistinct(boolean distinct)
void	setFreeTextEntries(List<String> freeTextEntries)
void	setMaxEntries(int maxEntries)
void	setTwoStepDeletion(boolean twoStepDeletion)
void	setValue(List<RECORD> records)
void	setWrappingMode(TagBoxWrappingMode wrappingMode)

Methods inherited from class org.teamapps.ux.component.field.combobox.AbstractComboBox

addParentLinkToUiRecord, createUiTreeRecordWithoutParentRelation, getDropDownMaxHeight, getDropDownMinWidth, getDropDownTemplate, getDropdownTemplateDecider, getEmptyText, getFreeTextRecordFactory, getModel, getPropertyProvider, getRecordToStringFunction, getSelectedEntryTemplate, getSelectedEntryTemplateDecider, getTextHighlightingEntryLimit, handleUiEvent, handleUiQuery, isAllowFreeText, isAnimate, isAutoComplete, isDistinctModelResultFiltering, isDropDownButtonVisible, isFreeTextEntry, isHighlightFirstResultEntry, isShowClearButton, isShowDropDownAfterResultsArrive, isShowExpanders, isShowHighlighting, mapCommonUiComboBoxProperties, onSpecialKeyPressed, onTextInput, setAllowFreeText, setAnimate, setAutoComplete, setDistinctModelResultFiltering, setDropDownButtonVisible, setDropDownMaxHeight, setDropDownMinWidth, setDropDownTemplate, setDropdownTemplateDecider, setEmptyText, setFreeTextRecordFactory, setHighlightFirstResultEntry, setModel, setPropertyExtractor, setPropertyProvider, setRecordToStringFunction, setSelectedEntryTemplate, setSelectedEntryTemplateDecider, setShowClearButton, setShowDropDownAfterResultsArrive, setShowExpanders, setShowHighlighting, setTemplate, setTemplateDecider, setTextHighlightingEntryLimit

Methods inherited from class org.teamapps.ux.component.field.AbstractField

addCustomFieldMessage, addCustomFieldMessage, addValidator, applyValueFromUi, clearCustomFieldMessages, clearValidatorMessages, focus, getCustomFieldMessages, getDefaultMessagePosition, getDefaultMessageVisibility, getEditingMode, getFieldMessages, getMaxFieldMessageSeverity, getValidators, getValue, isEmpty, isRequired, isValid, isValueChangedByClient, isValueLocked, mapAbstractFieldAttributesToUiField, removeCustomFieldMessage, removeValidator, setAndLockValue, setCustomFieldMessages, setDefaultMessagePosition, setDefaultMessageVisibility, setEditingMode, setRequired, setRequiredIfVisibleAndEditable, setValueChangedByClient, setVisible, validate

Methods inherited from class org.teamapps.ux.component.AbstractComponent

createUiReference, getDebuggingId, getId, getParent, getSessionContext, isRendered, isVisible, mapAbstractUiComponentProperties, queueCommandIfRendered, render, reRenderIfRendered, setAttribute, setCssStyle, setDebuggingId, setParent, toggleCssClass, toString, unrender

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.teamapps.ux.component.Component

setAriaLabel, setAttribute, setCssStyle, setHtmlTitle, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setShadow, toggleCssClass

Methods inherited from interface org.teamapps.ux.component.field.TextInputHandlingField

defaultHandleTextInputEvent

Field Details

onFreeTextEntered

public final Event<String> onFreeTextEntered

onFreeTextRemoved

public final Event<String> onFreeTextRemoved

Constructor Details

TagComboBox

public TagComboBox()

TagComboBox

public TagComboBox(Template template)

TagComboBox

public TagComboBox(ComboBoxModel<RECORD> model)

Method Details

getSelectedRecords

protected Set<RECORD> getSelectedRecords()

Specified by:

getSelectedRecords in class AbstractComboBox<RECORD,List<RECORD>>

createForList

public static <R> TagComboBox<R> createForList(List<R> staticData)

createForList

public static <R> TagComboBox<R> createForList(List<R> staticData,
 Template template)

createForList

public static <R> TagComboBox<R> createForList(List<R> staticData,
 TreeNodeInfoExtractor<R> treeNodeInfoExtractor)

createForEnum

public static <ENUM extends Enum> TagComboBox<ENUM> createForEnum(Class<ENUM> enumClass)

createUiComponent

public UiField createUiComponent()

Specified by:

createUiComponent in class AbstractComponent

setValue

public void setValue(List<RECORD> records)

Overrides:

setValue in class AbstractField<List<RECORD>>

convertUiValueToUxValue

public List<RECORD> convertUiValueToUxValue(Object value)

Overrides:

convertUiValueToUxValue in class AbstractField<List<RECORD>>

isEmptyValue

protected boolean isEmptyValue(List<RECORD> records)

Description copied from class: AbstractField

Whether this value be regarded as empty / "no user input". Override for field-specific behaviour.

Overrides:

isEmptyValue in class AbstractField<List<RECORD>>

Returns:

true if the value can be regarded as "empty".

convertUxValueToUiValue

public Object convertUxValueToUiValue(List<RECORD> uxValue)

Description copied from class: AbstractField

Converts a server-side value to a client-side field-specific value. Implementations must not have any side effects to the component!

Overrides:

convertUxValueToUiValue in class AbstractField<List<RECORD>>

Parameters:

uxValue - the server-side value

Returns:

the object to be sent to the ui

getMaxEntries

public int getMaxEntries()

setMaxEntries

public void setMaxEntries(int maxEntries)

getWrappingMode

public TagBoxWrappingMode getWrappingMode()

setWrappingMode

public void setWrappingMode(TagBoxWrappingMode wrappingMode)

isDistinct

public boolean isDistinct()

setDistinct

public void setDistinct(boolean distinct)

getFreeTextEntries

public List<String> getFreeTextEntries()

setFreeTextEntries

public void setFreeTextEntries(List<String> freeTextEntries)

isTwoStepDeletion

public boolean isTwoStepDeletion()

setTwoStepDeletion

public void setTwoStepDeletion(boolean twoStepDeletion)