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 () |
void | dispose () |
void | ensureCursorVisible () |
int | getCursorLine () |
int | getCursorLineCharCount () |
int | getCursorLineFor (int pos) |
int | getCursorPosition () |
int | getFirstLine () |
RangeModel | getHorizontalRangeModel () |
int | getLineCount () |
int | getMaximalWidth () |
Point | getMinimumSize () |
Point | getMinimumSizeForWidth (int width) |
Minimum size of widget using reference widget width and variable height. More... | |
int | getRowCount () |
Number display rows. More... | |
Point | getSelection () |
Point | getTextSize () |
RangeModel | getVerticalRangeModel () |
void | insertText (String text) |
Insert text at cursor deleting selected text if present. More... | |
TextArea | new () |
TextArea | new (String text) |
TextArea | new (TextModel textModel) |
TextArea | new (TextModel textModel, bool readOnly) |
Create text area. More... | |
TextArea | new (TextModel textModel, int rowCount) |
Create text area. More... | |
TextArea | new (TextModel textModel, int rowCount, bool readOnly) |
Create text area. 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 () |
void | onKeyPress (KeyEvent event) |
void | onKeyType (KeyEvent event) |
void | onModelChanged () |
Text model changed. More... | |
void | onMouseMove (MouseEvent event) |
void | onPaddingChanged () |
Padding changed. More... | |
void | onResize (WidgetEvent event) |
Size changed. More... | |
void | onSetFont () |
void | onSetTextColor () |
void | rangeChanged (RangeModel rangeModel) |
Read only state changed. \vesion 1.7. More... | |
void | setCursorPosition (int pos) |
void | setCursorPositionEnd () |
void | setCursorPositionNear (Point position) |
Set cursor position closest to position relative to widget. More... | |
void | setCursorPositionStart () |
void | setMaximalWidth (int width) |
void | setRowCount (int rowCount) |
Set number display rows. More... | |
void | setSelection (Point selection) |
void | setSelectionAll () |
void | showContextMenu (Point position) |
Show context menu at position relative to widget. More... | |
void | textChanged (TextModel textModel) |
void | valueChanged (RangeModel rangeModel) |
Public Member Functions inherited from Dragengine.Gui.TextWidget | |
void | addActionListener (ActionListener listener) |
Add action listener. 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... | |
float | measureAdvance (int fromPosition, int toPosition, Font font) |
Measure advance starting from navigator position. More... | |
void | onReadOnlyChanged () |
Read only state changed. \vrsion 1.7. 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... | |
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 | 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 () |
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 | |
int | bestCharNear (int line, int refXPos) |
Index of best character on line in respect to reference x position. More... | |
UTF8Navigator | bestCharNearNav (int line, int refXPos) |
Navigator of best character on line in respect to reference x position. More... | |
int | bestLineNear (int refYPos) |
void | checkBoundaries () |
Check cursor is inside text boundaries and adjust 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 | getCaret () |
Point | getOffsetToCursor () |
int | getRefXPos () |
Point | getSelectionXOffsets () |
void | updateRangeModels () |
void | updateTextLayout () |
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... | |
Displays an edit field where the user can enter a text with more than one line.
Supports designing using designer selector "TextArea".
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 |
Index of best character on line in respect to reference x position.
|
protected |
Navigator of best character on line in respect to reference x position.
|
protected |
Finds best line in reference to a given y position.
|
protected |
Check cursor is inside text boundaries and adjust 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.TextArea.deleteSelectedText | ( | ) |
Deletes the selected text if present.
void Dragengine.Gui.TextArea.dispose | ( | ) |
Dispose of this widget.
Reimplemented from Dragengine.Gui.TextWidget.
void Dragengine.Gui.TextArea.ensureCursorVisible | ( | ) |
Ensure that the cursor is visible by scrolling the text if necessary.
|
protected |
Extend selection to the right.
|
protected |
Retrieves the caret position.
int Dragengine.Gui.TextArea.getCursorLine | ( | ) |
Retrieves the line the cursor is on.
int Dragengine.Gui.TextArea.getCursorLineCharCount | ( | ) |
Retrieves the number of UTF-8 bytes on the current line.
int Dragengine.Gui.TextArea.getCursorLineFor | ( | int | pos | ) |
Retrieves the line for a specific cursor position.
int Dragengine.Gui.TextArea.getCursorPosition | ( | ) |
Retrieves the current position of the cursor in the text.
int Dragengine.Gui.TextArea.getFirstLine | ( | ) |
Retrieves the index of the first line visible.
RangeModel Dragengine.Gui.TextArea.getHorizontalRangeModel | ( | ) |
Retrieves the horizontal range model. Viewport widgets can use this range model to synchronize with their horizontal scrollbar. If this widget has no reasonable horizontal range model it should return null.
Reimplemented from Dragengine.Gui.Widget.
int Dragengine.Gui.TextArea.getLineCount | ( | ) |
Retrieves the number of text lines.
int Dragengine.Gui.TextArea.getMaximalWidth | ( | ) |
Retrieve maximal width of text before break occurs.
Point Dragengine.Gui.TextArea.getMinimumSize | ( | ) |
Retrieve the minimal size of widget.
Reimplemented from Dragengine.Gui.Widget.
Point Dragengine.Gui.TextArea.getMinimumSizeForWidth | ( | int | width | ) |
Minimum size of widget using reference widget width and variable height.
Default implementation uses getMinimumSize().
Reimplemented from Dragengine.Gui.Widget.
|
protected |
Calculates the offset to cursor.
|
protected |
Retrieves the reference x position.
int Dragengine.Gui.TextArea.getRowCount | ( | ) |
Number display rows.
Point Dragengine.Gui.TextArea.getSelection | ( | ) |
Retrieves the selection if present.
|
protected |
Retrieves the selection x offsets.
Point Dragengine.Gui.TextArea.getTextSize | ( | ) |
Calculates the size of the content text.
RangeModel Dragengine.Gui.TextArea.getVerticalRangeModel | ( | ) |
Retrieves the vertical range model. Viewport widgets can use this range model to synchronize with their vertical scrollbar. If this widget has no reasonable vertical range model it should return null.
Reimplemented from Dragengine.Gui.Widget.
void Dragengine.Gui.TextArea.insertText | ( | String | text | ) |
Insert text at cursor deleting selected text if present.
TextArea Dragengine.Gui.TextArea.new | ( | ) |
Creates a new Text Area.
Reimplemented from Dragengine.Gui.Widget.
TextArea Dragengine.Gui.TextArea.new | ( | String | text | ) |
Creates a new Text Field.
Creates a new Text Field.
Reimplemented from Dragengine.Gui.TextWidget.
Create text area.
Reimplemented from Dragengine.Gui.TextWidget.
Create text area.
void Dragengine.Gui.TextArea.onButtonPress | ( | MouseEvent | event | ) |
Key released event. Notification that a mouse button has been pressed.
void Dragengine.Gui.TextArea.onButtonRelease | ( | MouseEvent | event | ) |
Notification that a mouse button has been released.
void Dragengine.Gui.TextArea.onClipboardCopy | ( | ) |
void Dragengine.Gui.TextArea.onClipboardCut | ( | ) |
void Dragengine.Gui.TextArea.onClipboardPaste | ( | ) |
void Dragengine.Gui.TextArea.onFocusLost | ( | FocusEvent | event | ) |
Widget lost focus.
Reimplemented from Dragengine.Gui.TextWidget.
void Dragengine.Gui.TextArea.onFocusReceived | ( | FocusEvent | event | ) |
Widget received focus.
Reimplemented from Dragengine.Gui.Widget.
void Dragengine.Gui.TextArea.onGuiThemeChanged | ( | ) |
Notification that the gui theme changed.
Reimplemented from Dragengine.Gui.Widget.
void Dragengine.Gui.TextArea.onKeyPress | ( | KeyEvent | event | ) |
Key pressed event.
Reimplemented from Dragengine.Gui.TextWidget.
void Dragengine.Gui.TextArea.onKeyType | ( | KeyEvent | event | ) |
Key typed event.
Reimplemented from Dragengine.Gui.TextWidget.
void Dragengine.Gui.TextArea.onModelChanged | ( | ) |
Text model changed.
Reimplemented from Dragengine.Gui.TextWidget.
void Dragengine.Gui.TextArea.onMouseMove | ( | MouseEvent | event | ) |
Notification that the mouse has moved.
void Dragengine.Gui.TextArea.onPaddingChanged | ( | ) |
Padding changed.
Reimplemented from Dragengine.Gui.Widget.
void Dragengine.Gui.TextArea.onResize | ( | WidgetEvent | event | ) |
Size changed.
Reimplemented from Dragengine.Gui.Widget.
void Dragengine.Gui.TextArea.onSetFont | ( | ) |
Notify about font change.
Reimplemented from Dragengine.Gui.Widget.
void Dragengine.Gui.TextArea.onSetTextColor | ( | ) |
Foreground color changed.
Reimplemented from Dragengine.Gui.Widget.
void Dragengine.Gui.TextArea.rangeChanged | ( | RangeModel | rangeModel | ) |
Read only state changed. \vesion 1.7.
Send if the outer range properties like minimum value, maximum value or page size has changed.
Implements Dragengine.Gui.RangeModelListener.
void Dragengine.Gui.TextArea.setCursorPosition | ( | int | pos | ) |
Sets the current cursor position in the text. If the cursor is outside the visible area the text is shifted to make the cursor visible.
void Dragengine.Gui.TextArea.setCursorPositionEnd | ( | ) |
Sets the cursor position to the end of the text.
void Dragengine.Gui.TextArea.setCursorPositionNear | ( | Point | position | ) |
Set cursor position closest to position relative to widget.
void Dragengine.Gui.TextArea.setCursorPositionStart | ( | ) |
Sets the cursor position to the start of the text.
void Dragengine.Gui.TextArea.setMaximalWidth | ( | int | width | ) |
Sets maximal width of text before break occurs.
void Dragengine.Gui.TextArea.setRowCount | ( | int | rowCount | ) |
Set number display rows.
void Dragengine.Gui.TextArea.setSelection | ( | Point | selection | ) |
Sets the selection or clears it.
void Dragengine.Gui.TextArea.setSelectionAll | ( | ) |
Sets the selection to the entire text.
void Dragengine.Gui.TextArea.showContextMenu | ( | Point | position | ) |
Show context menu at position relative to widget.
void Dragengine.Gui.TextArea.textChanged | ( | TextModel | textModel | ) |
Send if the text string has changed. Implementation of TextModle interface.
Reimplemented from Dragengine.Gui.TextWidget.
|
protected |
Update range models.
|
protected |
Updates the text layout for the label.
void Dragengine.Gui.TextArea.valueChanged | ( | RangeModel | rangeModel | ) |
Send if the value has changed.
Implements Dragengine.Gui.RangeModelListener.