Inheritance diagram for g4p_controls.GGroup:

[legend]

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 (GWindow theWindow)

	GGroup (PApplet theApplet)

	GGroup (PApplet theApplet, int startAlpha)

boolean	isFading ()

void	pre ()

void	removeControl (GAbstractControl control)

void	removeControls (GAbstractControl... controls)

void	setAlpha (int alpha)

void	setAlpha (int alpha, boolean includeChildren)

void	setEnabled (boolean enable)

void	setEnabled (int delay, boolean enable)

void	setLocalColorScheme (int colScheme)

void	setLocalColorScheme (int delay, int colScheme)

void	setVisible (boolean visible)

void	setVisible (int delay, boolean visible)

int	timeLeftFading ()

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

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

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 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< GAbstractControl >	children = 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

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

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

◆ GGroup() [1/3]

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

theApplet the associated PApplet

◆ GGroup() [2/3]

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

theApplet	the associated PApplet
startAlpha	the starting alpha level (must 0-255 incl)

◆ GGroup() [3/3]

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

theWindow the associated GWindow

Member Function Documentation

◆ addControl()

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

control a G4P control to add to this group

Reimplemented from g4p_controls.GAbstractControl.

◆ addControls()

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

controls comma separated list of G4P controls to add to this group

Reimplemented from g4p_controls.GAbstractControl.

◆ fadeIn()

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

◆ fadeOut()

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

◆ fadeTo()

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

◆ pre()

void g4p_controls.GGroup.pre ( )

Reimplemented from g4p_controls.GAbstractControl.

◆ removeControl()

void g4p_controls.GGroup.removeControl ( GAbstractControl control )

Remove a single G4P control from this group.

Parameters

control a G4P control to remove from this group

◆ removeControls()

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

◆ setAlpha() [1/2]

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

alpha value in the range 0 (transparent) to 255 (opaque)

Reimplemented from g4p_controls.GAbstractControl.

◆ setAlpha() [2/2]

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

alpha	value in the range 0 (transparent) to 255 (opaque)
includeChildren	if do do the same for all descendants

Reimplemented from g4p_controls.GAbstractControl.

◆ setEnabled() [1/2]

void g4p_controls.GGroup.setEnabled ( boolean enable )

Enable / disable the controls immediately.

Reimplemented from g4p_controls.GAbstractControl.

◆ setEnabled() [2/2]

void g4p_controls.GGroup.setEnabled	(	int	delay,
		boolean	enable
	)

Enable / disable the controls.

Parameters

delay	delay time before action is performed (milli-seconds)
enable	whether the control group is to be enabled or not

◆ setLocalColorScheme() [1/2]

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

colScheme the colour scheme (0-15) to be used.

Reimplemented from g4p_controls.GAbstractControl.

◆ setLocalColorScheme() [2/2]

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

delay	time before colour change (milli-seconds)
colScheme	the colour scheme (0-15) to be used.

◆ setVisible() [1/2]

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

visible whether to make the control visible or not

Reimplemented from g4p_controls.GAbstractControl.

◆ setVisible() [2/2]

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

delay	delay time before action is performed (milli-seconds)
visible	whether to make the control visible or not

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GGroup() [1/3]

◆ GGroup() [2/3]

◆ GGroup() [3/3]

Member Function Documentation

◆ addControl()

◆ addControls()

◆ fadeIn()

◆ fadeOut()

◆ fadeTo()

◆ pre()

◆ removeControl()

◆ removeControls()

◆ setAlpha() [1/2]

◆ setAlpha() [2/2]

◆ setEnabled() [1/2]

◆ setEnabled() [2/2]

◆ setLocalColorScheme() [1/2]

◆ setLocalColorScheme() [2/2]

◆ setVisible() [1/2]

◆ setVisible() [2/2]