pl.fhframework.model.forms

Class DictionaryCombo

java.lang.Object

pl.fhframework.model.forms.Component

pl.fhframework.model.forms.FormElement

pl.fhframework.model.forms.FormElementWithAriaSupport

pl.fhframework.model.forms.FormElementWithConfirmationSupport

pl.fhframework.model.forms.BaseInputField

pl.fhframework.model.forms.BaseInputFieldWithKeySupport

pl.fhframework.model.forms.Combo

pl.fhframework.model.forms.DictionaryCombo

All Implemented Interfaces:

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

@DocumentedComponent(documentationExample=true,
                     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=false)
public class DictionaryCombo
extends Combo
implements IGroupingComponent<DictionaryComboParameter>

Nested Class Summary

Nested classes/interfaces inherited from class pl.fhframework.model.forms.Combo

Combo.ComboItemDTO

Nested classes/interfaces inherited from class pl.fhframework.model.forms.Component

Component.ComponentAttr, Component.IGenerationUtils

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	multiselect

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

ADDED_TAG, cleared, CLEARED, cursor, CURSOR, cursorBinding, filteredObjectValues, filteredValues, filterFunction, filterInvoked, filterText, firstLoad, freeTyping, modelType, MULTISELECT_RAW_VALUE_ATTR, multiselectRawValue, preload, rawValue, REMOVED_INDEX_ATTR, SELECTED_INDEX_ATTR, SELECTED_INDEX_GROUP_ATTR, SELECTED_ITEM_ATTR, selectedItem, selectedItemIndex, TEXT, values

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

AUTOCOMPLETE_ATTR, HINT_INPUT_GROUP_ATTR, 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.FormElementWithAriaSupport

ariaLabel, ariaLabelBinding, ATTR_ARIA_LABEL

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
DictionaryCombo(Form form)

Method Summary

Modifier and Type	Method and Description
void	addSubcomponent(DictionaryComboParameter component) Adds component to the container.
protected void	changeSelectedItemBinding()
protected org.springframework.util.MultiValueMap<String,Combo.ComboItemDTO>	collectValues(org.springframework.util.MultiValueMap<String,Object> valuesToConvert)
ElementChanges	comboParameterModelRefreash()
List<DictionaryComboParameter>	getParameters()
List<DictionaryComboParameter>	getSubcomponents()
void	init()
protected String	objectToString(Object s)
protected void	processFiltering(String text)
protected boolean	processValueBinding(ElementChanges elementChanges)
protected boolean	processValuesBinding()
protected boolean	processValuesExternal(String text)
void	removeSubcomponent(DictionaryComboParameter removedFormElement)

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

convertToRaw, createNewSameComponent, doCopy, getAllBingings, getEventHandler, getOptionalFormatter, prepareComponentAfterValidation, processFilterBinding, processPresentationStyle, selectItemByFilterText, setFormatter, setOnDblSpecialKey, setOnEmptyValue, setOnEmptyValue, setOnInput, setOnInput, setOnSpecialKey, setOnSpecialKey, toRawValue, updateFilterTextBinding, updateModel, updateView, validate

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

setOnKeyEvent, setOnKeyEvent

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

calculateAvailability, calculatePresentationStyle, checkBinding, convertMainValueToString, createValidationManager, getTargetModelBinding, processAutocompleteBinding, 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.FormElementWithAriaSupport

getAriaLabel, getAriaLabelBinding, setAriaLabelBinding, updateAriaLabelView

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

getHeight, getHint, getHintBinding, getHintPlacement, getHintTrigger, getHintType, getHorizontalAlign, getHtmlAccessibilityRole, getInlineStyle, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getStyleClasses, getVerticalAlign, getWidth, getWrapperStyle, isPush, refreshElementToForm, refreshView, refreshView, setHeight, setHintBinding, setHintPlacement, setHintTrigger, setHintType, setHorizontalAlign, setHtmlAccessibilityRole, 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, getGenerationUtils, getGroupingParentComponent, getId, getOnDesignerToolboxDrop, getRawId, getType, hashCode, isArtificial, isGeneratedId, isInitDone, isInvisible, isStopProcessingUpdateView, onProcessingFinish, onProcessingStart, postClone, preConfigureClear, prepareEventDataArgument, refreshAvailability, resetInitDone, setArtificial, setAvailability, setAvailabilityModelBinding, setBindingContext, setGenerationUtils, 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.model.forms.IGroupingComponent

doActionForEveryActiveSubcomponent, doActionForEverySubcomponent, doActionForEverySubcomponent, doActionForEverySubcomponentInlcudingRepeated, getGroupingComponent, getNonVisualSubcomponents, processComponents

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

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

multiselect

protected boolean multiselect

Constructor Detail

DictionaryCombo

public DictionaryCombo(Form form)

Method Detail

init

public void init()

Overrides:

init in class BaseInputFieldWithKeySupport

getParameters

public List<DictionaryComboParameter> getParameters()

processValuesBinding

protected boolean processValuesBinding()

Overrides:

processValuesBinding in class Combo

processValuesExternal

protected boolean processValuesExternal(String text)

processFiltering

protected void processFiltering(String text)

Overrides:

processFiltering in class Combo

addSubcomponent

public void addSubcomponent(DictionaryComboParameter component)

Adds component to the container.

Specified by:

addSubcomponent in interface IGroupingComponent<DictionaryComboParameter>

removeSubcomponent

public void removeSubcomponent(DictionaryComboParameter removedFormElement)

Specified by:

removeSubcomponent in interface IGroupingComponent<DictionaryComboParameter>

getSubcomponents

public List<DictionaryComboParameter> getSubcomponents()

Specified by:

getSubcomponents in interface IGroupingComponent<DictionaryComboParameter>

objectToString

protected String objectToString(Object s)

Overrides:

objectToString in class Combo

changeSelectedItemBinding

protected void changeSelectedItemBinding()

Overrides:

changeSelectedItemBinding in class Combo

collectValues

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

Overrides:

collectValues in class Combo

processValueBinding

protected boolean processValueBinding(ElementChanges elementChanges)

Overrides:

processValueBinding in class Combo

comboParameterModelRefreash

public ElementChanges comboParameterModelRefreash()