Super class for widgets supporting text input. More...

Inheritance diagram for Dragengine.Gui.TextWidget:

Classes
class	ActionCopy
	Action listener calling onClipboardCopy(). More...

class	ActionCut
	Action listener calling onClipboardCut(). More...

class	ActionPaste
	Action listener calling onClipboardPaste(). More...

Public Member Functions
void	addActionListener (ActionListener listener)
	Add action listener.

void	dispose ()
	Dispose of widget.

void	fireAction (int modifiers)
	Fire action.

bool	getActionOnEnter ()
	Call action listeners if enter is pressed after user changed text by typing into the widget.

bool	getAddTabToText ()
	Add tab to text instead of moving focus.

bool	getHasTyped ()
	User has changed text by typing in the widget since the last action listener call.

TextModel	getModel ()
	Text model.

bool	getReadOnly ()

TextValidator	getValidator ()
	Text validator or null if not used.

float	measureAdvance (int fromPosition, int toPosition, Font font)
	Measure advance starting from navigator position.

TextWidget	new (TextModel model)
	Create text widget.

TextWidget	new (TextModel model, bool readOnly)
	Create text widget.

void	onClipboardCopy ()
	Copy to clipboard requested.

void	onClipboardCut ()
	Cut to clipboard requested.

void	onClipboardPaste ()
	Paste from clipboard requested.

void	onFocusLost (FocusEvent event)
	Widget lost focus.

void	onKeyPress (KeyEvent event)
	Key has been pressed.

void	onKeyType (KeyEvent event)
	Key typed event. " " Convenience method called if onKeyPress is called with an event containing a printable key.

void	onModelChanged ()
	Text model changed.

void	onReadOnlyChanged ()
	Read only state changed.

void	removeActionListener (ActionListener listener)
	Remove action listener.

void	setActionOnEnter (bool actionOnEnter)
	Set to call action listeners if enter is pressed after user changed text by typing into the widget.

void	setAddTabToText (bool addTabToText)
	Set to add tab to text instead of moving focus.

void	setModel (TextModel model)
	Set text model.

void	setReadOnly (bool readOnly)

void	setText (String text)
	Set text.

void	setValidator (TextValidator validator)
	Set text validator or null if not used.

void	textChanged (TextModel textModel)
	Text in model changed.

Public Member Functions inherited from Dragengine.Gui.Widget
void	addDragListener (DragListener listener)

void	addFocusListener (FocusListener listener)
	Add focus listener.

void	addGamepadListener (GamepadListener listener)
	Add gamepad listener.

void	addKeyListener (KeyListener listener)

void	addMouseListener (MouseListener listener)

void	addStateChangeListener (StateChangeListener listener)
	Add state change listener.

void	addWidgetListener (WidgetListener listener)
	Add widget listener.

bool	canGrabFullFocus ()

void	captureDirectional ()
	Captures directional navigation if not already captured by another widget.

void	collectClosestFocusWidget (ClosestDirectionFocusFinder finder, Point origin)
	Find closest focus widget for directional navigation.

void	design ()
	Design widget using WidgetDesigner.

void	desktopWarpMouseFocusHere ()
	Warp mouse to focus location on this widget.

void	desktopWarpMouseFocusLocation ()
	Warp mouse to focus location on desktop focus widget.

void	ensureVisible ()
	Ensure widget is fully visible on desktop if possible.

void	ensureVisible (RectArea boundary)
	Ensure boundary is visible on desktop if possible.

Widget	findFocusableWidget ()

Widget	findLastFocusableWidget ()

void	focusDirectional (int direction)
	Focus widget in direction that can grab the focus.

CanvasCreator	getBackgroundCanvasCreator ()
	Background canvas creator or null to use background color.

bool	getBlockLayoutParent ()
	Block layoutParent calls.

Border	getBorder ()

BorderSize	getBorderSize ()

RectArea	getBoundary ()
	Rectangular boundary of the widget.

RectArea	getBoundaryWithBorder ()
	Rectangular boundary of the widget including border.

bool	getCanFocus ()

bool	getCanFocusDirectional ()
	Widget can get focus using directional navigation.

CanvasView	getCanvasBackground ()

CanvasView	getCanvasContent ()

CanvasView	getCanvasWidget ()

Clipboard	getClipboard ()
	Clipboard or null to use parent clipboard.

ColorMatrix	getColorTransformation ()
	Color transformation.

WidgetDesigner	getDesigner ()
	Designer.

String	getDesignerSelector ()
	Designer selector.

Desktop	getDesktop ()

RectArea	getDesktopBoundary ()
	Rectangular boundary of widget relative to desktop.

RectArea	getDesktopBoundaryWithBorder ()
	Rectangular boundary of widget including border relative to parent.

Point	getDesktopPosition ()
	Widget position in desktop coordinates.

Widget	getDirectionalCaptureWidget ()
	Widget having captured directional navigation.

bool	getEnabled ()

MousePointerFactory	getFirstMousePointer ()
	First assigned mouse pointer.

Point	getFocusMouseLocation ()
	Focus mouse location in widget coordinates.

Font	getFont ()

bool	getHasBlockedLayoutParent ()
	layoutParent calls happened during runWhileBlockingLayoutParent.

bool	getHasFocus ()

int	getHeight ()
	Height of widget.

RangeModel	getHorizontalRangeModel ()
	Horizontal range model for viewports to synchronize the horizontal scrollbar.

Widget	getHoverWidget ()
	Widget the mouse hovers above or null.

Point	getLocalMouseLocation ()
	Parent desktop mouse location in widget coordinates.

Point	getMinimumSize ()

Point	getMinimumSizeForHeight (int height)
	Minimum size of widget using reference widget height and variable width.

Point	getMinimumSizeForWidth (int width)
	Minimum size of widget using reference widget width and variable height.

Point	getMinimumSizeWithBorder ()

Point	getMinimumSizeWithBorderForHeight (int height)
	Minimum size of widget with border using reference height.

Point	getMinimumSizeWithBorderForWidth (int width)
	Minimum size of widget with border for reference width.

Widget	getMouseCaptureWidget ()
	Widget having captured the mouse.

MousePointerFactory	getMousePointer ()
	Mouse pointer to use.

BorderSize	getPadding ()
	Padding.

Container	getParent ()

Point	getPosition ()
	Position of the widget.

bool	getProtectBackgroundCanvasCreator ()
	Protect custom set background canvas creator.

bool	getProtectBorder ()
	Protect custom set border.

bool	getProtectFont ()
	Protect custom set font.

bool	getProtectMinimumSize ()
	Protect custom set minimumsize.

bool	getProtectMousePointer ()
	Protect custom set mouse pointer.

bool	getProtectPadding ()
	Protect custom set padding.

bool	getProtectTextColor ()
	Protect custom set text color.

RectArea	getRelativeBoundary (Container parent)
	Rectangular boundary of widget relative to parent.

RectArea	getRelativeBoundaryWithBorder (Container parent)
	Rectangular boundary of widget including border relative to parent.

Point	getRelativePosition (Container parent)
	Widget position in parent widget coordinates.

Point	getScreenPosition ()
	Widget position in screen coordinates.

RectArea	getScreenRectArea ()

Point	getSetMinimumSize ()

Point	getSize ()
	Size of the widget.

Color	getTextColor ()
	Text color.

String	getTitle ()
	Widget title.

Object	getToolTip ()
	Tooltip or null.

float	getTotalTransparency ()

TexMatrix2	getTransformation ()

float	getTransparency ()

RangeModel	getVerticalRangeModel ()
	Vertical range model for viewports to synchronize the vertical scrollbar.

bool	getVisible ()

RectArea	getVisibleDesktopBoundary ()
	Visible widget boundary in desktop coordinates.

RectArea	getVisibleRelativeBoundary (Container parent)
	Visible widget boundary relative to parent coordinate system.

Widget	getWidgetAt (Point position)
	Widget at coordinates or null if not found.

int	getWidth ()
	Width of widget.

Window	getWindow ()

Point	getWindowPosition ()
	Widget position in window coordinates.

int	getX ()
	X position of widget.

int	getY ()
	Y position of widget.

void	grabFocus ()

bool	hasParent (Container container)

bool	isCapturingDirectional ()
	Widget is capturing directional navigation.

bool	isCapturingMouse ()
	Widget is capturing mouse.

bool	isDesignerSet ()
	Custom designer is set.

bool	isFullEnabled ()
	Widget and all parent widgets are enabled.

bool	isMinimumSizeSet ()

bool	isMouseInside ()
	Mouse is hovering over this widget.

bool	isPointInside (Point position)

bool	isTransformationSet ()

void	layoutParent ()

void	layoutParentIfBlocked ()
	Calls layoutParent if getHasBlockedLayoutParent() is true.

Widget	new ()
	Create widget.

Widget	new (int x, int y, int width, int height)
	Create widget with initial location and size.

Widget	new (Point position, Point size)
	Create widget with initial location and size.

Widget	nextFocusWidget ()
	Find next widget in the focus cycle that can grab the focus.

void	notifyBorderParametersChanged ()

void	onDesignerChanged ()
	Designer changed.

void	onDesignerSelectorChanged ()
	Designer selector changed.

void	onDispose (WidgetEvent event)
	Window is disposing.

void	onFocusReceived (FocusEvent event)
	Widget received focus.

void	onFrameUpdate (float elapsed)
	Do frame update.

void	onGamepadButtonPressed (GamepadEvent event)
	Gamepad button has been pressed.

void	onGamepadButtonReleased (GamepadEvent event)
	Gamepad button has been released.

void	onGuiThemeChanged ()

void	onHidden (WidgetEvent event)
	Widget has been hidden.

void	onPaddingChanged ()
	Padding changed.

void	onParentStateChanged ()
	Parent state changed.

void	onParentStateChanged (bool force)
	Parent state changed.

void	onReposition (WidgetEvent event)
	Position changed.

void	onResize (WidgetEvent event)
	Size changed.

void	onSetFont ()

void	onSetTextColor ()
	Text color changed.

void	onShown (WidgetEvent event)
	Widget has been shown.

void	onStateChanged (StateChangeEvent event)
	State changed.

void	onTranslationChanged ()
	Translation manager or active language pack changed.

void	popdownVirtualKeyboard ()
	Popdown virtual keyboard if Desktop has one assigned.

void	popdownVirtualKeyboardDirectional ()
	Popdown virtual keyboard if Desktop has one assigned and direction focus widget.

void	popupVirtualKeyboard ()
	Popup virtual keyboard if Desktop has one assigned.

Widget	prevFocusWidget ()
	Find previous widget in the focus cycle that can grab the focus.

void	processEvent (Event event)
	Process an event.

void	releaseDirectional ()
	Release directional navigation capture.

void	releaseMouse ()

void	removeDragListener (DragListener listener)

void	removeFocusListener (FocusListener listener)
	Remove focus listener.

void	removeGamepadListener (GamepadListener listener)
	Remove gamepad listener.

void	removeKeyListener (KeyListener listener)

void	removeMouseListener (MouseListener listener)

void	removeStateChangeListener (StateChangeListener listener)
	Remove state change listener.

void	removeWidgetListener (WidgetListener listener)
	Remove widget listener.

void	requestGrabFocus (Widget widget)

void	runWhileBlockingLayoutParent (Block ablock)
	Run block while layouting is blocked.

void	safeDispose ()
	Safely dispose of widget.

void	sendEvent (Event event)

void	sendEventToListeners (Event event, bool sendToParent)
	Send event to all appropriate listeners for events of its kind.

void	setBackgroundCanvasCreator (CanvasCreator creator)
	Set background canvas creator or null to use background color.

void	setBlockLayoutParent (bool blockLayoutParent)
	Set block layoutParent calls.

void	setBorder (Border border)

void	setCanFocus (bool canFocus)

void	setCanFocusDirectional (bool canFocus)
	Set if widget can get focus using directional navigation.

void	setClipboard (Clipboard clipboard)
	Set clipboard or null to use parent clipboard.

void	setColorTransformation (ColorMatrix transformation)
	Set color transformation.

void	setDesigner (WidgetDesigner designer)
	Set designer.

void	setDesignerSelector (String selector)
	Set designer selector.

void	setEnabled (bool enabled)

void	setFont (Font font)

void	setHasBlockedLayoutParent (bool hasBlockedLayoutParent)
	Set if layoutParent calls happened during runWhileBlockingLayoutParent.

void	setHasFocus (bool hasFocus)

void	setHeight (int height)
	Set height of widget.

void	setMinimumSize (Point size)

void	setMousePointer (MousePointerFactory mousePointer)
	Set mouse pointer to use.

void	setPadding (BorderSize padding)
	Set padding.

void	setParent (Container parent)

void	setPosition (Point position)
	Set position of widget.

void	setProtectBackgroundCanvasCreator (bool protect)
	Set protect custom set background canvas creator.

void	setProtectBorder (bool protect)
	Set protect custom set border.

void	setProtectFont (bool protect)
	Set protect custom set font.

void	setProtectMinimumSize (bool protect)
	Set protect custom set minimumsize.

void	setProtectMousePointer (bool protect)
	Set protect custom set mouse pointer.

void	setProtectPadding (bool protect)
	Set protect custom set padding.

void	setProtectTextColor (bool protect)
	Set protect custom set text color.

void	setSize (Point size)
	Set size of widget.

void	setTextColor (Color color)
	Set text color.

void	setTitle (String title)
	Set widget title.

void	setToolTip (Object toolTip)
	Set tooltip or null.

void	setTransformation (TexMatrix2 transformation)

void	setTransparency (float transparency)

void	setVisible (bool visible)

void	setWidth (int width)
	Set width of widget.

void	setX (int x)
	Set X position of widget.

void	setY (int y)
	Set Y Position of widget.

void	simulateKeyPress (int keyCode, int keyChar)
	Simulate keyboard press event.

void	simulateKeyPressRelease (int keyCode, int keyChar)
	Simulate keyboard press and release event.

void	simulateKeyRelease (int keyCode, int keyChar)
	Simulate keyboard release event.

void	startFrameUpdater ()
	Start frame updater if not running.

void	stopFrameUpdater ()
	Stop frame updater if running.

Public Attributes
Array	pActionListeners

bool	pActionOnEnter

bool	pAddTabToText

bool	pHasTyped

TextModel	pModel

bool	pReadOnly

TextValidator	pValidator

Public Attributes inherited from Dragengine.Gui.Widget
CanvasCreator	pBackgroundCanvasCreator

bool	pBlockLayoutParent

Border	pBorder

CanvasView	pCanvasWidget

Clipboard	pClipboard

WidgetDesigner	pDesigner

String	pDesignerSelector

Font	pFont

FrameUpdater	pFrameUpdater

bool	pIsDesignerSet

Array	pKeyListeners

MousePointerFactory	pMousePointer

BorderSize	pPadding

Container	pParent

Point	pPosition

bool	pProtectBackgroundCanvasCreator

RepeatKeyEventTimer	pRepeatEventTimer

Color	pTextColor

GuiTheme	pTheme

String	pThemeSelector

String	pTitle

Object	pToolTip

TexMatrix2	pTransformation

TranslationManager	pTranslationManager

float	pTransparency

bool	pVisible

Protected Member Functions
void	setHasTyped (bool hasTyped)
	Set if user has changed text by typing in the widget since the last action listener call.

Protected Member Functions inherited from Dragengine.Gui.Widget
WidgetDesigner	getDesignerFromTheme ()
	Get designer from gui theme.

void	updateCanvasBackground ()
	Update background canvas content.

void	updateCanvasGeometry ()
	Update canvas position and size.

Detailed Description

Super class for widgets supporting text input.

Provides onKeyType() method called if key press event contains printable character.

Member Function Documentation

◆ addActionListener()

void Dragengine.Gui.TextWidget.addActionListener ( ActionListener listener )

Add action listener.

Version: 1.8

Reimplemented in Dragengine.Gui.DefaultComboBoxEditor.

◆ dispose()

void Dragengine.Gui.TextWidget.dispose ( )

Dispose of widget.

Reimplemented from Dragengine.Gui.Widget.

Reimplemented in Dragengine.Gui.ConsoleInputField, Dragengine.Gui.DefaultComboBoxEditor, and Dragengine.Gui.TextArea.

◆ fireAction()

void Dragengine.Gui.TextWidget.fireAction ( int modifiers )

Fire action.

Version: 1.8

◆ getActionOnEnter()

bool Dragengine.Gui.TextWidget.getActionOnEnter ( )

Call action listeners if enter is pressed after user changed text by typing into the widget.

Version: 1.8

◆ getAddTabToText()

bool Dragengine.Gui.TextWidget.getAddTabToText ( )

Add tab to text instead of moving focus.

Version: 1.8

◆ getHasTyped()

bool Dragengine.Gui.TextWidget.getHasTyped ( )

User has changed text by typing in the widget since the last action listener call.

Version: 1.8

◆ getModel()

TextModel Dragengine.Gui.TextWidget.getModel ( )

Text model.

◆ getReadOnly()

bool Dragengine.Gui.TextWidget.getReadOnly ( )

Determines if the text is read only.

◆ getValidator()

TextValidator Dragengine.Gui.TextWidget.getValidator ( )

Text validator or null if not used.

◆ measureAdvance()

float Dragengine.Gui.TextWidget.measureAdvance	(	int	fromPosition,
		int	toPosition,
		Font	font
	)

Measure advance starting from navigator position.

Version: 1.16

Parameters

fromPosition	Byte position to start measure from.
toPosition	End position to measure to. Character at end position is not included.
font	Font to use for measuring.

Exceptions

EInvalidParam toPosition is less than fromPosition

Reimplemented in Dragengine.Gui.TextField.

◆ new() [1/2]

TextWidget Dragengine.Gui.TextWidget.new ( TextModel model )

Create text widget.

Reimplemented in Dragengine.Gui.DefaultComboBoxEditor, Dragengine.Gui.TextField, and Dragengine.Gui.TextArea.

◆ new() [2/2]

TextWidget Dragengine.Gui.TextWidget.new	(	TextModel	model,
		bool	readOnly
	)

Create text widget.

Version: 1.7

Reimplemented in Dragengine.Gui.TextField, and Dragengine.Gui.TextArea.

◆ onClipboardCopy()

void Dragengine.Gui.TextWidget.onClipboardCopy ( )

Copy to clipboard requested.

Version: 1.11

Reimplemented in Dragengine.Gui.TextArea, and Dragengine.Gui.TextField.

◆ onClipboardCut()

void Dragengine.Gui.TextWidget.onClipboardCut ( )

Cut to clipboard requested.

Version: 1.11

Reimplemented in Dragengine.Gui.TextArea, and Dragengine.Gui.TextField.

◆ onClipboardPaste()

void Dragengine.Gui.TextWidget.onClipboardPaste ( )

Paste from clipboard requested.

Version: 1.11

Reimplemented in Dragengine.Gui.TextArea, and Dragengine.Gui.TextField.

◆ onFocusLost()

void Dragengine.Gui.TextWidget.onFocusLost ( FocusEvent event )

Widget lost focus.

Reimplemented from Dragengine.Gui.Widget.

Reimplemented in Dragengine.Gui.TextArea, and Dragengine.Gui.TextField.

◆ onKeyPress()

void Dragengine.Gui.TextWidget.onKeyPress ( KeyEvent event )

Key has been pressed.

If event contains a printable character onKeyType() is called after super.onKeyPress().

Reimplemented in Dragengine.Gui.ConsoleInputField, Dragengine.Gui.TextArea, and Dragengine.Gui.TextField.

◆ onKeyType()

void Dragengine.Gui.TextWidget.onKeyType ( KeyEvent event )

Key typed event. " " Convenience method called if onKeyPress is called with an event containing a printable key.

Reimplemented in Dragengine.Gui.ConsoleInputField, Dragengine.Gui.TextArea, and Dragengine.Gui.TextField.

◆ onModelChanged()

void Dragengine.Gui.TextWidget.onModelChanged ( )

Text model changed.

Reimplemented in Dragengine.Gui.TextArea, and Dragengine.Gui.TextField.

◆ onReadOnlyChanged()

void Dragengine.Gui.TextWidget.onReadOnlyChanged ( )

Read only state changed.

Version: 1.7

Reimplemented in Dragengine.Gui.TextField.

◆ removeActionListener()

void Dragengine.Gui.TextWidget.removeActionListener ( ActionListener listener )

Remove action listener.

Version: 1.8

Reimplemented in Dragengine.Gui.DefaultComboBoxEditor.

◆ setActionOnEnter()

void Dragengine.Gui.TextWidget.setActionOnEnter ( bool actionOnEnter )

Set to call action listeners if enter is pressed after user changed text by typing into the widget.

Version: 1.8

◆ setAddTabToText()

void Dragengine.Gui.TextWidget.setAddTabToText ( bool addTabToText )

Set to add tab to text instead of moving focus.

Version: 1.8

◆ setHasTyped()

void Dragengine.Gui.TextWidget.setHasTyped ( bool hasTyped )

protected

Set if user has changed text by typing in the widget since the last action listener call.

Version: 1.8

◆ setModel()

void Dragengine.Gui.TextWidget.setModel ( TextModel model )

Set text model.

◆ setReadOnly()

void Dragengine.Gui.TextWidget.setReadOnly ( bool readOnly )

Sets if the text is read only.

◆ setText()

void Dragengine.Gui.TextWidget.setText ( String text )

Set text.

Convenience method for calling getModel().setText().

◆ setValidator()

void Dragengine.Gui.TextWidget.setValidator ( TextValidator validator )

Set text validator or null if not used.

Current model text is not re-validated. Caller has to ensure text is valid before assigning a new validator to avoid impossible to solve situations.

◆ textChanged()

void Dragengine.Gui.TextWidget.textChanged ( TextModel textModel )

Text in model changed.

Implementation of TextModelListener.textChanged().

Implements Dragengine.Gui.TextModelListener.

Reimplemented in Dragengine.Gui.DefaultComboBoxEditor, Dragengine.Gui.TextArea, and Dragengine.Gui.TextField.

Member Data Documentation

◆ pActionListeners

Array Dragengine.Gui.TextWidget.pActionListeners

◆ pActionOnEnter

bool Dragengine.Gui.TextWidget.pActionOnEnter

◆ pAddTabToText

bool Dragengine.Gui.TextWidget.pAddTabToText

◆ pHasTyped

bool Dragengine.Gui.TextWidget.pHasTyped

◆ pModel

TextModel Dragengine.Gui.TextWidget.pModel

◆ pReadOnly

bool Dragengine.Gui.TextWidget.pReadOnly

◆ pValidator

TextValidator Dragengine.Gui.TextWidget.pValidator

The documentation for this class was generated from the following file:

TextWidget.ds

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

◆ addActionListener()

◆ dispose()

◆ fireAction()

◆ getActionOnEnter()

◆ getAddTabToText()

◆ getHasTyped()

◆ getModel()

◆ getReadOnly()

◆ getValidator()

◆ measureAdvance()

◆ new() [1/2]

◆ new() [2/2]

◆ onClipboardCopy()

◆ onClipboardCut()

◆ onClipboardPaste()

◆ onFocusLost()

◆ onKeyPress()

◆ onKeyType()

◆ onModelChanged()

◆ onReadOnlyChanged()

◆ removeActionListener()

◆ setActionOnEnter()

◆ setAddTabToText()

◆ setHasTyped()

◆ setModel()

◆ setReadOnly()

◆ setText()

◆ setValidator()

◆ textChanged()

Member Data Documentation

◆ pActionListeners

◆ pActionOnEnter

◆ pAddTabToText

◆ pHasTyped

◆ pModel

◆ pReadOnly

◆ pValidator