Drag[en]gine Script Module DragonScript
1.23
|
Classes | |
class | ActionDeselect |
Action listener calling setSelection(null). More... | |
class | ActionSelectAll |
Action listener calling setSelectionAll(). More... | |
Public Member Functions | |
void | deleteSelectedText () |
Delete selected text if present. More... | |
void | ensureCursorVisible () |
Ensure cursor is visible by scrolling the text if necessary. More... | |
int | getCursorPosition () |
Current position of the cursor in bytes. More... | |
int | getDisplayCharCount () |
Count of characters the edit field has to be able to display. More... | |
int | getFirstCharacter () |
Index in bytes of the first visible character. More... | |
Point | getMinimumSize () |
Minimal size of widget. More... | |
int | getPasswordChar () |
Password character to obfuscate passwords. More... | |
Point | getSelection () |
Selection if present. More... | |
void | insertText (String text) |
Insert text at cursor deleting selected text if present. More... | |
float | measureAdvance (int fromPosition, int toPosition, Font font) |
Measure advance starting from navigator position. More... | |
TextField | new () |
Create Text Field. More... | |
TextField | new (String text) |
Create Text Field. More... | |
TextField | new (TextModel model) |
Create Text Field. More... | |
TextField | new (TextModel model, bool readOnly) |
Create Text Field. More... | |
TextField | new (TextModel model, int displayCharCount) |
Create text field. More... | |
TextField | new (TextModel model, int displayCharCount, bool readOnly) |
Create text field. More... | |
void | onButtonPress (MouseEvent event) |
void | onButtonRelease (MouseEvent event) |
void | onClipboardCopy () |
Copy to clipboard requested. More... | |
void | onClipboardCut () |
Cut to clipboard requested. More... | |
void | onClipboardPaste () |
Paste from clipboard requested. More... | |
void | onFocusLost (FocusEvent event) |
Widget lost focus. More... | |
void | onFocusReceived (FocusEvent event) |
Widget received focus. More... | |
void | onGuiThemeChanged () |
GUI theme changed. More... | |
void | onKeyPress (KeyEvent event) |
Key pressed event. More... | |
void | onKeyType (KeyEvent event) |
Key typed event. "
" Convenience method called if onKeyPress is called with an event containing a printable key. More... | |
void | onModelChanged () |
Text model changed. More... | |
void | onMouseMove (MouseEvent event) |
void | onPaddingChanged () |
Padding changed. More... | |
void | onReadOnlyChanged () |
Read only state changed. \vrsion 1.7. More... | |
void | onResize (WidgetEvent event) |
Size changed. More... | |
void | onSetFont () |
Widget font changed. More... | |
void | onSetTextColor () |
Foreground color changed. More... | |
void | setCursorPosition (int position) |
Set current cursor position in bytes. More... | |
void | setCursorPositionEnd () |
Set cursor position to end of text. More... | |
void | setCursorPositionNear (Point position) |
Set cursor position closest to position relative to widget. More... | |
void | setCursorPositionStart () |
Set cursor position to start of text. More... | |
void | setDisplayCharCount (int count) |
Set count of characters the edit field has to be able to display. More... | |
void | setPasswordChar (int passwordChar) |
Set password character to obfuscate passwords. More... | |
void | setSelection (Point selection) |
Set selection or clears it. More... | |
void | setSelectionAll () |
Set selection to entire text. More... | |
void | setSelectionNone () |
Clear selection. More... | |
void | showContextMenu (Point position) |
Show context menu at position relative to widget. More... | |
void | textChanged (TextModel textModel) |
Model text changed. More... | |
Public Member Functions inherited from Dragengine.Gui.TextWidget | |
void | addActionListener (ActionListener listener) |
Add action listener. More... | |
void | dispose () |
Dispose of widget. More... | |
void | fireAction (int modifiers) |
Fire action. More... | |
bool | getActionOnEnter () |
Call action listeners if enter is pressed after user changed text by typing into the widget. More... | |
bool | getAddTabToText () |
Add tab to text instead of moving focus. More... | |
bool | getHasTyped () |
User has changed text by typing in the widget since the last action listener call. More... | |
TextModel | getModel () |
Text model. More... | |
bool | getReadOnly () |
TextValidator | getValidator () |
Text validator or null if not used. More... | |
void | removeActionListener (ActionListener listener) |
Remove action listener. More... | |
void | setActionOnEnter (bool actionOnEnter) |
Set to call action listeners if enter is pressed after user changed text by typing into the widget. More... | |
void | setAddTabToText (bool addTabToText) |
Set to add tab to text instead of moving focus. More... | |
void | setModel (TextModel model) |
Set text model. More... | |
void | setReadOnly (bool readOnly) |
void | setText (String text) |
Set text. More... | |
void | setValidator (TextValidator validator) |
Set text validator or null if not used. More... | |
Public Member Functions inherited from Dragengine.Gui.Widget | |
void | addDragListener (DragListener listener) |
void | addFocusListener (FocusListener listener) |
Add focus listener. More... | |
void | addGamepadListener (GamepadListener listener) |
Add gamepad listener. More... | |
void | addKeyListener (KeyListener listener) |
void | addMouseListener (MouseListener listener) |
void | addStateChangeListener (StateChangeListener listener) |
Add state change listener. More... | |
void | addWidgetListener (WidgetListener listener) |
Add widget listener. More... | |
bool | canGrabFullFocus () |
void | captureMouse () |
void | design () |
Design widget using WidgetDesigner. More... | |
Widget | findFocusableWidget () |
Widget | findLastFocusableWidget () |
CanvasCreator | getBackgroundCanvasCreator () |
Background canvas creator or null to use background color. More... | |
bool | getBlockLayoutParent () |
Block layoutParent calls. More... | |
Border | getBorder () |
BorderSize | getBorderSize () |
RectArea | getBoundary () |
Rectangulare boundary of the widget. More... | |
RectArea | getBoundaryWithBorder () |
Rectangulare boundary of the widget including border. More... | |
bool | getCanFocus () |
CanvasView | getCanvasBackground () |
CanvasView | getCanvasContent () |
CanvasView | getCanvasWidget () |
Clipboard | getClipboard () |
Clipboard or null to use parent clipboard. More... | |
ColorMatrix | getColorTransformation () |
Color transformation. More... | |
WidgetDesigner | getDesigner () |
Designer. More... | |
String | getDesignerSelector () |
Designer selector. More... | |
Desktop | getDesktop () |
Point | getDesktopPosition () |
Widget position in desktop coordinates. More... | |
bool | getEnabled () |
MousePointerFactory | getFirstMousePointer () |
First assigned mouse pointer. More... | |
Font | getFont () |
bool | getHasBlockedLayoutParent () |
layoutParent calls happened during runWhileBlockingLayoutParent. More... | |
bool | getHasFocus () |
int | getHeight () |
Height of widget. More... | |
RangeModel | getHorizontalRangeModel () |
Horizontal range model for viewports to synchronize the horizontal scrollbar. More... | |
Widget | getHoverWidget () |
Widget the mouse hovers above or null. More... | |
Point | getLocalMouseLocation () |
Parent desktop mouse location in widget coordinates. More... | |
Point | getMinimumSizeForHeight (int height) |
Minimum size of widget using reference widget height and variable width. More... | |
Point | getMinimumSizeForWidth (int width) |
Minimum size of widget using reference widget width and variable height. More... | |
Point | getMinimumSizeWithBorder () |
Point | getMinimumSizeWithBorderForHeight (int height) |
Minimum size of widget with border using reference height. More... | |
Point | getMinimumSizeWithBorderForWidth (int width) |
Minimum size of widget with border for reference width. More... | |
MousePointerFactory | getMousePointer () |
Mouse pointer to use. More... | |
BorderSize | getPadding () |
Padding. More... | |
Container | getParent () |
Point | getPosition () |
Position of the widget. More... | |
bool | getProtectBackgroundCanvasCreator () |
Protect custom set background canvas creator. More... | |
bool | getProtectBorder () |
Protect custom set border. More... | |
bool | getProtectFont () |
Protect custom set font. More... | |
bool | getProtectMinimumSize () |
Protect custom set minimumsize. More... | |
bool | getProtectMousePointer () |
Protect custom set mouse pointer. More... | |
bool | getProtectPadding () |
Protect custom set padding. More... | |
bool | getProtectTextColor () |
Protect custom set text color. More... | |
Point | getRelativePosition (Container parent) |
Widget position in parent widget coordinates. More... | |
Point | getScreenPosition () |
Widget position in screen coordinates. More... | |
RectArea | getScreenRectArea () |
Point | getSetMinimumSize () |
Point | getSize () |
Size of the widget. More... | |
Color | getTextColor () |
Text color. More... | |
String | getTitle () |
Widget title. More... | |
Object | getToolTip () |
Tooltip or null. More... | |
float | getTotalTransparency () |
TexMatrix2 | getTransformation () |
float | getTransparency () |
RangeModel | getVerticalRangeModel () |
Vertical range model for viewports to synchronize the vertical scrollbar. More... | |
bool | getVisible () |
Widget | getWidgetAt (Point position) |
Widget at coordinates or null if not found. More... | |
int | getWidth () |
Width of widget. More... | |
Window | getWindow () |
Point | getWindowPosition () |
Widget position in window coordinates. More... | |
int | getX () |
X position of widget. More... | |
int | getY () |
Y position of widget. More... | |
void | grabFocus () |
bool | hasParent (Container container) |
bool | isDesignerSet () |
Custom designer is set. More... | |
bool | isFullEnabled () |
Widget and all parent widgets are enabled. More... | |
bool | isMinimumSizeSet () |
bool | isMouseInside () |
Mouse is hovering over this widget. More... | |
bool | isPointInside (Point position) |
bool | isTransformationSet () |
void | layoutParent () |
void | layoutParentIfBlocked () |
Calls layoutParent if getHasBlockedLayoutParent() is true. More... | |
Widget | new (int x, int y, int width, int height) |
Create widget with initial location and size. More... | |
Widget | new (Point position, Point size) |
Create widget with initial location and size. More... | |
Widget | nextFocusWidget () |
Find next widget in the focus cycle that can grab the focus. More... | |
void | notifyBorderParametersChanged () |
void | onDesignerChanged () |
Designer changed. More... | |
void | onDesignerSelectorChanged () |
Designer selector changed. More... | |
void | onDispose (WidgetEvent event) |
Window is disposing. More... | |
void | onFrameUpdate (float elapsed) |
Do frame update. More... | |
void | onGamepadButtonPressed (GamepadEvent event) |
Gamepad button has been pressed. More... | |
void | onGamepadButtonReleased (GamepadEvent event) |
Gamepad button has been released. More... | |
void | onHidden (WidgetEvent event) |
Widget has been hidden. More... | |
void | onParentStateChanged () |
Parent state changed. More... | |
void | onParentStateChanged (bool force) |
Parent state changed. More... | |
void | onReposition (WidgetEvent event) |
Position changed. More... | |
void | onShown (WidgetEvent event) |
Widget has been shown. More... | |
void | onStateChanged (StateChangeEvent event) |
State changed. More... | |
void | onTranslationChanged () |
Translation manager or active language pack changed. More... | |
void | popdownVirtualKeyboard () |
Popdown virtual keyboard if Desktop has one assigned. More... | |
void | popupVirtualKeyboard () |
Popup virtual keyboard if Desktop has one assigned. More... | |
Widget | prevFocusWidget () |
Find previous widget in the focus cycle that can grab the focus. More... | |
void | processEvent (Event event) |
void | releaseMouse () |
void | removeDragListener (DragListener listener) |
void | removeFocusListener (FocusListener listener) |
Remove focus listener. More... | |
void | removeGamepadListener (GamepadListener listener) |
Remove gamepad listener. More... | |
void | removeKeyListener (KeyListener listener) |
void | removeMouseListener (MouseListener listener) |
void | removeStateChangeListener (StateChangeListener listener) |
Remove state change listener. More... | |
void | removeWidgetListener (WidgetListener listener) |
Remove widget listener. More... | |
void | requestGrabFocus (Widget widget) |
void | runWhileBlockingLayoutParent (Block ablock) |
Run block while layouting is blocked. More... | |
void | safeDispose () |
Safely dispose of widget. More... | |
void | sendEvent (Event event) |
void | sendEventToListeners (Event event, bool sendToParent) |
Send event to all appropriate listeners for events of its kind. More... | |
void | setBackgroundCanvasCreator (CanvasCreator creator) |
Set background canvas creator or null to use background color. More... | |
void | setBlockLayoutParent (bool blockLayoutParent) |
Set block layoutParent calls. More... | |
void | setBorder (Border border) |
void | setCanFocus (bool canFocus) |
void | setClipboard (Clipboard clipboard) |
Set clipboard or null to use parent clipboard. More... | |
void | setColorTransformation (ColorMatrix transformation) |
Set color transformation. More... | |
void | setDesigner (WidgetDesigner designer) |
Set designer. More... | |
void | setDesignerSelector (String selector) |
Set designer selector. More... | |
void | setEnabled (bool enabled) |
void | setFont (Font font) |
void | setHasBlockedLayoutParent (bool hasBlockedLayoutParent) |
Set if layoutParent calls happened during runWhileBlockingLayoutParent. More... | |
void | setHasFocus (bool hasFocus) |
void | setHeight (int height) |
Set height of widget. More... | |
void | setMinimumSize (Point size) |
void | setMousePointer (MousePointerFactory mousePointer) |
Set mouse pointer to use. More... | |
void | setPadding (BorderSize padding) |
Set padding. More... | |
void | setParent (Container parent) |
void | setPosition (Point position) |
Set position of widget. More... | |
void | setProtectBackgroundCanvasCreator (bool protect) |
Set protect custom set background canvas creator. More... | |
void | setProtectBorder (bool protect) |
Set protect custom set border. More... | |
void | setProtectFont (bool protect) |
Set protect custom set font. More... | |
void | setProtectMinimumSize (bool protect) |
Set protect custom set minimumsize. More... | |
void | setProtectMousePointer (bool protect) |
Set protect custom set mouse pointer. More... | |
void | setProtectPadding (bool protect) |
Set protect custom set padding. More... | |
void | setProtectTextColor (bool protect) |
Set protect custom set text color. More... | |
void | setSize (Point size) |
Set size of widget. More... | |
void | setTextColor (Color color) |
Set text color. More... | |
void | setTitle (String title) |
Set widget title. More... | |
void | setToolTip (Object toolTip) |
Set tooltip or null. More... | |
void | setTransformation (TexMatrix2 transformation) |
void | setTransparency (float transparency) |
void | setVisible (bool visible) |
void | setWidth (int width) |
Set width of widget. More... | |
void | setX (int x) |
Set X position of widget. More... | |
void | setY (int y) |
Set Y Position of widget. More... | |
void | startFrameUpdater () |
Start frame updater if not running. More... | |
void | stopFrameUpdater () |
Stop frame updater if running. More... | |
Protected Member Functions | |
UTF8Navigator | bestCharNear (int refXPos) |
Navigator of best character on line in respect to reference x position. More... | |
void | checkCursor () |
Check cursor is inside the text boundaries and adjust it if necessary. More... | |
MenuPopup | createContextMenu (Point position) |
Create context menu at position relative to widget. More... | |
MenuPopup | createContextMenu (Point position, TranslationManager translationManager) |
void | extendSelectionRight (UTF8Navigator position) |
Extend selection to the right. More... | |
Point | getSelectionXOffsets () |
Selection X offsets. More... | |
Protected Member Functions inherited from Dragengine.Gui.TextWidget | |
void | setHasTyped (bool hasTyped) |
Set if user has changed text by typing in the widget since the last action listener call. More... | |
Protected Member Functions inherited from Dragengine.Gui.Widget | |
WidgetDesigner | getDesignerFromTheme () |
Get designer from gui theme. More... | |
void | updateCanvasBackground () |
Update background canvas content. More... | |
void | updateCanvasGeometry () |
Update canvas position and size. More... | |
Text Field Widget.
Displays an edit field where the user can enter a short one line text.
Supports designing using designer selector "TextField".
Supports adding ActionListener instances. If InputEventKey.enter is pressed or focus is lost after typing in the widget action listeners are called.
Since version 1.16 showContextMenu() and createContextMenu() is present. If present the BaseGameApp translation manager is used. To translate the menu entries add these entries:
|
protected |
Navigator of best character on line in respect to reference x position.
|
protected |
Check cursor is inside the text boundaries and adjust it if necessary.
Create context menu at position relative to widget.
position | Position relative to text are the context menu has to be created for. |
|
protected |
void Dragengine.Gui.TextField.deleteSelectedText | ( | ) |
Delete selected text if present.
void Dragengine.Gui.TextField.ensureCursorVisible | ( | ) |
Ensure cursor is visible by scrolling the text if necessary.
|
protected |
Extend selection to the right.
int Dragengine.Gui.TextField.getCursorPosition | ( | ) |
Current position of the cursor in bytes.
int Dragengine.Gui.TextField.getDisplayCharCount | ( | ) |
Count of characters the edit field has to be able to display.
int Dragengine.Gui.TextField.getFirstCharacter | ( | ) |
Index in bytes of the first visible character.
Point Dragengine.Gui.TextField.getMinimumSize | ( | ) |
Minimal size of widget.
Reimplemented from Dragengine.Gui.Widget.
int Dragengine.Gui.TextField.getPasswordChar | ( | ) |
Password character to obfuscate passwords.
Point Dragengine.Gui.TextField.getSelection | ( | ) |
Selection if present.
|
protected |
Selection X offsets.
void Dragengine.Gui.TextField.insertText | ( | String | text | ) |
Insert text at cursor deleting selected text if present.
float Dragengine.Gui.TextField.measureAdvance | ( | int | fromPosition, |
int | toPosition, | ||
Font | font | ||
) |
Measure advance starting from navigator position.
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. |
EInvalidParam | toPosition is less than fromPosition |
Reimplemented from Dragengine.Gui.TextWidget.
TextField Dragengine.Gui.TextField.new | ( | ) |
Create Text Field.
Reimplemented from Dragengine.Gui.Widget.
Reimplemented in Dragengine.Gui.DefaultComboBoxEditor, and Dragengine.Gui.ConsoleInputField.
TextField Dragengine.Gui.TextField.new | ( | String | text | ) |
Create Text Field.
Create Text Field.
Reimplemented from Dragengine.Gui.TextWidget.
Reimplemented in Dragengine.Gui.DefaultComboBoxEditor.
Create Text Field.
Reimplemented from Dragengine.Gui.TextWidget.
Create text field.
Reimplemented in Dragengine.Gui.DefaultComboBoxEditor.
Create text field.
void Dragengine.Gui.TextField.onButtonPress | ( | MouseEvent | event | ) |
Notification that a mouse button has been pressed.
void Dragengine.Gui.TextField.onButtonRelease | ( | MouseEvent | event | ) |
Notification that a mouse button has been released.
void Dragengine.Gui.TextField.onClipboardCopy | ( | ) |
void Dragengine.Gui.TextField.onClipboardCut | ( | ) |
void Dragengine.Gui.TextField.onClipboardPaste | ( | ) |
void Dragengine.Gui.TextField.onFocusLost | ( | FocusEvent | event | ) |
Widget lost focus.
Reimplemented from Dragengine.Gui.TextWidget.
void Dragengine.Gui.TextField.onFocusReceived | ( | FocusEvent | event | ) |
Widget received focus.
Reimplemented from Dragengine.Gui.Widget.
void Dragengine.Gui.TextField.onGuiThemeChanged | ( | ) |
GUI theme changed.
Reimplemented from Dragengine.Gui.Widget.
void Dragengine.Gui.TextField.onKeyPress | ( | KeyEvent | event | ) |
Key pressed event.
Reimplemented from Dragengine.Gui.TextWidget.
Reimplemented in Dragengine.Gui.ConsoleInputField.
void Dragengine.Gui.TextField.onKeyType | ( | KeyEvent | event | ) |
Key typed event. " " Convenience method called if onKeyPress is called with an event containing a printable key.
Reimplemented from Dragengine.Gui.TextWidget.
Reimplemented in Dragengine.Gui.ConsoleInputField.
void Dragengine.Gui.TextField.onModelChanged | ( | ) |
Text model changed.
Reimplemented from Dragengine.Gui.TextWidget.
void Dragengine.Gui.TextField.onMouseMove | ( | MouseEvent | event | ) |
Notification that the mouse has moved.
void Dragengine.Gui.TextField.onPaddingChanged | ( | ) |
Padding changed.
Reimplemented from Dragengine.Gui.Widget.
void Dragengine.Gui.TextField.onReadOnlyChanged | ( | ) |
Read only state changed. \vrsion 1.7.
Reimplemented from Dragengine.Gui.TextWidget.
void Dragengine.Gui.TextField.onResize | ( | WidgetEvent | event | ) |
Size changed.
Reimplemented from Dragengine.Gui.Widget.
void Dragengine.Gui.TextField.onSetFont | ( | ) |
Widget font changed.
Reimplemented from Dragengine.Gui.Widget.
void Dragengine.Gui.TextField.onSetTextColor | ( | ) |
Foreground color changed.
Reimplemented from Dragengine.Gui.Widget.
void Dragengine.Gui.TextField.setCursorPosition | ( | int | position | ) |
Set current cursor position in bytes.
If the cursor is outside the visible area the text is shifted to make the cursor visible
void Dragengine.Gui.TextField.setCursorPositionEnd | ( | ) |
Set cursor position to end of text.
void Dragengine.Gui.TextField.setCursorPositionNear | ( | Point | position | ) |
Set cursor position closest to position relative to widget.
void Dragengine.Gui.TextField.setCursorPositionStart | ( | ) |
Set cursor position to start of text.
void Dragengine.Gui.TextField.setDisplayCharCount | ( | int | count | ) |
Set count of characters the edit field has to be able to display.
void Dragengine.Gui.TextField.setPasswordChar | ( | int | passwordChar | ) |
Set password character to obfuscate passwords.
use noPasswordChar to disable obfuscation of passwords.
void Dragengine.Gui.TextField.setSelection | ( | Point | selection | ) |
Set selection or clears it.
void Dragengine.Gui.TextField.setSelectionAll | ( | ) |
Set selection to entire text.
void Dragengine.Gui.TextField.setSelectionNone | ( | ) |
Clear selection.
void Dragengine.Gui.TextField.showContextMenu | ( | Point | position | ) |
Show context menu at position relative to widget.
void Dragengine.Gui.TextField.textChanged | ( | TextModel | textModel | ) |
Model text changed.
Reimplemented from Dragengine.Gui.TextWidget.
Reimplemented in Dragengine.Gui.DefaultComboBoxEditor.
final int Dragengine.Gui.TextField.noPasswordChar = 0 |
Use no password character constant.