g4p_controls

Class GTextArea

java.lang.Object

g4p_controls.GAbstractControl

g4p_controls.GEditableTextControl

g4p_controls.GTextArea

All Implemented Interfaces:

GConstants, GConstantsInternal, 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 text input 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.

Author:

Peter Lager

Nested Class Summary

Nested classes/interfaces inherited from class g4p_controls.GAbstractControl

GAbstractControl.Z_Order

Field Summary

Fields inherited from class g4p_controls.GAbstractControl

tag, tagNo

Fields inherited from interface processing.core.PConstants

ADD, ALPHA, ALPHA_MASK, ALT, AMBIENT, ARC, ARGB, ARROW, BACKSPACE, BASELINE, BEVEL, BEZIER_VERTEX, BLEND, BLUE_MASK, BLUR, BOTTOM, BOX, BREAK, BURN, CENTER, CHATTER, CLAMP, CLOSE, CODED, COMPLAINT, CONTROL, CORNER, CORNERS, CROSS, CURVE_VERTEX, CUSTOM, DARKEST, DEG_TO_RAD, DELETE, DIAMETER, DIFFERENCE, DILATE, DIRECTIONAL, DISABLE_ACCURATE_2D, DISABLE_ACCURATE_TEXTURES, DISABLE_DEPTH_MASK, DISABLE_DEPTH_SORT, DISABLE_DEPTH_TEST, DISABLE_NATIVE_FONTS, DISABLE_OPENGL_ERRORS, DISABLE_STROKE_PERSPECTIVE, DISABLE_STROKE_PURE, DISABLE_TEXTURE_CACHE, DISABLE_TEXTURE_MIPMAPS, DISABLE_TRANSFORM_CACHE, DODGE, DOWN, DXF, ELLIPSE, ENABLE_ACCURATE_2D, ENABLE_ACCURATE_TEXTURES, ENABLE_DEPTH_MASK, ENABLE_DEPTH_SORT, ENABLE_DEPTH_TEST, ENABLE_NATIVE_FONTS, ENABLE_OPENGL_ERRORS, ENABLE_STROKE_PERSPECTIVE, ENABLE_STROKE_PURE, ENABLE_TEXTURE_CACHE, ENABLE_TEXTURE_MIPMAPS, ENABLE_TRANSFORM_CACHE, ENTER, EPSILON, ERODE, ERROR_BACKGROUND_IMAGE_FORMAT, ERROR_BACKGROUND_IMAGE_SIZE, ERROR_PUSHMATRIX_OVERFLOW, ERROR_PUSHMATRIX_UNDERFLOW, ERROR_TEXTFONT_NULL_PFONT, ESC, EXCLUSION, GIF, GRAY, GREEN_MASK, 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, platformNames, POINT, POINTS, POLYGON, PORTRAIT, POSTERIZE, PROBLEM, PROJECT, PROJECTION, QUAD, QUAD_BEZIER_VERTEX, QUAD_STRIP, QUADS, QUARTER_PI, RAD_TO_DEG, RADIUS, RECT, RED_MASK, REPEAT, REPLACE, RETURN, RGB, RIGHT, ROUND, SCREEN, SHAPE, SHIFT, SOFT_LIGHT, SPHERE, SPOT, SQUARE, SUBTRACT, TAB, TARGA, 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, CLOSE_WINDOW, CTRL_ANGULAR, CTRL_HORIZONTAL, CTRL_VERTICAL, CYAN_SCHEME, DECIMAL, EXIT_APP, EXPONENT, FAMILY, FOREGROUND, GOLD_SCHEME, GREEN_SCHEME, INTEGER, KEEP_OPEN, ORANGE_SCHEME, ORIENT_LEFT, ORIENT_RIGHT, ORIENT_TRACK, POSTURE, POSTURE_OBLIQUE, POSTURE_REGULAR, PURPLE_SCHEME, RED_SCHEME, SCHEME_10, SCHEME_11, SCHEME_12, SCHEME_13, SCHEME_14, SCHEME_15, SCHEME_8, SCHEME_9, SCROLLBAR_HORIZONTAL, SCROLLBAR_VERTICAL, 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, 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, YELLOW_SCHEME

Fields inherited from interface g4p_controls.GConstantsInternal

ALL_METHOD, CLIP_RUN, COMBI_MODES, DRAW_METHOD, EXCP_IN_HANDLER, grid, I_CL, I_COVERED, I_CR, I_INSIDE, I_MODES, I_NONE, I_TL, I_TR, KEY_METHOD, MERGE_RUNS, MISSING, MOUSE_METHOD, NONEXISTANT, OFF_CONTROL, OVER_CONTROL, pen_1_0, pen_2_0, pen_3_0, pen_4_0, POST_METHOD, PRE_METHOD, PRESS_CONTROL, RUNTIME_ERROR, TINT_FOR_ALPHA

Constructor Summary

Constructors

Constructor and Description
GTextArea(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(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(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	appendText(String extraText) Add text to the end of the current text.
void	draw()
PGraphics	getSnapshot() This method should be used sparingly since it is heavy on resources.
void	mouseEvent(MouseEvent event) Will respond to mouse events.
void	pre()
void	setDefaultText(String dtext) Set the default text for this control.
GTextArea	setText(String text) Set the text to be used.
void	setText(String text, int wrapWidth) Set the text to display and adjust any scrollbars

Methods inherited from class g4p_controls.GEditableTextControl

clearStyle, flashCaret, getDefaultText, getSelectedText, getText, hasSelection, hsbEventHandler, keyEvent, markForDisposal, setFocus, setFont, setJustify, setLocalColorScheme, setSelectedTextStyle, vsbEventHandler

Methods inherited from class g4p_controls.GAbstractControl

addControl, addControl, addControl, addControls, addEventHandler, forceBufferUpdate, getCursorOver, getCX, getCY, getFocusName, getHeight, getLocalColorScheme, getPApplet, getParent, getWidth, getX, getY, hasFocus, isDragging, isEnabled, isOpaque, isVisible, post, setAlpha, setAlpha, setAvailable, setAvailableChildren, setCursorOver, setEnabled, setLocalColorScheme, setOpaque, setRotation, setRotation, setVisible, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GTextArea

public GTextArea(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(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(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 -

Method Detail

setDefaultText

public void setDefaultText(String dtext)

Set the default text for this control. If provided this text will be displayed in italic whenever it is empty. It will also be wrapped to the control size.

Overrides:

setDefaultText in class GEditableTextControl

Parameters:

dtext -

setText

public GTextArea setText(String text)

Set the text to be used. The wrap width is determined by the size of the control.

Parameters:

text -

setText

public void setText(String text,
           int wrapWidth)

Set the text to display and adjust any scrollbars

Parameters:

text -

wrapWidth -

appendText

public void appendText(String extraText)

Add text to the end of the current text. This is useful for a logging' type activity.

Parameters:

extraText -

pre

public void pre()

Overrides:

pre in class GAbstractControl

draw

public void draw()

Overrides:

draw in class GAbstractControl

getSnapshot

public 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:

mouseEvent

public void mouseEvent(MouseEvent event)

Will respond to mouse events.

Overrides:

mouseEvent in class GAbstractControl