G4P (GUI for Processing) 4.3.11
A set of GUI controls for your Processing sketch.
Loading...
Searching...
No Matches
g4p_controls.GTextBase Class Referenceabstract
Inheritance diagram for g4p_controls.GTextBase:

Classes

class  Zone
 

Public Member Functions

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 ()
 
float getRotation ()
 
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 offset, float angle)
 
void setTip (GToolTip tt, GAlign ax, GAlign ay, float gap)
 
void setTip (String text, float offset, float angle)
 
void setTip (String text, GAlign ax, GAlign ay, float gap)
 
void setTipDisplayTime (long msecs)
 
void setTipEnabled (boolean enable)
 
void setTipHorz (boolean level)
 
void setTipPos (float radius, float ang)
 
void setTipPos (GAlign ax, GAlign ay, float gap)
 
void setTipText (String text)
 
void setVisible (boolean visible)
 
String toString ()
 

Protected Member Functions

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 ()
 
void resizeToFit (GControlMode mode)
 
- 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)
 
boolean controlSupportsToolTips ()
 
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 resize (int w, int h, GControlMode mode)
 
void setAvailable (boolean avail)
 
void setZ (int parentZ)
 
void showTip ()
 
void takeFocus ()
 
void updateBuffer ()
 
int whichHotSpot (float px, float py)
 

Protected Attributes

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
 
boolean available = true
 
PGraphicsJava2D buffer = null
 
boolean bufferInvalid = true
 
LinkedList< GAbstractControlchildren = null
 
int currSpot = -1
 
int cursorOver = HAND
 
float cx
 
float cy
 
boolean dragging = false
 
boolean enabled = true
 
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
 
boolean visible = true
 
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
 
TextAttribute UNDERLINE = TextAttribute.UNDERLINE
 
int UNDERLINE_OFF = Integer.valueOf(-1)
 
int UNDERLINE_ON = TextAttribute.UNDERLINE_ON
 
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 GAbstractControl controlToTakeFocus = null
 
static GAbstractControl cursorIsOver
 
static float epsilon = 0.001f
 
static GAbstractControl focusIsWith = null
 

Detailed Description

Base class for any control that uses styled text.

Author
Peter Lager

Constructor & Destructor Documentation

◆ GTextBase()

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

Constructor

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

Member Function Documentation

◆ addAttributeImpl() [1/2]

void g4p_controls.GTextBase.addAttributeImpl ( TextAttribute  style,
Object  value 
)
protected

Apply the style to the whole text

Parameters
stylethe style attribute
value'amount' to apply

◆ addAttributeImpl() [2/2]

void g4p_controls.GTextBase.addAttributeImpl ( TextAttribute  style,
Object  value,
int  s,
int  e 
)
protected

Apply the style to a portion of the string

Parameters
stylethe style attribute
value'amount' to apply
sfirst character to be included for styling
ethe first character not to be included for styling

◆ displayText()

void g4p_controls.GTextBase.displayText ( Graphics2D  g2d,
LinkedList< TextLayoutInfo lines,
Color  fore 
)
protected

Default implementation for displaying the control's text. Child classes may override this if needed.

◆ forceBufferUpdate()

void g4p_controls.GTextBase.forceBufferUpdate ( )

See comments in GAbstractControl class

Reimplemented from g4p_controls.GAbstractControl.

◆ getStyledText()

StyledString g4p_controls.GTextBase.getStyledText ( )

Get the text used for this control.

Returns
the displayed text with styling

Reimplemented in g4p_controls.GEditableTextControl.

◆ getText()

String g4p_controls.GTextBase.getText ( )

Get the text used for this control.

Returns
the displayed text without styling

Reimplemented in g4p_controls.GEditableTextControl.

◆ loadText()

boolean g4p_controls.GTextBase.loadText ( String  fname)

Load the styled string to be used by this control.

Parameters
fnamethe name of the file to use
Returns
true if loaded successfully else false

Reimplemented in g4p_controls.GEditableTextControl.

◆ resizeToFit() [1/2]

void g4p_controls.GTextBase.resizeToFit ( )
protected

Resize the control so it just fits the text. This will also change the buffer size using global control mode.

◆ resizeToFit() [2/2]

void g4p_controls.GTextBase.resizeToFit ( GControlMode  mode)
protected

Resize the control so it just fits the text. This will also change the buffer size using specified control mode

Parameters
modecontrol mode CORNER, CORNERS or CENTER

◆ saveText()

boolean g4p_controls.GTextBase.saveText ( String  fname)

Save the styled text used by this control to file.

Parameters
fnamethe name of the file to use
Returns
true if saved successfully else false

Reimplemented in g4p_controls.GEditableTextControl.

◆ setFont()

void g4p_controls.GTextBase.setFont ( Font  font)

Set the font to be used in this control

Parameters
fontAWT font to use

Reimplemented in g4p_controls.GEditableTextControl, and g4p_controls.GPanel.

◆ setStyledText()

void g4p_controls.GTextBase.setStyledText ( StyledString  ss)

Allows the user to provide their own styled text for this component

Parameters
ssthe styled string to display

Reimplemented in g4p_controls.GSpinner, g4p_controls.GTextField, and g4p_controls.GTextArea.

◆ setText() [1/2]

void g4p_controls.GTextBase.setText ( String  text)

Set the text to be displayed.

Parameters
textthe text to display

Reimplemented in g4p_controls.GPanel, g4p_controls.GSpinner, g4p_controls.GTextArea, g4p_controls.GTextField, g4p_controls.GTextIconBase, and g4p_controls.GToolTip.

◆ setText() [2/2]

void g4p_controls.GTextBase.setText ( String  text,
GAlign  horz,
GAlign  vert 
)

Combines setting the text and text alignment in one method.

If you want to set just one of the alignments then pass null in the other.

Parameters
textthe text to display
horzGAlign.LEFT, CENTER, RIGHT or JUSTIFY
vertGAlign.TOP, MIDDLE, BOTTOM

Reimplemented in g4p_controls.GTextIconBase.

◆ setTextAlign()

void g4p_controls.GTextBase.setTextAlign ( GAlign  horz,
GAlign  vert 
)

Set the horizontal and/or vertical text alignment. Use the constants in GAlign e.g. GAlign.LEFT

If you want to set just one of these then pass null in the other

Parameters
horzGAlign.LEFT, CENTER, RIGHT or JUSTIFY
vertGAlign.TOP, MIDDLE, BOTTOM

◆ setTextBold() [1/2]

void g4p_controls.GTextBase.setTextBold ( )

Make all the characters bold.

◆ setTextBold() [2/2]

void g4p_controls.GTextBase.setTextBold ( int  start,
int  end 
)

Make the selected characters bold.
Characters affected are ≥ start and < end

Parameters
startthe first character to style
endthe first character not to style

◆ setTextItalic() [1/2]

void g4p_controls.GTextBase.setTextItalic ( )

Make all the characters italic.

◆ setTextItalic() [2/2]

void g4p_controls.GTextBase.setTextItalic ( int  start,
int  end 
)

Make the selected characters italic.
Characters affected are ≥ start and < end

Parameters
startthe first character to style
endthe first character not to style

◆ setTextPlain()

void g4p_controls.GTextBase.setTextPlain ( )

Clear all applied styles from the whole text.

Member Data Documentation

◆ stext

StyledString g4p_controls.GTextBase.stext = new StyledString("")
protected

The styled text used by this control