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

Class ComboBox<RECORD>

java.lang.Object

org.teamapps.ux.component.AbstractComponent

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

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

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

All Implemented Interfaces:

ClientObject, Component, TextInputHandlingField

public class ComboBox<RECORD>
extends AbstractComboBox<RECORD,RECORD>
implements TextInputHandlingField

Field Summary

Fields

Modifier and Type	Field	Description
final Event<String>	onFreeTextEntered

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
ComboBox()
ComboBox(Template template)
ComboBox(ComboBoxModel<RECORD> model)

Method Summary

Modifier and Type	Method	Description
void	addToolButton(ToolButton toolButton)
RECORD	convertUiValueToUxValue(Object value)
Object	convertUxValueToUiValue(RECORD record)	Converts a server-side value to a client-side field-specific value.
static <ENUM extends Enum> ComboBox<ENUM>	createForEnum(Class<ENUM> enumClass)
static <R> ComboBox<R>	createForList(List<R> staticData)
static <R> ComboBox<R>	createForList(List<R> staticData, Template template)
static <R> ComboBox<R>	createForList(List<R> staticData, TreeNodeInfoExtractor<R> treeNodeInfoExtractor)
UiField	createUiComponent()
String	getFreeText()
protected Set<RECORD>	getSelectedRecords()
void	removeToolButton(ToolButton toolButton)
void	setValue(RECORD record)

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, isEmptyValue, 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, onSpecialKeyPressed, onTextInput

Field Details

onFreeTextEntered

public final Event<String> onFreeTextEntered

Constructor Details

ComboBox

public ComboBox()

ComboBox

public ComboBox(ComboBoxModel<RECORD> model)

ComboBox

public ComboBox(Template template)

Method Details

getSelectedRecords

protected Set<RECORD> getSelectedRecords()

Specified by:

getSelectedRecords in class AbstractComboBox<RECORD,RECORD>

createForList

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

createForList

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

createForList

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

createForEnum

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

createUiComponent

public UiField createUiComponent()

Specified by:

createUiComponent in class AbstractComponent

setValue

public void setValue(RECORD record)

Overrides:

setValue in class AbstractField<RECORD>

convertUiValueToUxValue

public RECORD convertUiValueToUxValue(Object value)

Overrides:

convertUiValueToUxValue in class AbstractField<RECORD>

convertUxValueToUiValue

public Object convertUxValueToUiValue(RECORD record)

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<RECORD>

Parameters:

record - the server-side value

Returns:

the object to be sent to the ui

getFreeText

public String getFreeText()

addToolButton

public void addToolButton(ToolButton toolButton)

removeToolButton

public void removeToolButton(ToolButton toolButton)