Package org.teamapps.ux.component.field

Class AbstractField<VALUE>

java.lang.Object

org.teamapps.ux.component.AbstractComponent

org.teamapps.ux.component.field.AbstractField<VALUE>

All Implemented Interfaces:

Component

Direct Known Subclasses:

AbstractComboBox, AbstractDateField, AbstractDateTimeField, AbstractTimeField, Button, CheckBox, ColorPicker, ComponentField, CurrencyField, DisplayField, FileField, ImageField, Label, NumberField, RichTextEditor, Slider, TextField

public abstract class AbstractField<VALUE>
extends AbstractComponent

Field Summary

Fields

Modifier and Type	Field	Description
Event<VALUE>	onValueChanged
Event<java.lang.Boolean>	onVisibilityChanged

Fields inherited from class org.teamapps.ux.component.AbstractComponent

onDestroyed, onRendered

Constructor Summary

Constructors

Constructor	Description
AbstractField()

Method Summary

Modifier and Type	Method	Description
void	addFieldMessage(FieldMessage fieldMessage)
protected void	applyValueFromUi(java.lang.Object value)
VALUE	convertUiValueToUxValue(java.lang.Object value)
java.lang.Object	convertUxValueToUiValue(VALUE value)	Converts a server-side value to a client-side field-specific value.
protected abstract void	doDestroy()	Override this method to release resources whenever this component gets destroyed
void	focus()
FieldEditingMode	getEditingMode()
java.util.List<FieldMessage>	getFieldMessages()
VALUE	getValue()
void	handleUiEvent(org.teamapps.dto.UiEvent event)
boolean	isVisible()
protected void	mapAbstractFieldAttributesToUiField(org.teamapps.dto.UiField uiField)
void	removeFieldMessage(FieldMessage fieldMessage)
void	removeFieldMessages(java.util.List<FieldMessage> fieldMessages)
void	removeValidationMessages()
protected MultiWriteLockableValue.Lock	setAndLockValue(VALUE value)
void	setEditingMode(FieldEditingMode editingMode)
void	setFieldMessages(java.util.List<FieldMessage> fieldMessages)
void	setValidationMessage(FieldMessage fieldMessage)
void	setValue(VALUE value)
void	setVisible(boolean visible)

Methods inherited from class org.teamapps.ux.component.AbstractComponent

createUiComponent, createUiComponentReference, destroy, getId, getParent, getSessionContext, isDestroyed, isEffectivelyVisible, isRendered, mapAbstractUiComponentProperties, queueCommandIfRendered, render, reRenderIfRendered, setCssStyle, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setParent, setShadow, toString, unrender

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.teamapps.ux.component.Component

setCssStyle

Field Detail

onValueChanged

public final Event<VALUE> onValueChanged

onVisibilityChanged

public final Event<java.lang.Boolean> onVisibilityChanged

Constructor Detail

AbstractField

public AbstractField()

Method Detail

getEditingMode

public FieldEditingMode getEditingMode()

setEditingMode

public void setEditingMode(FieldEditingMode editingMode)

isVisible

public boolean isVisible()

Specified by:

isVisible in interface Component

Overrides:

isVisible in class AbstractComponent

setVisible

public void setVisible(boolean visible)

Specified by:

setVisible in interface Component

Overrides:

setVisible in class AbstractComponent

focus

public void focus()

mapAbstractFieldAttributesToUiField

protected void mapAbstractFieldAttributesToUiField(org.teamapps.dto.UiField uiField)

setValue

public void setValue(VALUE value)

setAndLockValue

protected MultiWriteLockableValue.Lock setAndLockValue(VALUE value)

convertUxValueToUiValue

public java.lang.Object convertUxValueToUiValue(VALUE value)

Converts a server-side value to a client-side field-specific value. Implementations must not have any side effects to the component!

Parameters:

value - the server-side value

Returns:

the object to be sent to the ui

getValue

public VALUE getValue()

handleUiEvent

public void handleUiEvent(org.teamapps.dto.UiEvent event)

applyValueFromUi

protected void applyValueFromUi(java.lang.Object value)

convertUiValueToUxValue

public VALUE convertUiValueToUxValue(java.lang.Object value)

doDestroy

protected abstract void doDestroy()

Description copied from class: AbstractComponent

Override this method to release resources whenever this component gets destroyed

Overrides:

doDestroy in class AbstractComponent

getFieldMessages

public java.util.List<FieldMessage> getFieldMessages()

setFieldMessages

public void setFieldMessages(java.util.List<FieldMessage> fieldMessages)

setValidationMessage

public void setValidationMessage(FieldMessage fieldMessage)

removeValidationMessages

public void removeValidationMessages()

addFieldMessage

public void addFieldMessage(FieldMessage fieldMessage)

removeFieldMessage

public void removeFieldMessage(FieldMessage fieldMessage)

removeFieldMessages

public void removeFieldMessages(java.util.List<FieldMessage> fieldMessages)