com.simsilica.lemur.component

Class TextEntryComponent

java.lang.Object

com.simsilica.lemur.component.AbstractGuiComponent

com.simsilica.lemur.component.TextEntryComponent

All Implemented Interfaces:

ColoredComponent, GuiComponent, FocusTarget

public class TextEntryComponent
extends AbstractGuiComponent
implements FocusTarget, ColoredComponent

A basic text entry component that allows displaying and editing of text based on a DocumentModel. Default key bindings are setup for common navigation functions and the key input is taken over while the component has focus.

Field Summary

Fields

Modifier and Type	Field and Description
static KeyActionListener	BACKSPACE
static KeyActionListener	DELETE
static KeyActionListener	DOC_END
static KeyActionListener	DOC_HOME
static KeyActionListener	FOCUS_DOWN
static KeyActionListener	FOCUS_NEXT
static KeyActionListener	FOCUS_PREVIOUS
static KeyActionListener	FOCUS_UP
static KeyActionListener	LEFT
static KeyActionListener	LINE_END
static KeyActionListener	LINE_HOME
static KeyActionListener	NEW_LINE
static KeyActionListener	NEXT_LINE
static KeyActionListener	NO_OP
static KeyActionListener	PREV_LINE
static KeyActionListener	RIGHT

Constructor Summary

Constructors

Constructor and Description
TextEntryComponent(com.jme3.font.BitmapFont font)
TextEntryComponent(DocumentModel model, com.jme3.font.BitmapFont font)

Method Summary

Modifier and Type	Method and Description
void	attach(GuiControl parent)
void	calculatePreferredSize(com.jme3.math.Vector3f size)
TextEntryComponent	clone()
void	detach(GuiControl parent)
void	focusGained() Notifies this focus target that is has gained focus.
void	focusLost() Notifies this focus target that is has lost focus.
java.util.Map<KeyAction,KeyActionListener>	getActionMap()
float	getAlpha() Returns the current alpha multiplier that is applied to the color when set to the actual visuals.
com.jme3.math.ColorRGBA	getColor() Returns the current color of this component.
float	getCursorWidth()
DocumentModel	getDocumentModel()
com.jme3.font.BitmapFont	getFont()
float	getFontSize()
HAlignment	getHAlignment()
java.lang.Float	getPreferredCursorWidth()
float	getPreferredLineCount()
com.jme3.math.Vector3f	getPreferredSize()
float	getPreferredWidth()
java.lang.String	getText()
VAlignment	getVAlignment()
protected float	getVisibleWidth(java.lang.String text)
boolean	isFocusable() Returns true if this target can currently accept focus through a normal transition.
boolean	isFocused() Returns true if this focus target currently has the focus.
boolean	isSingleLine()
protected void	resetAlignment()
protected void	resetCursorColor()
protected void	resetCursorPosition()
protected void	resetCursorState()
protected void	resetText()
void	reshape(com.jme3.math.Vector3f pos, com.jme3.math.Vector3f size)
protected void	resizeCursor()
void	setAlpha(float f) Sets an alpha multiplier that will be applied to the color when set to the actual visuals.
void	setColor(com.jme3.math.ColorRGBA color) Sets the color for this component.
void	setFont(com.jme3.font.BitmapFont font)
void	setFontSize(float f)
void	setHAlignment(HAlignment a)
void	setPreferredCursorWidth(java.lang.Float f)
void	setPreferredLineCount(int i)
void	setPreferredSize(com.jme3.math.Vector3f v)
void	setPreferredWidth(float f)
void	setSingleLine(boolean f)
void	setText(java.lang.String text)
void	setVAlignment(VAlignment a)

Methods inherited from class com.simsilica.lemur.component.AbstractGuiComponent

getGuiControl, getNode, invalidate, isAttached

Methods inherited from class java.lang.Object

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

Field Detail

DOC_HOME

public static final KeyActionListener DOC_HOME

DOC_END

public static final KeyActionListener DOC_END

LINE_HOME

public static final KeyActionListener LINE_HOME

LINE_END

public static final KeyActionListener LINE_END

PREV_LINE

public static final KeyActionListener PREV_LINE

NEXT_LINE

public static final KeyActionListener NEXT_LINE

LEFT

public static final KeyActionListener LEFT

RIGHT

public static final KeyActionListener RIGHT

NO_OP

public static final KeyActionListener NO_OP

BACKSPACE

public static final KeyActionListener BACKSPACE

NEW_LINE

public static final KeyActionListener NEW_LINE

DELETE

public static final KeyActionListener DELETE

FOCUS_NEXT

public static final KeyActionListener FOCUS_NEXT

FOCUS_PREVIOUS

public static final KeyActionListener FOCUS_PREVIOUS

FOCUS_DOWN

public static final KeyActionListener FOCUS_DOWN

FOCUS_UP

public static final KeyActionListener FOCUS_UP

Constructor Detail

TextEntryComponent

public TextEntryComponent(com.jme3.font.BitmapFont font)

TextEntryComponent

public TextEntryComponent(DocumentModel model,
                          com.jme3.font.BitmapFont font)

Method Detail

clone

public TextEntryComponent clone()

Specified by:

clone in interface GuiComponent

Overrides:

clone in class AbstractGuiComponent

attach

public void attach(GuiControl parent)

Specified by:

attach in interface GuiComponent

Overrides:

attach in class AbstractGuiComponent

detach

public void detach(GuiControl parent)

Specified by:

detach in interface GuiComponent

Overrides:

detach in class AbstractGuiComponent

isFocused

public boolean isFocused()

Description copied from interface: FocusTarget

Returns true if this focus target currently has the focus.

Specified by:

isFocused in interface FocusTarget

isFocusable

public boolean isFocusable()

Description copied from interface: FocusTarget

Returns true if this target can currently accept focus through a normal transition. If an attempt is made to force the focus to this target then focus may actually transition to a different target.

Specified by:

isFocusable in interface FocusTarget

focusGained

public void focusGained()

Description copied from interface: FocusTarget

Notifies this focus target that is has gained focus.

Specified by:

focusGained in interface FocusTarget

focusLost

public void focusLost()

Description copied from interface: FocusTarget

Notifies this focus target that is has lost focus.

Specified by:

focusLost in interface FocusTarget

getActionMap

public java.util.Map<KeyAction,KeyActionListener> getActionMap()

getDocumentModel

public DocumentModel getDocumentModel()

setSingleLine

public void setSingleLine(boolean f)

isSingleLine

public boolean isSingleLine()

setFont

public void setFont(com.jme3.font.BitmapFont font)

getFont

public com.jme3.font.BitmapFont getFont()

setFontSize

public void setFontSize(float f)

getFontSize

public float getFontSize()

resetCursorColor

protected void resetCursorColor()

setColor

public void setColor(com.jme3.math.ColorRGBA color)

Description copied from interface: ColoredComponent

Sets the color for this component.

Specified by:

setColor in interface ColoredComponent

getColor

public com.jme3.math.ColorRGBA getColor()

Description copied from interface: ColoredComponent

Returns the current color of this component.

Specified by:

getColor in interface ColoredComponent

setAlpha

public void setAlpha(float f)

Description copied from interface: ColoredComponent

Sets an alpha multiplier that will be applied to the color when set to the actual visuals.

Specified by:

setAlpha in interface ColoredComponent

getAlpha

public float getAlpha()

Description copied from interface: ColoredComponent

Returns the current alpha multiplier that is applied to the color when set to the actual visuals.

Specified by:

getAlpha in interface ColoredComponent

resetText

protected void resetText()

getVisibleWidth

protected float getVisibleWidth(java.lang.String text)

setPreferredCursorWidth

public void setPreferredCursorWidth(java.lang.Float f)

getPreferredCursorWidth

public java.lang.Float getPreferredCursorWidth()

getCursorWidth

public float getCursorWidth()

resizeCursor

protected void resizeCursor()

resetCursorState

protected void resetCursorState()

resetCursorPosition

protected void resetCursorPosition()

setText

public void setText(java.lang.String text)

getText

public java.lang.String getText()

setHAlignment

public void setHAlignment(HAlignment a)

getHAlignment

public HAlignment getHAlignment()

setVAlignment

public void setVAlignment(VAlignment a)

getVAlignment

public VAlignment getVAlignment()

setPreferredSize

public void setPreferredSize(com.jme3.math.Vector3f v)

getPreferredSize

public com.jme3.math.Vector3f getPreferredSize()

setPreferredWidth

public void setPreferredWidth(float f)

getPreferredWidth

public float getPreferredWidth()

setPreferredLineCount

public void setPreferredLineCount(int i)

getPreferredLineCount

public float getPreferredLineCount()

reshape

public void reshape(com.jme3.math.Vector3f pos,
                    com.jme3.math.Vector3f size)

Specified by:

reshape in interface GuiComponent

calculatePreferredSize

public void calculatePreferredSize(com.jme3.math.Vector3f size)

Specified by:

calculatePreferredSize in interface GuiComponent

resetAlignment

protected void resetAlignment()