com.simsilica.lemur.value

Class TextFieldValueEditor<T>

java.lang.Object

com.simsilica.lemur.value.TextFieldValueEditor<T>

All Implemented Interfaces:

com.simsilica.lemur.core.VersionedObject<T>, ValueEditor<T>

public class TextFieldValueEditor<T>
extends java.lang.Object
implements ValueEditor<T>

Uses a text field and a pair of object-string and string-object transform functions to implement a ValueEditor.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TextFieldValueEditor.FocusObserver

Constructor Summary

Constructors

Constructor and Description
TextFieldValueEditor(com.google.common.base.Function<java.lang.Object,java.lang.String> toString, com.google.common.base.Function<java.lang.String,T> toObject)

Method Summary

Modifier and Type	Method and Description
void	configureStyle(com.simsilica.lemur.style.ElementId elementId, java.lang.String style) Called by the using component to set the preferred ElementId and style for the editor.
com.simsilica.lemur.core.VersionedReference<T>	createReference()
protected com.simsilica.lemur.TextField	createTextField()
com.simsilica.lemur.text.DocumentModelFilter	getDocumentModelFilter()
com.simsilica.lemur.Panel	getEditor() Returns the GUI element that is providing editing support.
com.simsilica.lemur.style.ElementId	getElementId()
T	getObject() Returns the current committed value of the editor.
java.lang.String	getStyle()
long	getVersion()
protected void	incrementVersion()
boolean	isActive() Returns true if this editor is still active.
protected void	resetText() Resets the text field to reflect the current model value.
void	setDocumentModelFilter(com.simsilica.lemur.text.DocumentModelFilter model) Sets the document model for this editor.
void	setElementId(com.simsilica.lemur.style.ElementId elementId) Sets a preconfigured ElementId for created editors.
void	setObject(T object) Sets the initial value of the object to be edited.
void	setStyle(java.lang.String style) Sets a preconfigured style for created editors.
com.simsilica.lemur.Panel	startEditing(T initialValue) Starts editing and returns the Panel that should be added to the parent to facilitate that editing.
protected void	stopEditing(boolean canceled)
boolean	updateState(float tpf) Called to update the state of the editor and returns true or false if editing should continue.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextFieldValueEditor

public TextFieldValueEditor(com.google.common.base.Function<java.lang.Object,java.lang.String> toString,
                            com.google.common.base.Function<java.lang.String,T> toObject)

Method Detail

incrementVersion

protected void incrementVersion()

createReference

public com.simsilica.lemur.core.VersionedReference<T> createReference()

Specified by:

createReference in interface com.simsilica.lemur.core.VersionedObject<T>

getVersion

public long getVersion()

Specified by:

getVersion in interface com.simsilica.lemur.core.VersionedObject<T>

setObject

public void setObject(T object)

Description copied from interface: ValueEditor

Sets the initial value of the object to be edited.

Specified by:

setObject in interface ValueEditor<T>

getObject

public T getObject()

Description copied from interface: ValueEditor

Returns the current committed value of the editor. If the editor holds-and-modifies that value then this will return the unedited value until editing is complete. If the editor is a 'live' editor then this will always return the current value. The versioned reference for this editor can be used to watch for value changes.

Specified by:

getObject in interface com.simsilica.lemur.core.VersionedObject<T>

Specified by:

getObject in interface ValueEditor<T>

updateState

public boolean updateState(float tpf)

Description copied from interface: ValueEditor

Called to update the state of the editor and returns true or false if editing should continue. This should be called once per frame as part of the parent's own updates.

Specified by:

updateState in interface ValueEditor<T>

isActive

public boolean isActive()

Description copied from interface: ValueEditor

Returns true if this editor is still active.

Specified by:

isActive in interface ValueEditor<T>

setElementId

public void setElementId(com.simsilica.lemur.style.ElementId elementId)

Sets a preconfigured ElementId for created editors. If this is non-null then the default implementation of configureStyle() will ignore the configureStyle() elementId argument.

getElementId

public com.simsilica.lemur.style.ElementId getElementId()

setStyle

public void setStyle(java.lang.String style)

Sets a preconfigured style for created editors. If this is non-null then the default implementation of configureStyle() will ignore the configureStyle() style argument.

getStyle

public java.lang.String getStyle()

configureStyle

public void configureStyle(com.simsilica.lemur.style.ElementId elementId,
                           java.lang.String style)

Description copied from interface: ValueEditor

Called by the using component to set the preferred ElementId and style for the editor. Implementations can ignore this if they wish to override the default element ID or style.

Specified by:

configureStyle in interface ValueEditor<T>

setDocumentModelFilter

public void setDocumentModelFilter(com.simsilica.lemur.text.DocumentModelFilter model)

Sets the document model for this editor. Note: this should not be called while a value is being edited as it will cause the old editor to be invalidated.

getDocumentModelFilter

public com.simsilica.lemur.text.DocumentModelFilter getDocumentModelFilter()

createTextField

protected com.simsilica.lemur.TextField createTextField()

startEditing

public com.simsilica.lemur.Panel startEditing(T initialValue)

Description copied from interface: ValueEditor

Starts editing and returns the Panel that should be added to the parent to facilitate that editing.

Specified by:

startEditing in interface ValueEditor<T>

getEditor

public com.simsilica.lemur.Panel getEditor()

Description copied from interface: ValueEditor

Returns the GUI element that is providing editing support.

Specified by:

getEditor in interface ValueEditor<T>

resetText

protected void resetText()

Resets the text field to reflect the current model value.

stopEditing

protected void stopEditing(boolean canceled)