g4p_controls

Class GButton

java.lang.Object

g4p_controls.GAbstractControl

g4p_controls.GTextControl

g4p_controls.GTextIconControl

g4p_controls.GButton

All Implemented Interfaces:

GConstants, GConstantsInternal, PConstants

public class GButton
extends GTextIconControl

This class is the Button component. The button face can have either text or an image or both just pick the right constructor. Three types of event can be generated :-
PRESSED RELEASED CLICKED
To simplify event handling the button only fires off CLICKED events if the mouse button is pressed and released over the button face (the default behaviour).
Using

button1.fireAllEvents(true);

enables the other 2 events for button button1. A PRESSED event is created if the mouse button is pressed down over the button face, the CLICKED event is then generated if the mouse button is released over the button face. Releasing the button off the button face creates a RELEASED event.
The image file can either be a single image which is used for all button states, or be a composite of 3 images (tiled horizontally) which are used for the different button states OFF, OVER and DOWN in which case the image width should be divisible by 3.
A number of setImages(...) methods exist to set button state images, these can be used once the button is created.

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.GTextControl

stext

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
GButton(PApplet theApplet, float p0, float p1, float p2, float p3)
GButton(PApplet theApplet, float p0, float p1, float p2, float p3, String text)

Method Summary

Methods

Modifier and Type	Method and Description
void	draw()
void	fireAllEvents(boolean all) If the parameter is true all 3 event types are generated, if false only CLICKED events are generated (default behaviour).
void	mouseEvent(MouseEvent event) When a button is clicked on a GButton it generates 3 events (in this order) mouse down, mouse up and mouse clicked.
void	setEnabled(boolean enable) Enable or disable the ability of the component to generate mouse events. If the control is to be disabled when it is clicked then this will guarentee the mouse offf button image is used.

Methods inherited from class g4p_controls.GTextIconControl

setIcon, setIcon, setIconAlign, setText, toString

Methods inherited from class g4p_controls.GTextControl

setFont, setStyledText, setTextAlign, setTextBold, setTextBold, setTextItalic, setTextItalic, setTextPlain

Methods inherited from class g4p_controls.GAbstractControl

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

Methods inherited from class java.lang.Object

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

Constructor Detail

GButton

public GButton(PApplet theApplet,
       float p0,
       float p1,
       float p2,
       float p3)

GButton

public GButton(PApplet theApplet,
       float p0,
       float p1,
       float p2,
       float p3,
       String text)

Method Detail

fireAllEvents

public void fireAllEvents(boolean all)

If the parameter is true all 3 event types are generated, if false only CLICKED events are generated (default behaviour).

Parameters:

all -

setEnabled

public void setEnabled(boolean enable)

Enable or disable the ability of the component to generate mouse events.
If the control is to be disabled when it is clicked then this will guarentee the mouse offf button image is used.

Overrides:

setEnabled in class GAbstractControl

Parameters:

enable - true to enable else false

mouseEvent

public void mouseEvent(MouseEvent event)

When a button is clicked on a GButton it generates 3 events (in this order) mouse down, mouse up and mouse clicked.
You can test for a particular event type with PRESSED, RELEASED:

        void handleButtonEvents(GButton button) {
          if(button == btnName && button.eventType == GButton.PRESSED){
        // code for button click event
    }
 

Where

btnName

is the GButton identifier (variable name)

If you only wish to respond to button click events then use the statement

btnName.fireAllEvents(false); 

This is the default mode.

Overrides:

mouseEvent in class GAbstractControl

draw

public void draw()

Overrides:

draw in class GAbstractControl