Package com.storedobject.ui

Interface ObjectInput<T extends StoredObject>

Type Parameters:

T - Type of objects that can be inputted.

All Superinterfaces:

AbstractObjectInput<T>, 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, ValueRequired

All Known Subinterfaces:

DelegatedObjectInput<T>, ItemInput<T>

All Known Implementing Classes:

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

public interface ObjectInput<T extends StoredObject>
extends AbstractObjectInput<T>, ValueRequired

Fields that can input a given type of StoredObject value.

Author:

Syam

Method Summary

Modifier and Type	Method	Description
String	getInternalLabel()	Get the internal label of this field.
default T	getObject()	Get the current object.
default ObjectBrowser<T>	getSearcher()	Get the searcher for this field.
T	getValue()	Get the current value.
void	load(ObjectIterator<T> objects)	Load allowed values from a list.
void	reload()	Reload the allowed values by applying newly set filters.
void	setInternalLabel(String label)	Set the internal label for this field.
default void	setObject(T object)	Set the given object as the value.
default void	setObjectClass(Class<? extends T>... classes)	Set one or more (typically more than one) class subtypes that this field should allow.
default void	setValue(Id id)	Set the value as an Id.
void	setValue(T value)	Set the value.

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

applyFilterPredicate, clear, convert, focus, getCached, getDetailComponent, getDisplayDetail, getObject, getObjectClass, getObjectId, getObjectId, isAllowAny, setCached, setDetailComponent, setDisplayDetail, setEnabled, setItemLabelGenerator, setObject, setPrefixFieldControl, setReadOnly

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

Methods inherited from interface com.storedobject.vaadin.ValueRequired

isRequired, setRequired

Method Details

setValue

void setValue(T value)

Set the value.

Parameters:

value - Value to set.

getValue

T getValue()

Get the current value.

Returns:

Value.

setInternalLabel

void setInternalLabel(String label)

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

Parameters:

label - Label.

getInternalLabel

String getInternalLabel()

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

Returns:

Label.

setValue

default void setValue(Id id)

Set the value as an Id. The object representing the Id value will be set. If the corresponding object value is not compatible, null value will be set.

Parameters:

id - Id of the object to be set.

getObject

default T getObject()

Get the current object. Same as getValue().

Specified by:

getObject in interface AbstractObjectInput<T extends StoredObject>

Specified by:

getObject in interface ObjectGetter<T extends StoredObject>

Specified by:

getObject in interface ObjectProvider<T extends StoredObject>

Returns:

Current object.

setObject

default void setObject(T object)

Set the given object as the value.

Specified by:

setObject in interface AbstractObjectInput<T extends StoredObject>

Specified by:

setObject in interface ObjectSetter<T extends StoredObject>

Parameters:

object - Object to set.

load

void load(ObjectIterator<T> objects)

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.

Parameters:

objects - Objects to load.

reload

void reload()

Reload the allowed values by applying newly set filters.

setObjectClass

default void setObjectClass(Class<? extends T>... classes)

Set one or more (typically more than one) class subtypes that this field should allow.

Parameters:

classes - Classes to allow.

getSearcher

default ObjectBrowser<T> getSearcher()

Get the searcher for this field. (A searcher is available only in certain implementations).

Returns:

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