Package de.gurkenlabs.litiengine.gui

Class TextFieldComponent

java.lang.Object

de.gurkenlabs.litiengine.gui.GuiComponent

de.gurkenlabs.litiengine.gui.ImageComponent

de.gurkenlabs.litiengine.gui.TextFieldComponent

All Implemented Interfaces:

IRenderable, Tweenable, MouseListener, MouseMotionListener, MouseWheelListener, EventListener

Direct Known Subclasses:

NumberAdjuster

public class TextFieldComponent
extends ImageComponent

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DOUBLE_FORMAT
static final String	INTEGER_FORMAT

Fields inherited from class de.gurkenlabs.litiengine.gui.ImageComponent

BACKGROUND_DISABLED_INDEX, BACKGROUND_HOVER_INDEX, BACKGROUND_INDEX, BACKGROUND_PRESSED_INDEX

Fields inherited from class de.gurkenlabs.litiengine.gui.GuiComponent

ICON_FONT

Constructor Summary

Constructors

Constructor	Description
TextFieldComponent(double x, double y, double width, double height, String text)

Method Summary

Modifier and Type	Method	Description
boolean	canHandleInput()
String	getCursor()
String	getFormat()
int	getMaxLength()
String	getText()	Gets the entire Text associated with this GuiComponent.
String	getTextToRender(Graphics2D g)	Gets only the non-cropped bits of Text visible on this GuiComponent.m To retrieve only the entire text associated with this GuiComponent, use GuiComponent.getText().
void	handleTypedKey(KeyEvent event)
void	onChangeConfirmed(Consumer<String> cons)
void	render(Graphics2D g)	Renders the component using the provided Graphics2D context.
void	setCursor(String newCursor)
void	setFlickerDelay(int flickerDelayMillis)
void	setFormat(String format)
void	setMaxLength(int maxLength)
void	setText(String text)	Sets the text.

Methods inherited from class de.gurkenlabs.litiengine.gui.ImageComponent

getBackground, getImage, getImageAlign, getImageScaleInterpolation, getImageScaleMode, getImageValign, getSpritesheet, getSpritesheetScaleFactor, getSpritesheetScaleInterpolation, getSpritesheetScaleMode, rescaleImage, setHeight, setImage, setImageAlign, setImageScaleInterpolation, setImageScaleMode, setImageValign, setSpritesheet, setSpritesheet, setSpritesheet, setSpritesheetScaleFactor, setSpritesheetScaleInterpolation, setSpritesheetScaleMode, setWidth

Methods inherited from class de.gurkenlabs.litiengine.gui.GuiComponent

addRenderedListener, addRenderListener, getAppearance, getAppearanceDisabled, getAppearanceHovered, getBoundingBox, getCenterX, getCenterY, getClickConsumer, getComponentId, getComponents, getCurrentAppearance, getFont, getHeight, getHoverConsumer, getHoverSound, getLocation, getMouseDraggedConsumer, getMouseEnterConsumer, getMouseLeaveConsumer, getMouseMovedConsumer, getMousePressedConsumer, getMouseReleasedConsumer, getMouseWheelConsumer, getName, getShape, getTag, getTextAlign, getTextAngle, getTextShadowColor, getTextShadowRadius, getTextValign, getTextX, getTextY, getTweenValues, getWidth, getX, getY, hasAutomaticLineBreaks, hasTextAntialiasing, hasTextShadow, initializeComponents, isEnabled, isForwardMouseEvents, isHovered, isPressed, isSelected, isSuspended, isVisible, mouseClicked, mouseDragged, mouseEntered, mouseEventShouldBeForwarded, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, onClicked, onHovered, onMouseDragged, onMouseEnter, onMouseLeave, onMouseMoved, onMousePressed, onMouseReleased, onMouseWheelScrolled, onTextChanged, prepare, removeListener, removeListener, setAutomaticLineBreaks, setDimension, setEnabled, setFont, setFontSize, setForwardMouseEvents, setHovered, setHoverSound, setLocation, setLocation, setName, setSelected, setTag, setTextAlign, setTextAngle, setTextAntialiasing, setTextShadow, setTextShadowColor, setTextShadowRadius, setTextValign, setTextX, setTextY, setTweenValues, setVisible, setX, setY, suspend, toggleSelection, toggleSuspension

Methods inherited from class java.lang.Object

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

Field Details

DOUBLE_FORMAT

public static final String DOUBLE_FORMAT

See Also:

• Constant Field Values

INTEGER_FORMAT

public static final String INTEGER_FORMAT

See Also:

• Constant Field Values

Constructor Details

TextFieldComponent

public TextFieldComponent(double x,
 double y,
 double width,
 double height,
 String text)

Method Details

getFormat

public String getFormat()

setFormat

public void setFormat(String format)

getCursor

public String getCursor()

setCursor

public void setCursor(String newCursor)

getMaxLength

public int getMaxLength()

setMaxLength

public void setMaxLength(int maxLength)

getText

public String getText()

Description copied from class: GuiComponent

Gets the entire Text associated with this GuiComponent. Parts of the Text may get cropped and can therefore be invisible. To retrieve only the visible part of the text, use GuiComponent.getTextToRender(Graphics2D g).

Overrides:

getText in class GuiComponent

Returns:

the entire text on this GuiComponent

setText

public void setText(String text)

Description copied from class: GuiComponent

Sets the text.

Overrides:

setText in class GuiComponent

Parameters:

text - the new text

getTextToRender

public String getTextToRender(Graphics2D g)

Description copied from class: GuiComponent

Gets only the non-cropped bits of Text visible on this GuiComponent.m To retrieve only the entire text associated with this GuiComponent, use GuiComponent.getText().

Overrides:

getTextToRender in class GuiComponent

Parameters:

g - The graphics object to render on.

Returns:

the text to render

handleTypedKey

public void handleTypedKey(KeyEvent event)

canHandleInput

public boolean canHandleInput()

onChangeConfirmed

public void onChangeConfirmed(Consumer<String> cons)

render

public void render(Graphics2D g)

Description copied from class: ImageComponent

Renders the component using the provided Graphics2D context. If the component is suspended or not visible, the method returns immediately. Otherwise, it renders the background image (if available) and the main image (if available), and then calls the superclass's render method.

Specified by:

render in interface IRenderable

Overrides:

render in class ImageComponent

Parameters:

g - The Graphics2D context used for rendering.

See Also:

• RenderEngine.renderEntity(Graphics2D, de.gurkenlabs.litiengine.entities.IEntity)

setFlickerDelay

public void setFlickerDelay(int flickerDelayMillis)