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

Class AbstractComboBox<COMPONENT extends 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<COMPONENT,RECORD,VALUE>

All Implemented Interfaces:

Component, TextInputHandlingField

Direct Known Subclasses:

ComboBox, TagComboBox

public abstract class AbstractComboBox<COMPONENT extends 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>	freeTextRecordFactory
Event<SpecialKey>	onSpecialKeyPressed
Event<java.lang.String>	onTextInput
protected ClientRecordCache<RECORD,org.teamapps.dto.UiComboBoxTreeRecord>	recordCache

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

onValueChanged, onVisibilityChanged

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

onDestroyed, onRendered

Constructor Summary

Constructors

Modifier	Constructor	Description
	AbstractComboBox(java.util.List<RECORD> staticData)
protected	AbstractComboBox(BaseTreeModel<RECORD> model)

Method Summary

Modifier and Type	Method	Description
void	addDropDownItem(RECORD record)
void	addDropDownItems(java.util.List<RECORD> records)
void	addDropDownItems(RECORD... records)
protected void	addParentLinkToUiRecord(RECORD record, org.teamapps.dto.UiComboBoxTreeRecord uiTreeRecord, java.util.Map<RECORD,org.teamapps.dto.UiComboBoxTreeRecord> othersCurrentlyBeingAddedToCache)
protected org.teamapps.dto.UiComboBoxTreeRecord	createUiTreeRecordWithoutParentRelation(RECORD record)
protected void	doDestroy()	Override this method to release resources whenever this component gets destroyed
Template	getDropDownTemplate()
TemplateDecider<RECORD>	getDropdownTemplateDecider()
java.util.function.Function<java.lang.String,RECORD>	getFreeTextRecordFactory()
BaseTreeModel	getModel()
PropertyExtractor<RECORD>	getPropertyExtractor()
java.util.function.Function<RECORD,java.lang.String>	getRecordToStringFunction()
Template	getSelectedEntryTemplate()
TemplateDecider<RECORD>	getSelectedEntryTemplateDecider()
java.util.List<RECORD>	getStaticData()
int	getTextHighlightingEntryLimit()
TextMatchingMode	getTextMatchingMode()
TreeNodeInfoExtractor<RECORD>	getTreeNodeInfoExtractor()
void	handleUiEvent(org.teamapps.dto.UiEvent event)
boolean	isAllowFreeText()
boolean	isAnimate()
boolean	isAutoComplete()
protected boolean	isFreeTextEntry(org.teamapps.dto.UiComboBoxTreeRecord uiTreeRecord)
boolean	isHighlightFirstResultEntry()
boolean	isShowClearButton()
boolean	isShowDropDownAfterResultsArrive()
boolean	isShowDropDownButton()
boolean	isShowExpanders()
boolean	isShowHighlighting()
protected void	mapCommonUiComboBoxProperties(org.teamapps.dto.UiComboBox comboBox)
Event<SpecialKey>	onSpecialKeyPressed()
Event<java.lang.String>	onTextInput()
void	setAllowFreeText(boolean allowFreeText)
void	setAnimate(boolean animate)
void	setAutoComplete(boolean autoComplete)
void	setDropDownTemplate(Template dropDownTemplate)
void	setDropdownTemplateDecider(TemplateDecider<RECORD> dropdownTemplateDecider)
void	setFreeTextRecordFactory(java.util.function.Function<java.lang.String,RECORD> freeTextRecordFactory)
void	setHighlightFirstResultEntry(boolean highlightFirstResultEntry)
void	setModel(BaseTreeModel<RECORD> model)
void	setPropertyExtractor(PropertyExtractor<RECORD> propertyExtractor)
void	setRecordToStringFunction(java.util.function.Function<RECORD,java.lang.String> recordToStringFunction)
void	setSelectedEntryTemplate(Template selectedEntryTemplate)
void	setSelectedEntryTemplateDecider(TemplateDecider<RECORD> selectedEntryTemplateDecider)
void	setShowClearButton(boolean showClearButton)
void	setShowDropDownAfterResultsArrive(boolean showDropDownAfterResultsArrive)
void	setShowDropDownButton(boolean showDropDownButton)
void	setShowExpanders(boolean showExpanders)
void	setShowHighlighting(boolean showHighlighting)
void	setStaticData(java.util.List<RECORD> staticData)
void	setTemplate(Template template)
void	setTemplateDecider(TemplateDecider<RECORD> templateDecider)
void	setTextHighlightingEntryLimit(int textHighlightingEntryLimit)
void	setTextMatchingMode(TextMatchingMode textMatchingMode)
void	setTreeNodeInfoExtractor(TreeNodeInfoExtractor<RECORD> treeNodeInfoExtractor)

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

addCustomFieldMessage, addValidator, applyValueFromUi, clearCustomFieldMessages, convertUiValueToUxValue, convertUxValueToUiValue, focus, getCustomFieldMessages, getDefaultMessagePosition, getDefaultMessageVisibility, getEditingMode, getFieldMessages, getMaxFieldMessageSeverity, getValidators, getValue, isEmpty, isRequired, isValid, isVisible, mapAbstractFieldAttributesToUiField, removeCustomFieldMessage, removeValidator, setAndLockValue, setCustomFieldMessages, setDefaultMessagePosition, setDefaultMessageVisibility, setEditingMode, setRequired, setValue, setVisible, validate

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

createUiComponent, createUiComponentReference, destroy, getId, getParent, getSessionContext, isDestroyed, isEffectivelyVisible, isRendered, mapAbstractUiComponentProperties, onDestroyed, queueCommandIfRendered, render, reRenderIfRendered, setCssStyle, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setParent, setShadow, 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

setCssStyle

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

defaultHandleTextInputEvent

Field Detail

onTextInput

public final Event<java.lang.String> onTextInput

onSpecialKeyPressed

public final Event<SpecialKey> onSpecialKeyPressed

recordCache

protected final ClientRecordCache<RECORD,org.teamapps.dto.UiComboBoxTreeRecord> recordCache

freeTextRecordFactory

protected java.util.function.Function<java.lang.String,RECORD> freeTextRecordFactory

Constructor Detail

AbstractComboBox

protected AbstractComboBox(BaseTreeModel<RECORD> model)

AbstractComboBox

public AbstractComboBox(java.util.List<RECORD> staticData)

Method Detail

mapCommonUiComboBoxProperties

protected void mapCommonUiComboBoxProperties(org.teamapps.dto.UiComboBox comboBox)

handleUiEvent

public void handleUiEvent(org.teamapps.dto.UiEvent event)

Specified by:

handleUiEvent in interface Component

Overrides:

handleUiEvent in class AbstractField<VALUE>

createUiTreeRecordWithoutParentRelation

protected org.teamapps.dto.UiComboBoxTreeRecord createUiTreeRecordWithoutParentRelation(RECORD record)

addParentLinkToUiRecord

protected void addParentLinkToUiRecord(RECORD record,
                                       org.teamapps.dto.UiComboBoxTreeRecord uiTreeRecord,
                                       java.util.Map<RECORD,org.teamapps.dto.UiComboBoxTreeRecord> othersCurrentlyBeingAddedToCache)

isFreeTextEntry

protected boolean isFreeTextEntry(org.teamapps.dto.UiComboBoxTreeRecord uiTreeRecord)

doDestroy

protected void doDestroy()

Description copied from class: AbstractComponent

Override this method to release resources whenever this component gets destroyed

Overrides:

doDestroy in class AbstractComponent

isAnimate

public boolean isAnimate()

getStaticData

public java.util.List<RECORD> getStaticData()

setStaticData

public void setStaticData(java.util.List<RECORD> staticData)

addDropDownItem

public void addDropDownItem(RECORD record)

addDropDownItems

public void addDropDownItems(RECORD... records)

addDropDownItems

public void addDropDownItems(java.util.List<RECORD> records)

getModel

public BaseTreeModel getModel()

setModel

public void setModel(BaseTreeModel<RECORD> model)

getTextMatchingMode

public TextMatchingMode getTextMatchingMode()

isShowDropDownButton

public boolean isShowDropDownButton()

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()

setShowDropDownButton

public void setShowDropDownButton(boolean showDropDownButton)

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)

setTextMatchingMode

public void setTextMatchingMode(TextMatchingMode textMatchingMode)

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 java.util.function.Function<java.lang.String,RECORD> getFreeTextRecordFactory()

setFreeTextRecordFactory

public void setFreeTextRecordFactory(java.util.function.Function<java.lang.String,RECORD> freeTextRecordFactory)

getRecordToStringFunction

public java.util.function.Function<RECORD,java.lang.String> getRecordToStringFunction()

setRecordToStringFunction

public void setRecordToStringFunction(java.util.function.Function<RECORD,java.lang.String> recordToStringFunction)

getPropertyExtractor

public PropertyExtractor<RECORD> getPropertyExtractor()

setPropertyExtractor

public void setPropertyExtractor(PropertyExtractor<RECORD> propertyExtractor)

onTextInput

public Event<java.lang.String> onTextInput()

Specified by:

onTextInput in interface TextInputHandlingField

onSpecialKeyPressed

public Event<SpecialKey> onSpecialKeyPressed()

Specified by:

onSpecialKeyPressed in interface TextInputHandlingField

getTreeNodeInfoExtractor

public TreeNodeInfoExtractor<RECORD> getTreeNodeInfoExtractor()

setTreeNodeInfoExtractor

public void setTreeNodeInfoExtractor(TreeNodeInfoExtractor<RECORD> treeNodeInfoExtractor)