Package org.teamapps.ux.component.field

Class TextField

java.lang.Object

org.teamapps.ux.component.AbstractComponent

org.teamapps.ux.component.field.AbstractField<java.lang.String>

org.teamapps.ux.component.field.TextField

All Implemented Interfaces:

Component, TextInputHandlingField

Direct Known Subclasses:

MultiLineTextField, PasswordField

public class TextField
extends AbstractField<java.lang.String>
implements TextInputHandlingField

Field Summary

Fields

Modifier and Type	Field	Description
Event<SpecialKey>	onSpecialKeyPressed
Event<java.lang.String>	onTextInput

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

onValueChanged, onVisibilityChanged

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

onDestroyed, onRendered

Constructor Summary

Constructors

Constructor	Description
TextField()

Method Summary

Modifier and Type	Method	Description
org.teamapps.dto.UiField	createUiComponent()
protected void	doDestroy()	Override this method to release resources whenever this component gets destroyed
java.lang.String	getEmptyText()
int	getMaxCharacters()
void	handleUiEvent(org.teamapps.dto.UiEvent event)
boolean	isAutofill()
boolean	isEmpty()	Whether this field can be regarded as empty / "no user input".
boolean	isShowClearButton()
Event<SpecialKey>	onSpecialKeyPressed()
Event<java.lang.String>	onTextInput()
void	setAutofill(boolean autofill)
TextField	setEmptyText(java.lang.String emptyText)
TextField	setMaxCharacters(int maxCharacters)
TextField	setShowClearButton(boolean showClearButton)

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

addCustomFieldMessage, addValidator, applyValueFromUi, clearCustomFieldMessages, convertUiValueToUxValue, convertUxValueToUiValue, focus, getCustomFieldMessages, getDefaultMessagePosition, getDefaultMessageVisibility, getEditingMode, getFieldMessages, getMaxFieldMessageSeverity, getValidators, getValue, isRequired, isValid, mapAbstractFieldAttributesToUiField, removeCustomFieldMessage, removeValidator, setAndLockValue, setCustomFieldMessages, setDefaultMessagePosition, setDefaultMessageVisibility, setEditingMode, setRequired, setValue, setVisible, validate

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

createUiComponentReference, destroy, getDebuggingId, getId, getParent, getSessionContext, isDestroyed, isEffectivelyVisible, isRendered, isVisible, mapAbstractUiComponentProperties, onDestroyed, queueCommandIfRendered, render, reRenderIfRendered, setCssStyle, setDebuggingId, 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

Methods inherited from interface org.teamapps.ux.component.field.TextInputHandlingField

defaultHandleTextInputEvent

Field Details

onTextInput

public final Event<java.lang.String> onTextInput

onSpecialKeyPressed

public final Event<SpecialKey> onSpecialKeyPressed

Constructor Details

TextField

public TextField()

Method Details

getMaxCharacters

public int getMaxCharacters()

setMaxCharacters

public TextField setMaxCharacters(int maxCharacters)

isShowClearButton

public boolean isShowClearButton()

setShowClearButton

public TextField setShowClearButton(boolean showClearButton)

getEmptyText

public java.lang.String getEmptyText()

setEmptyText

public TextField setEmptyText(java.lang.String emptyText)

isAutofill

public boolean isAutofill()

setAutofill

public void setAutofill(boolean autofill)

createUiComponent

public org.teamapps.dto.UiField createUiComponent()

Specified by:

createUiComponent in class AbstractComponent

handleUiEvent

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

Specified by:

handleUiEvent in interface Component

Overrides:

handleUiEvent in class AbstractField<java.lang.String>

isEmpty

public boolean isEmpty()

Description copied from class: AbstractField

Whether this field can be regarded as empty / "no user input". Override for field-specific behaviour.

Overrides:

isEmpty in class AbstractField<java.lang.String>

Returns:

true if the value can be regarded as "empty".

doDestroy

protected void doDestroy()

Description copied from class: AbstractComponent

Override this method to release resources whenever this component gets destroyed

Overrides:

doDestroy in class AbstractComponent

onTextInput

public Event<java.lang.String> onTextInput()

Specified by:

onTextInput in interface TextInputHandlingField

onSpecialKeyPressed

public Event<SpecialKey> onSpecialKeyPressed()

Specified by:

onSpecialKeyPressed in interface TextInputHandlingField