GGroup (Javadocs: G4P)

java.lang.Object
- g4p_controls.GAbstractControl
- - g4p_controls.GGroup

All Implemented Interfaces:

GConstants, processing.core.PConstants
```
public final class GGroup
extends GAbstractControl
```
This class allows you to group GUI controls so that they can be treated as a single entity for common GUI actions.
Once grouped a single statement change the enabled status, visibility status, colour scheme and transparency for all the controls in the group. It is possible to specify a delay before the action is executed, and in the case of transparency, specify the amount of time the fade occurs.
This is particularly useful if your sketch has a number of 'modes' and each mode has its own set of G4P controls. Simply create a GGroup object for each mode then as the mode changes it is easy to display the controls for the current mode and hide the others.
A GGroup is associated with a window (or GWindow) and can only be used with controls displayed on that window.

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
`GGroup(GWindow theWindow)` Create a control group for the indicated GWindow.
`GGroup(processing.core.PApplet theApplet)` Create a control group for the indicated PApplet.
`GGroup(processing.core.PApplet theApplet, int startAlpha)` Create a control group for the indicated PApplet.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addControl(GAbstractControl control)` A single G4P control to add to this group.
`void`	`addControls(GAbstractControl... controls)` Add one or more G4P controls to this group.
`void`	`fadeIn(int delay, int duration)` Fade to fully opaque.
`void`	`fadeOut(int delay, int duration)` Fade to invisible.
`void`	`fadeTo(int delay, int duration, int alpha)` Fade to an alpha value
`boolean`	`isFading()`
`void`	`pre()`
`void`	`removeControl(GAbstractControl control)` Remove a single G4P control from this group.
`void`	`removeControls(GAbstractControl... controls)` Remove one or more G4P controls from this group.
`void`	`setEnabled(boolean enable)` Enable / disable the controls immediately.
`void`	`setEnabled(int delay, boolean enable)` Enable / disable the controls.
`void`	`setLocalColorScheme(int colScheme)` Set the color scheme used by these controls with immediate effect.
`void`	`setLocalColorScheme(int delay, int colScheme)` Set the color scheme used by these controls after a delay.
`void`	`setVisible(boolean visible)` Make the control visible or invisible with immediate effect.
`void`	`setVisible(int delay, boolean visible)` Make the control visible or invisible.
`int`	`timeLeftFading()`

Methods inherited from class g4p_controls.GAbstractControl
addControl, addControl, addEventHandler, dispose, draw, forceBufferUpdate, getCursorOver, getCX, getCY, getHeight, getLocalColorScheme, getPApplet, getParent, getSnapshot, getWidth, getX, getY, hasFocus, isDragging, isEnabled, isOpaque, isOver, isVisible, keyEvent, markForDisposal, mouseEvent, moveTo, moveTo, post, saveSnapshot, saveSnapshot, setAlpha, setAlpha, setCursorOver, setFocus, setLocalColor, setLocalColorScheme, setOpaque, setRotation, setRotation, 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
  - GGroup
```
public GGroup(processing.core.PApplet theApplet)
```
    Create a control group for the indicated PApplet. Only controls created with this PApplet can be added to this group.
    All controls added will be initialised as fully opaque.
    
    Parameters:
    theApplet - the associated PApplet
  - GGroup
```
public GGroup(processing.core.PApplet theApplet,
      int startAlpha)
```
    Create a control group for the indicated PApplet. Only controls created with this PApplet can be added to this group.
    All controls added will be initialised as fully opaque.
    
    Parameters:
    theApplet - the associated PApplet
    startAlpha - the starting alpha level (must 0-255 incl)
  - GGroup
```
public GGroup(GWindow theWindow)
```
    Create a control group for the indicated GWindow. Only controls displayed in this GWindow can be added to this group.
    All controls added will be initialised as fully opaque.
    
    Parameters:
    theWindow - the associated GWindow
- Method Detail
  - fadeOut
```
public void fadeOut(int delay,
           int duration)
```
    Fade to invisible. (alpha = 0)
    
    Parameters:
    delay - time before starting fade (milli-seconds)
    duration - time to fade over (milli-seconds)
  - fadeIn
```
public void fadeIn(int delay,
          int duration)
```
    Fade to fully opaque. (alpha = 255)
    
    Parameters:
    delay - time before starting fade (milli-seconds)
    duration - time to fade over (milli-seconds)
  - fadeTo
```
public void fadeTo(int delay,
          int duration,
          int alpha)
```
    Fade to an alpha value
    
    Parameters:
    delay - time before starting fade (milli-seconds)
    duration - time to fade over (milli-seconds)
    alpha - the target alpha value
  - setEnabled
```
public void setEnabled(int delay,
              boolean enable)
```
    Enable / disable the controls.
    
    Parameters:
    delay - delay time before action is performed (milli-seconds)
  - isFading
```
public boolean isFading()
```
  - timeLeftFading
```
public int timeLeftFading()
```
  - setEnabled
```
public void setEnabled(boolean enable)
```
    Enable / disable the controls immediately.
    
    Overrides:
    
    setEnabled in class GAbstractControl
    
    Parameters:
    enable - true to enable else false
  - setVisible
```
public void setVisible(int delay,
              boolean visible)
```
    Make the control visible or invisible.
    If you simply want to change the controls' visibility status then use this in preference to fadeIn/fadeOut
    
    Parameters:
    delay - delay time before action is performed (milli-seconds)
  - setVisible
```
public void setVisible(boolean visible)
```
    Make the control visible or invisible with immediate effect.
    If you simply want to change the controls' visibility status then use this in preference to fadeIn/fadeOut
    
    Overrides:
    
    setVisible in class GAbstractControl
    
    Parameters:
    visible - the visibility to set
  - setLocalColorScheme
```
public void setLocalColorScheme(int colScheme)
```
    Set the color scheme used by these controls with immediate effect.
    
    Overrides:
    
    setLocalColorScheme in class GAbstractControl
    
    Parameters:
    colScheme - the colour scheme (0-15) to be used.
    See Also:
    for colour constants (e.g. BLUE_SCHEME) to use.
  - setLocalColorScheme
```
public void setLocalColorScheme(int delay,
                       int colScheme)
```
    Set the color scheme used by these controls after a delay.
    
    Parameters:
    delay - time before colour change (milli-seconds)
    colScheme - the colour scheme (0-15) to be used.
    See Also:
    for colour constants (e.g. BLUE_SCHEME) to use.
  - pre
```
public void pre()
```
    Overrides:
    
    pre in class GAbstractControl
  - addControls
```
public void addControls(GAbstractControl... controls)
```
    Add one or more G4P controls to this group.
    If a control is not a valid type for group control, or if the control and group are for different windows then the control is not added and a warning message is displayed.
    
    Overrides:
    
    addControls in class GAbstractControl
    
    Parameters:
    controls - comma separated list of G4P controls to add to this group
  - addControl
```
public void addControl(GAbstractControl control)
```
    A single G4P control to add to this group.
    If a control is not a valid type for group control, or if the control and group are for different windows then the control is not added and a warning message is displayed.
    
    Overrides:
    
    addControl in class GAbstractControl
    
    Parameters:
    control - a G4P control to add to this group
  - removeControls
```
public void removeControls(GAbstractControl... controls)
```
    Remove one or more G4P controls from this group.
    
    Parameters:
    controls - comma separated list of G4P controls to remove from this group
  - removeControl
```
public void removeControl(GAbstractControl control)
```
    Remove a single G4P control from this group.
    
    Parameters:
    control - a G4P control to remove from this group

Class GGroup

Nested Class Summary

Nested classes/interfaces inherited from class g4p_controls.GAbstractControl

Field Summary

Fields inherited from class g4p_controls.GAbstractControl

Fields inherited from interface processing.core.PConstants

Fields inherited from interface g4p_controls.GConstants

Constructor Summary

Method Summary

Methods inherited from class g4p_controls.GAbstractControl

Methods inherited from class java.lang.Object

Field Detail

SLIDER_STYLES

DEFAULT_SLIDER_STYLE

DRAW_METHOD

MOUSE_METHOD

PRE_METHOD

KEY_METHOD

POST_METHOD

ALL_METHOD

GROUP_CONTROL_METHOD

MISSING

NONEXISTANT

INVALID_TYPE

INVALID_PAPPLET

EXCP_IN_HANDLER

OFF_CONTROL

OVER_CONTROL

PRESS_CONTROL

DRAG_CONTROL

TINT_FOR_ALPHA

I_NONE

I_TL

I_TR

I_CL

I_CR

I_INSIDE

I_COVERED

I_MODES

MERGE_RUNS

CLIP_RUN

COMBI_MODES

grid

pen_1_0

pen_2_0

pen_3_0

pen_4_0

TPAD2

TPAD4

TPAD6

TPAD8

SCROLLBAR_VERTICAL

SCROLLBAR_HORIZONTAL

WHEEL_DELTA

WHEEL_STICK_FACTOR

EOL

Z_STICKY

Z_SLIPPY

Z_SLIPPY_EXPANDS

Z_PANEL

Constructor Detail

GGroup

GGroup

GGroup

Method Detail

fadeOut

fadeIn

fadeTo

setEnabled

isFading

timeLeftFading

setEnabled

setVisible

setVisible

setLocalColorScheme

setLocalColorScheme

pre

addControls

addControl

removeControls