Drag[en]gine Script Module DragonScript  1.23
Dragengine.Gui.DefaultComboBoxEditor Class Reference

Default implementation of ComboBoxEditor using a TextField. More...

Inheritance diagram for Dragengine.Gui.DefaultComboBoxEditor:
Dragengine.Gui.TextField Dragengine.Gui.ComboBoxEditor Dragengine.Gui.TextWidget Dragengine.Gui.Widget Dragengine.Gui.TextModelListener

Public Member Functions

void addActionListener (ActionListener listener)
 Add action listener. More...
 
void addTextActionListener (ActionListener listener)
 Add text widget action listener. More...
 
void dispose ()
 Dispose of widget. More...
 
ComboBox getComboBox ()
 Get parent ComboBox. More...
 
Object getEditorValue ()
 Get editor value. More...
 
Widget getWidget ()
 Get widget to use for editing. More...
 
DefaultComboBoxEditor new ()
 Create default combo box editor. More...
 
DefaultComboBoxEditor new (TextModel model)
 Create default combo box editor. More...
 
DefaultComboBoxEditor new (TextModel model, int displayCharCount)
 Create default combo box editor. More...
 
void removeActionListener (ActionListener listener)
 Remove action listener. More...
 
void removeTextActionListener (ActionListener listener)
 Remove text widget action listener. More...
 
void setEditorValue (Object object)
 Set editor value to object or null to clear. More...
 
void startEditing ()
 Start editing. More...
 
void textChanged (TextModel textModel)
 Text string has changed. More...
 
- Public Member Functions inherited from Dragengine.Gui.TextField
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 (String text)
 Create Text Field. More...
 
TextField new (TextModel model, bool readOnly)
 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...
 
- Public Member Functions inherited from Dragengine.Gui.TextWidget
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 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...
 

Public Attributes

Array pEditorActionListeners
 
- Public Attributes inherited from Dragengine.Gui.TextField
final int noPasswordChar = 0
 Use no password character constant. More...
 
- Public Attributes inherited from Dragengine.Gui.Widget
CanvasCreator pBackgroundCanvasCreator
 
bool pBlockLayoutParent
 
Border pBorder
 
bool pCanFocus
 
CanvasView pCanvasBackground
 
CanvasView pCanvasContent
 
CanvasView pCanvasWidget
 
Clipboard pClipboard
 
WidgetDesigner pDesigner
 
String pDesignerSelector
 
Array pDragListeners
 
bool pEnabled
 
Array pFocusListeners
 
Font pFont
 
FrameUpdater pFrameUpdater
 
Array pGamepadListeners
 
bool pHasBlockedLayoutParent
 
bool pHasFocus
 
bool pIsDesignerSet
 
Array pKeyListeners
 
Point pMinSize
 
Array pMouseListeners
 
MousePointerFactory pMousePointer
 
BorderSize pPadding
 
Container pParent
 
Point pPosition
 
bool pProtectBackgroundCanvasCreator
 
bool pProtectBorder
 
bool pProtectFont
 
bool pProtectMinimumSize
 
bool pProtectMousePointer
 
bool pProtectPadding
 
bool pProtectTextColor
 
RepeatKeyEventTimer pRepeatEventTimer
 
Point pSize
 
Array pStateChangeListeners
 
Color pTextColor
 
GuiTheme pTheme
 
String pThemeSelector
 
String pTitle
 
Object pToolTip
 
TexMatrix2 pTransformation
 
TranslationManager pTranslationManager
 
float pTransparency
 
bool pVisible
 
Array pWidgetListeners
 

Additional Inherited Members

- Protected Member Functions inherited from Dragengine.Gui.TextField
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...
 

Detailed Description

Default implementation of ComboBoxEditor using a TextField.

Uses Object.toString() of the value object as text to edit. Returns A String object if asked for the value.

Supports designing using designer selector "TextField.ComboBoxEditor".

Member Function Documentation

◆ addActionListener()

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

Add action listener.

Action listener is called whenever the edited object changes.

Note
This shadows TextWidget.addActionListener(). To use it use addTextActionListener().

Implements Dragengine.Gui.ComboBoxEditor.

◆ addTextActionListener()

void Dragengine.Gui.DefaultComboBoxEditor.addTextActionListener ( ActionListener  listener)

Add text widget action listener.

Version
1.8
Note
Forwards to shadowed TextWidget.addActionListener().

◆ dispose()

void Dragengine.Gui.DefaultComboBoxEditor.dispose ( )

Dispose of widget.

Reimplemented from Dragengine.Gui.TextWidget.

◆ getComboBox()

ComboBox Dragengine.Gui.DefaultComboBoxEditor.getComboBox ( )

Get parent ComboBox.

Version
1.17

◆ getEditorValue()

Object Dragengine.Gui.DefaultComboBoxEditor.getEditorValue ( )

Get editor value.

The returned object can be the one previously set by setEditorValue() if unchanged or a new object if changed.

Implements Dragengine.Gui.ComboBoxEditor.

◆ getWidget()

Widget Dragengine.Gui.DefaultComboBoxEditor.getWidget ( )

Get widget to use for editing.

Implements Dragengine.Gui.ComboBoxEditor.

◆ new() [1/3]

DefaultComboBoxEditor Dragengine.Gui.DefaultComboBoxEditor.new ( )

Create default combo box editor.

Reimplemented from Dragengine.Gui.TextField.

◆ new() [2/3]

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

Create default combo box editor.

Reimplemented from Dragengine.Gui.TextField.

◆ new() [3/3]

DefaultComboBoxEditor Dragengine.Gui.DefaultComboBoxEditor.new ( TextModel  model,
int  displayCharCount 
)

Create default combo box editor.

Reimplemented from Dragengine.Gui.TextField.

◆ removeActionListener()

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

Remove action listener.

Note
This shadows TextWidget.removeActionListener(). To use it use removeTextActionListener().

Implements Dragengine.Gui.ComboBoxEditor.

◆ removeTextActionListener()

void Dragengine.Gui.DefaultComboBoxEditor.removeTextActionListener ( ActionListener  listener)

Remove text widget action listener.

Version
1.8
Note
Forwards to shadowed TextWidget.removeActionListener().

◆ setEditorValue()

void Dragengine.Gui.DefaultComboBoxEditor.setEditorValue ( Object  object)

Set editor value to object or null to clear.

object is garanteed to not be modified by the editor.

Implements Dragengine.Gui.ComboBoxEditor.

◆ startEditing()

void Dragengine.Gui.DefaultComboBoxEditor.startEditing ( )

Start editing.

Typically this selects the entire text or otherwise prepare editor for directly manipulating the set value. There is no stop editing call since the widget is hidden in this case.

Implements Dragengine.Gui.ComboBoxEditor.

◆ textChanged()

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

Text string has changed.

Reimplemented from Dragengine.Gui.TextField.

Member Data Documentation

◆ pEditorActionListeners

Array Dragengine.Gui.DefaultComboBoxEditor.pEditorActionListeners

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