Inheritance diagram for g4p_controls.GWindow:

[legend]

Classes
class	GCloseNotifier

class	WindowAdapterAWT

class	WindowAdapterNEWT

Public Member Functions
void	addData (GWinData data)

void	addDrawHandler (Object obj, String methodName)

void	addKeyHandler (Object obj, String methodName)

void	addMouseHandler (Object obj, String methodName)

void	addOnCloseHandler (Object obj, String methodName)

void	addPostHandler (Object obj, String methodName)

void	addPreHandler (Object obj, String methodName)

void	close ()

void	draw ()

void	forceClose ()

abstract PVector	getPosition (PVector pos)

abstract String	getTitle ()

abstract boolean	isVisible ()

void	keyEvent (KeyEvent event)

void	mouseEvent (MouseEvent event)

void	performCloseAction ()

void	post ()

void	pre ()

abstract void	setActionOnClose (int action)

abstract void	setAlwaysOnTop (boolean ontop)

abstract void	setLocation (int x, int y)

void	settings ()

abstract void	setTitle (String title)

void	setup ()

abstract void	setVisible (boolean visible)

abstract boolean	usesGL ()

Static Public Member Functions
static GWindow	getWindow (PApplet app, String title, int px, int py, int w, int h, String renderer)

Public Attributes
GWinData	data

String	tag

int	tagNo

LinkedList< GAbstractControl >	toAdd = new LinkedList<GAbstractControl>()

LinkedList< GAbstractControl >	toRemove = new LinkedList<GAbstractControl>()

LinkedList< GAbstractControl >	windowControls = new LinkedList<GAbstractControl>()

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
void	addToWindow (GAbstractControl control)

abstract void	fireCloseWindowEvent ()

	GWindow (String title, int w, int h)

abstract void	initListeners ()

void	prepareWindowForClosure ()

void	registerMethods ()

void	removeFromWindow (GAbstractControl control)

void	unregisterMethods ()

Protected Attributes
int	actionOnClose = KEEP_OPEN

String	closeHandlerMethodName

Object	closeHandlerObject = null

Method	closetHandlerMethod = null

Method	drawHandlerMethod = null

String	drawHandlerMethodName

Object	drawHandlerObject = null

int	h

boolean	is3D = false

Method	keyHandlerMethod = null

String	keyHandlerMethodName

Object	keyHandlerObject = null

Method	mouseHandlerMethod = null

String	mouseHandlerMethodName

Object	mouseHandlerObject = null

Method	postHandlerMethod = null

String	postHandlerMethodName

Object	postHandlerObject = null

Method	preHandlerMethod = null

String	preHandlerMethodName

Object	preHandlerObject = null

boolean	preparedForClosure = false

String	renderer_type

String	title

int	w

Detailed Description

Base class for independent windows using JAVA2D, P2D or P3D renderers. These can be used to hold G4P GUI components or used for drawing or both combined.

A number of examples are included in the library and more info can be found at www.lagers.org.uk

Updated for Processing V3

Author: Peter Lager

Member Function Documentation

◆ addData()

void g4p_controls.GWindow.addData ( GWinData data )

To provide a unique fields for this window create a class that inherits from GWinData with public access fields. Then use this method to associate the data with this window.

Parameters

data	the GWinData object associated with this window

◆ addDrawHandler()

void g4p_controls.GWindow.addDrawHandler	(	Object	obj,
		String	methodName
	)

Attempt to add the 'draw' handler method. The default event handler is a method that returns void and has two parameters PApplet and GWinData

Parameters

obj	the object to handle the event
methodName	the method to execute in the object handler class

◆ addKeyHandler()

void g4p_controls.GWindow.addKeyHandler	(	Object	obj,
		String	methodName
	)

Attempt to add the 'key' handler method. The default event handler is a method that returns void and has three parameters GWinApplet, GWinData and a KeyEvent

Parameters

obj	the object to handle the event
methodName	the method to execute in the object handler class

◆ addMouseHandler()

void g4p_controls.GWindow.addMouseHandler	(	Object	obj,
		String	methodName
	)

Attempt to add the 'mouse' handler method. The default event handler is a method that returns void and has three parameters GWinApplet, GWinData and a MouseEvent

Parameters

obj	the object to handle the event
methodName	the method to execute in the object handler class

◆ addOnCloseHandler()

void g4p_controls.GWindow.addOnCloseHandler	(	Object	obj,
		String	methodName
	)

Attempt to create the on-close-window event handler for this GWindow. The default event handler is a method that returns void and has a single parameter of type GWindow (this will be a reference to the window that is closing)

The handler will not be called if the setActionOnClose flag is set to EXIT_APP
If the flag is set to CLOSE_WINDOW then the handler is called when the window is closed by clicking on the window-close-icon or using either the close or forceClose methods.
If the flag is set to KEEP_OPEN the window can only be closed using the forceClose method. In this case the handler will be called.

Parameters

obj	the object to handle the on-close-window event
methodName	the method to execute in the object handler class

◆ addPostHandler()

void g4p_controls.GWindow.addPostHandler	(	Object	obj,
		String	methodName
	)

Attempt to add the 'post' handler method. The default event handler is a method that returns void and has two parameters GWinApplet and GWinData

Parameters

obj	the object to handle the event
methodName	the method to execute in the object handler class

◆ addPreHandler()

void g4p_controls.GWindow.addPreHandler	(	Object	obj,
		String	methodName
	)

Attempt to add the 'pre' handler method. The default event handler is a method that returns void and has two parameters GWinApplet and GWinData

Parameters

obj	the object to handle the event
methodName	the method to execute in the object handler class

◆ addToWindow()

void g4p_controls.GWindow.addToWindow ( GAbstractControl control )

protected

Add a control to this window, ignoring duplicates.

Parameters

control control to be added

◆ close()

void g4p_controls.GWindow.close ( )

This will close the window provided the action-on-close flag is CLOSE_WINDOW otherwise the window remains open.

◆ draw()

void g4p_controls.GWindow.draw ( )

Execute any draw handler for this window.

Reimplemented in g4p_controls.GWindowAWT, and g4p_controls.GWindowNEWT.

◆ fireCloseWindowEvent()

abstract void g4p_controls.GWindow.fireCloseWindowEvent ( )

abstractprotected

Fire a window closing event

Reimplemented in g4p_controls.GWindowAWT, and g4p_controls.GWindowNEWT.

◆ forceClose()

void g4p_controls.GWindow.forceClose ( )

This will close the window provided the action-on-close flag is CLOSE_WINDOW or KEEP_OPEN otherwise the window remains open.

◆ getPosition()

abstract PVector g4p_controls.GWindow.getPosition ( PVector pos )

abstract

Parameters

pos	the PVector to populate

Returns: a PVector with the windows top-left coordinates.

Reimplemented in g4p_controls.GWindowAWT, and g4p_controls.GWindowNEWT.

◆ getTitle()

abstract String g4p_controls.GWindow.getTitle ( )

abstract

Returns: the window's title bar text

Reimplemented in g4p_controls.GWindowAWT, and g4p_controls.GWindowNEWT.

◆ getWindow()

static GWindow g4p_controls.GWindow.getWindow	(	PApplet	app,
		String	title,
		int	px,
		int	py,
		int	w,
		int	h,
		String	renderer
	)

static

Factory method to create and start a new window. The renderer must be JAVA2D, P2D or P3D otherwise this method returns null.

Parameters

app	the main sketch window PApplet instance ('this')
title	text to appear in frame title bar
px	horizontal position of top-left corner
py	vertical position of top-left corner
w	width of drawing surface
h	height of surface
renderer	renderer must be JAVA2D, P3D or P3D

Returns: the window created (use this to get a handle on your window)

◆ initListeners()

abstract void g4p_controls.GWindow.initListeners ( )

abstractprotected

Set up the 'window' listeners

Reimplemented in g4p_controls.GWindowAWT, and g4p_controls.GWindowNEWT.

◆ isVisible()

abstract boolean g4p_controls.GWindow.isVisible ( )

abstract

Returns: true if this window is visible else false

Reimplemented in g4p_controls.GWindowAWT, and g4p_controls.GWindowNEWT.

◆ keyEvent()

void g4p_controls.GWindow.keyEvent ( KeyEvent event )

Execute any key event handler associated with this window and its controls

Parameters

event the key event to process

Reimplemented in g4p_controls.GWindowNEWT.

◆ mouseEvent()

void g4p_controls.GWindow.mouseEvent ( MouseEvent event )

Execute any mouse event handler associated with this window and its controls

Parameters

event the mouse event to process

◆ performCloseAction()

void g4p_controls.GWindow.performCloseAction ( )

This method is executed when the window closes. It will call the user defined on-close-handler method set with

◆ post()

void g4p_controls.GWindow.post ( )

Execute any post handler associated with this window and its controls.
Add/remove any controls request by user, this is done here outside the drawing phase to prevent crashes.

◆ pre()

void g4p_controls.GWindow.pre ( )

Execute any pre handler associated with this window and its controls

◆ prepareWindowForClosure()

void g4p_controls.GWindow.prepareWindowForClosure ( )

protected

Prepare the window for closure by stopping the animation loop, unregistering the event handlers and firing a window close event using a new thread.

◆ registerMethods()

void g4p_controls.GWindow.registerMethods ( )

protected

Register this window for pre, draw, post, mouseEvent and keyEvent methods.

◆ removeFromWindow()

void g4p_controls.GWindow.removeFromWindow ( GAbstractControl control )

protected

Remove a control to this window.

Parameters

control control to be removed

◆ setActionOnClose()

abstract void g4p_controls.GWindow.setActionOnClose ( int action )

abstract

This sets what happens when the users attempts to close the window.
There are 3 possible actions depending on the value passed.
G4P.KEEP_OPEN - ignore attempt to close window (default action),
G4P.CLOSE_WINDOW - close this window,
G4P.EXIT_APP - exit the app, this will cause all windows to close.

Parameters

action the required close action

Reimplemented in g4p_controls.GWindowAWT, and g4p_controls.GWindowNEWT.

◆ setAlwaysOnTop()

abstract void g4p_controls.GWindow.setAlwaysOnTop ( boolean ontop )

abstract

Sets whether this window should always be above other windows. If there are multiple always-on-top windows, their relative order is unspecified and platform dependent.

Parameters

ontop if true the window will always remain above other windows

Reimplemented in g4p_controls.GWindowAWT, and g4p_controls.GWindowNEWT.

◆ setLocation()

abstract void g4p_controls.GWindow.setLocation	(	int	x,
		int	y
	)

abstract

Set the windows position

Parameters

x	horizontal position of window
y	vertical position of window

Reimplemented in g4p_controls.GWindowAWT, and g4p_controls.GWindowNEWT.

◆ setTitle()

abstract void g4p_controls.GWindow.setTitle ( String title )

abstract

Set the window title

Parameters

title the window's title bar text

Reimplemented in g4p_controls.GWindowAWT, and g4p_controls.GWindowNEWT.

◆ setVisible()

abstract void g4p_controls.GWindow.setVisible ( boolean visible )

abstract

Set the windows visibility

Parameters

visible whether the window is to be visible or not

Reimplemented in g4p_controls.GWindowAWT, and g4p_controls.GWindowNEWT.

◆ unregisterMethods()

void g4p_controls.GWindow.unregisterMethods ( )

protected

Unregister this window for pre, draw, post, mouseEvent and keyEvent methods. This method is called when the window closes.

◆ usesGL()

abstract boolean g4p_controls.GWindow.usesGL ( )

abstract

Reimplemented in g4p_controls.GWindowAWT, and g4p_controls.GWindowNEWT.

Member Data Documentation

◆ closeHandlerMethodName

String g4p_controls.GWindow.closeHandlerMethodName

protected

the name of the method to handle the event

◆ closeHandlerObject

Object g4p_controls.GWindow.closeHandlerObject = null

protected

The object to handle the window closing event

◆ closetHandlerMethod

Method g4p_controls.GWindow.closetHandlerMethod = null

protected

The method in closeHandlerObject to execute

◆ data

GWinData g4p_controls.GWindow.data

Used to associated data to a GWindow

◆ drawHandlerMethod

Method g4p_controls.GWindow.drawHandlerMethod = null

protected

The method in drawHandlerObject to execute

◆ drawHandlerMethodName

String g4p_controls.GWindow.drawHandlerMethodName

protected

the name of the method to handle the event

◆ drawHandlerObject

Object g4p_controls.GWindow.drawHandlerObject = null

protected

The object to handle the draw event

◆ keyHandlerMethod

Method g4p_controls.GWindow.keyHandlerMethod = null

protected

The method in keyHandlerObject to execute

◆ keyHandlerMethodName

String g4p_controls.GWindow.keyHandlerMethodName

protected

the name of the method to handle the event

◆ keyHandlerObject

Object g4p_controls.GWindow.keyHandlerObject = null

protected

The object to handle the key event

◆ mouseHandlerMethod

Method g4p_controls.GWindow.mouseHandlerMethod = null

protected

The method in mouseHandlerObject to execute

◆ mouseHandlerMethodName

String g4p_controls.GWindow.mouseHandlerMethodName

protected

the name of the method to handle the event

◆ mouseHandlerObject

Object g4p_controls.GWindow.mouseHandlerObject = null

protected

The object to handle the mouse event

◆ postHandlerMethod

Method g4p_controls.GWindow.postHandlerMethod = null

protected

The method in postHandlerObject to execute

◆ postHandlerMethodName

String g4p_controls.GWindow.postHandlerMethodName

protected

the name of the method to handle the event

◆ postHandlerObject

Object g4p_controls.GWindow.postHandlerObject = null

protected

The object to handle the post event

◆ preHandlerMethod

Method g4p_controls.GWindow.preHandlerMethod = null

protected

The method in preHandlerObject to execute

◆ preHandlerMethodName

String g4p_controls.GWindow.preHandlerMethodName

protected

the name of the method to handle the event

◆ preHandlerObject

Object g4p_controls.GWindow.preHandlerObject = null

protected

The object to handle the pre event

◆ tag

String g4p_controls.GWindow.tag

Simple tag that can be used by the user

◆ tagNo

int g4p_controls.GWindow.tagNo

Allows user to specify a number for this component

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ addData()

◆ addDrawHandler()

◆ addKeyHandler()

◆ addMouseHandler()

◆ addOnCloseHandler()

◆ addPostHandler()

◆ addPreHandler()

◆ addToWindow()

◆ close()

◆ draw()

◆ fireCloseWindowEvent()

◆ forceClose()

◆ getPosition()

◆ getTitle()

◆ getWindow()

◆ initListeners()

◆ isVisible()

◆ keyEvent()

◆ mouseEvent()

◆ performCloseAction()

◆ post()

◆ pre()

◆ prepareWindowForClosure()

◆ registerMethods()

◆ removeFromWindow()

◆ setActionOnClose()

◆ setAlwaysOnTop()

◆ setLocation()

◆ setTitle()

◆ setVisible()

◆ unregisterMethods()

◆ usesGL()

Member Data Documentation

◆ closeHandlerMethodName

◆ closeHandlerObject

◆ closetHandlerMethod

◆ data

◆ drawHandlerMethod

◆ drawHandlerMethodName

◆ drawHandlerObject

◆ keyHandlerMethod

◆ keyHandlerMethodName

◆ keyHandlerObject

◆ mouseHandlerMethod

◆ mouseHandlerMethodName

◆ mouseHandlerObject

◆ postHandlerMethod

◆ postHandlerMethodName

◆ postHandlerObject

◆ preHandlerMethod

◆ preHandlerMethodName

◆ preHandlerObject

◆ tag

◆ tagNo