g4p_controls

Class GTextIconBase

java.lang.Object

g4p_controls.GAbstractControl

g4p_controls.GTextBase

g4p_controls.GTextIconBase

All Implemented Interfaces:

GConstants, processing.core.PConstants

Direct Known Subclasses:

GButton, GLabel, GToggleControl

public abstract class GTextIconBase
extends GTextBase

This is the base class for all controls that can display text and/or icon i.e. GButton, GLabel, GCheckbox and GOption.
It allows the user to control the position of the icon relative to the text and also their alignment.
Icon Position
Use the setIconPos(GAlign pos); where pos is either

 GAlign.NORTH, GAlign.SOUTH, GAlign.EAST or GAlign.WEST 

to position the icon relative to the text.

The icon will reserve just enough space vertically (NORTH/SOUTH) or horizontally (EAST/WEST) to display itself. The setIconAlign(GAlign horz, GAlign vert); can be used to align the icon within its space so usable combinations are

 Icon positions         Usable Icon Alignment 
 NORTH, SOUTH           LEFT, CENTER, RIGHT 
 EAST, WEST             TOP, MIDDLE, BOTTOM
 

Specifying unusable icon alignments will be accepted but will have no visual effect on the control e.g.

 control.setIconPos(GAlign.NORTH);  // Icon above text
 control.setIconAlign(GAlign.TOP);  // Instruction is accepted but has no visual effect
 

This is new to V4.0.6 replaces the GTextAlign and GTextIconAlignBase 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
GTextIconBase(processing.core.PApplet theApplet, float p0, float p1, float p2, float p3)

Method Summary

Methods

Modifier and Type	Method and Description
GAnimIcon	getIcon() If an animated icon (GAnimIcon) is associated with this control then it is returned otherwise it returns null.
void	setIcon(GIcon g_icon, GAlign pos, GAlign horz, GAlign vert) Set the icon to be used for this control.
void	setIcon(processing.core.PImage img, int nbrImages, GAlign horz, GAlign vert) Set the non-animated icon to be used and the horizontal and/or vertical icon alignment.
void	setIcon(processing.core.PImage img, int nbrImages, GAlign pos, GAlign horz, GAlign vert) Set the non-animated icon to be used for this control.
void	setIcon(java.lang.String fname, int nbrImages) Set the non-animated icon to be used, keeping the current icon alignment and position.
void	setIcon(java.lang.String fname, int nbrImages, GAlign horz, GAlign vert) Set the non-animated icon to be used and the horizontal and/or vertical icon alignment.
void	setIcon(java.lang.String fname, int nbrImages, GAlign pos, GAlign horz, GAlign vert) Set the non-animated icon to be used and the horizontal and/or vertical icon alignment.
void	setIconAlign(GAlign horz, GAlign vert) Change the alignment of an existing icon.
void	setIconPos(GAlign icon_pos) Set the position for the icon relative to the text.
void	setText(java.lang.String text) Set the text to be displayed and calculate the wrap length taking into account any icon set.
void	setText(java.lang.String text, GAlign horz, GAlign vert) Combines setting the text and text alignment in one method.
void	setTextAlign(GAlign horz, GAlign vert) Set the horizontal and/or vertical text alignment.

Methods inherited from class g4p_controls.GTextBase

forceBufferUpdate, getStyledText, getText, loadText, saveText, setFont, setStyledText, setTextBold, setTextBold, setTextItalic, setTextItalic, setTextPlain

Methods inherited from class g4p_controls.GAbstractControl

addControl, addControl, addControl, addControls, addEventHandler, dispose, draw, getCursorOver, getCX, getCY, getHeight, getLocalColorScheme, getPApplet, getParent, getSnapshot, getWidth, getX, getY, hasFocus, isDragging, isEnabled, isOpaque, isOver, isVisible, keyEvent, markForDisposal, mouseEvent, moveTo, moveTo, post, pre, saveSnapshot, saveSnapshot, setAlpha, setAlpha, setCursorOver, setEnabled, setFocus, setLocalColor, setLocalColorScheme, 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

GTextIconBase

public GTextIconBase(processing.core.PApplet theApplet,
             float p0,
             float p1,
             float p2,
             float p3)

Method Detail

setIconPos

public void setIconPos(GAlign icon_pos)

Set the position for the icon relative to the text.

Parameters:

icon_pos - GAlign.NORTH, SOUTH, EAST or WEST

setIconAlign

public void setIconAlign(GAlign horz,
                GAlign vert)

Change the alignment of an existing icon. You can pass null if you don't want to change a particular alignment.

Parameters:

horz - horizontal alignment

vert - vertical alignment

setIcon

public void setIcon(java.lang.String fname,
           int nbrImages)

Set the non-animated icon to be used, keeping the current icon alignment and position.

Parameters:

fname - name of the icon image file

nbrImages - number of tiles in the image

setIcon

public void setIcon(java.lang.String fname,
           int nbrImages,
           GAlign horz,
           GAlign vert)

Set the non-animated icon to be used and the horizontal and/or vertical icon alignment. Use the constants in GAlign e.g. GAlign.LEFT
You can pass null if you don't want to change a particular alignment.

Parameters:

fname - name of the icon image file

nbrImages - number of tiles in the image

horz - GAlign.LEFT CENTER or RIGHT

vert - GAlign.TOP, MIDDLE, BOTTOM

setIcon

public void setIcon(java.lang.String fname,
           int nbrImages,
           GAlign pos,
           GAlign horz,
           GAlign vert)

Set the non-animated icon to be used and the horizontal and/or vertical icon alignment. Use the constants in GAlign e.g. GAlign.LEFT
You can pass null if you don't want to change a particular position/alignment.

Parameters:

fname - name of the icon image file

nbrImages - number of tiles in the image

pos - GAlign.NORTH, SOUTH, EAST or WEST

horz - GAlign.LEFT, CENTER or RIGHT

vert - GAlign.TOP, MIDDLE, BOTTOM

setIcon

public void setIcon(processing.core.PImage img,
           int nbrImages,
           GAlign horz,
           GAlign vert)

Set the non-animated icon to be used and the horizontal and/or vertical icon alignment. Use the constants in GAlign e.g. GAlign.LEFT
You can pass null if you don't want to change a particular position/alignment.

Parameters:

img - the icon

nbrImages - number of tiles in the image

horz - GAlign.LEFT, CENTER or RIGHT

vert - GAlign.TOP, MIDDLE, BOTTOM

setIcon

public void setIcon(processing.core.PImage img,
           int nbrImages,
           GAlign pos,
           GAlign horz,
           GAlign vert)

Set the non-animated icon to be used for this control.
Use the constants in GAlign e.g. GAlign.LEFT
You can pass null if you don't want to change a particular position/alignment.

Parameters:

img - the icon

nbrImages - number of tiles in the image

pos - GAlign.NORTH, SOUTH, EAST or WEST

horz - GAlign.LEFT, CENTER or RIGHT

vert - GAlign.TOP, MIDDLE, BOTTOM

setIcon

public void setIcon(GIcon g_icon,
           GAlign pos,
           GAlign horz,
           GAlign vert)

Set the icon to be used for this control.
Use the constants in GAlign e.g. GAlign.LEFT
This is the only method that allows you to use an animated icon. Create and configure the icon before adding to this control. You can use the getIcon() method to access its methods. You can pass null if you don't want to change a particular position/alignment.

Parameters:

g_icon - the icon to use

pos - GAlign.NORTH, SOUTH, EAST or WEST

horz - GAlign.LEFT, CENTER or RIGHT

vert - GAlign.TOP, MIDDLE, BOTTOM

getIcon

public GAnimIcon getIcon()

If an animated icon (GAnimIcon) is associated with this control then it is returned otherwise it returns null.
This is used to access the icon if we want to animate it e.g.

control.getIcon().animate();

setTextAlign

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

horz - GAlign.LEFT, CENTER, RIGHT or JUSTIFY

vert - GAlign.TOP, MIDDLE, BOTTOM

setText

public void setText(java.lang.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:

text -

horz - GAlign.LEFT, CENTER, RIGHT or JUSTIFY

vert - GAlign.TOP, MIDDLE, BOTTOM

setText

public void setText(java.lang.String text)

Set the text to be displayed and calculate the wrap length taking into account any icon set.

Overrides:

setText in class GTextBase

Parameters:

text -