pl.fhframework.model.forms

Class Combo

java.lang.Object

pl.fhframework.model.forms.Component

pl.fhframework.model.forms.FormElement

pl.fhframework.model.forms.FormElementWithConfirmationSupport

pl.fhframework.model.forms.BaseInputField

pl.fhframework.model.forms.BaseInputFieldWithKeySupport

pl.fhframework.model.forms.Combo

All Implemented Interfaces:

Cloneable, pl.fhframework.aspects.snapshots.model.IUnmanagedUseCaseParameter, pl.fhframework.core.forms.IHasBoundableLabel, pl.fhframework.core.forms.IValidatedComponent, pl.fhframework.events.IDesignEventSource, pl.fhframework.events.IEventSource, pl.fhframework.events.IFormElementWithKeySupport, pl.fhframework.model.forms.Boundable, pl.fhframework.model.forms.IChangeableByClient, Iconable, TableComponent<BaseInputField>

Direct Known Subclasses:

DictionaryCombo

@DesignerControl(defaultWidth=3)
 @DocumentedComponent(category=INPUTS_AND_VALIDATION,
                     value="Enables users to quickly find and select from a pre-populated list of values as they type, leveraging searching and filtering.",
                     icon="fa fa-outdent")
 @Control(parents={PanelGroup.class,Group.class,Column.class,Tab.class,Row.class,pl.fhframework.model.forms.Form.class,Repeater.class},
         invalidParents=Table.class,
         canBeDesigned=true)
public class Combo
extends BaseInputFieldWithKeySupport

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Combo.ComboItemDTO

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ADDED_TAG
protected boolean	cleared
protected static String	CLEARED
protected Integer	cursor
protected static String	CURSOR
protected pl.fhframework.binding.ModelBinding	cursorBinding
protected org.springframework.util.MultiValueMap<String,Object>	filteredObjectValues
protected org.springframework.util.MultiValueMap<String,Combo.ComboItemDTO>	filteredValues
protected java.util.function.BiPredicate<Object,String>	filterFunction
protected boolean	filterInvoked
protected String	filterText
protected boolean	firstLoad
protected boolean	freeTyping
protected Class<?>	modelType
protected boolean	multiselect
protected static String	MULTISELECT_RAW_VALUE_ATTR
protected String	multiselectRawValue
protected boolean	preload
protected String	rawValue
protected static String	REMOVED_INDEX_ATTR
protected static String	SELECTED_INDEX_ATTR
protected static String	SELECTED_INDEX_GROUP_ATTR
static String	SELECTED_ITEM_ATTR Old name of value property used by Combo
protected Object	selectedItem
protected int	selectedItemIndex
protected static String	TEXT
protected org.springframework.util.MultiValueMap<String,Object>	values

Fields inherited from class pl.fhframework.model.forms.BaseInputField

LABEL_ATTR, MESSAGE_FOR_FIELD_ATTR, ON_CHANGE_ATTR, PRESENTATION_STYLE_ATTR, RAW_VALUE_ATTR, REQUIRED_ATTR, VALIDATION_LABEL_ATTR, validationManager, validConversion, VALUE_ATTR

Fields inherited from class pl.fhframework.model.forms.FormElementWithConfirmationSupport

CONFIRATION_MSG_ATTR

Fields inherited from class pl.fhframework.model.forms.Component

ACCESSIBILITY, RESOLUTION_SIZE

Fields inherited from interface pl.fhframework.events.IFormElementWithKeySupport

ON_KEY_EVENT, ON_KEY_EVENT_HASH

Fields inherited from interface pl.fhframework.model.forms.Iconable

BINDING, ICON

Fields inherited from interface pl.fhframework.events.IDesignEventSource

ON_DROP_COMPONENT, ON_RESIZE_COMPONENT

Constructor Summary

Constructors

Constructor and Description
Combo(pl.fhframework.model.forms.Form form)

Method Summary

Modifier and Type	Method and Description
protected void	changeSelectedItemBinding()
protected org.springframework.util.MultiValueMap<String,Combo.ComboItemDTO>	collectValues(org.springframework.util.MultiValueMap<String,Object> valuesToConvert)
protected String	convertToRaw(pl.fhframework.BindingResult<?> bindingResult)
Combo	createNewSameComponent() Create a new component of the same type.
void	doCopy(Table table, Map<String,String> iteratorReplacements, BaseInputField baseClone) Copies values of attributes with replaced iterators in bindings and actions to a new component of the same type.
List<pl.fhframework.binding.ModelBinding>	getAllBingings()
Optional<pl.fhframework.binding.ActionBinding>	getEventHandler(pl.fhframework.model.dto.InMessageEventData eventData)
Optional<String>	getOptionalFormatter()
protected String	objectToString(Object s)
void	prepareComponentAfterValidation(pl.fhframework.model.dto.ElementChanges elementChanges)
protected boolean	processFilterBinding(pl.fhframework.model.dto.ElementChanges elementChanges, boolean valuesChanged)
protected void	processFiltering(String text)
protected pl.fhframework.validation.FormFieldHints	processPresentationStyle(pl.fhframework.model.dto.ElementChanges elementChanges, List<pl.fhframework.validation.FieldValidationResult> fieldValidationResults)
protected boolean	processValueBinding(pl.fhframework.model.dto.ElementChanges elementChanges)
protected boolean	processValuesBinding()
protected void	selectItemByFilterText()
void	setFormatter(String formatter)
void	setOnDblSpecialKey(pl.fhframework.binding.ActionBinding onDblSpecialKey)
void	setOnEmptyValue(pl.fhframework.binding.ActionBinding onEmptyValue)
pl.fhframework.binding.IActionCallbackContext	setOnEmptyValue(pl.fhframework.binding.IActionCallback onEmptyValue)
void	setOnInput(pl.fhframework.binding.ActionBinding onInput)
pl.fhframework.binding.IActionCallbackContext	setOnInput(pl.fhframework.binding.IActionCallback onInput)
void	setOnSpecialKey(pl.fhframework.binding.ActionBinding onSpecialKey)
pl.fhframework.binding.IActionCallbackContext	setOnSpecialKey(pl.fhframework.binding.IActionCallback onSpecialKey)
protected String	toRawValue(Object s)
protected void	updateFilterTextBinding()
void	updateModel(pl.fhframework.model.dto.ValueChange valueChange)
pl.fhframework.model.dto.ElementChanges	updateView()
void	validate()

Methods inherited from class pl.fhframework.model.forms.BaseInputFieldWithKeySupport

init, setOnKeyEvent, setOnKeyEvent

Methods inherited from class pl.fhframework.model.forms.BaseInputField

calculateAvailability, calculatePresentationStyle, checkBinding, convertMainValueToString, createValidationManager, getTargetModelBinding, processCoversionException, processLabelBinding, processStylesAndHints, processValidationForThisComponent, setLabelModelBindingAdHoc, setModelBindingAdHoc, setOnChange, setOnChange

Methods inherited from class pl.fhframework.model.forms.FormElementWithConfirmationSupport

getConfirmationMsg, getConfirmationMsgBinding, getConfirmOnEvent, processConfirmationMsgBinding, setConfirmationMsg, setConfirmationMsgBinding, setConfirmOnEvent

Methods inherited from class pl.fhframework.model.forms.FormElement

getHeight, getHint, getHintBinding, getHintPlacement, getHintTrigger, getHorizontalAlign, getInlineStyle, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getStyleClasses, getVerticalAlign, getWidth, getWrapperStyle, isPush, refreshElementToForm, refreshView, refreshView, setHeight, setHintBinding, setHintPlacement, setHintTrigger, setHorizontalAlign, setInlineStyle, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPush, setStyleClasses, setVerticalAlign, setWidth, setWrapperStyle, tryParseAttributeInPixelOrPercentageUnit, tryParseAttributeInPixelUnit, tryParseAttributeInPixelUnit

Methods inherited from class pl.fhframework.model.forms.Component

areModelValuesTheSame, areValuesTheSame, clone, convertBindingValueToString, convertBindingValueToString, convertValue, convertValueToString, convertValueToString, createAdHocModelBinding, equals, finalizeReading, generateId, getAccessibilityRules, getAvailability, getAvailabilityModelBinding, getAvailablityAffectingActions, getBindingContext, getEventProcessingForm, getForm, getGeneratedIdPrefix, getGroupingParentComponent, getId, getOnDesignerToolboxDrop, getRawId, getType, hashCode, isArtificial, isGeneratedId, isInitDone, isInvisible, isStopProcessingUpdateView, onProcessingFinish, onProcessingStart, postClone, preConfigureClear, prepareEventDataArgument, refreshAvailability, resetInitDone, setArtificial, setAvailability, setAvailabilityModelBinding, setBindingContext, setGroupingParentComponent, setId, setInvisible, setOnDesignerToolboxDrop, setOnDesignerToolboxDrop, setRawId, setStopProcessingUpdateView, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface pl.fhframework.events.IFormElementWithKeySupport

getKeyEvent, getKeyEventHandler, getKeyEventHandlers, getOnKeyEvent, initKeyHandlers, setKeyEvent, setKeyEventHandlers

Methods inherited from interface pl.fhframework.model.forms.Iconable

getIcon, getIconAlignment, getIconBinding, resolveIconBinding

Methods inherited from interface pl.fhframework.model.forms.Boundable

updateBinding, updateBinding, updateBindingForValue, updateBindingForValue

Methods inherited from interface pl.fhframework.core.forms.IValidatedComponent

getId, getLabel, getModelBinding, getPresentationStyle, getValidationLabelModelBinding, skipSettingPresentation

Methods inherited from interface pl.fhframework.model.forms.TableComponent

doCopy, getCopy, getCopy

Methods inherited from interface pl.fhframework.core.forms.IHasBoundableLabel

getLabelModelBinding

Methods inherited from interface pl.fhframework.events.IDesignEventSource

isDesignActionAllowed, isDesignDeletable

Methods inherited from interface pl.fhframework.events.IEventSource

isModificationEvent

Field Detail

SELECTED_ITEM_ATTR

public static final String SELECTED_ITEM_ATTR

Old name of value property used by Combo

See Also:

Constant Field Values

MULTISELECT_RAW_VALUE_ATTR

protected static final String MULTISELECT_RAW_VALUE_ATTR

See Also:

Constant Field Values

TEXT

protected static final String TEXT

See Also:

Constant Field Values

ADDED_TAG

protected static final String ADDED_TAG

See Also:

Constant Field Values

SELECTED_INDEX_ATTR

protected static final String SELECTED_INDEX_ATTR

See Also:

Constant Field Values

REMOVED_INDEX_ATTR

protected static final String REMOVED_INDEX_ATTR

See Also:

Constant Field Values

SELECTED_INDEX_GROUP_ATTR

protected static final String SELECTED_INDEX_GROUP_ATTR

See Also:

Constant Field Values

CLEARED

protected static final String CLEARED

See Also:

Constant Field Values

CURSOR

protected static final String CURSOR

See Also:

Constant Field Values

selectedItem

protected Object selectedItem

selectedItemIndex

protected int selectedItemIndex

rawValue

protected String rawValue

filterText

protected String filterText

values

protected org.springframework.util.MultiValueMap<String,Object> values

filteredObjectValues

protected org.springframework.util.MultiValueMap<String,Object> filteredObjectValues

filteredValues

protected org.springframework.util.MultiValueMap<String,Combo.ComboItemDTO> filteredValues

cleared

protected boolean cleared

filterFunction

protected java.util.function.BiPredicate<Object,String> filterFunction

filterInvoked

protected boolean filterInvoked

preload

@XMLProperty
 @DocumentedComponentAttribute(defaultValue="false",
                              value="Defines if combo values should be present even if no text is typed")
protected boolean preload

firstLoad

protected boolean firstLoad

freeTyping

protected boolean freeTyping

multiselect

@XMLProperty
 @DocumentedComponentAttribute(defaultValue="false",
                              value="Determines if multiselect is enabled in combo. If multiselect is set to true, value has to be set to Collection.")
 @DesignerXMLProperty(functionalArea=SPECIFIC,
                     priority=10)
protected boolean multiselect

multiselectRawValue

protected String multiselectRawValue

modelType

protected Class<?> modelType

cursorBinding

@XMLProperty(value="cursor")
 @DesignerXMLProperty(allowedTypes=java.lang.Integer.class,
                     functionalArea=CONTENT)
 @DocumentedComponentAttribute(boundable=true,
                              value="Binding represents cursor from model of Form, used inside of \'{}\', like {model}.")
protected pl.fhframework.binding.ModelBinding cursorBinding

cursor

protected Integer cursor

Constructor Detail

Combo

public Combo(pl.fhframework.model.forms.Form form)

Method Detail

getEventHandler

public Optional<pl.fhframework.binding.ActionBinding> getEventHandler(pl.fhframework.model.dto.InMessageEventData eventData)

Specified by:

getEventHandler in interface pl.fhframework.events.IEventSource

Overrides:

getEventHandler in class BaseInputFieldWithKeySupport

updateModel

public void updateModel(pl.fhframework.model.dto.ValueChange valueChange)

Specified by:

updateModel in interface pl.fhframework.model.forms.IChangeableByClient

Overrides:

updateModel in class BaseInputField

updateFilterTextBinding

protected void updateFilterTextBinding()

selectItemByFilterText

protected void selectItemByFilterText()

validate

public void validate()

Specified by:

validate in interface pl.fhframework.core.forms.IValidatedComponent

Overrides:

validate in class BaseInputField

prepareComponentAfterValidation

public void prepareComponentAfterValidation(pl.fhframework.model.dto.ElementChanges elementChanges)

Specified by:

prepareComponentAfterValidation in interface pl.fhframework.core.forms.IValidatedComponent

Overrides:

prepareComponentAfterValidation in class BaseInputField

processPresentationStyle

protected pl.fhframework.validation.FormFieldHints processPresentationStyle(pl.fhframework.model.dto.ElementChanges elementChanges,
                                                                            List<pl.fhframework.validation.FieldValidationResult> fieldValidationResults)

Overrides:

processPresentationStyle in class BaseInputField

getAllBingings

public List<pl.fhframework.binding.ModelBinding> getAllBingings()

Specified by:

getAllBingings in interface pl.fhframework.core.forms.IValidatedComponent

Overrides:

getAllBingings in class BaseInputField

changeSelectedItemBinding

protected void changeSelectedItemBinding()

processFiltering

protected void processFiltering(String text)

updateView

public pl.fhframework.model.dto.ElementChanges updateView()

Overrides:

updateView in class BaseInputField

processValuesBinding

protected boolean processValuesBinding()

processFilterBinding

protected boolean processFilterBinding(pl.fhframework.model.dto.ElementChanges elementChanges,
                                       boolean valuesChanged)

processValueBinding

protected boolean processValueBinding(pl.fhframework.model.dto.ElementChanges elementChanges)

Overrides:

processValueBinding in class BaseInputField

collectValues

protected org.springframework.util.MultiValueMap<String,Combo.ComboItemDTO> collectValues(org.springframework.util.MultiValueMap<String,Object> valuesToConvert)

toRawValue

protected String toRawValue(Object s)

objectToString

protected String objectToString(Object s)

convertToRaw

protected String convertToRaw(pl.fhframework.BindingResult<?> bindingResult)

Overrides:

convertToRaw in class BaseInputField

getOptionalFormatter

public Optional<String> getOptionalFormatter()

setFormatter

public void setFormatter(String formatter)

createNewSameComponent

public Combo createNewSameComponent()

Description copied from interface: TableComponent

Create a new component of the same type.

Returns:

a new component of the same type

doCopy

public void doCopy(Table table,
                   Map<String,String> iteratorReplacements,
                   BaseInputField baseClone)

Description copied from interface: TableComponent

Copies values of attributes with replaced iterators in bindings and actions to a new component of the same type.

Specified by:

doCopy in interface TableComponent<BaseInputField>

Overrides:

doCopy in class BaseInputField

Parameters:

table - table

iteratorReplacements - iterator replacements

baseClone - a new component of the same type

setOnInput

public void setOnInput(pl.fhframework.binding.ActionBinding onInput)

setOnInput

public pl.fhframework.binding.IActionCallbackContext setOnInput(pl.fhframework.binding.IActionCallback onInput)

setOnEmptyValue

public void setOnEmptyValue(pl.fhframework.binding.ActionBinding onEmptyValue)

setOnEmptyValue

public pl.fhframework.binding.IActionCallbackContext setOnEmptyValue(pl.fhframework.binding.IActionCallback onEmptyValue)

setOnSpecialKey

public void setOnSpecialKey(pl.fhframework.binding.ActionBinding onSpecialKey)

setOnDblSpecialKey

public void setOnDblSpecialKey(pl.fhframework.binding.ActionBinding onDblSpecialKey)

setOnSpecialKey

public pl.fhframework.binding.IActionCallbackContext setOnSpecialKey(pl.fhframework.binding.IActionCallback onSpecialKey)