Class AbstractComboBox<RECORD,VALUE>
java.lang.Object
org.teamapps.ux.component.AbstractComponent
org.teamapps.ux.component.field.AbstractField<VALUE>
org.teamapps.ux.component.field.combobox.AbstractComboBox<RECORD,VALUE>
- All Implemented Interfaces:
ClientObject,Component,TextInputHandlingField
- Direct Known Subclasses:
ComboBox,TagComboBox
public abstract class AbstractComboBox<RECORD,VALUE> extends AbstractField<VALUE> implements TextInputHandlingField
-
Field Summary
Fields Modifier and Type Field Description protected java.util.function.Function<java.lang.String,RECORD>freeTextRecordFactoryEvent<SpecialKey>onSpecialKeyPressedEvent<java.lang.String>onTextInputprotected ClientRecordCache<RECORD,org.teamapps.dto.UiComboBoxTreeRecord>recordCacheFields inherited from class org.teamapps.ux.component.field.AbstractField
onValueChanged, onVisibilityChangedFields inherited from class org.teamapps.ux.component.AbstractComponent
DELETED_ATTRIBUTE, onRendered -
Constructor Summary
Constructors Modifier Constructor Description protectedAbstractComboBox()protectedAbstractComboBox(ComboBoxModel<RECORD> model) -
Method Summary
Modifier and Type Method Description protected voidaddParentLinkToUiRecord(RECORD record, org.teamapps.dto.UiComboBoxTreeRecord uiTreeRecord, java.util.Map<RECORD,org.teamapps.dto.UiComboBoxTreeRecord> othersCurrentlyBeingAddedToCache)protected org.teamapps.dto.UiComboBoxTreeRecordcreateUiTreeRecordWithoutParentRelation(RECORD record)TemplategetDropDownTemplate()TemplateDecider<RECORD>getDropdownTemplateDecider()java.lang.StringgetEmptyText()java.util.function.Function<java.lang.String,RECORD>getFreeTextRecordFactory()ComboBoxModel<RECORD>getModel()PropertyProvider<RECORD>getPropertyProvider()java.util.function.Function<RECORD,java.lang.String>getRecordToStringFunction()TemplategetSelectedEntryTemplate()TemplateDecider<RECORD>getSelectedEntryTemplateDecider()protected abstract java.util.Set<RECORD>getSelectedRecords()intgetTextHighlightingEntryLimit()voidhandleUiEvent(org.teamapps.dto.UiEvent event)java.util.concurrent.CompletableFuture<?>handleUiQuery(org.teamapps.dto.UiQuery query)booleanisAllowFreeText()booleanisAnimate()booleanisAutoComplete()booleanisDistinctModelResultFiltering()booleanisDropDownButtonVisible()protected booleanisFreeTextEntry(org.teamapps.dto.UiComboBoxTreeRecord uiTreeRecord)booleanisHighlightFirstResultEntry()booleanisShowClearButton()booleanisShowDropDownAfterResultsArrive()booleanisShowExpanders()booleanisShowHighlighting()protected voidmapCommonUiComboBoxProperties(org.teamapps.dto.UiComboBox ui)Event<SpecialKey>onSpecialKeyPressed()Event<java.lang.String>onTextInput()voidsetAllowFreeText(boolean allowFreeText)voidsetAnimate(boolean animate)voidsetAutoComplete(boolean autoComplete)voidsetDistinctModelResultFiltering(boolean distinctModelResultFiltering)voidsetDropDownButtonVisible(boolean dropDownButtonVisible)voidsetDropDownTemplate(Template dropDownTemplate)voidsetDropdownTemplateDecider(TemplateDecider<RECORD> dropdownTemplateDecider)voidsetEmptyText(java.lang.String emptyText)voidsetFreeTextRecordFactory(java.util.function.Function<java.lang.String,RECORD> freeTextRecordFactory)voidsetHighlightFirstResultEntry(boolean highlightFirstResultEntry)voidsetModel(ComboBoxModel<RECORD> model)voidsetPropertyExtractor(PropertyExtractor<RECORD> propertyExtractor)voidsetPropertyProvider(PropertyProvider<RECORD> propertyProvider)voidsetRecordToStringFunction(java.util.function.Function<RECORD,java.lang.String> recordToStringFunction)voidsetSelectedEntryTemplate(Template selectedEntryTemplate)voidsetSelectedEntryTemplateDecider(TemplateDecider<RECORD> selectedEntryTemplateDecider)voidsetShowClearButton(boolean showClearButton)voidsetShowDropDownAfterResultsArrive(boolean showDropDownAfterResultsArrive)voidsetShowExpanders(boolean showExpanders)voidsetShowHighlighting(boolean showHighlighting)voidsetTemplate(Template template)voidsetTemplateDecider(TemplateDecider<RECORD> templateDecider)voidsetTextHighlightingEntryLimit(int textHighlightingEntryLimit)Methods inherited from class org.teamapps.ux.component.field.AbstractField
addCustomFieldMessage, addCustomFieldMessage, addValidator, applyValueFromUi, clearCustomFieldMessages, clearValidatorMessages, convertUiValueToUxValue, convertUxValueToUiValue, focus, getCustomFieldMessages, getDefaultMessagePosition, getDefaultMessageVisibility, getEditingMode, getFieldMessages, getMaxFieldMessageSeverity, getValidators, getValue, isEmpty, isRequired, isValid, isValueChangedByClient, mapAbstractFieldAttributesToUiField, removeCustomFieldMessage, removeValidator, setAndLockValue, setCustomFieldMessages, setDefaultMessagePosition, setDefaultMessageVisibility, setEditingMode, setRequired, setRequiredIfVisibleAndEditable, setValue, setValueChangedByClient, setVisible, validateMethods inherited from class org.teamapps.ux.component.AbstractComponent
createUiComponent, createUiReference, getDebuggingId, getId, getParent, getSessionContext, isRendered, isVisible, mapAbstractUiComponentProperties, queueCommandIfRendered, render, reRenderIfRendered, setAttribute, setCssStyle, setDebuggingId, setParent, toggleCssClass, toString, unrenderMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.teamapps.ux.component.Component
setAttribute, setCssStyle, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setShadow, toggleCssClassMethods inherited from interface org.teamapps.ux.component.field.TextInputHandlingField
defaultHandleTextInputEvent
-
Field Details
-
onTextInput
-
onSpecialKeyPressed
-
recordCache
-
freeTextRecordFactory
-
-
Constructor Details
-
AbstractComboBox
-
AbstractComboBox
protected AbstractComboBox()
-
-
Method Details
-
mapCommonUiComboBoxProperties
protected void mapCommonUiComboBoxProperties(org.teamapps.dto.UiComboBox ui) -
handleUiEvent
public void handleUiEvent(org.teamapps.dto.UiEvent event)- Specified by:
handleUiEventin interfaceClientObject- Overrides:
handleUiEventin classAbstractField<VALUE>
-
handleUiQuery
public java.util.concurrent.CompletableFuture<?> handleUiQuery(org.teamapps.dto.UiQuery query)- Specified by:
handleUiQueryin interfaceClientObject
-
getSelectedRecords
-
createUiTreeRecordWithoutParentRelation
protected org.teamapps.dto.UiComboBoxTreeRecord createUiTreeRecordWithoutParentRelation(RECORD record) -
addParentLinkToUiRecord
-
isFreeTextEntry
protected boolean isFreeTextEntry(org.teamapps.dto.UiComboBoxTreeRecord uiTreeRecord) -
isAnimate
public boolean isAnimate() -
getModel
-
setModel
-
isDropDownButtonVisible
public boolean isDropDownButtonVisible() -
isShowDropDownAfterResultsArrive
public boolean isShowDropDownAfterResultsArrive() -
isHighlightFirstResultEntry
public boolean isHighlightFirstResultEntry() -
isAutoComplete
public boolean isAutoComplete() -
isShowHighlighting
public boolean isShowHighlighting() -
getTextHighlightingEntryLimit
public int getTextHighlightingEntryLimit() -
isAllowFreeText
public boolean isAllowFreeText() -
isShowClearButton
public boolean isShowClearButton() -
setDropDownButtonVisible
public void setDropDownButtonVisible(boolean dropDownButtonVisible) -
setShowDropDownAfterResultsArrive
public void setShowDropDownAfterResultsArrive(boolean showDropDownAfterResultsArrive) -
setHighlightFirstResultEntry
public void setHighlightFirstResultEntry(boolean highlightFirstResultEntry) -
setAutoComplete
public void setAutoComplete(boolean autoComplete) -
setShowHighlighting
public void setShowHighlighting(boolean showHighlighting) -
setAllowFreeText
public void setAllowFreeText(boolean allowFreeText) -
setShowClearButton
public void setShowClearButton(boolean showClearButton) -
setAnimate
public void setAnimate(boolean animate) -
isShowExpanders
public boolean isShowExpanders() -
setShowExpanders
public void setShowExpanders(boolean showExpanders) -
setSelectedEntryTemplate
-
setDropDownTemplate
-
setTemplate
-
setTextHighlightingEntryLimit
public void setTextHighlightingEntryLimit(int textHighlightingEntryLimit) -
getSelectedEntryTemplate
-
getDropDownTemplate
-
getSelectedEntryTemplateDecider
-
setSelectedEntryTemplateDecider
-
getDropdownTemplateDecider
-
setDropdownTemplateDecider
-
setTemplateDecider
-
getFreeTextRecordFactory
-
setFreeTextRecordFactory
public void setFreeTextRecordFactory(java.util.function.Function<java.lang.String,RECORD> freeTextRecordFactory) -
getRecordToStringFunction
-
setRecordToStringFunction
public void setRecordToStringFunction(java.util.function.Function<RECORD,java.lang.String> recordToStringFunction) -
getPropertyProvider
-
setPropertyProvider
-
setPropertyExtractor
-
getEmptyText
public java.lang.String getEmptyText() -
setEmptyText
public void setEmptyText(java.lang.String emptyText) -
isDistinctModelResultFiltering
public boolean isDistinctModelResultFiltering() -
setDistinctModelResultFiltering
public void setDistinctModelResultFiltering(boolean distinctModelResultFiltering) -
onTextInput
- Specified by:
onTextInputin interfaceTextInputHandlingField
-
onSpecialKeyPressed
- Specified by:
onSpecialKeyPressedin interfaceTextInputHandlingField
-