Package com.storedobject.ui.util

Interface AbstractObjectInput<T extends StoredObject>

Type Parameters:

T - Type of input.

All Superinterfaces:

Consumer<T>, FilterMethods<T>, HasElement, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasLabel, com.vaadin.flow.component.HasPlaceholder, HasThemeStyle, ObjectGetter<T>, ObjectProvider<T>, ObjectSetter<T>, Serializable

All Known Subinterfaces:

DelegatedIdInput<T>, DelegatedObjectInput<T>, IdInput<T>, ItemInput<T>, ObjectInput<T>

All Known Implementing Classes:

AbstractObjectField, AccountField, AssemblyItemField, BinField, BlockComboField, FileField, ItemComboField, ItemField, ItemGetField, ItemTypeGetField, LocationField, ObjectCodeField, ObjectComboField, ObjectField, ObjectFormField, ObjectGetField, ObjectListField, ObjectSearcherField, ObjectSearchField, UserField

public interface AbstractObjectInput<T extends StoredObject>
extends ObjectProvider<T>, ObjectSetter<T>, ObjectGetter<T>, HasElement, com.vaadin.flow.component.HasLabel, com.vaadin.flow.component.HasPlaceholder, FilterMethods<T>

Methods used by fields for inputting StoredObjects or Ids.

Author:

Syam

Method Summary

Modifier and Type	Method	Description
default void	applyFilterPredicate()	This method is called whenever a filter predicate is changed.
void	clear()	Clear the field value.
default T	convert(StoredObject object)	Convert a raw object to the type that is accepted.
void	focus()	Focus this field.
T	getCached()	Get the currently cached object.
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.
T	getObject()	Get the object that is currently set.
default T	getObject(Id objectId)	Get the object for the given Id.
Class<T>	getObjectClass()	Class of the object supported in this input field.
default Id	getObjectId()	Get the Id of the current object.
default Id	getObjectId(T object)	Get the Id of the given object.
default boolean	isAllowAny()	Whether this field allows any derived object values or not.
default 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.
default 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.
default void	setObject(Id objectId)	Set object for the given Id.
void	setObject(T object)	Set the object.
void	setPrefixFieldControl(boolean prefixFieldControl)	Decide whether "prefix components" needs to be controlled by this field or not.
void	setReadOnly(boolean readOnly)	Make this field read-only.

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface com.storedobject.core.FilterMethods

applyFilter, getEffectiveCondition, getFilterCondition, getLoadFilter, setFilter, setFilter, setFilter, setFilter, setFilter, setFilter, setLoadFilter, setLoadFilter, setViewFilter, setViewFilter

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.HasLabel

getLabel, setLabel

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

getPlaceholder, setPlaceholder

Methods inherited from interface com.storedobject.vaadin.HasThemeStyle

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

Methods inherited from interface com.storedobject.core.ObjectSetter

accept

Method Details

clear

void clear()

Clear the field value.

getObjectClass

Class<T> getObjectClass()

Class of the object supported in this input field.

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.

getObject

T getObject()

Get the object that is currently set.

Specified by:

getObject in interface ObjectGetter<T extends StoredObject>

Specified by:

getObject in interface ObjectProvider<T extends StoredObject>

Returns:

Object that is currently set. It could be null.

setObject

void setObject(T object)

Set the object.

Specified by:

setObject in interface ObjectSetter<T extends StoredObject>

Parameters:

object - Object to set.

convert

default T convert(StoredObject object)

Convert a raw object to the type that is accepted. (This is a helper method).

Parameters:

object - Object to convert.

Returns:

Converted object or null if not convertible.

setObject

default void setObject(Id objectId)

Set object for the given Id.

Specified by:

setObject in interface ObjectSetter<T extends StoredObject>

Parameters:

objectId - Id of the object to be set.

getObject

default T getObject(Id objectId)

Get the object for the given Id. (This is a helper method.)

Parameters:

objectId - Id for which object needs to be returned.

Returns:

Object retrieved from the database or cache. It returns null if not found.

setCached

default void setCached(T cached)

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

Parameters:

cached - Object to be cached.

getCached

T getCached()

Get the currently cached object.

Returns:

Object that is currently cached. It may return null.

getObjectId

default Id getObjectId(T object)

Get the Id of the given object. (This is a helper method.)

Parameters:

object - Object for which Id is required.

Returns:

Id of the object.

getObjectId

default Id getObjectId()

Get the Id of the current object.

Specified by:

getObjectId in interface ObjectGetter<T extends StoredObject>

Specified by:

getObjectId in interface ObjectProvider<T extends StoredObject>

Returns:

Id or null if no object is currently set.

isAllowAny

default boolean isAllowAny()

Whether this field allows any derived object values or not.

Specified by:

isAllowAny in interface ObjectGetter<T extends StoredObject>

Specified by:

isAllowAny in interface ObjectSetter<T extends StoredObject>

Returns:

True or false.

setDetailComponent

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

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

Parameters:

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

getDetailComponent

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

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

Returns:

Component that is displaying the details.

setDisplayDetail

void setDisplayDetail(Consumer<T> displayDetail)

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

Parameters:

displayDetail - A consumer that can accept the object value.

getDisplayDetail

Consumer<T> getDisplayDetail()

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

Returns:

Consumer that is currently set.

setPrefixFieldControl

void setPrefixFieldControl(boolean prefixFieldControl)

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 setEnabled(boolean), setReadOnly(boolean) etc. In some cases, prefix components may be displayed elsewhere and needs to be controlled outside the field.

Parameters:

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

setReadOnly

void setReadOnly(boolean readOnly)

Make this field read-only.

Parameters:

readOnly - True to set as read-only.

setEnabled

void setEnabled(boolean enabled)

Enable/disable this field.

Parameters:

enabled - True for enabling.

setItemLabelGenerator

default 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. (It is mainly used to display the object).

Parameters:

itemLabelGenerator - Item value generator.

focus

void focus()

Focus this field.

applyFilterPredicate

default void applyFilterPredicate()

Description copied from interface: FilterMethods

This method is called whenever a filter predicate 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.

Note: This method is used to show the filtered result of the existing entries

Specified by:

applyFilterPredicate in interface FilterMethods<T extends StoredObject>