G4P (GUI for Processing)  4.3.8
A set of GUI controls for your Processing sketch.
 All Classes Functions Variables Pages
g4p_controls.GTextField Class Reference
Inheritance diagram for g4p_controls.GTextField:

Public Member Functions

void appendText (String extraText)
 
void draw ()
 
PGraphics getSnapshot ()
 
float getValueF ()
 
int getValueI ()
 
 GTextField (PApplet theApplet, float p0, float p1, float p2, float p3)
 
 GTextField (PApplet theApplet, float p0, float p1, float p2, float p3, int sbPolicy)
 
void hsbEventHandler (GScrollbar scrollbar, GEvent event)
 
boolean isValid ()
 
void keyEvent (KeyEvent e)
 
void mouseEvent (MouseEvent event)
 
void pre ()
 
void setNumeric (int low, int high, int default_value)
 
void setNumeric (float low, float high, float default_value)
 
void setNumericType (int...f)
 
void setStyledText (StyledString ss)
 
void setText (String text)
 
- Public Member Functions inherited from g4p_controls.GEditableTextControl
void addStyle (TextAttribute attr, Object value, int charStart, int charEnd)
 
void addStyle (TextAttribute attr, Object value)
 
void clearSelectionStyle ()
 
void clearStyles (int charStart, int charEnd)
 
void clearStyles ()
 
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 setTextBold (int start, int end)
 
void setTextBold ()
 
void setTextItalic (int start, int end)
 
void setTextItalic ()
 
void setTextPlain ()
 
- Public Member Functions inherited from g4p_controls.GAbstractControl
void addControl (GAbstractControl c, float x, float y, float angle)
 
void addControl (GAbstractControl c, float x, float y)
 
void addControl (GAbstractControl c)
 
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 ()
 
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 ()
 
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 setVisible (boolean visible)
 
String toString ()
 

Protected Member Functions

void cancelSelection ()
 
boolean changeText ()
 
void keyPressedProcess (int keyCode, char keyChar, boolean shiftDown, boolean ctrlDown)
 
void keyTypedProcess (int keyCode, char keyChar, boolean shiftDown, boolean ctrlDown)
 
void testValidity (String text)
 
void updateBuffer ()
 
- Protected Member Functions inherited from g4p_controls.GEditableTextControl
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)
 
- Protected Member Functions inherited from g4p_controls.GAbstractControl
void addToParent (GAbstractControl p)
 
void calcTransformedOrigin (float px, float py)
 
void createEventHandler (Object handlerObj, String methodName, Class[] param_classes, String[] param_names)
 
void fireEvent (Object...objects)
 
int focusObjectZ ()
 
PGraphics getBuffer ()
 
int getCurrHotSpot ()
 
AffineTransform getTransform (AffineTransform aff)
 
boolean isAvailable ()
 
boolean isDisplayable (int ascii)
 
boolean isSuitableForGroupControl (GAbstractControl control)
 
void loseFocus (GAbstractControl grabber)
 
void makeBuffer ()
 
void resize (int w, int h)
 
void setAvailable (boolean avail)
 
void setTextRenderingHints (Graphics2D g2d, int hint)
 
void setZ (int parentZ)
 
void takeFocus ()
 
void updateBuffer ()
 
int whichHotSpot (float px, float py)
 

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
 
- Public Attributes inherited from g4p_controls.GConstantsInternal
int ALL_METHOD = 0x0000001f
 
int CLIP_RUN = 512
 
int COMBI_MODES = 768
 
String DEFAULT_SLIDER_STYLE = "grey_blue"
 
int DRAG_CONTROL = 3
 
int DRAW_METHOD = 0x00000001
 
char EOL = '\n'
 
int EXCP_IN_HANDLER = 0xff000005
 
int[][] grid
 
int GROUP_CONTROL_METHOD = DRAW_METHOD | MOUSE_METHOD | KEY_METHOD
 
int I_CL = 4
 
int I_COVERED = 32
 
int I_CR = 8
 
int I_INSIDE = 16
 
int I_MODES = 63
 
int I_NONE = 0
 
int I_TL = 1
 
int I_TR = 2
 
int INVALID_PAPPLET = 0xff000004
 
int INVALID_TYPE = 0xff000003
 
int KEY_METHOD = 0x00000008
 
int MERGE_RUNS = 256
 
int MISSING = 0xff000001
 
int MOUSE_METHOD = 0x00000002
 
int NONEXISTANT = 0xff000002
 
int OFF_CONTROL = 0
 
int OVER_CONTROL = 1
 
BasicStroke pen_1_0 = new BasicStroke(1, BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND)
 
BasicStroke pen_2_0 = new BasicStroke(2, BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND)
 
BasicStroke pen_3_0 = new BasicStroke(3, BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND)
 
BasicStroke pen_4_0 = new BasicStroke(4, BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND)
 
int POST_METHOD = 0x00000010
 
int PRE_METHOD = 0x00000004
 
int PRESS_CONTROL = 2
 
int SCROLLBAR_HORIZONTAL = GConstants.SCROLLBARS_HORIZONTAL_ONLY
 
int SCROLLBAR_VERTICAL = GConstants.SCROLLBARS_VERTICAL_ONLY
 
String SLIDER_STYLES = "|grey_blue|blue18px|green_red20px|purple18px|red_yellow18px|"
 
int TINT_FOR_ALPHA = 255
 
int TPAD2 = 2
 
int TPAD4 = 4
 
int TPAD6 = 6
 
int TPAD8 = 8
 
float WHEEL_DELTA = 0.01f
 
float WHEEL_STICK_FACTOR = 0.51f
 
int Z_PANEL = 1024
 
int Z_SLIPPY = 24
 
int Z_SLIPPY_EXPANDS = 48
 
int Z_STICKY = 0
 
- Protected Attributes inherited from g4p_controls.GEditableTextControl
boolean autoHide = false
 
GTimer caretFlasher
 
float caretX
 
int endChar = -1
 
TextLayoutHitInfo endTLHI = new TextLayoutHitInfo()
 
GeneralPath gpTextDisplayArea
 
GScrollbar hsb
 
boolean keepCursorInView = false
 
StyledString promptText = null
 
float ptx
 
final int scrollbarPolicy
 
boolean showCaret = false
 
TextLayoutHitInfo startTLHI = new TextLayoutHitInfo()
 
boolean textChanged = false
 
float tx
 
int wrapWidth = Integer.MAX_VALUE
 
- Protected Attributes inherited from g4p_controls.GTextBase
Font localFont = G4P.displayFont
 
StyledString stext = new StyledString("")
 
- Protected Attributes inherited from g4p_controls.GAbstractControl
int alphaLevel = G4P.globalAlpha
 
PGraphicsJava2D buffer = null
 
boolean bufferInvalid = true
 
LinkedList< GAbstractControlchildren = null
 
int currSpot = -1
 
int cursorOver = HAND
 
float cx
 
boolean dragging = false
 
Method eventHandlerMethod = null
 
String eventHandlerMethodName
 
Object eventHandlerObject = null
 
float halfWidth
 
HotSpot[] hotspots = null
 
int localColorScheme = G4P.globalColorScheme
 
boolean opaque = false
 
float ox
 
Color[] palette = null
 
GAbstractControl parent = null
 
int registeredMethods = 0
 
float rotAngle
 
double[] temp = new double[2]
 
float width
 
PApplet winApp
 
float x
 
int z = Z_STICKY
 
- Static Protected Attributes inherited from g4p_controls.GAbstractControl
static float epsilon = 0.001f
 

Detailed Description

The text field component.

This control allows the user to enter and edit a single line of text. The control also allows default text and a horizontal scrollbar.

can be created to manage either a single line of text or multiple lines of text.

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.

As well as text this control will accept numeric input either integer or decimal within a user specified range. Invalid user input is highlighted in the control to be corrected by the user.

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.

From V4.3.3 The text field can be used to validate numeric input within a user defined range. The input can be either integer

int

or decimal

float

, using the

method. If all three parameters are integers then only integer values in the range are valid, if any of the parameters is a

float

then any decimal value in the range is valid.

Decimal formats include numbers in exponential format e.g. -4.911e-2

Author
Peter Lager

Constructor & Destructor Documentation

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

Create a text field without a scrollbar.

Parameters
theAppletthe main sketch or GWindow control for this control
p0x position based on control mode
p1y position based on control mode
p2x position or width based on control mode
p3y position or height based on control mode
g4p_controls.GTextField.GTextField ( PApplet  theApplet,
float  p0,
float  p1,
float  p2,
float  p3,
int  sbPolicy 
)

Create a text field with the given scrollbar policy.
This policy can be one of these

  • SCROLLBARS_NONE
  • SCROLLBARS_HORIZONTAL_ONLY

If you want the scrollbar to auto hide then perform a logical or with

  • SCROLLBARS_AUTOHIDE

e.g. SCROLLBARS_HORIZONTAL_ONLY | SCROLLBARS_AUTOHIDE

Parameters
theAppletthe main sketch or GWindow control for this control
p0x position based on control mode
p1y position based on control mode
p2x position or width based on control mode
p3y position or height based on control mode
sbPolicyscrollbar policy

Member Function Documentation

void g4p_controls.GTextField.appendText ( String  extraText)

Add some plain text to the end of the existing text.

Parameters
extraTextthe text to append
void g4p_controls.GTextField.cancelSelection ( )
protected

Cancels any selection. So the selection box will disappear.

float g4p_controls.GTextField.getValueF ( )

If the field is displaying a valid float within the specified range return it. Otherwise the default float value.

int g4p_controls.GTextField.getValueI ( )

If the field is displaying a valid integer within the specified range return it. Otherwise the default int value.

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

Do not call this method directly, G4P uses it to handle input from the horizontal scrollbar.

boolean g4p_controls.GTextField.isValid ( )
Returns
true if the visible input is valid for the filter
void g4p_controls.GTextField.setNumeric ( int  low,
int  high,
int  default_value 
)

Will cause the text field to show when an invalid integer has been entered into the field.
An invalid integer is any text that cannot be converted into an integer or is outside the range indicated by the first two parameters.
If

is called then it will return the current valid integer or if invalid the value passed in the third parameter.
Note: all the parameters must be of type

int


Parameters
lowthe lowest valid integer
highthe highest valid integer
default_valuethe value to be returned by for invalid user input
void g4p_controls.GTextField.setNumeric ( float  low,
float  high,
float  default_value 
)

Will cause the text field to show when an invalid float has been entered into the field.
An invalid float is any text that cannot be converted into a float or is outside the range indicated by the first two parameters.
If

is called then it will return the current valid float or if invalid the value passed in the third parameter.
Note: at least one of the parameters must be of type

float


Parameters
lowthe lowest valid float
highthe highest valid float
default_valuethe value to be returned by for invalid user input
void g4p_controls.GTextField.setNumericType ( int...  f)

Sets the filter to be used, valid parameter values are G4P.INTEGER, G4P.DECIMAL or G4P.EXPONENT and the accepted range will be based on range of valid values for the Java data types

int

or

float

.
if the parameter is null or missing then it cancels the filter and all text values are considered valid.

Parameters
fthe filter to apply (can be null or omitted)
void g4p_controls.GTextField.setStyledText ( StyledString  ss)

Set the styled text for this textfield after ensuring that all EOL characters have been removed.

Parameters
ssthe styled text to be displayed
void g4p_controls.GTextField.setText ( String  text)

Set the text to be displayed.

Parameters
textthe text to be displayed
void g4p_controls.GTextField.updateBuffer ( )
protected

If the buffer is invalid then redraw it. need to use palette for colours