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

Public Member Functions

void addControl (GAbstractControl control)
 
void addControls (GAbstractControl...controls)
 
void fadeIn (int delay, int duration)
 
void fadeOut (int delay, int duration)
 
void fadeTo (int delay, int duration, int alpha)
 
 GGroup (PApplet theApplet)
 
 GGroup (PApplet theApplet, int startAlpha)
 
 GGroup (GWindow theWindow)
 
boolean isFading ()
 
void pre ()
 
void removeControl (GAbstractControl control)
 
void removeControls (GAbstractControl...controls)
 
void setAlpha (int alpha)
 
void setAlpha (int alpha, boolean includeChildren)
 
void setEnabled (int delay, boolean enable)
 
void setEnabled (boolean enable)
 
void setLocalColorScheme (int colScheme)
 
void setLocalColorScheme (int delay, int colScheme)
 
void setVisible (int delay, boolean visible)
 
void setVisible (boolean visible)
 
int timeLeftFading ()
 
- 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 ()
 

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 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)
 
- 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

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

Constructor & Destructor Documentation

g4p_controls.GGroup.GGroup ( 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
theAppletthe associated PApplet
g4p_controls.GGroup.GGroup ( 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
theAppletthe associated PApplet
startAlphathe starting alpha level (must 0-255 incl)
g4p_controls.GGroup.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
theWindowthe associated GWindow

Member Function Documentation

void g4p_controls.GGroup.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.

Parameters
controla G4P control to add to this group
void g4p_controls.GGroup.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.

Parameters
controlscomma separated list of G4P controls to add to this group
void g4p_controls.GGroup.fadeIn ( int  delay,
int  duration 
)

Fade to fully opaque. (alpha = 255)

Parameters
delaytime before starting fade (milli-seconds)
durationtime to fade over (milli-seconds)
void g4p_controls.GGroup.fadeOut ( int  delay,
int  duration 
)

Fade to invisible. (alpha = 0)

Parameters
delaytime before starting fade (milli-seconds)
durationtime to fade over (milli-seconds)
void g4p_controls.GGroup.fadeTo ( int  delay,
int  duration,
int  alpha 
)

Fade to an alpha value

Parameters
delaytime before starting fade (milli-seconds)
durationtime to fade over (milli-seconds)
alphathe target alpha value
void g4p_controls.GGroup.removeControl ( GAbstractControl  control)

Remove a single G4P control from this group.

Parameters
controla G4P control to remove from this group
void g4p_controls.GGroup.removeControls ( GAbstractControl...  controls)

Remove one or more G4P controls from this group.

Parameters
controlscomma separated list of G4P controls to remove from this group
void g4p_controls.GGroup.setAlpha ( int  alpha)

Set the transparency of this group of controls and make it unavailable to mouse and keyboard events if below the threshold. Child controls are ignored?

Parameters
alphavalue in the range 0 (transparent) to 255 (opaque)
void g4p_controls.GGroup.setAlpha ( int  alpha,
boolean  includeChildren 
)

Set the transparency of this group of controls and make them unavailable to mouse and keyboard events if below the threshold. Child controls are ignored?
If required include the children and their children.

Parameters
alphavalue in the range 0 (transparent) to 255 (opaque)
includeChildrenif do do the same for all descendants
void g4p_controls.GGroup.setEnabled ( int  delay,
boolean  enable 
)

Enable / disable the controls.

Parameters
delaydelay time before action is performed (milli-seconds)
enablewhether the control group is to be enabled or not
void g4p_controls.GGroup.setEnabled ( boolean  enable)

Enable / disable the controls immediately.

void g4p_controls.GGroup.setLocalColorScheme ( int  colScheme)

Set the color scheme used by these controls with immediate effect.

See Also
GConstants for colour constants (e.g. BLUE_SCHEME) to use.
Parameters
colSchemethe colour scheme (0-15) to be used.
void g4p_controls.GGroup.setLocalColorScheme ( int  delay,
int  colScheme 
)

Set the color scheme used by these controls after a delay.

See Also
GConstants for colour constants (e.g. BLUE_SCHEME) to use.
Parameters
delaytime before colour change (milli-seconds)
colSchemethe colour scheme (0-15) to be used.
void g4p_controls.GGroup.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
delaydelay time before action is performed (milli-seconds)
visiblewhether to make the control visible or not
void g4p_controls.GGroup.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

Parameters
visiblewhether to make the control visible or not