Drag[en]gine Script Module DragonScript Script API  1.0
TextArea Class Reference
Inheritance diagram for TextArea:
Widget TextModelNotifier RangeModelNotifier

Public Member Functions

void deleteSelectedText ()
 
void design ()
 Design text area using TextFieldDesigner. More...
 
void dispose ()
 
void ensureCursorVisible ()
 
int getCursorLine ()
 
int getCursorLineCharCount ()
 
int getCursorLineFor (int pos)
 
int getCursorPosition ()
 
TextAreaDesigner getDesigner ()
 Text area designer. More...
 
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...
 
TextModel getModel ()
 
BorderSize getPadding ()
 Padding. More...
 
bool getReadOnly ()
 
Point getSelection ()
 
Point getTextSize ()
 
RangeModel getVerticalRangeModel ()
 
bool isDesignerSet ()
 Designer is set manually. More...
 
TextArea new ()
 
TextArea new (String text)
 
TextArea new (TextModel textModel)
 
void onButtonPress (MouseEvent event)
 
void onButtonRelease (MouseEvent event)
 
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 onMouseMove (MouseEvent event)
 
void onResize (WidgetEvent event)
 Size changed. More...
 
void onSetFont ()
 
void onSetForegroundColor ()
 
void onStateChanged (StateChangeEvent event)
 State changed. More...
 
void rangeChanged (RangeModel rangeModel)
 
void setCursorPosition (int pos)
 
void setCursorPositionEnd ()
 
void setCursorPositionStart ()
 
void setDesigner (TextAreaDesigner designer)
 Set text area designer. More...
 
void setMaximalWidth (int width)
 
void setModel (TextModel model)
 
void setPadding (BorderSize padding)
 Set padding. More...
 
void setReadOnly (bool readOnly)
 
void setSelection (Point selection)
 
void setSelectionAll ()
 
void textChanged (TextModel textModel)
 
void valueChanged (RangeModel rangeModel)
 
- 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...
 

Protected Member Functions

int bestCharNear (int line, int refXPos)
 
int bestLineNear (int refYPos)
 
void checkBoundaries ()
 
Point getCaret ()
 
Point getOffsetToCursor ()
 
int getRefXPos ()
 
Point getSelectionXOffsets ()
 
void updateRangeModels ()
 
void updateTextLayout ()
 

Detailed Description

Displays an edit field where the user can enter a text with more than one line.

Author
Roland Pl├╝ss
Version
1.0

Member Function Documentation

§ bestCharNear()

int bestCharNear ( int  line,
int  refXPos 
)
protected

Retrieves the index of the best character on line in respect to the reference x position.

§ bestLineNear()

int bestLineNear ( int  refYPos)
protected

Finds best line in reference to a given y position.

§ checkBoundaries()

void checkBoundaries ( )
protected

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

§ deleteSelectedText()

void deleteSelectedText ( )

Deletes the selected text if present.

§ design()

void design ( )

Design text area using TextFieldDesigner.

§ dispose()

void dispose ( )

Dispose of this widget.

§ ensureCursorVisible()

void ensureCursorVisible ( )

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

§ getCaret()

Point getCaret ( )
protected

Retrieves the caret position.

§ getCursorLine()

int getCursorLine ( )

Retrieves the line the cursor is on.

§ getCursorLineCharCount()

int getCursorLineCharCount ( )

Retrieves the number of characters on the current line.

§ getCursorLineFor()

int getCursorLineFor ( int  pos)

Retrieves the line for a spefici cursor position.

§ getCursorPosition()

int getCursorPosition ( )

Retrieves the current position of the cursor in the text.

§ getDesigner()

TextAreaDesigner getDesigner ( )

Text area designer.

§ getFirstLine()

int getFirstLine ( )

Retrieves the index of the first line visible.

§ getHorizontalRangeModel()

RangeModel 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.

§ getLineCount()

int getLineCount ( )

Retrieves the number of text lines.

§ getMaximalWidth()

int getMaximalWidth ( )

Retrieve maximal width of text before break occurs.

§ getMinimumSize()

Point getMinimumSize ( )

Retrieve the minimal size of widget.

§ getMinimumSizeForWidth()

Point getMinimumSizeForWidth ( int  width)

Minimum size of widget using reference widget width and variable height.

Default implementation uses getMinimumSize().

§ getModel()

TextModel getModel ( )

Retrieves the text model.

§ getOffsetToCursor()

Point getOffsetToCursor ( )
protected

Calculates the offset to cursor.

§ getPadding()

BorderSize getPadding ( )

Padding.

§ getReadOnly()

bool getReadOnly ( )

Determines if the text is read only.

§ getRefXPos()

int getRefXPos ( )
protected

Retrieves the reference x position.

§ getSelection()

Point getSelection ( )

Retrieves the selection if present.

§ getSelectionXOffsets()

Point getSelectionXOffsets ( )
protected

Retrieves the selection x offsets.

§ getTextSize()

Point getTextSize ( )

Calculates the size of the content text.

§ getVerticalRangeModel()

RangeModel 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.

§ isDesignerSet()

bool isDesignerSet ( )

Designer is set manually.

§ new() [1/3]

TextArea new ( )

Creates a new Text Area.

§ new() [2/3]

TextArea new ( String  text)

Creates a new Text Field.

§ new() [3/3]

TextArea new ( TextModel  textModel)

Creates a new Text Field.

§ onButtonPress()

void onButtonPress ( MouseEvent  event)

Notification that a mouse button has been pressed.

§ onButtonRelease()

void onButtonRelease ( MouseEvent  event)

Notification that a mouse button has been released.

§ 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.

§ onMouseMove()

void onMouseMove ( MouseEvent  event)

Notification that the mouse has moved.

§ onResize()

void onResize ( WidgetEvent  event)

Size changed.

§ onSetFont()

void onSetFont ( )

Notify about font change.

§ onSetForegroundColor()

void onSetForegroundColor ( )

Foreground color changed.

§ onStateChanged()

void onStateChanged ( StateChangeEvent  event)

State changed.

Sends event to listeners.

§ rangeChanged()

void rangeChanged ( RangeModel  rangeModel)

Send if the outer range properties like minimum value, maximum value or page size has changed.

Implements RangeModelNotifier.

§ setCursorPosition()

void 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.

§ setCursorPositionEnd()

void setCursorPositionEnd ( )

Sets the cursor position to the end of the text.

§ setCursorPositionStart()

void setCursorPositionStart ( )

Sets the cursor position to the start of the text.

§ setDesigner()

void setDesigner ( TextAreaDesigner  designer)

Set text area designer.

§ setMaximalWidth()

void setMaximalWidth ( int  width)

Sets maximal width of text before break occurs.

§ setModel()

void setModel ( TextModel  model)

Sets the text model.

§ setPadding()

void setPadding ( BorderSize  padding)

Set padding.

§ setReadOnly()

void setReadOnly ( bool  readOnly)

Sets if the text is read only.

§ setSelection()

void setSelection ( Point  selection)

Sets the selection or clears it.

§ setSelectionAll()

void setSelectionAll ( )

Sets the selection to the entire text.

§ textChanged()

void textChanged ( TextModel  textModel)

Send if the text string has changed. Implementation of TextModle interface.

Implements TextModelNotifier.

§ updateRangeModels()

void updateRangeModels ( )
protected

Update range models.

§ updateTextLayout()

void updateTextLayout ( )
protected

Updates the text layout for the label.

§ valueChanged()

void valueChanged ( RangeModel  rangeModel)

Send if the value has changed.

Implements RangeModelNotifier.


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