Drag[en]gine Script Module DragonScript Script API  1.0
TextField Class Reference
Inheritance diagram for TextField:
Widget TextModelNotifier ConsoleInputField DefaultComboBoxEditor IntegerTextField

Public Member Functions

void design ()
 Design text field using TextFieldDesigner. More...
 
void dispose ()
 
void ensureCursorVisible ()
 
int getCursorPosition ()
 
TextFieldDesigner getDesigner ()
 Text field designer. More...
 
int getDisplayCharCount ()
 
int getFirstCharacter ()
 
Point getMinimumSize ()
 
TextModel getModel ()
 
BorderSize getPadding ()
 
int getPasswordChar ()
 
bool getReadOnly ()
 
bool isDesignerSet ()
 Designer is set manually. More...
 
bool isValid (String text)
 
TextField new ()
 
TextField new (String text)
 
TextField new (TextModel model)
 
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 onMouseEnter (MouseEvent event)
 
void onMouseLeave (MouseEvent event)
 
void onResize (WidgetEvent event)
 Size changed. More...
 
void onSetFont ()
 
void onSetForegroundColor ()
 
void onStateChanged (StateChangeEvent event)
 State changed. More...
 
void setCursorPosition (int position)
 
void setDesigner (TextFieldDesigner designer)
 Set text field designer. More...
 
void setDisplayCharCount (int count)
 
void setModel (TextModel model)
 
void setPadding (BorderSize padding)
 
void setPasswordChar (int passwordChar)
 
void setReadOnly (bool readOnly)
 
void textChanged (TextModel textModel)
 
- Public Member Functions inherited from Widget
void addDragListener (DragListener listener)
 
void addFocusListener (FocusListener listener)
 Add focus 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 dispose ()
 
Widget findFocusableWidget ()
 
Widget findLastFocusableWidget ()
 
CanvasCreator getBackgroundCanvasCreator ()
 Background canvas creator or null to use background color. More...
 
Color getBackgroundColor ()
 
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 ()
 
ColorMatrix getColorTransformation ()
 Color transformation. More...
 
Desktop getDesktop ()
 
Point getDesktopPosition ()
 Widget position in desktop coordinates. More...
 
bool getEnabled ()
 
MousePointer getFirstMousePointer ()
 
Font getFont ()
 
Color getForegroundColor ()
 
GuiTheme getGuiTheme ()
 
bool getHasFocus ()
 
int getHeight ()
 Height of widget. More...
 
RangeModel getHorizontalRangeModel ()
 Horizontal range model for viewports to synchronize the horizontal scrollbar. More...
 
Point getMinimumSize ()
 
Point getMinimumSizeForHeight (int height)
 Minimum size of widget using reference widget height and variable width. More...
 
Point getMinimumSizeForHeightWithBorder (int height)
 Minimum size of widget with border 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 getMinimumSizeForWidthWithBorder (int width)
 Minimum size of widget with border using reference widget width and variable height. More...
 
Point getMinimumSizeWithBorder ()
 
MousePointer getMousePointer ()
 
Container getParent ()
 
Point getPosition ()
 Position of the widget. 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...
 
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 isBackgroundColorSet ()
 
bool isFontSet ()
 
bool isForegroundColorSet ()
 
bool isGuiThemeSet ()
 
bool isMinimumSizeSet ()
 
bool isMouseInside ()
 Mouse is hovering over this widget. More...
 
bool isPointInside (Point position)
 
bool isTransformationSet ()
 
void layoutParent ()
 
Widget new ()
 
Widget new (int x, int y, int width, int height)
 
Widget nextFocusWidget ()
 Find next widget in the focus cycle that can grab the focus. More...
 
void notifyBorderParametersChanged ()
 
void onButtonPress (MouseEvent event)
 
void onButtonRelease (MouseEvent event)
 
void onDispose (WidgetEvent event)
 Window is disposing. More...
 
void onDragDrop (DragEvent event)
 
void onDragEnter (DragEvent event)
 
void onDragLeave (DragEvent event)
 
void onDragOver (DragEvent event)
 
void onFocusLost (FocusEvent event)
 Widget lost focus. More...
 
void onFocusReceived (FocusEvent event)
 Widget received focus. More...
 
void onGuiThemeChanged ()
 
void onHidden (WidgetEvent event)
 Widget has been hidden. More...
 
void onKeyPress (KeyEvent event)
 
void onKeyRelease (KeyEvent event)
 
void onKeyType (KeyEvent event)
 
void onMouseEnter (MouseEvent event)
 
void onMouseLeave (MouseEvent event)
 
void onMouseMove (MouseEvent event)
 
void onReposition (WidgetEvent event)
 Position changed. More...
 
void onResize (WidgetEvent event)
 Size changed. More...
 
void onSetBackgroundColor ()
 
void onSetFont ()
 
void onSetForegroundColor ()
 
void onShown (WidgetEvent event)
 Widget has been shown. More...
 
void onStateChanged (StateChangeEvent event)
 State changed. 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 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 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 setBackgroundColor (Color color)
 
void setBorder (Border border)
 
void setCanFocus (bool canFocus)
 
void setColorTransformation (ColorMatrix transformation)
 Set color transformation. More...
 
void setEnabled (bool enabled)
 
void setFont (Font font)
 
void setForegroundColor (Color color)
 
void setGuiTheme (GuiTheme theme)
 
void setHasFocus (bool hasFocus)
 
void setHeight (int height)
 Set height of widget. More...
 
void setMinimumSize (Point size)
 
void setMousePointer (MousePointer mousePointer)
 
void setParent (Container parent)
 
void setPosition (Point position)
 Set position of widget. More...
 
void setSize (Point size)
 Set size of widget. 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 stopRepeatEventTimer ()
 
void updateCanvasBackground ()
 Update background canvas content. More...
 

Public Attributes

final int NO_PASSWORD_CHAR = 0hffff
 

Protected Member Functions

void checkCursor ()
 

Detailed Description

Text Field Widget. Displays an edit field where the user can enter a short one line text.

Author
Roland Pl├╝ss
Version
1.0

Member Function Documentation

§ checkCursor()

void checkCursor ( )
protected

Checks that the cursor is inside the text boundaries and adjust it if necessary.

§ design()

void design ( )

Design text field using TextFieldDesigner.

§ dispose()

void dispose ( )

Disposes of this widget.

§ ensureCursorVisible()

void ensureCursorVisible ( )

Ensure that the cursor is visible by scrolling the text if necessary.

§ getCursorPosition()

int getCursorPosition ( )

Retrieves the current position of the cursor.

§ getDesigner()

TextFieldDesigner getDesigner ( )

Text field designer.

§ getDisplayCharCount()

int getDisplayCharCount ( )

Retrieves the number of characters the edit field has to be able to display.

§ getFirstCharacter()

int getFirstCharacter ( )

Retrieves the index of the first character visible.

§ getMinimumSize()

Point getMinimumSize ( )

Retrieve the minimal size of widget.

§ getModel()

TextModel getModel ( )

Retrieves the text model.

§ getPadding()

BorderSize getPadding ( )

Retrieves the padding of the text.

§ getPasswordChar()

int getPasswordChar ( )

Retrieves the password character to obfuscate passwords.

§ getReadOnly()

bool getReadOnly ( )

Determines if the text is read only.

§ isDesignerSet()

bool isDesignerSet ( )

Designer is set manually.

§ isValid()

bool isValid ( String  text)

Determines if the new text is valid.

§ new() [1/3]

TextField new ( )

Creates a new Text Field.

§ new() [2/3]

TextField new ( String  text)

Creates a new Text Field.

§ new() [3/3]

TextField new ( TextModel  model)

Creates a new Text Field.

§ onFocusLost()

void onFocusLost ( FocusEvent  event)

Widget lost focus.

§ onFocusReceived()

void onFocusReceived ( FocusEvent  event)

Widget received focus.

§ onGuiThemeChanged()

void onGuiThemeChanged ( )

Notification that the gui theme changed.

§ onKeyPress()

void onKeyPress ( KeyEvent  event)

Key pressed event.

§ onKeyType()

void onKeyType ( KeyEvent  event)

Key released event. Key typed event.

§ onMouseEnter()

void onMouseEnter ( MouseEvent  event)

Notification that the mouse entered the widget. The default behaviour is to send the message to all registered listeners or propagate it back to the parent if allowed.

§ onMouseLeave()

void onMouseLeave ( MouseEvent  event)

Notification that the mouse left the widget. The default behaviour is to send the message to all registered listeners or propagate it back to the parent if allowed.

§ onResize()

void onResize ( WidgetEvent  event)

Size changed.

§ onSetFont()

void onSetFont ( )

Notification that the widget font changed.

§ onSetForegroundColor()

void onSetForegroundColor ( )

Foreground color changed.

§ onStateChanged()

void onStateChanged ( StateChangeEvent  event)

State changed.

Sends event to listeners.

§ setCursorPosition()

void setCursorPosition ( int  position)

Sets the current cursor position. If the cursor is outside the visible area the text is shifted to make the cursor visible

§ setDesigner()

void setDesigner ( TextFieldDesigner  designer)

Set text field designer.

§ setDisplayCharCount()

void setDisplayCharCount ( int  count)

Sets the number of characters the edit field has to be able to display.

§ setModel()

void setModel ( TextModel  model)

Sets the text model.

§ setPadding()

void setPadding ( BorderSize  padding)

Sets the padding of the text.

§ setPasswordChar()

void setPasswordChar ( int  passwordChar)

Sets password character to obfuscate passwords. use NO_PASSWORD_CHAR to disable obfuscation of passwords.

§ setReadOnly()

void setReadOnly ( bool  readOnly)

Sets if the text is read only.

§ textChanged()

void textChanged ( TextModel  textModel)

Send if the text string has changed.

Implements TextModelNotifier.

Member Data Documentation

§ NO_PASSWORD_CHAR

final int NO_PASSWORD_CHAR = 0hffff

Use no password character constant


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