io.jmix.ui.component.impl

Class AbstractValueComponent<T extends com.vaadin.ui.Component & com.vaadin.data.HasValue<P>,P,V>

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<T>

io.jmix.ui.component.impl.AbstractValueComponent<T,P,V>

All Implemented Interfaces:

AttachNotifier, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasValueSource<V>, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasValue<V>

Direct Known Subclasses:

AbstractField

public abstract class AbstractValueComponent<T extends com.vaadin.ui.Component & com.vaadin.data.HasValue<P>,P,V>
extends AbstractComponent<T>
implements HasValue<V>, HasValueSource<V>

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected V	internalValue
protected UiTestIdsSupport	uiTestIdsSupport
protected ValueBinding<V>	valueBinding

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor and Description
AbstractValueComponent()

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addValueChangeListener(java.util.function.Consumer<HasValue.ValueChangeEvent<V>> listener)
protected void	commit()
protected void	componentValueChanged(P prevComponentValue, P newComponentValue, boolean isUserOriginated)
protected V	convertToModel(P componentRawValue)
protected P	convertToPresentation(V modelValue)
protected void	discard()
protected boolean	fieldValueEquals(V value, V oldValue)
V	getValue()
ValueSource<V>	getValueSource()
protected boolean	isBuffered()
protected boolean	isModified()
protected void	setBuffered(boolean buffered)
protected void	setUiTestId(ValueSource<V> valueSource)
void	setUiTestIdsSupport(UiTestIdsSupport uiTestIdsSupport)
void	setValue(V value)
void	setValueSource(ValueSource<V> valueSource) Sets value source for component.
protected void	setValueToPresentation(P value)
protected void	valueBindingActivated(ValueSource<V> valueSource)
protected void	valueBindingConnected(ValueSource<V> valueSource)

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDebugId, setDescription, setDescriptionAsHtml, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setParent, setResponsive, setStyleName, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.ui.component.HasValue

clear, getEmptyValue, isEmpty

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Field Detail

internalValue

protected V internalValue

valueBinding

protected ValueBinding<V> valueBinding

uiTestIdsSupport

protected UiTestIdsSupport uiTestIdsSupport

Constructor Detail

AbstractValueComponent

public AbstractValueComponent()

Method Detail

setUiTestIdsSupport

@Autowired
public void setUiTestIdsSupport(UiTestIdsSupport uiTestIdsSupport)

setValueSource

public void setValueSource(@Nullable
                           ValueSource<V> valueSource)

Description copied from interface: HasValueSource

Sets value source for component.

Specified by:

setValueSource in interface HasValueSource<V>

Parameters:

valueSource - value source

setUiTestId

protected void setUiTestId(ValueSource<V> valueSource)

valueBindingConnected

protected void valueBindingConnected(ValueSource<V> valueSource)

valueBindingActivated

protected void valueBindingActivated(ValueSource<V> valueSource)

getValueSource

@Nullable
public ValueSource<V> getValueSource()

Specified by:

getValueSource in interface HasValueSource<V>

Returns:

currently bound value source

getValue

@Nullable
public V getValue()

Specified by:

getValue in interface HasValue<V>

setValue

public void setValue(@Nullable
                     V value)

Specified by:

setValue in interface HasValue<V>

addValueChangeListener

public io.jmix.core.common.event.Subscription addValueChangeListener(java.util.function.Consumer<HasValue.ValueChangeEvent<V>> listener)

Specified by:

addValueChangeListener in interface HasValue<V>

setValueToPresentation

protected void setValueToPresentation(@Nullable
                                      P value)

componentValueChanged

protected void componentValueChanged(P prevComponentValue,
                                     P newComponentValue,
                                     boolean isUserOriginated)

convertToModel

@Nullable
protected V convertToModel(@Nullable
                                     P componentRawValue)
                              throws ConversionException

Throws:

ConversionException

convertToPresentation

@Nullable
protected P convertToPresentation(@Nullable
                                            V modelValue)
                                     throws ConversionException

Throws:

ConversionException

fieldValueEquals

protected boolean fieldValueEquals(@Nullable
                                   V value,
                                   @Nullable
                                   V oldValue)

commit

protected void commit()

discard

protected void discard()

isBuffered

protected boolean isBuffered()

setBuffered

protected void setBuffered(boolean buffered)

isModified

protected boolean isModified()