Package com.storedobject.ui.util

Interface DelegatedObjectInput<T extends StoredObject>

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>, ObjectInput<T>, ObjectProvider<T>, ObjectSetter<T>, Serializable, ValueRequired

public interface DelegatedObjectInput<T extends StoredObject>
extends ObjectInput<T>

Method Summary

Modifier and Type	Method	Description
default com.vaadin.flow.component.Component	getDetailComponent()	Get the component that is currently displaying details of the object value.
default Consumer<T>	getDisplayDetail()	Get the consumer that is currently consuming details of the object value.
default Class<T>	getObjectClass()	Class of the object supported in this input field.
ObjectInput<T>	getObjectInput()
default boolean	isAllowAny()	Whether this field allows any derived object values or not.
default void	setDetailComponent(com.vaadin.flow.component.Component detailComponent)	Set a component that will display details of the object value.
default void	setDisplayDetail(Consumer<T> displayDetail)	Set a consumer that can display/consume the details of the object value.
default void	setFilter(FilterProvider filterProvider)	Set a filter provider to be used when loading takes place.
default void	setPrefixFieldControl(boolean searchFieldControl)	Decide whether "prefix components" needs to be controlled by this field or not.

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

applyFilterPredicate, convert, focus, getCached, getObject, getObjectId, getObjectId, setCached, setEnabled, setItemLabelGenerator, setObject, 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, 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.ui.ObjectInput

getInternalLabel, getObject, getSearcher, getValue, load, reload, setInternalLabel, setObject, setObjectClass, setValue, setValue

Methods inherited from interface com.storedobject.core.ObjectSetter

accept

Methods inherited from interface com.storedobject.vaadin.ValueRequired

isRequired, setRequired

Method Details

getObjectInput

ObjectInput<T> getObjectInput()

getObjectClass

default 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

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

setFilter

default void setFilter(FilterProvider filterProvider)

Description copied from interface: FilterMethods

Set a filter provider to be used when loading takes place.

Specified by:

setFilter in interface FilterMethods<T extends StoredObject>

Parameters:

filterProvider - Filter provider.

setDetailComponent

default 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

default 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

default 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

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

setPrefixFieldControl

default void setPrefixFieldControl(boolean searchFieldControl)

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:

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