Package com.storedobject.ui

Class AbstractObjectField<T extends StoredObject>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.customfield.CustomField<T>,T>

com.vaadin.flow.component.customfield.CustomField<T>

com.storedobject.vaadin.CustomField<T>

com.storedobject.ui.AbstractObjectField<T>

Type Parameters:

T - Type of object instance accepted.

All Implemented Interfaces:

FilterMethods<T>, ObjectGetter<T>, ObjectSetter<T>, ObjectInput<T>, ObjectProvider<T>, AbstractObjectInput<T>, HasElement, HasThemeStyle, ValueRequired, com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.customfield.CustomField<T>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.customfield.CustomField<T>>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.customfield.CustomField<T>>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, com.vaadin.flow.component.HasPlaceholder, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.HasValidation, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<T>,T>,T>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<T>,T>,T>, com.vaadin.flow.component.shared.HasTooltip, com.vaadin.flow.component.shared.HasValidationProperties, com.vaadin.flow.component.shared.InputField<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<T>,T>,T>, Serializable, Consumer<T>

Direct Known Subclasses:

FileField, ObjectGetField, ObjectSearchField

public abstract class AbstractObjectField<T extends StoredObject>
extends CustomField<T>
implements ObjectInput<T>, ValueRequired

The base field for accepting a StoredObject instance. (This is the base for a couple of fields that accept object instances).

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField

com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C extends com.vaadin.flow.component.Component,V>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue

com.vaadin.flow.component.HasValue.ValueChangeEvent<V>, com.vaadin.flow.component.HasValue.ValueChangeListener<E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<?>>

Constructor Summary

Constructors

Constructor	Description
AbstractObjectField(Class<T> objectClass, boolean allowAny)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	applyFilter()	This method is called whenever a filter condition is changed.
protected final ObjectBrowser<T>	createDefaultSearcher()	Create the default searcher.
protected abstract com.vaadin.flow.component.Component	createPrefixComponent()
protected ObjectBrowser<T>	createSearcher()	Get the searcher for this field.
protected void	doSearch()	Do a search using the searcher component.
protected ObjectEditor<T>	editor()	Return the ObjectEditor associated with this.
protected T	filter(T value)	Check a given value to see if it satisfies the filter condition of the searcher.
protected ObjectIterator<T>	filteredList(ObjectIterator<T> list)	Check a given set of values to see if they satisfy the filter condition of the searcher.
StringList	getBrowseColumns()	Get browse columns of the searcher.
final T	getCached()	Get the currently cached object.
protected ButtonLayout	getContent()	This is where the content of the field display is created.
com.vaadin.flow.component.Component	getDetailComponent()	Get the component that is currently displaying details of the object value.
Consumer<T>	getDisplayDetail()	Get the consumer that is currently consuming details of the object value.
String	getInternalLabel()	Get the internal label of this field.
ObjectLoadFilter<T>	getLoadFilter()	Get the load filter.
final Class<T>	getObjectClass()	Class of the object supported in this input field.
com.vaadin.flow.component.Component	getPrefixComponent()
StringList	getSearchColumns()	Get search columns.
final ObjectBrowser<T>	getSearcher()	Get the searcher for this field.
protected ButtonLayout	initComponent()	This is where the display parts of the field is initialized.
final boolean	isAllowAny()	Whether this field allows any derived object values or not.
boolean	isInvalid()
boolean	isRequired()	Get the value required flag.
void	load(ObjectIterator<T> objects)	Load allowed values from a list.
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
protected void	reget()	Check the current value to see if it is satisfying the filter condition of the searcher or not.
void	reload()	Reload the allowed values by applying newly set filters.
void	setBrowseColumns(StringList browseColumns)	Set browse columns of the searcher.
final void	setCached(T cached)	Cache an object instance.
void	setDetailComponent(com.vaadin.flow.component.Component detailComponent)	Set a component that will display details of the object value.
void	setDisplayDetail(Consumer<T> displayDetail)	Set a consumer that can display/consume the details of the object value.
void	setEnabled(boolean enabled)	Enable/disable this field.
void	setInternalLabel(String label)	Set the internal label for this field.
void	setItemLabelGenerator(com.vaadin.flow.component.ItemLabelGenerator<T> itemLabelGenerator)	Set an "item label generator" that returns the string value of the object value of this field.
void	setPrefixFieldControl(boolean prefixFieldControl)	Decide whether "prefix components" needs to be controlled by this field or not.
protected void	setPresentationValue(T value)
void	setReadOnly(boolean readOnly)	Make this field read-only.
void	setRequired(boolean required)	Set value required flag.
void	setSearchColumns(StringList searchColumns)	Set search columns.

Methods inherited from class com.storedobject.vaadin.CustomField

addField, addField, focus

Methods inherited from class com.vaadin.flow.component.customfield.CustomField

add, addThemeVariants, generateModelValue, getLabel, remove, removeThemeVariants, setLabel, updateValue

Methods inherited from class com.vaadin.flow.component.AbstractField

addValueChangeListener, getEmptyValue, getValue, isEmpty, setModelValue, setValue, valueEquals

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.storedobject.ui.util.AbstractObjectInput

applyFilterPredicate, convert, focus, getObject, getObjectId, getObjectId, setObject

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.BlurNotifier

addBlurListener

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.storedobject.core.FilterMethods

getEffectiveCondition, getFilterCondition, setFilter, setFilter, setFilter, setFilter, setFilter, setFilter, setLoadFilter, setLoadFilter, setViewFilter, setViewFilter

Methods inherited from interface com.vaadin.flow.component.Focusable

addFocusShortcut, blur, getTabIndex, setTabIndex

Methods inherited from interface com.vaadin.flow.component.FocusNotifier

addFocusListener

Methods inherited from interface com.storedobject.vaadin.HasElement

getAttribute, getStyle, setAttribute, setStyle

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled

Methods inherited from interface com.vaadin.flow.component.HasHelper

getHelperComponent, getHelperText, setHelperComponent, setHelperText

Methods inherited from interface com.vaadin.flow.component.HasLabel

getLabel, setLabel

Methods inherited from interface com.vaadin.flow.component.HasPlaceholder

getPlaceholder, setPlaceholder

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.HasTheme

addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface com.storedobject.vaadin.HasThemeStyle

addTheme, asPrimary, asSmall, clearThemes, getInternalElement, removeTheme, setTheme

Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip

getTooltip, setTooltipText

Methods inherited from interface com.vaadin.flow.component.HasValidation

setManualValidation

Methods inherited from interface com.vaadin.flow.component.shared.HasValidationProperties

getErrorMessage, setErrorMessage, setInvalid

Methods inherited from interface com.vaadin.flow.component.HasValue

addValueChangeListener, clear, getEmptyValue, getOptionalValue, getValue, isEmpty, setValue

Methods inherited from interface com.vaadin.flow.component.HasValueAndElement

isReadOnly, isRequiredIndicatorVisible, setRequiredIndicatorVisible

Methods inherited from interface com.storedobject.ui.ObjectInput

getObject, getValue, setObject, setObjectClass, setValue, setValue

Methods inherited from interface com.storedobject.core.ObjectSetter

accept

Constructor Details

AbstractObjectField

public AbstractObjectField(Class<T> objectClass,
 boolean allowAny)

Constructor.

Parameters:

objectClass - Class of the objects that are valid.

allowAny - Whether subclasses should be allowed or not.

Method Details

initComponent

protected ButtonLayout initComponent()

This is where the display parts of the field is initialized. If overridden, you need to make sure to always return the same component between calls.

Returns:

The layout component containing other display components.

onAttach

protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)

Overrides:

onAttach in class com.vaadin.flow.component.customfield.CustomField<T extends StoredObject>

getContent

protected ButtonLayout getContent()

This is where the content of the field display is created. The default implementation invokes initComponent() and stuffs the return value into the layout. If overridden, you need to make sure to always return the same component between calls.

Returns:

Content part of the field.

setInternalLabel

public void setInternalLabel(String label)

Description copied from interface: ObjectInput

Set the internal label for this field. Internal labels are used by the embedded field within this field.

Specified by:

setInternalLabel in interface ObjectInput<T extends StoredObject>

Parameters:

label - Label.

getInternalLabel

public String getInternalLabel()

Description copied from interface: ObjectInput

Get the internal label of this field. Internal labels are used by the embedded field within this field.

Specified by:

getInternalLabel in interface ObjectInput<T extends StoredObject>

Returns:

Label.

getCached

public final T getCached()

Description copied from interface: AbstractObjectInput

Get the currently cached object.

Specified by:

getCached in interface AbstractObjectInput<T extends StoredObject>

Returns:

Object that is currently cached. It may return null.

setCached

public final void setCached(T cached)

Description copied from interface: AbstractObjectInput

Cache an object instance. Default implementation doesn't do anything but a field may cache it and re-used for eliminating unwanted database access.

Specified by:

setCached in interface AbstractObjectInput<T extends StoredObject>

Parameters:

cached - Object to be cached.

createPrefixComponent

protected abstract com.vaadin.flow.component.Component createPrefixComponent()

getObjectClass

public final Class<T> getObjectClass()

Description copied from interface: AbstractObjectInput

Class of the object supported in this input field.

Specified by:

getObjectClass in interface AbstractObjectInput<T extends StoredObject>

Specified by:

getObjectClass in interface ObjectGetter<T extends StoredObject>

Specified by:

getObjectClass in interface ObjectProvider<T extends StoredObject>

Specified by:

getObjectClass in interface ObjectSetter<T extends StoredObject>

Returns:

Class of the supported object.

isAllowAny

public final boolean isAllowAny()

Description copied from interface: AbstractObjectInput

Whether this field allows any derived object values or not.

Specified by:

isAllowAny in interface AbstractObjectInput<T extends StoredObject>

Specified by:

isAllowAny in interface ObjectGetter<T extends StoredObject>

Specified by:

isAllowAny in interface ObjectSetter<T extends StoredObject>

Returns:

True or false.

getPrefixComponent

public com.vaadin.flow.component.Component getPrefixComponent()

filter

protected T filter(T value)

Check a given value to see if it satisfies the filter condition of the searcher.

Parameters:

value - Value to check.

Returns:

The value itself if the condition is satisfied. Otherwise, null.

filteredList

protected ObjectIterator<T> filteredList(ObjectIterator<T> list)

Check a given set of values to see if they satisfy the filter condition of the searcher.

Parameters:

list - Values to check.

Returns:

The list of values that satisfy the filter condition.

reget

protected void reget()

Check the current value to see if it is satisfying the filter condition of the searcher or not.

getLoadFilter

@Nonnull
public ObjectLoadFilter<T> getLoadFilter()

Description copied from interface: FilterMethods

Get the load filter.

Specified by:

getLoadFilter in interface FilterMethods<T extends StoredObject>

Returns:

Current load filter.

applyFilter

public void applyFilter()

Description copied from interface: FilterMethods

This method is called whenever a filter condition is changed. Methods with default implementation already invoke this method. If any of those methods are overridden, make sure that it invokes this method so that logic to handle filter changes can be coded here.

Specified by:

applyFilter in interface FilterMethods<T extends StoredObject>

doSearch

protected void doSearch()

Do a search using the searcher component.

getSearcher

public final ObjectBrowser<T> getSearcher()

Get the searcher for this field. If you want to return a customized searcher, override createSearcher().

Specified by:

getSearcher in interface ObjectInput<T extends StoredObject>

Returns:

Typically, an instance of the ObjectBrowser that has search capability.

createDefaultSearcher

protected final ObjectBrowser<T> createDefaultSearcher()

Create the default searcher.

Returns:

Searcher (which is an ObjectBrowser).

editor

protected ObjectEditor<T> editor()

Return the ObjectEditor associated with this. This will be invoked when the searcher is set and the editor will be checked for additional filter conditions.

Returns:

Editor instance is available.

load

public void load(ObjectIterator<T> objects)

Description copied from interface: ObjectInput

Load allowed values from a list. Once invoked, only this list will be used for showing the allowed objects that can be selected via this field.

Specified by:

load in interface ObjectInput<T extends StoredObject>

Parameters:

objects - Objects to load.

createSearcher

protected ObjectBrowser<T> createSearcher()

Get the searcher for this field.

Returns:

Typically, an instance of the ObjectBrowser that has search capability.

setDetailComponent

public void setDetailComponent(com.vaadin.flow.component.Component detailComponent)

Description copied from interface: AbstractObjectInput

Set a component that will display details of the object value.

Specified by:

setDetailComponent in interface AbstractObjectInput<T extends StoredObject>

Parameters:

detailComponent - A component that can display information regarding the object.

getDetailComponent

public com.vaadin.flow.component.Component getDetailComponent()

Description copied from interface: AbstractObjectInput

Get the component that is currently displaying details of the object value.

Specified by:

getDetailComponent in interface AbstractObjectInput<T extends StoredObject>

Returns:

Component that is displaying the details.

setDisplayDetail

public void setDisplayDetail(Consumer<T> displayDetail)

Description copied from interface: AbstractObjectInput

Set a consumer that can display/consume the details of the object value.

Specified by:

setDisplayDetail in interface AbstractObjectInput<T extends StoredObject>

Parameters:

displayDetail - A consumer that can accept the object value.

getDisplayDetail

public Consumer<T> getDisplayDetail()

Description copied from interface: AbstractObjectInput

Get the consumer that is currently consuming details of the object value.

Specified by:

getDisplayDetail in interface AbstractObjectInput<T extends StoredObject>

Returns:

Consumer that is currently set.

setPresentationValue

protected void setPresentationValue(T value)

Specified by:

setPresentationValue in class com.vaadin.flow.component.customfield.CustomField<T extends StoredObject>

setItemLabelGenerator

public void setItemLabelGenerator(com.vaadin.flow.component.ItemLabelGenerator<T> itemLabelGenerator)

Description copied from interface: AbstractObjectInput

Set an "item label generator" that returns the string value of the object value of this field. (It is mainly used to display the object).

Specified by:

setItemLabelGenerator in interface AbstractObjectInput<T extends StoredObject>

Parameters:

itemLabelGenerator - Item value generator.

setPrefixFieldControl

public void setPrefixFieldControl(boolean prefixFieldControl)

Description copied from interface: AbstractObjectInput

Decide whether "prefix components" needs to be controlled by this field or not. "Prefix components" are parts of the field that display extra information, and it needs to be turned on or off when the status of the field changes via methods such as AbstractObjectInput.setEnabled(boolean), AbstractObjectInput.setReadOnly(boolean) etc. In some cases, prefix components may be displayed elsewhere and needs to be controlled outside the field.

Specified by:

setPrefixFieldControl in interface AbstractObjectInput<T extends StoredObject>

Parameters:

prefixFieldControl - True if it needs to be controlled by this field.

setReadOnly

public void setReadOnly(boolean readOnly)

Description copied from interface: AbstractObjectInput

Make this field read-only.

Specified by:

setReadOnly in interface AbstractObjectInput<T extends StoredObject>

Specified by:

setReadOnly in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<T extends StoredObject>,T extends StoredObject>,T extends StoredObject>

Specified by:

setReadOnly in interface com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<T extends StoredObject>,T extends StoredObject>,T extends StoredObject>

Parameters:

readOnly - True to set as read-only.

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: AbstractObjectInput

Enable/disable this field.

Specified by:

setEnabled in interface AbstractObjectInput<T extends StoredObject>

Specified by:

setEnabled in interface com.vaadin.flow.component.HasEnabled

Parameters:

enabled - True for enabling.

isRequired

public boolean isRequired()

Description copied from interface: ValueRequired

Get the value required flag.

Specified by:

isRequired in interface ValueRequired

Returns:

Whether required or not.

setRequired

public void setRequired(boolean required)

Description copied from interface: ValueRequired

Set value required flag.

Specified by:

setRequired in interface ValueRequired

Parameters:

required - Required or not

isInvalid

public boolean isInvalid()

Specified by:

isInvalid in interface com.vaadin.flow.component.HasValidation

Specified by:

isInvalid in interface com.vaadin.flow.component.shared.HasValidationProperties

reload

public void reload()

Description copied from interface: ObjectInput

Reload the allowed values by applying newly set filters.

Specified by:

reload in interface ObjectInput<T extends StoredObject>

setBrowseColumns

public void setBrowseColumns(StringList browseColumns)

Set browse columns of the searcher.

Parameters:

browseColumns - Browse columns.

getBrowseColumns

public StringList getBrowseColumns()

Get browse columns of the searcher. Used by createDefaultSearcher().

Returns:

Browse columns of the searcher.

setSearchColumns

public void setSearchColumns(StringList searchColumns)

Set search columns.

Parameters:

searchColumns - Search columns of the searcher's browser.

getSearchColumns

public StringList getSearchColumns()

Get search columns. Used by createDefaultSearcher().

Returns:

Search columns of the searcher's browser.