GEditableTextControl (Javadocs: G4P)

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

All Implemented Interfaces:

Focusable, GConstants, processing.core.PConstants

Direct Known Subclasses:

GTextArea, GTextField
```
public abstract class GEditableTextControl
extends GTextBase
implements Focusable
```
This class is the basis for the GTextField and GTextArea classes.

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
`GEditableTextControl(processing.core.PApplet theApplet, float p0, float p1, float p2, float p3, int scrollbars)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addStyle(java.awt.font.TextAttribute attr, java.lang.Object value)` Adds the text attribute to a range of characters on a particular line.
`void`	`addStyle(java.awt.font.TextAttribute attr, java.lang.Object value, int charStart, int charEnd)` Adds the text attribute to a range of characters on a particular line.
`void`	`clearSelectionStyle()` Clear any styles applied to the selected text.
`void`	`clearStyles()` Clear all styles from the entire text.
`void`	`clearStyles(int charStart, int charEnd)` Clears all text attribute from a range of characters starting at position charStart and ending with the character preceding charEnd.
`void`	`dispose()` Remove from its tab manager before disposing.
`void`	`flashCaret(GTimer timer)` Do not call this directly.
`java.lang.String`	`getPromptText()` Get the prompt text used in this control.
`java.lang.String`	`getSelectedText()` Get the text that has been selected (highlighted) by the user.
`StyledString`	`getStyledText()` Get the styled text in the control
`java.lang.String`	`getText()` Get the text in the control
`int`	`getWrapWidth()`
`boolean`	`hasSelection()` Find out if some text is selected (highlighted)
`void`	`hsbEventHandler(g4p_controls.GScrollbar scrollbar, GEvent event)` Do not call this method directly, G4P uses it to handle input from the horizontal scrollbar.
`boolean`	`isTextEditEnabled()` Is this control keyboard enabled
`void`	`keyEvent(processing.event.KeyEvent e)`
`boolean`	`loadText(java.lang.String fname)` Load the styled string to be used by this control.
`void`	`markForDisposal()` Permanently dispose of this control.
`boolean`	`saveText(java.lang.String fname)` Save the styled text used by this control to file.
`void`	`setFocus(boolean focus)` Determines whether this component is to have focus or not.
`void`	`setFont(java.awt.Font font)` Set the font for this control.
`void`	`setJustify(boolean justify)`
`void`	`setLocalColorScheme(int cs)` Sets the local colour scheme for this control
`void`	`setPromptText(java.lang.String ptext)` Set the prompt text for this control.
`void`	`setSelectedTextStyle(java.awt.font.TextAttribute style, java.lang.Object value)` If some text has been selected then set the style.
`void`	`setTabManager(GTabManager tm)`
`void`	`setTextEditEnabled(boolean enableTextEdit)` Determines whether the text can be edited using the keyboard or mouse.
`void`	`setWrapWidth(int wrapWidth)`
`void`	`vsbEventHandler(g4p_controls.GScrollbar scrollbar, GEvent event)` Do not call this method directly, G4P uses it to handle input from the vertical scrollbar.

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

Methods inherited from class g4p_controls.GAbstractControl
addControl, addControl, addControl, addControls, addEventHandler, draw, getCursorOver, getCX, getCY, getHeight, getLocalColorScheme, getPApplet, getParent, getSnapshot, getWidth, getX, getY, hasFocus, isDragging, isEnabled, isOpaque, isOver, isVisible, mouseEvent, moveTo, moveTo, post, pre, 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
  - GEditableTextControl
```
public GEditableTextControl(processing.core.PApplet theApplet,
                    float p0,
                    float p1,
                    float p2,
                    float p3,
                    int scrollbars)
```
- Method Detail
  - setTabManager
```
public void setTabManager(GTabManager tm)
```
    Specified by:
    
    setTabManager in interface Focusable
  - setFocus
```
public void setFocus(boolean focus)
```
    Determines whether this component is to have focus or not.
    
    Overrides:
    
    setFocus in class GAbstractControl
  - setPromptText
```
public void setPromptText(java.lang.String ptext)
```
    Set the prompt text for this control. When the text control is empty the prompt text (italic) is displayed instead. .
    
    Parameters:
    ptext - prompt text
  - getWrapWidth
```
public int getWrapWidth()
```
    Returns:
    the wrapWidth
  - setWrapWidth
```
public void setWrapWidth(int wrapWidth)
```
    Parameters:
    wrapWidth - the wrapWidth to set
  - getPromptText
```
public java.lang.String getPromptText()
```
    Get the prompt text used in this control.
    
    Returns:
    the prompt text without styling
  - getText
```
public java.lang.String getText()
```
    Get the text in the control
    
    Overrides:
    
    getText in class GTextBase
    
    Returns:
    the text without styling
  - getStyledText
```
public StyledString getStyledText()
```
    Get the styled text in the control
    
    Overrides:
    
    getStyledText in class GTextBase
    
    Returns:
    the text with styling
  - addStyle
```
public void addStyle(java.awt.font.TextAttribute attr,
            java.lang.Object value,
            int charStart,
            int charEnd)
```
    Adds the text attribute to a range of characters on a particular 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
    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)
```
    Adds the text attribute to a range of characters on a particular 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
  - clearStyles
```
public void clearStyles(int charStart,
               int charEnd)
```
    Clears all text attribute from a range of characters starting at position charStart and ending with the character preceding charEnd.
    
    Parameters:
    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()
```
    Clear all styles from the entire text.
  - setFont
```
public void setFont(java.awt.Font font)
```
    Set the font for this control.
    
    Overrides:
    
    setFont in class GTextBase
    
    Parameters:
    font -
  - getSelectedText
```
public java.lang.String getSelectedText()
```
    Get the text that has been selected (highlighted) by the user.
    
    Returns:
    the selected text without styling
  - setSelectedTextStyle
```
public void setSelectedTextStyle(java.awt.font.TextAttribute style,
                        java.lang.Object value)
```
    If some text has been selected then set the style. If there is no selection then the text is unchanged.
    
    Parameters:
    style -
  - clearSelectionStyle
```
public void clearSelectionStyle()
```
    Clear any styles applied to the selected text.
  - setJustify
```
public void setJustify(boolean justify)
```
  - setLocalColorScheme
```
public void setLocalColorScheme(int cs)
```
    Sets the local colour scheme for this control
    
    Overrides:
    
    setLocalColorScheme in class GAbstractControl
    
    Parameters:
    cs - the colour scheme to use (0-15 incl.)
  - hasSelection
```
public boolean hasSelection()
```
    Find out if some text is selected (highlighted)
    
    Returns:
    true if some text is selected else false
  - setTextEditEnabled
```
public void setTextEditEnabled(boolean enableTextEdit)
```
    Determines whether the text can be edited using the keyboard or mouse. It still allows the text to be modified by the sketch code.
    If text editing is being disabled and the control has focus then it is forced to give up that focus.
    This might be useful if you want to use a GTextArea control to display large amounts of text that needs scrolling (so cannot use a GLabel) but must not change e.g. a user instruction guide.
    
    Parameters:
    enableTextEdit - false to disable keyboard input
  - isTextEditEnabled
```
public boolean isTextEditEnabled()
```
    Is this control keyboard enabled
  - keyEvent
```
public void keyEvent(processing.event.KeyEvent e)
```
    Overrides:
    
    keyEvent in class GAbstractControl
  - flashCaret
```
public void flashCaret(GTimer timer)
```
    Do not call this directly. A timer calls this method as and when required.
  - hsbEventHandler
```
public void hsbEventHandler(g4p_controls.GScrollbar scrollbar,
                   GEvent event)
```
    Do not call this method directly, G4P uses it to handle input from the horizontal scrollbar.
  - vsbEventHandler
```
public void vsbEventHandler(g4p_controls.GScrollbar scrollbar,
                   GEvent event)
```
    Do not call this method directly, G4P uses it to handle input from the vertical scrollbar.
  - markForDisposal
```
public void markForDisposal()
```
    Permanently dispose of this control.
    
    Overrides:
    
    markForDisposal in class GAbstractControl
  - dispose
```
public void dispose()
```
    Remove from its tab manager before disposing.
    
    Overrides:
    
    dispose in class GAbstractControl
  - saveText
```
public boolean saveText(java.lang.String fname)
```
    Save the styled text used by this control to file.
    It will also save the start and end position of any text selection.
    
    Overrides:
    
    saveText in class GTextBase
    
    Parameters:
    fname - the name of the file to use
    
    Returns:
    true if saved successfully else false
  - loadText
```
public boolean loadText(java.lang.String fname)
```
    Load the styled string to be used by this control.
    It will also restore any text selection saved with the text.
    
    Overrides:
    
    loadText in class GTextBase
    
    Parameters:
    fname - the name of the file to use
    
    Returns:
    true if loaded successfully else false

Class GEditableTextControl

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

GEditableTextControl

Method Detail

setTabManager

setFocus

setPromptText

getWrapWidth

setWrapWidth

getPromptText

getText

getStyledText

addStyle

addStyle

clearStyles

clearStyles

setFont

getSelectedText

setSelectedTextStyle

clearSelectionStyle