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

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 Function<String,RECORD>	freeTextRecordFactory
final Event<SpecialKey>	onSpecialKeyPressed
final Event<String>	onTextInput
protected final ClientRecordCache<RECORD,UiComboBoxTreeRecord>	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

Modifier	Constructor	Description
protected	AbstractComboBox()
protected	AbstractComboBox(ComboBoxModel<RECORD> model)

Method Summary

Modifier and Type	Method	Description
protected void	addParentLinkToUiRecord(RECORD record, UiComboBoxTreeRecord uiTreeRecord, Map<RECORD,UiComboBoxTreeRecord> othersCurrentlyBeingAddedToCache)
protected UiComboBoxTreeRecord	createUiTreeRecordWithoutParentRelation(RECORD record)
Integer	getDropDownMaxHeight()
Integer	getDropDownMinWidth()
Template	getDropDownTemplate()
TemplateDecider<RECORD>	getDropdownTemplateDecider()
String	getEmptyText()
Function<String,RECORD>	getFreeTextRecordFactory()
ComboBoxModel<RECORD>	getModel()
PropertyProvider<RECORD>	getPropertyProvider()
Function<RECORD,String>	getRecordToStringFunction()
Template	getSelectedEntryTemplate()
TemplateDecider<RECORD>	getSelectedEntryTemplateDecider()
protected abstract Set<RECORD>	getSelectedRecords()
int	getTextHighlightingEntryLimit()
void	handleUiEvent(UiEvent event)
Object	handleUiQuery(UiQuery query)
boolean	isAllowFreeText()
boolean	isAnimate()
boolean	isAutoComplete()
boolean	isDistinctModelResultFiltering()
boolean	isDropDownButtonVisible()
protected boolean	isFreeTextEntry(UiComboBoxTreeRecord uiTreeRecord)
boolean	isHighlightFirstResultEntry()
boolean	isShowClearButton()
boolean	isShowDropDownAfterResultsArrive()
boolean	isShowExpanders()
boolean	isShowHighlighting()
protected void	mapCommonUiComboBoxProperties(AbstractUiComboBox ui)
Event<SpecialKey>	onSpecialKeyPressed()
Event<String>	onTextInput()
void	setAllowFreeText(boolean allowFreeText)
void	setAnimate(boolean animate)
void	setAutoComplete(boolean autoComplete)
void	setDistinctModelResultFiltering(boolean distinctModelResultFiltering)
void	setDropDownButtonVisible(boolean dropDownButtonVisible)
void	setDropDownMaxHeight(Integer dropDownMaxHeight)
void	setDropDownMinWidth(Integer dropDownMinWidth)
void	setDropDownTemplate(Template dropDownTemplate)
void	setDropdownTemplateDecider(TemplateDecider<RECORD> dropdownTemplateDecider)
void	setEmptyText(String emptyText)
void	setFreeTextRecordFactory(Function<String,RECORD> freeTextRecordFactory)
void	setHighlightFirstResultEntry(boolean highlightFirstResultEntry)
void	setModel(ComboBoxModel<RECORD> model)
void	setPropertyExtractor(PropertyExtractor<RECORD> propertyExtractor)
void	setPropertyProvider(PropertyProvider<RECORD> propertyProvider)
void	setRecordToStringFunction(Function<RECORD,String> recordToStringFunction)
void	setSelectedEntryTemplate(Template selectedEntryTemplate)
void	setSelectedEntryTemplateDecider(TemplateDecider<RECORD> selectedEntryTemplateDecider)
void	setShowClearButton(boolean showClearButton)
void	setShowDropDownAfterResultsArrive(boolean showDropDownAfterResultsArrive)
void	setShowExpanders(boolean showExpanders)
void	setShowHighlighting(boolean showHighlighting)
void	setTemplate(Template template)
void	setTemplateDecider(TemplateDecider<RECORD> templateDecider)
void	setTextHighlightingEntryLimit(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, isEmptyValue, isRequired, isValid, isValueChangedByClient, isValueLocked, mapAbstractFieldAttributesToUiField, removeCustomFieldMessage, removeValidator, setAndLockValue, setCustomFieldMessages, setDefaultMessagePosition, setDefaultMessageVisibility, setEditingMode, setRequired, setRequiredIfVisibleAndEditable, setValue, setValueChangedByClient, setVisible, validate

Methods 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, 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

onTextInput

public final Event<String> onTextInput

onSpecialKeyPressed

public final Event<SpecialKey> onSpecialKeyPressed

recordCache

protected final ClientRecordCache<RECORD,UiComboBoxTreeRecord> recordCache

freeTextRecordFactory

protected Function<String,RECORD> freeTextRecordFactory

Constructor Details

AbstractComboBox

protected AbstractComboBox(ComboBoxModel<RECORD> model)

AbstractComboBox

protected AbstractComboBox()

Method Details

mapCommonUiComboBoxProperties

protected void mapCommonUiComboBoxProperties(AbstractUiComboBox ui)

handleUiEvent

public void handleUiEvent(UiEvent event)

Specified by:

handleUiEvent in interface ClientObject

Overrides:

handleUiEvent in class AbstractField<VALUE>

handleUiQuery

public Object handleUiQuery(UiQuery query)

Specified by:

handleUiQuery in interface ClientObject

getSelectedRecords

protected abstract Set<RECORD> getSelectedRecords()

createUiTreeRecordWithoutParentRelation

protected UiComboBoxTreeRecord createUiTreeRecordWithoutParentRelation(RECORD record)

addParentLinkToUiRecord

protected void addParentLinkToUiRecord(RECORD record,
 UiComboBoxTreeRecord uiTreeRecord,
 Map<RECORD,UiComboBoxTreeRecord> othersCurrentlyBeingAddedToCache)

isFreeTextEntry

protected boolean isFreeTextEntry(UiComboBoxTreeRecord uiTreeRecord)

isAnimate

public boolean isAnimate()

getModel

public ComboBoxModel<RECORD> getModel()

setModel

public void setModel(ComboBoxModel<RECORD> model)

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

public void setSelectedEntryTemplate(Template selectedEntryTemplate)

setDropDownTemplate

public void setDropDownTemplate(Template dropDownTemplate)

setTemplate

public void setTemplate(Template template)

setTextHighlightingEntryLimit

public void setTextHighlightingEntryLimit(int textHighlightingEntryLimit)

getSelectedEntryTemplate

public Template getSelectedEntryTemplate()

getDropDownTemplate

public Template getDropDownTemplate()

getSelectedEntryTemplateDecider

public TemplateDecider<RECORD> getSelectedEntryTemplateDecider()

setSelectedEntryTemplateDecider

public void setSelectedEntryTemplateDecider(TemplateDecider<RECORD> selectedEntryTemplateDecider)

getDropdownTemplateDecider

public TemplateDecider<RECORD> getDropdownTemplateDecider()

setDropdownTemplateDecider

public void setDropdownTemplateDecider(TemplateDecider<RECORD> dropdownTemplateDecider)

setTemplateDecider

public void setTemplateDecider(TemplateDecider<RECORD> templateDecider)

getFreeTextRecordFactory

public Function<String,RECORD> getFreeTextRecordFactory()

setFreeTextRecordFactory

public void setFreeTextRecordFactory(Function<String,RECORD> freeTextRecordFactory)

getRecordToStringFunction

public Function<RECORD,String> getRecordToStringFunction()

setRecordToStringFunction

public void setRecordToStringFunction(Function<RECORD,String> recordToStringFunction)

getPropertyProvider

public PropertyProvider<RECORD> getPropertyProvider()

setPropertyProvider

public void setPropertyProvider(PropertyProvider<RECORD> propertyProvider)

setPropertyExtractor

public void setPropertyExtractor(PropertyExtractor<RECORD> propertyExtractor)

getEmptyText

public String getEmptyText()

setEmptyText

public void setEmptyText(String emptyText)

isDistinctModelResultFiltering

public boolean isDistinctModelResultFiltering()

setDistinctModelResultFiltering

public void setDistinctModelResultFiltering(boolean distinctModelResultFiltering)

getDropDownMinWidth

public Integer getDropDownMinWidth()

setDropDownMinWidth

public void setDropDownMinWidth(Integer dropDownMinWidth)

getDropDownMaxHeight

public Integer getDropDownMaxHeight()

setDropDownMaxHeight

public void setDropDownMaxHeight(Integer dropDownMaxHeight)

onTextInput

public Event<String> onTextInput()

Specified by:

onTextInput in interface TextInputHandlingField

onSpecialKeyPressed

public Event<SpecialKey> onSpecialKeyPressed()

Specified by:

onSpecialKeyPressed in interface TextInputHandlingField