Inheritance diagram for g4p_controls.GEditableTextControl:

[legend]

Public Member Functions
void	addStyle (TextAttribute attr, Object value)

void	addStyle (TextAttribute attr, Object value, int charStart, int charEnd)

void	clearSelectionStyle ()

void	clearStyles ()

void	clearStyles (int charStart, int charEnd)

void	dispose ()

void	flashCaret (GTimer timer)

	GEditableTextControl (PApplet theApplet, float p0, float p1, float p2, float p3)

	GEditableTextControl (PApplet theApplet, float p0, float p1, float p2, float p3, int scrollbars)

String	getPromptText ()

String	getSelectedText ()

StyledString	getStyledText ()

String	getText ()

int	getWrapWidth ()

boolean	hasSelection ()

void	hsbEventHandler (GScrollbar scrollbar, GEvent event)

boolean	isTextEditEnabled ()

void	keyEvent (KeyEvent e)

boolean	loadText (String fname)

boolean	saveText (String fname)

void	setFocus (boolean focus)

void	setFont (Font font)

void	setJustify (boolean justify)

void	setLocalColorScheme (int cs)

void	setPromptText (String ptext)

void	setSelectedTextStyle (TextAttribute style, Object value)

void	setTabManager (GTabManager tm)

void	setTextEditEnabled (boolean enableTextEdit)

void	setWrapWidth (int wrapWidth)

void	vsbEventHandler (GScrollbar scrollbar, GEvent event)

Public Member Functions inherited from g4p_controls.GTextBase
void	forceBufferUpdate ()

StyledString	getStyledText ()

String	getText ()

	GTextBase (PApplet theApplet, float p0, float p1, float p2, float p3)

boolean	loadText (String fname)

boolean	saveText (String fname)

void	setFont (Font font)

void	setStyledText (StyledString ss)

void	setText (String text)

void	setText (String text, GAlign horz, GAlign vert)

void	setTextAlign (GAlign horz, GAlign vert)

void	setTextBold ()

void	setTextBold (int start, int end)

void	setTextItalic ()

void	setTextItalic (int start, int end)

void	setTextPlain ()

Public Member Functions inherited from g4p_controls.GAbstractControl
void	addControl (GAbstractControl c)

void	addControl (GAbstractControl c, float x, float y)

void	addControl (GAbstractControl c, float x, float y, float angle)

void	addControls (GAbstractControl... controls)

void	addEventHandler (Object obj, String methodName)

void	dispose ()

void	draw ()

void	forceBufferUpdate ()

	GAbstractControl (PApplet theApplet)

	GAbstractControl (PApplet theApplet, float p0, float p1)

	GAbstractControl (PApplet theApplet, float p0, float p1, float p2, float p3)

int	getAlpha ()

int	getCursorOver ()

float	getCX ()

float	getCY ()

float	getHeight ()

int	getLocalColorScheme ()

PApplet	getPApplet ()

GAbstractControl	getParent ()

PGraphics	getSnapshot ()

GToolTip	getTip ()

float	getWidth ()

float	getX ()

float	getY ()

boolean	hasFocus ()

boolean	isDragging ()

boolean	isEnabled ()

boolean	isOpaque ()

boolean	isVisible ()

void	keyEvent (KeyEvent e)

void	mouseEvent (MouseEvent event)

void	moveTo (float px, float py)

void	moveTo (float px, float py, GControlMode mode)

void	post ()

void	pre ()

void	removeTip ()

boolean	saveSnapshot ()

boolean	saveSnapshot (String filename)

void	setAlpha (int alpha)

void	setAlpha (int alpha, boolean includeChildren)

void	setCursorOver (int cursorOver)

void	setEnabled (boolean enable)

void	setFocus (boolean focus)

void	setLocalColor (int colorNo, int color)

void	setLocalColorScheme (int cs)

void	setLocalColorScheme (int cs, boolean includeChildren)

void	setOpaque (boolean opaque)

void	setRotation (float angle)

void	setRotation (float angle, GControlMode mode)

void	setTip (GToolTip tt, float dx, float dy)

void	setTip (GToolTip tt, GAlign ax, GAlign ay, float gap)

void	setTip (String text, float dx, float dy)

void	setTip (String text, GAlign ax, GAlign ay, float gap)

void	setTipDisplayTime (long msecs)

void	setTipHorz (boolean level)

void	setTipText (String text)

void	setVisible (boolean visible)

String	toString ()

void	setTabManager (GTabManager tm)

Protected Member Functions
void	calculateCaretPos (TextLayoutHitInfo tlhi)

boolean	changeText ()

float	getScrollAmount ()

void	keyPressedProcess (int keyCode, char keyChar, boolean shiftDown, boolean ctrlDown)

void	keyTypedProcess (int keyCode, char keyChar, boolean shiftDown, boolean ctrlDown)

void	loseFocus (GAbstractControl grabber)

boolean	moveCaretEndOfLine (TextLayoutHitInfo currPos)

boolean	moveCaretLeft (TextLayoutHitInfo currPos)

boolean	moveCaretRight (TextLayoutHitInfo currPos)

boolean	moveCaretStartOfLine (TextLayoutHitInfo currPos)

void	takeFocus ()

Protected Member Functions inherited from g4p_controls.GTextBase
void	addAttributeImpl (TextAttribute style, Object value)

void	addAttributeImpl (TextAttribute style, Object value, int s, int e)

void	calcTextZone ()

void	displayText (Graphics2D g2d, LinkedList< TextLayoutInfo > lines)

void	displayText (Graphics2D g2d, LinkedList< TextLayoutInfo > lines, Color fore)

void	resizeToFit ()

Protected Member Functions inherited from g4p_controls.GAbstractControl
void	addControlImpl (GAbstractControl c, float x, float y, float angle)

void	addToParent (GAbstractControl p)

void	calcTransformedOrigin (float px, float py)

void	createEventHandler (Object handlerObj, String methodName, Class[] param_classes, String[] param_names)

void	drawChildren ()

void	fireEvent (Object... objects)

int	focusObjectZ ()

PGraphics	getBuffer ()

int	getCurrHotSpot ()

AffineTransform	getTransform (AffineTransform aff)

void	hideTip ()

boolean	isAvailable ()

boolean	isDisplayable (int ascii)

boolean	isSuitableForGroupControl (GAbstractControl control)

void	loseFocus (GAbstractControl grabber)

void	makeBuffer ()

void	manageToolTip ()

void	resize (int w, int h)

void	setAvailable (boolean avail)

void	setTextRenderingHints (Graphics2D g2d, int hint)

void	setZ (int parentZ)

void	showTip ()

void	takeFocus ()

void	updateBuffer ()

int	whichHotSpot (float px, float py)

Protected Attributes
int	adjust = 0

boolean	autoHide = false

GTimer	caretFlasher

float	caretX

float	caretY

int	endChar = -1

TextLayoutHitInfo	endTLHI = new TextLayoutHitInfo()

GeneralPath	gpTextDisplayArea

GScrollbar	hsb

boolean	keepCursorInView = false

int	nbr = 0

int	pos = endChar

StyledString	promptText = null

float	ptx

float	pty

final int	scrollbarPolicy

boolean	selectionChanged = false

boolean	showCaret = false

int	startChar = -1

TextLayoutHitInfo	startTLHI = new TextLayoutHitInfo()

boolean	textChanged = false

float	th

float	tw

float	tx

float	ty

GScrollbar	vsb

int	wrapWidth = Integer.MAX_VALUE

Protected Attributes inherited from g4p_controls.GTextBase
Font	localFont = G4P.displayFont

float	PAD = 2

StyledString	stext = new StyledString("")

GAlign	textAlignH = GAlign.LEFT

GAlign	textAlignV = GAlign.MIDDLE

Zone	textZone = new Zone()

Protected Attributes inherited from g4p_controls.GAbstractControl
boolean	allowChildren = true

boolean	allowToolTips = true

int	alphaLevel = G4P.globalAlpha

PGraphicsJava2D	buffer = null

boolean	bufferInvalid = true

LinkedList< GAbstractControl >	children = null

int	currSpot = -1

int	cursorOver = HAND

float	cx

float	cy

boolean	dragging = false

Method	eventHandlerMethod = null

String	eventHandlerMethodName

Object	eventHandlerObject = null

float	halfHeight

float	halfWidth

float	height

HotSpot[]	hotspots = null

int	lastSpot = -1

int	localColorScheme = G4P.globalColorScheme

boolean	opaque = false

float	ox

float	oy

Color[]	palette = null

GAbstractControl	parent = null

int	registeredMethods = 0

float	rotAngle

double[]	temp = new double[2]

GToolTip	tip = null

float	width

PApplet	winApp

float	x

float	y

int	z = Z_STICKY

Additional Inherited Members
Public Attributes inherited from g4p_controls.GAbstractControl
String	tag = ""

int	tagNo

Public Attributes inherited from g4p_controls.GConstants
int	ALPHA_BLOCK = 128

int	ALPHA_PICK = 48

TextAttribute	BACKGROUND = TextAttribute.BACKGROUND

int	BLUE_SCHEME = 6

int	BOLD = Font.BOLD

int	CANCEL = JOptionPane.CANCEL_OPTION

int	CLOSE_WINDOW = 0x00000f02

int	CLOSED = JOptionPane.CLOSED_OPTION

int	CTRL_ANGULAR = 0x00000501

int	CTRL_HORIZONTAL = 0x00000502

int	CTRL_VERTICAL = 0x00000503

int	CYAN_SCHEME = 5

int	DECIMAL = 1

char	END = java.awt.event.KeyEvent.VK_END

int	ERROR_MESSAGE = JOptionPane.ERROR_MESSAGE

int	EXIT_APP = 0x00000f01

int	EXPONENT = 2

TextAttribute	FAMILY = TextAttribute.FAMILY

TextAttribute	FOREGROUND = TextAttribute.FOREGROUND

int	FORWARD = 1

int	GOLD_SCHEME = 7

int	GREEN_SCHEME = 1

int	HIDE_WINDOW = 0x00000f04

char	HOME = java.awt.event.KeyEvent.VK_HOME

int	INFO_MESSAGE = JOptionPane.INFORMATION_MESSAGE

int	INTEGER = 0

int	ITALIC = Font.ITALIC

int	KEEP_OPEN = 0x00000f03

int	NO = JOptionPane.NO_OPTION

int	OK = JOptionPane.OK_OPTION

int	OK_CANCEL = JOptionPane.OK_CANCEL_OPTION

int	ORANGE_SCHEME = 4

int	ORIENT_LEFT = -1

int	ORIENT_RIGHT = 1

int	ORIENT_TRACK = 0

int	PLAIN = Font.PLAIN

int	PLAIN_MESSAGE = JOptionPane.PLAIN_MESSAGE

TextAttribute	POSTURE = TextAttribute.POSTURE

Float	POSTURE_OBLIQUE = new Float(0.20f)

Float	POSTURE_REGULAR = new Float(0.0f)

int	PURPLE_SCHEME = 3

int	QUERY_MESSAGE = JOptionPane.QUESTION_MESSAGE

int	RED_SCHEME = 0

int	REVERSE = -1

int	SCHEME_10 = 10

int	SCHEME_11 = 11

int	SCHEME_12 = 12

int	SCHEME_13 = 13

int	SCHEME_14 = 14

int	SCHEME_15 = 15

int	SCHEME_8 = 8

int	SCHEME_9 = 9

int	SCROLLBARS_AUTOHIDE = 0x1000

int	SCROLLBARS_BOTH = 0x0003

int	SCROLLBARS_HORIZONTAL_ONLY = 0x0002

int	SCROLLBARS_NONE = 0x0000

int	SCROLLBARS_VERTICAL_ONLY = 0x0001

TextAttribute	SIZE = TextAttribute.SIZE

TextAttribute	STRIKETHROUGH = TextAttribute.STRIKETHROUGH

Boolean	STRIKETHROUGH_OFF = new Boolean(false)

Boolean	STRIKETHROUGH_ON = new Boolean(true)

TextAttribute	SUPERSCRIPT = TextAttribute.SUPERSCRIPT

Integer	SUPERSCRIPT_OFF = new Integer(0)

Integer	SUPERSCRIPT_SUB = new Integer(-1)

Integer	SUPERSCRIPT_SUPER = new Integer(1)

int	UNDEFINED = Integer.MAX_VALUE

int	USER_COL_SCHEME = 0x00010102

int	WARN_MESSAGE = JOptionPane.WARNING_MESSAGE

TextAttribute	WEIGHT = TextAttribute.WEIGHT

Float	WEIGHT_BOLD = new Float(2.0f)

Float	WEIGHT_DEMIBOLD = new Float(1.75f)

Float	WEIGHT_DEMILIGHT = new Float(0.875f)

Float	WEIGHT_EXTRA_LIGHT = new Float(0.5f)

Float	WEIGHT_EXTRABOLD = new Float(2.5f)

Float	WEIGHT_HEAVY = new Float(2.25f)

Float	WEIGHT_LIGHT = new Float(0.75f)

Float	WEIGHT_MEDIUM = new Float(1.5f)

Float	WEIGHT_REGULAR = new Float(1.0f)

Float	WEIGHT_SEMIBOLD = new Float(1.25f)

Float	WEIGHT_ULTRABOLD = new Float(2.75f)

TextAttribute	WIDTH = TextAttribute.WIDTH

Float	WIDTH_CONDENSED = new Float(0.75f)

Float	WIDTH_EXTENDED = new Float(1.5f)

Float	WIDTH_REGULAR = new Float(1.0f)

Float	WIDTH_SEMI_CONDENSED = new Float(0.875f)

Float	WIDTH_SEMI_EXTENDED = new Float(1.25f)

int	X4 = 1

int	X8 = 2

int	YELLOW_SCHEME = 2

int	YES = JOptionPane.YES_OPTION

int	YES_NO = JOptionPane.YES_NO_OPTION

int	YES_NO_CANCEL = JOptionPane.YES_NO_CANCEL_OPTION

Static Protected Attributes inherited from g4p_controls.GAbstractControl
static float	epsilon = 0.001f

Detailed Description

This class is the basis for the GTextField and GTextArea classes.

Author: Peter Lager

Constructor & Destructor Documentation

◆ GEditableTextControl() [1/2]

g4p_controls.GEditableTextControl.GEditableTextControl	(	PApplet	theApplet,
		float	p0,
		float	p1,
		float	p2,
		float	p3
	)

Base class for controls with editable text.

Parameters

theApplet	the main sketch or GWindow control for this control
p0	x position based on control mode
p1	y position based on control mode
p2	x position or width based on control mode
p3	y position or height based on control mode
scrollbars	scrollbar policy

◆ GEditableTextControl() [2/2]

g4p_controls.GEditableTextControl.GEditableTextControl	(	PApplet	theApplet,
		float	p0,
		float	p1,
		float	p2,
		float	p3,
		int	scrollbars
	)

Base class for controls with editable text.

Parameters

theApplet	the main sketch or GWindow control for this control
p0	x position based on control mode
p1	y position based on control mode
p2	x position or width based on control mode
p3	y position or height based on control mode
scrollbars	scrollbar policy

Member Function Documentation

◆ addStyle() [1/2]

void g4p_controls.GEditableTextControl.addStyle	(	TextAttribute	attr,
		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

◆ addStyle() [2/2]

void g4p_controls.GEditableTextControl.addStyle	(	TextAttribute	attr,
		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

◆ calculateCaretPos()

void g4p_controls.GEditableTextControl.calculateCaretPos ( TextLayoutHitInfo tlhi )

protected

Calculate the caret (text insertion point)

Parameters

tlhi

Reimplemented in g4p_controls.GTextArea.

◆ clearSelectionStyle()

void g4p_controls.GEditableTextControl.clearSelectionStyle ( )

Clear any styles applied to the selected text.

◆ clearStyles() [1/2]

void g4p_controls.GEditableTextControl.clearStyles ( )

Clear all styles from the entire text.

◆ clearStyles() [2/2]

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

◆ dispose()

void g4p_controls.GEditableTextControl.dispose ( )

Remove from its tab manager before disposing.

Reimplemented from g4p_controls.GAbstractControl.

◆ getPromptText()

String g4p_controls.GEditableTextControl.getPromptText ( )

Get the prompt text used in this control.

Returns: the prompt text without styling

◆ getScrollAmount()

float g4p_controls.GEditableTextControl.getScrollAmount ( )

protected

Get the amount to scroll the text per frame when scrolling text to keep the insertion point on screen.

Returns: the amount to scroll in pixels.

◆ getSelectedText()

String g4p_controls.GEditableTextControl.getSelectedText ( )

Get the text that has been selected (highlighted) by the user.

Returns: the selected text without styling

◆ getStyledText()

StyledString g4p_controls.GEditableTextControl.getStyledText ( )

Get the styled text in the control

Returns: the text with styling

Reimplemented from g4p_controls.GTextBase.

◆ getText()

String g4p_controls.GEditableTextControl.getText ( )

Get the text in the control

Returns: the text without styling

Reimplemented from g4p_controls.GTextBase.

◆ getWrapWidth()

int g4p_controls.GEditableTextControl.getWrapWidth ( )

Returns: the wrapWidth

◆ hasSelection()

boolean g4p_controls.GEditableTextControl.hasSelection ( )

Find out if some text is selected (highlighted)

Returns: true if some text is selected else false

◆ hsbEventHandler()

void g4p_controls.GEditableTextControl.hsbEventHandler	(	GScrollbar	scrollbar,
		GEvent	event
	)

Reimplemented in g4p_controls.GTextField.

◆ isTextEditEnabled()

boolean g4p_controls.GEditableTextControl.isTextEditEnabled ( )

Returns: true if this control is keyboard enabled

◆ keyEvent()

void g4p_controls.GEditableTextControl.keyEvent ( KeyEvent e )

Reimplemented from g4p_controls.GAbstractControl.

◆ loadText()

boolean g4p_controls.GEditableTextControl.loadText ( String fname )

Load the styled string to be used by this control.
It will also restore any text selection saved with the text.

Parameters

fname the name of the file to use

Returns: true if loaded successfully else false

Reimplemented from g4p_controls.GTextBase.

◆ loseFocus()

void g4p_controls.GEditableTextControl.loseFocus ( GAbstractControl grabber )

protected

Give up focus but if the text is only made from spaces then set it to null text.
Fire focus events for the GTextField and GTextArea controls

Reimplemented from g4p_controls.GAbstractControl.

Reimplemented in g4p_controls.GSpinner.

◆ moveCaretEndOfLine()

boolean g4p_controls.GEditableTextControl.moveCaretEndOfLine ( TextLayoutHitInfo currPos )

protected

Move caret to the end of the line that has the current caret position

Parameters

currPos the current position of the caret

Returns: true if caret moved else false

Reimplemented in g4p_controls.GTextArea.

◆ moveCaretLeft()

boolean g4p_controls.GEditableTextControl.moveCaretLeft ( TextLayoutHitInfo currPos )

protected

Move caret left by one character.

Parameters

currPos the current position of the caret

Returns: true if caret moved else false

Reimplemented in g4p_controls.GTextArea.

◆ moveCaretRight()

boolean g4p_controls.GEditableTextControl.moveCaretRight ( TextLayoutHitInfo currPos )

protected

Move caret right by one character.

Parameters

currPos the current position of the caret

Returns: true if caret moved else false

Reimplemented in g4p_controls.GTextArea.

◆ moveCaretStartOfLine()

boolean g4p_controls.GEditableTextControl.moveCaretStartOfLine ( TextLayoutHitInfo currPos )

protected

Move caret to home position

Parameters

currPos the current position of the caret

Returns: true if caret moved else false

Reimplemented in g4p_controls.GTextArea.

◆ saveText()

boolean g4p_controls.GEditableTextControl.saveText ( 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.

Parameters

fname the name of the file to use

Returns: true if saved successfully else false

Reimplemented from g4p_controls.GTextBase.

◆ setFocus()

void g4p_controls.GEditableTextControl.setFocus ( boolean focus )

Determines whether this component is to have focus or not.

Reimplemented from g4p_controls.GAbstractControl.

◆ setFont()

void g4p_controls.GEditableTextControl.setFont ( Font font )

Set the font for this control.

Parameters

font	the java.awt.Font to use

Reimplemented from g4p_controls.GTextBase.

◆ setLocalColorScheme()

void g4p_controls.GEditableTextControl.setLocalColorScheme ( int cs )

Sets the local colour scheme for this control

Reimplemented from g4p_controls.GAbstractControl.

◆ setPromptText()

void g4p_controls.GEditableTextControl.setPromptText ( 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

◆ setSelectedTextStyle()

void g4p_controls.GEditableTextControl.setSelectedTextStyle	(	TextAttribute	style,
		Object	value
	)

If some text has been selected then set the style. If there is no selection then the text is unchanged.

Parameters

style	set the style of some selected text
value	a value associated with this style

◆ setTabManager()

void g4p_controls.GEditableTextControl.setTabManager ( GTabManager tm )

Implements g4p_controls.Focusable.

◆ setTextEditEnabled()

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

◆ setWrapWidth()

void g4p_controls.GEditableTextControl.setWrapWidth ( int wrapWidth )

Parameters

wrapWidth the wrapWidth to set

◆ takeFocus()

void g4p_controls.GEditableTextControl.takeFocus ( )

protected

Give the focus to this component but only after allowing the current component with focus to release it gracefully.
Always cancel the keyFocusIsWith irrespective of the component type. Fire focus events for the GTextField and GTextArea controls

Reimplemented from g4p_controls.GAbstractControl.

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GEditableTextControl() [1/2]

◆ GEditableTextControl() [2/2]

Member Function Documentation

◆ addStyle() [1/2]

◆ addStyle() [2/2]

◆ calculateCaretPos()

◆ clearSelectionStyle()

◆ clearStyles() [1/2]

◆ clearStyles() [2/2]

◆ dispose()

◆ getPromptText()

◆ getScrollAmount()

◆ getSelectedText()

◆ getStyledText()

◆ getText()

◆ getWrapWidth()

◆ hasSelection()

◆ hsbEventHandler()

◆ isTextEditEnabled()

◆ keyEvent()

◆ loadText()

◆ loseFocus()

◆ moveCaretEndOfLine()

◆ moveCaretLeft()

◆ moveCaretRight()

◆ moveCaretStartOfLine()

◆ saveText()

◆ setFocus()

◆ setFont()

◆ setLocalColorScheme()

◆ setPromptText()

◆ setSelectedTextStyle()

◆ setTabManager()

◆ setTextEditEnabled()

◆ setWrapWidth()

◆ takeFocus()