Package org.teamapps.ux.component.field

Class TemplateField<RECORD>

java.lang.Object

org.teamapps.ux.component.AbstractComponent

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

org.teamapps.ux.component.field.TemplateField<RECORD>

All Implemented Interfaces:

ClientObject, Component

public class TemplateField<RECORD>
extends AbstractField<RECORD>

Field Summary

Fields

Modifier and Type	Field	Description
Event<java.lang.Void>	onClicked

Fields inherited from class org.teamapps.ux.component.field.AbstractField

onValueChanged, onVisibilityChanged

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

DELETED_ATTRIBUTE, onRendered

Constructor Summary

Constructors

Constructor	Description
TemplateField(Template template)
TemplateField(Template template, RECORD value)

Method Summary

Modifier and Type	Method	Description
RECORD	convertUiValueToUxValue(java.lang.Object value)
java.lang.Object	convertUxValueToUiValue(RECORD record)	Converts a server-side value to a client-side field-specific value.
org.teamapps.dto.UiTemplateField	createUiComponent()
PropertyProvider<RECORD>	getPropertyProvider()
Template	getTemplate()
void	handleUiEvent(org.teamapps.dto.UiEvent event)
TemplateField<RECORD>	setPropertyExtractor(PropertyExtractor<RECORD> propertyExtractor)
TemplateField<RECORD>	setPropertyProvider(PropertyProvider<RECORD> propertyProvider)
TemplateField<RECORD>	setTemplate(Template template)

Methods inherited from class org.teamapps.ux.component.field.AbstractField

addCustomFieldMessage, addCustomFieldMessage, addValidator, applyValueFromUi, clearCustomFieldMessages, clearValidatorMessages, focus, getCustomFieldMessages, getDefaultMessagePosition, getDefaultMessageVisibility, getEditingMode, getFieldMessages, getMaxFieldMessageSeverity, getValidators, getValue, isEmpty, isEmptyValue, isRequired, isValid, isValueChangedByClient, mapAbstractFieldAttributesToUiField, removeCustomFieldMessage, removeValidator, setAndLockValue, setCustomFieldMessages, setDefaultMessagePosition, setDefaultMessageVisibility, setEditingMode, setRequired, setRequiredIfVisibleAndEditable, setValue, setValueChangedByClient, setVisible, validate

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

createUiReference, getDebuggingId, getId, getParent, getSessionContext, isRendered, isVisible, mapAbstractUiComponentProperties, queueCommandIfRendered, render, reRenderIfRendered, setAttribute, setCssStyle, setDebuggingId, setParent, toggleCssClass, 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.ClientObject

handleUiQuery

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

setAriaLabel, setAttribute, setCssStyle, setHtmlTitle, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setShadow, toggleCssClass

Field Detail

onClicked

public final Event<java.lang.Void> onClicked

Constructor Detail

TemplateField

public TemplateField(Template template)

TemplateField

public TemplateField(Template template,
                     RECORD value)

Method Detail

handleUiEvent

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

Specified by:

handleUiEvent in interface ClientObject

Overrides:

handleUiEvent in class AbstractField<RECORD>

createUiComponent

public org.teamapps.dto.UiTemplateField createUiComponent()

Specified by:

createUiComponent in class AbstractComponent

convertUiValueToUxValue

public RECORD convertUiValueToUxValue(java.lang.Object value)

Overrides:

convertUiValueToUxValue in class AbstractField<RECORD>

convertUxValueToUiValue

public java.lang.Object convertUxValueToUiValue(RECORD record)

Description copied from class: AbstractField

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

Overrides:

convertUxValueToUiValue in class AbstractField<RECORD>

Parameters:

record - the server-side value

Returns:

the object to be sent to the ui

getTemplate

public Template getTemplate()

setTemplate

public TemplateField<RECORD> setTemplate(Template template)

getPropertyProvider

public PropertyProvider<RECORD> getPropertyProvider()

setPropertyProvider

public TemplateField<RECORD> setPropertyProvider(PropertyProvider<RECORD> propertyProvider)

setPropertyExtractor

public TemplateField<RECORD> setPropertyExtractor(PropertyExtractor<RECORD> propertyExtractor)