GTextArea (Javadocs: G4P)

java.lang.Object
- g4p_controls.GAbstractControl
- - g4p_controls.GTextBase
  - - g4p_controls.GEditableTextControl
    - - g4p_controls.GTextArea

All Implemented Interfaces:

Focusable, GConstants, processing.core.PConstants
```
public class GTextArea
extends GEditableTextControl
```
The text area component.
This control allows the user to enter and edit multiple lines of text. The control also allows default text, horizontal and vertical scrollbars.
Enables user to enter text at runtime. Text can be selected using the mouse or keyboard shortcuts and then copied or cut to the clipboard. Text can also be pasted in.
There are some methods to add and clear text attributes to all or some of the text in the control. If a method is expecting a line number, you should specify the actual line number for the entire text (lines numbers start at 0). It is not the line number in the visible display because this can change if the text has been scrolled vertically.
Fires SELECTION_CHANGED, CHANGED, ENTERED, LOST_FOCUS, GETS_FOCUS events.
The focus events are only fired if the control is added to a GTabManager object.

Author:

Peter Lager

Nested Class Summary
- Nested classes/interfaces inherited from class g4p_controls.GAbstractControl
  GAbstractControl.Z_Order

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALL_METHOD`
`static int`	`CLIP_RUN`
`static int`	`COMBI_MODES`
`static java.lang.String`	`DEFAULT_SLIDER_STYLE`
`static int`	`DRAG_CONTROL`
`static int`	`DRAW_METHOD`
`static char`	`EOL`
`static int`	`EXCP_IN_HANDLER`
`static int[][]`	`grid`
`static int`	`GROUP_CONTROL_METHOD`
`static int`	`I_CL`
`static int`	`I_COVERED`
`static int`	`I_CR`
`static int`	`I_INSIDE`
`static int`	`I_MODES`
`static int`	`I_NONE`
`static int`	`I_TL`
`static int`	`I_TR`
`static int`	`INVALID_PAPPLET`
`static int`	`INVALID_TYPE`
`static int`	`KEY_METHOD`
`static int`	`MERGE_RUNS`
`static int`	`MISSING`
`static int`	`MOUSE_METHOD`
`static int`	`NONEXISTANT`
`static int`	`OFF_CONTROL`
`static int`	`OVER_CONTROL`
`static java.awt.BasicStroke`	`pen_1_0`
`static java.awt.BasicStroke`	`pen_2_0`
`static java.awt.BasicStroke`	`pen_3_0`
`static java.awt.BasicStroke`	`pen_4_0`
`static int`	`POST_METHOD`
`static int`	`PRE_METHOD`
`static int`	`PRESS_CONTROL`
`static int`	`SCROLLBAR_HORIZONTAL`
`static int`	`SCROLLBAR_VERTICAL`
`static java.lang.String`	`SLIDER_STYLES`
`static int`	`TINT_FOR_ALPHA`
`static int`	`TPAD2`
`static int`	`TPAD4`
`static int`	`TPAD6`
`static int`	`TPAD8`
`static float`	`WHEEL_DELTA`
`static float`	`WHEEL_STICK_FACTOR`
`static int`	`Z_PANEL`
`static int`	`Z_SLIPPY`
`static int`	`Z_SLIPPY_EXPANDS`
`static int`	`Z_STICKY`

Fields inherited from class g4p_controls.GAbstractControl
tag, tagNo

Fields inherited from interface processing.core.PConstants
ADD, ALPHA, ALT, AMBIENT, ARC, ARGB, ARROW, BACKSPACE, BASELINE, BEVEL, BEZIER_VERTEX, BLEND, BLUR, BOTTOM, BOX, BREAK, BURN, CENTER, CHATTER, CHORD, CLAMP, CLOSE, CODED, COMPLAINT, CONTROL, CORNER, CORNERS, CROSS, CURVE_VERTEX, CUSTOM, DARKEST, DEG_TO_RAD, DELETE, DIAMETER, DIFFERENCE, DILATE, DIRECTIONAL, DISABLE_ASYNC_SAVEFRAME, DISABLE_BUFFER_READING, DISABLE_DEPTH_MASK, DISABLE_DEPTH_SORT, DISABLE_DEPTH_TEST, DISABLE_KEY_REPEAT, DISABLE_NATIVE_FONTS, DISABLE_OPENGL_ERRORS, DISABLE_OPTIMIZED_STROKE, DISABLE_STROKE_PERSPECTIVE, DISABLE_STROKE_PURE, DISABLE_TEXTURE_MIPMAPS, DODGE, DOWN, DXF, ELLIPSE, ENABLE_ASYNC_SAVEFRAME, ENABLE_BUFFER_READING, ENABLE_DEPTH_MASK, ENABLE_DEPTH_SORT, ENABLE_DEPTH_TEST, ENABLE_KEY_REPEAT, ENABLE_NATIVE_FONTS, ENABLE_OPENGL_ERRORS, ENABLE_OPTIMIZED_STROKE, ENABLE_STROKE_PERSPECTIVE, ENABLE_STROKE_PURE, ENABLE_TEXTURE_MIPMAPS, ENTER, EPSILON, ERODE, ESC, EXCLUSION, FX2D, GIF, GRAY, GROUP, HALF_PI, HAND, HARD_LIGHT, HINT_COUNT, HSB, IMAGE, INVERT, JAVA2D, JPEG, LANDSCAPE, LEFT, LIGHTEST, LINE, LINE_LOOP, LINE_STRIP, LINES, LINUX, MACOSX, MAX_FLOAT, MAX_INT, MIN_FLOAT, MIN_INT, MITER, MODEL, MODELVIEW, MOVE, MULTIPLY, NORMAL, OPAQUE, OPEN, OPENGL, ORTHOGRAPHIC, OTHER, OVERLAY, P2D, P3D, PATH, PDF, PERSPECTIVE, PI, PIE, platformNames, POINT, POINTS, POLYGON, PORTRAIT, POSTERIZE, PROBLEM, PROJECT, PROJECTION, QUAD, QUAD_BEZIER_VERTEX, QUAD_STRIP, QUADRATIC_VERTEX, QUADS, QUARTER_PI, RAD_TO_DEG, RADIUS, RECT, REPEAT, REPLACE, RETURN, RGB, RIGHT, ROUND, SCREEN, SHAPE, SHIFT, SOFT_LIGHT, SPAN, SPHERE, SPOT, SQUARE, SUBTRACT, SVG, TAB, TARGA, TAU, TEXT, THIRD_PI, THRESHOLD, TIFF, TOP, TRIANGLE, TRIANGLE_FAN, TRIANGLE_STRIP, TRIANGLES, TWO_PI, UP, VERTEX, WAIT, WHITESPACE, WINDOWS, X, Y, Z

Fields inherited from interface g4p_controls.GConstants
ALPHA_BLOCK, ALPHA_PICK, BACKGROUND, BLUE_SCHEME, CANCEL, CLOSE_WINDOW, CLOSED, CTRL_ANGULAR, CTRL_HORIZONTAL, CTRL_VERTICAL, CYAN_SCHEME, DECIMAL, END, ERROR, EXIT_APP, EXPONENT, FAMILY, FOREGROUND, FORWARD, GOLD_SCHEME, GREEN_SCHEME, HOME, INFO, INTEGER, KEEP_OPEN, NO, OK, OK_CANCEL, ORANGE_SCHEME, ORIENT_LEFT, ORIENT_RIGHT, ORIENT_TRACK, PLAIN, POSTURE, POSTURE_OBLIQUE, POSTURE_REGULAR, PURPLE_SCHEME, QUERY, RED_SCHEME, REVERSE, SCHEME_10, SCHEME_11, SCHEME_12, SCHEME_13, SCHEME_14, SCHEME_15, SCHEME_8, SCHEME_9, SCROLLBARS_AUTOHIDE, SCROLLBARS_BOTH, SCROLLBARS_HORIZONTAL_ONLY, SCROLLBARS_NONE, SCROLLBARS_VERTICAL_ONLY, SIZE, STRIKETHROUGH, STRIKETHROUGH_OFF, STRIKETHROUGH_ON, SUPERSCRIPT, SUPERSCRIPT_OFF, SUPERSCRIPT_SUB, SUPERSCRIPT_SUPER, USER_COL_SCHEME, WARNING, WEIGHT, WEIGHT_BOLD, WEIGHT_DEMIBOLD, WEIGHT_DEMILIGHT, WEIGHT_EXTRA_LIGHT, WEIGHT_EXTRABOLD, WEIGHT_HEAVY, WEIGHT_LIGHT, WEIGHT_MEDIUM, WEIGHT_REGULAR, WEIGHT_SEMIBOLD, WEIGHT_ULTRABOLD, WIDTH, WIDTH_CONDENSED, WIDTH_EXTENDED, WIDTH_REGULAR, WIDTH_SEMI_CONDENSED, WIDTH_SEMI_EXTENDED, X4, X8, YELLOW_SCHEME, YES, YES_NO, YES_NO_CANCEL

Constructor Summary

Constructors
Constructor and Description
`GTextArea(processing.core.PApplet theApplet, float p0, float p1, float p2, float p3)` Create a text area without scrollbars and a text wrap width to fit the control.
`GTextArea(processing.core.PApplet theApplet, float p0, float p1, float p2, float p3, int sbPolicy)` Create a text field with the given scrollbar policy and a text wrap width to fit the control.
`GTextArea(processing.core.PApplet theApplet, float p0, float p1, float p2, float p3, int sbPolicy, int wrapWidth)` Create a text field with the given scrollbar policy with a user specified text wrap length

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addStyle(java.awt.font.TextAttribute attr, java.lang.Object value, int lineNo)` Adds the text attribute to an entire display line.
`void`	`addStyle(java.awt.font.TextAttribute attr, java.lang.Object value, int lineNo, int charStart, int charEnd)` Adds the text attribute to a range of characters on a particular display line.
`boolean`	`appendText(java.lang.String text)` Add text to the end of the current text.
`void`	`clearStyles(int lineNo)` Clears all text attribute from an entire display line.
`void`	`clearStyles(int lineNo, int charStart, int charEnd)` Clears all text attribute from a range of characters on a particular display line.
`void`	`draw()`
`int[]`	`getCaretPos()` Get the current caret position.
`int[]`	`getCaretPos(int[] cpos)` Get the current caret position.
`processing.core.PGraphics`	`getSnapshot()` This method should be used sparingly since it is heavy on resources.
`java.lang.String`	`getText(int lineNo)` Get the text on a particular line in the text area.
`java.lang.String[]`	`getTextAsArray()` Get the text as a String array.
`int`	`getTextLength(int lineNo, boolean ignoreEOL)` Get the length of text on a particular line in the text area.
`boolean`	`insertText(java.lang.String text)` Insert text at the current caret position.
`boolean`	`insertText(java.lang.String text, boolean startWithEOL, boolean endWithEOL)` Insert text at the current caret position.
`boolean`	`insertText(java.lang.String text, int lineNo, int charNo)` Insert text at the display position specified.
`boolean`	`insertText(java.lang.String text, int lineNo, int charNo, boolean startWithEOL, boolean endWithEOL)` Insert text at the display position specified.
`void`	`mouseEvent(processing.event.MouseEvent event)` Will respond to mouse events.
`void`	`moveCaretTo(int lineNo, int charNo)` Move the insertion point (caret) to the specified line and character.
`void`	`pre()`
`void`	`setStyledText(StyledString st)` Set the styled text to be displayed.
`void`	`setText(java.lang.String text)` Set the text to be used.
`void`	`setText(java.lang.String[] lines)` Set the text to display and adjust any scrollbars
`void`	`setText(java.lang.String[] lines, int wrapWidth)` Set the text to display and adjust any scrollbars
`void`	`setText(java.lang.String text, int wrapWidth)` Set the text to display and adjust any scrollbars

Methods inherited from class g4p_controls.GEditableTextControl
addStyle, addStyle, clearSelectionStyle, clearStyles, clearStyles, dispose, flashCaret, getPromptText, getSelectedText, getStyledText, getText, getWrapWidth, hasSelection, hsbEventHandler, isTextEditEnabled, keyEvent, loadText, markForDisposal, saveText, setFocus, setFont, setJustify, setLocalColorScheme, setPromptText, setSelectedTextStyle, setTabManager, setTextEditEnabled, setWrapWidth, vsbEventHandler

Methods inherited from class g4p_controls.GTextBase
forceBufferUpdate, setTextBold, setTextBold, setTextItalic, setTextItalic, setTextPlain

Methods inherited from class g4p_controls.GAbstractControl
addControl, addControl, addControl, addControls, addEventHandler, getCursorOver, getCX, getCY, getHeight, getLocalColorScheme, getPApplet, getParent, getWidth, getX, getY, hasFocus, isDragging, isEnabled, isOpaque, isOver, isVisible, moveTo, moveTo, post, saveSnapshot, saveSnapshot, setAlpha, setAlpha, setCursorOver, setEnabled, setLocalColor, setLocalColorScheme, setOpaque, setRotation, setRotation, setVisible, toString

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SLIDER_STYLES
```
public static final java.lang.String SLIDER_STYLES
```
    See Also:
    Constant Field Values
  - DEFAULT_SLIDER_STYLE
```
public static final java.lang.String DEFAULT_SLIDER_STYLE
```
    See Also:
    Constant Field Values
  - DRAW_METHOD
```
public static final int DRAW_METHOD
```
    See Also:
    Constant Field Values
  - MOUSE_METHOD
```
public static final int MOUSE_METHOD
```
    See Also:
    Constant Field Values
  - PRE_METHOD
```
public static final int PRE_METHOD
```
    See Also:
    Constant Field Values
  - KEY_METHOD
```
public static final int KEY_METHOD
```
    See Also:
    Constant Field Values
  - POST_METHOD
```
public static final int POST_METHOD
```
    See Also:
    Constant Field Values
  - ALL_METHOD
```
public static final int ALL_METHOD
```
    See Also:
    Constant Field Values
  - GROUP_CONTROL_METHOD
```
public static final int GROUP_CONTROL_METHOD
```
    See Also:
    Constant Field Values
  - MISSING
```
public static final int MISSING
```
    See Also:
    Constant Field Values
  - NONEXISTANT
```
public static final int NONEXISTANT
```
    See Also:
    Constant Field Values
  - INVALID_TYPE
```
public static final int INVALID_TYPE
```
    See Also:
    Constant Field Values
  - INVALID_PAPPLET
```
public static final int INVALID_PAPPLET
```
    See Also:
    Constant Field Values
  - EXCP_IN_HANDLER
```
public static final int EXCP_IN_HANDLER
```
    See Also:
    Constant Field Values
  - OFF_CONTROL
```
public static final int OFF_CONTROL
```
    See Also:
    Constant Field Values
  - OVER_CONTROL
```
public static final int OVER_CONTROL
```
    See Also:
    Constant Field Values
  - PRESS_CONTROL
```
public static final int PRESS_CONTROL
```
    See Also:
    Constant Field Values
  - DRAG_CONTROL
```
public static final int DRAG_CONTROL
```
    See Also:
    Constant Field Values
  - TINT_FOR_ALPHA
```
public static final int TINT_FOR_ALPHA
```
    See Also:
    Constant Field Values
  - I_NONE
```
public static final int I_NONE
```
    See Also:
    Constant Field Values
  - I_TL
```
public static final int I_TL
```
    See Also:
    Constant Field Values
  - I_TR
```
public static final int I_TR
```
    See Also:
    Constant Field Values
  - I_CL
```
public static final int I_CL
```
    See Also:
    Constant Field Values
  - I_CR
```
public static final int I_CR
```
    See Also:
    Constant Field Values
  - I_INSIDE
```
public static final int I_INSIDE
```
    See Also:
    Constant Field Values
  - I_COVERED
```
public static final int I_COVERED
```
    See Also:
    Constant Field Values
  - I_MODES
```
public static final int I_MODES
```
    See Also:
    Constant Field Values
  - MERGE_RUNS
```
public static final int MERGE_RUNS
```
    See Also:
    Constant Field Values
  - CLIP_RUN
```
public static final int CLIP_RUN
```
    See Also:
    Constant Field Values
  - COMBI_MODES
```
public static final int COMBI_MODES
```
    See Also:
    Constant Field Values
  - grid
```
public static final int[][] grid
```
  - pen_1_0
```
public static final java.awt.BasicStroke pen_1_0
```
  - pen_2_0
```
public static final java.awt.BasicStroke pen_2_0
```
  - pen_3_0
```
public static final java.awt.BasicStroke pen_3_0
```
  - pen_4_0
```
public static final java.awt.BasicStroke pen_4_0
```
  - TPAD2
```
public static final int TPAD2
```
    See Also:
    Constant Field Values
  - TPAD4
```
public static final int TPAD4
```
    See Also:
    Constant Field Values
  - TPAD6
```
public static final int TPAD6
```
    See Also:
    Constant Field Values
  - TPAD8
```
public static final int TPAD8
```
    See Also:
    Constant Field Values
  - SCROLLBAR_VERTICAL
```
public static final int SCROLLBAR_VERTICAL
```
    See Also:
    Constant Field Values
  - SCROLLBAR_HORIZONTAL
```
public static final int SCROLLBAR_HORIZONTAL
```
    See Also:
    Constant Field Values
  - WHEEL_DELTA
```
public static final float WHEEL_DELTA
```
    See Also:
    Constant Field Values
  - WHEEL_STICK_FACTOR
```
public static final float WHEEL_STICK_FACTOR
```
    See Also:
    Constant Field Values
  - EOL
```
public static final char EOL
```
    See Also:
    Constant Field Values
  - Z_STICKY
```
public static final int Z_STICKY
```
    See Also:
    Constant Field Values
  - Z_SLIPPY
```
public static final int Z_SLIPPY
```
    See Also:
    Constant Field Values
  - Z_SLIPPY_EXPANDS
```
public static final int Z_SLIPPY_EXPANDS
```
    See Also:
    Constant Field Values
  - Z_PANEL
```
public static final int Z_PANEL
```
    See Also:
    Constant Field Values
- Constructor Detail
  - GTextArea
```
public GTextArea(processing.core.PApplet theApplet,
         float p0,
         float p1,
         float p2,
         float p3)
```
    Create a text area without scrollbars and a text wrap width to fit the control.
    
    Parameters:
    theApplet -
    p0 -
    p1 -
    p2 -
    p3 -
  - GTextArea
```
public GTextArea(processing.core.PApplet theApplet,
         float p0,
         float p1,
         float p2,
         float p3,
         int sbPolicy)
```
    Create a text field with the given scrollbar policy and a text wrap width to fit the control.
    The scrollbar policy can be one of these
    - SCROLLBARS_NONE
    - SCROLLBARS_HORIZONTAL_ONLY
    - SCROLLBARS_VERTICAL_ONLY
    - SCROLLBARS_BOTH
    If you want the scrollbar to auto hide then perform a logical or with
    - SCROLLBARS_AUTOHIDE
    e.g. SCROLLBARS_BOTH | SCROLLBARS_AUTOHIDE
    Parameters:
    theApplet -
    p0 -
    p1 -
    p2 -
    p3 -
    sbPolicy -
  - GTextArea
```
public GTextArea(processing.core.PApplet theApplet,
         float p0,
         float p1,
         float p2,
         float p3,
         int sbPolicy,
         int wrapWidth)
```
    Create a text field with the given scrollbar policy with a user specified text wrap length
    
    Parameters:
    theApplet -
    p0 -
    p1 -
    p2 -
    p3 -
    sbPolicy -
    wrapWidth -
- Method Detail
  - setText
```
public void setText(java.lang.String text,
           int wrapWidth)
```
    Set the text to display and adjust any scrollbars
    
    Parameters:
    text - text to display
    wrapWidth - the wrap width
  - setText
```
public void setText(java.lang.String text)
```
    Set the text to be used. The wrap width is determined by the current text wrapwidth or if there is no text then the text width of the control.
    
    Overrides:
    
    setText in class GTextBase
    
    Parameters:
    text - to be displayed
  - setText
```
public void setText(java.lang.String[] lines)
```
    Set the text to display and adjust any scrollbars
    
    Parameters:
    lines - an array of Strings representing the text to display
  - setText
```
public void setText(java.lang.String[] lines,
           int wrapWidth)
```
    Set the text to display and adjust any scrollbars
    
    Parameters:
    lines - an array of Strings representing the text to display
    wrapWidth - the wrap width
  - getTextAsArray
```
public java.lang.String[] getTextAsArray()
```
    Get the text as a String array. (splitting on line breaks).
    
    Returns:
    the associated plain text as a String array split on line breaks
  - addStyle
```
public void addStyle(java.awt.font.TextAttribute attr,
            java.lang.Object value,
            int lineNo,
            int charStart,
            int charEnd)
```
    Adds the text attribute to a range of characters on a particular display line. If charEnd is past the EOL then the attribute will be applied to the end-of-line.
    
    Parameters:
    attr - the text attribute to add
    value - value of the text attribute
    lineNo - the display line number (starts at 0)
    charStart - the position of the first character to apply the attribute
    charEnd - the position after the last character to apply the attribute
  - addStyle
```
public void addStyle(java.awt.font.TextAttribute attr,
            java.lang.Object value,
            int lineNo)
```
    Adds the text attribute to an entire display line.
    
    Parameters:
    attr - the text attribute to add
    value - value of the text attribute
    lineNo - the display line number (starts at 0)
  - clearStyles
```
public void clearStyles(int lineNo,
               int charStart,
               int charEnd)
```
    Clears all text attribute from a range of characters on a particular display line. If charEnd is past the EOL then the attributes will be cleared to the end-of-line.
    
    Parameters:
    lineNo - the display line number (starts at 0)
    charStart - the position of the first character to apply the attribute
    charEnd - the position after the last character to apply the attribute
  - clearStyles
```
public void clearStyles(int lineNo)
```
    Clears all text attribute from an entire display line.
    
    Parameters:
    lineNo - the display line number (starts at 0)
  - setStyledText
```
public void setStyledText(StyledString st)
```
    Set the styled text to be displayed.
    
    Overrides:
    
    setStyledText in class GTextBase
  - appendText
```
public boolean appendText(java.lang.String text)
```
    Add text to the end of the current text. This is useful for a logging' type activity.
    No events will be generated and the caret will be moved to the end of any appended text.
    
    Parameters:
    text - the text to append
    
    Returns:
    true if some characters were added
  - insertText
```
public boolean insertText(java.lang.String text,
                 int lineNo,
                 int charNo)
```
    Insert text at the display position specified.
    The area line number starts at 0 and includes any lines scrolled off the top. So if three lines have been scrolled off the top the first visible line is number 3.
    No events will be generated and the caret will be moved to the end of any inserted text.
    
    Parameters:
    text - the text to insert
    lineNo - the area line number
    charNo - the character position to insert text in display line
    
    Returns:
    true if some characters were inserted
  - insertText
```
public boolean insertText(java.lang.String text,
                 int lineNo,
                 int charNo,
                 boolean startWithEOL,
                 boolean endWithEOL)
```
    Insert text at the display position specified.
    The area line number starts at 0 and includes any lines scrolled off the top. So if three lines have been scrolled off the top the first visible line is number 3.
    No events will be generated and the caret will be moved to the end of any inserted text.
    
    Parameters:
    text - the text to insert
    lineNo - the area line number
    charNo - the character position to insert text in display line
    startWithEOL - if true,inserted text will start on newline
    endWithEOL - if true, text after inserted text will start on new line
    
    Returns:
    true if some characters were inserted
  - insertText
```
public boolean insertText(java.lang.String text,
                 boolean startWithEOL,
                 boolean endWithEOL)
```
    Insert text at the current caret position. If the current caret position is undefined the text will be inserted at the beginning of the text.
    No events will be generated and the caret will be moved to the end of any inserted text.
    
    Parameters:
    text - the text to insert
    startWithEOL - if true,inserted text will start on newline
    endWithEOL - if true, text after inserted text will start on new line
    
    Returns:
    true if some characters were inserted
  - insertText
```
public boolean insertText(java.lang.String text)
```
    Insert text at the current caret position. If the current caret position is undefined the text will be inserted at the beginning of the text.
    No events will be generated and the caret will be moved to the end of any inserted text.
    
    Parameters:
    text - the text to insert
    
    Returns:
    true if some characters were inserted
  - getText
```
public java.lang.String getText(int lineNo)
```
    Get the text on a particular line in the text area.
    The line does not need to be visible and the line numbers always start at 0.
    The result is not dependent on what is visible at any particular time but on the overall position in text area control.
    If the line number is invalid then an empty string is returned.
    Trailing EOL characters are removed.
    
    Parameters:
    lineNo - the text area line number we want
    
    Returns:
    the plain text in a display line
  - getTextLength
```
public int getTextLength(int lineNo,
                boolean ignoreEOL)
```
    Get the length of text on a particular line in the text area.
    The line does not need to be visible and the line numbers always start at 0.
    The result is not dependent on what is visible at any particular time but on the overall position in text area control.
    If ignoreEOL is true then EOL characters are not included in the count.
    
    Parameters:
    lineNo - the text area line number we want
    ignoreEOL - if true do not include trailing end=of-line characters
    
    Returns:
    the length of the line, or <) if the line number is invalid
  - pre
```
public void pre()
```
    Overrides:
    
    pre in class GAbstractControl
  - draw
```
public void draw()
```
    Overrides:
    
    draw in class GAbstractControl
  - getSnapshot
```
public processing.core.PGraphics getSnapshot()
```
    Description copied from class: GAbstractControl
    
    This method should be used sparingly since it is heavy on resources.
    
    Overrides:
    
    getSnapshot in class GAbstractControl
    
    Returns:
    a PGraphics object showing current state of the control (ignoring rotation)
  - moveCaretTo
```
public void moveCaretTo(int lineNo,
               int charNo)
```
    Move the insertion point (caret) to the specified line and character. If the position is invalid then the caret is not moved. The text will be scrolled so that the caret position is visible.
    
    Parameters:
    lineNo - the line number (starts at 0)
    charNo - the character position on the line (starts at 0)
  - getCaretPos
```
public int[] getCaretPos()
```
    Get the current caret position.
    The method will always return a 2 element array with the current caret position { line no, char no }
    If the current caret position is undefined then it will return the array { -1, -1 }
    
    Returns:
    a two element int array holding the caret position.
  - getCaretPos
```
public int[] getCaretPos(int[] cpos)
```
    Get the current caret position.
    If the parameter is a 2 element int array then it will be populated with the line number [0] and character no [1] of the caret's current position.
    The method will always return a 2 element array with the current caret position { line no, char no }
    If the current caret position is undefined then it will return the array { -1, -1 }
    
    Parameters:
    cpos - array to be populated with caret position
    
    Returns:
    a two element int array holding the caret position.
  - mouseEvent
```
public void mouseEvent(processing.event.MouseEvent event)
```
    Will respond to mouse events.
    
    Overrides:
    
    mouseEvent in class GAbstractControl

Class GTextArea

Nested Class Summary

Nested classes/interfaces inherited from class g4p_controls.GAbstractControl

Field Summary

Fields inherited from class g4p_controls.GAbstractControl

Fields inherited from interface processing.core.PConstants

Fields inherited from interface g4p_controls.GConstants

Constructor Summary

Method Summary

Methods inherited from class g4p_controls.GEditableTextControl

Methods inherited from class g4p_controls.GTextBase

Methods inherited from class g4p_controls.GAbstractControl

Methods inherited from class java.lang.Object

Field Detail

SLIDER_STYLES

DEFAULT_SLIDER_STYLE

DRAW_METHOD

MOUSE_METHOD

PRE_METHOD

KEY_METHOD

POST_METHOD

ALL_METHOD

GROUP_CONTROL_METHOD

MISSING

NONEXISTANT

INVALID_TYPE

INVALID_PAPPLET

EXCP_IN_HANDLER

OFF_CONTROL

OVER_CONTROL

PRESS_CONTROL

DRAG_CONTROL

TINT_FOR_ALPHA

I_NONE

I_TL

I_TR

I_CL

I_CR

I_INSIDE

I_COVERED

I_MODES

MERGE_RUNS

CLIP_RUN

COMBI_MODES

grid

pen_1_0

pen_2_0

pen_3_0

pen_4_0

TPAD2

TPAD4

TPAD6

TPAD8

SCROLLBAR_VERTICAL

SCROLLBAR_HORIZONTAL

WHEEL_DELTA

WHEEL_STICK_FACTOR

EOL

Z_STICKY

Z_SLIPPY

Z_SLIPPY_EXPANDS

Z_PANEL

Constructor Detail

GTextArea

GTextArea

GTextArea

Method Detail

setText

setText

setText

setText

getTextAsArray

addStyle

addStyle

clearStyles

clearStyles

setStyledText

appendText

insertText

insertText