g4p_controls

Class G4P

java.lang.Object

g4p_controls.G4P

All Implemented Interfaces:

GConstants, processing.core.PConstants

public class G4P
extends java.lang.Object
implements GConstants, processing.core.PConstants

The core class for the global manipulation and execution of G4P.
All the methods and constants are static so to call a method or reference a constant prefix it's name with 'G4P.' for example

 G4P.method_name(parameters);
 G4P.name_of_constant;
 

Prior to version 3.5 G4P used logical fonts to be cross-platform, unfortunately logical fonts do not use uniform metrics so it caused serious errors when formatting the text layout. In version 3.5 G4P will attempt to use a system fonts selected from this list
"Arial", "Trebuchet MS", "Tahoma", "Helvetica", "Verdana"
Arial is the preferred font (since most systems will have it installed) but if not found it will attempt to use the next one in the list. If the list is exhausted and no matching system font found it will use a logical font.
If this causes a problem with older sketches simple call

 G4P.usePre35Fonts();
 

before you create any GUI controls.

Author:

Peter Lager

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
G4P()

Method Summary

Methods

Modifier and Type	Method and Description
static GControlMode	getCtrlMode() Get the control creation mode @see ctrlMode(int mode)
static int	getCursor() Get the cursor shape used when the mouse is not over a G4P control set for the
static int	getCursorOff() Deprecated. use getCursor()
static GWindow[]	getOpenWindowsAsArray() Get an array of GWindow objects even if minimised or invisible.
static java.util.ArrayList<GWindow>	getOpenWindowsAsList(java.util.ArrayList<GWindow> list) Get a list of all open GWindow objects even if minimised or invisible.
static java.lang.String	getPrettyVersion() return the pretty version of the library.
static java.lang.String	getVersion() return the version of the library used by Processing
static boolean	isWindowOpen(GWindow window) Use this to check whether a GWindow window is still open (as far as G4P is concerned).
static void	messagesEnabled(boolean enable) G4P has a range of support messages eg if you create a GUI component without an event handler or, a slider where the visible size of the slider is less than the difference between min and max values.
static void	mouseWheelDirection(int dir) Determines how the direction of the mouse wheel rotation is interpreted for sliders and knobs.
static void	mouseWheelScrollbarDirection(int dir) Determines how the direction of the mouse wheel rotation is interpreted for sliders.
static void	registerSketch(processing.core.PApplet app) Used to register the main sketch window with G4P.
static int	selectColor() This will open a version of the Java Swing color chooser dialog.
static int	selectColor(java.awt.Color color) This will open a version of the Java Swing color chooser dialog.
static int	selectColor(int red, int green, int blue) This will open a version of the Java Swing color chooser dialog.
static java.lang.String	selectFolder(java.lang.String prompt) Select a folder from the local file system.
static java.lang.String	selectInput(java.lang.String prompt) Select a file for input from the local file system.
static java.lang.String	selectInput(java.lang.String prompt, java.lang.String startFolder) Select a file for input from the local file system.
static java.lang.String	selectInput(java.lang.String prompt, java.lang.String types, java.lang.String typeDesc) Select a file for input from the local file system.
static java.lang.String	selectInput(java.lang.String prompt, java.lang.String types, java.lang.String typeDesc, java.lang.String startFolder) Select a file for input from the local file system.
static int	selectOption(processing.core.PApplet owner, java.lang.String message, java.lang.String title, int messageType, int optionType) Display a simple message dialog window.
static java.lang.String	selectOutput(java.lang.String prompt) Select a file for output from the local file system.
static java.lang.String	selectOutput(java.lang.String prompt, java.lang.String startFolder) Select a file for output from the local file system.
static java.lang.String	selectOutput(java.lang.String prompt, java.lang.String types, java.lang.String typeDesc) Select a file for output from the local file system.
static java.lang.String	selectOutput(java.lang.String prompt, java.lang.String types, java.lang.String typeDesc, java.lang.String startFolder) Select a file for output from the local file system.
static void	setCtrlMode(GControlMode mode) Change the way position and size parameters are interpreted when a control is created.
static void	setCursor(int cursorOff) Set the cursor shape to be used when the mouse is not over a G4P control for the entire application including secondary windows.
static void	setCursorOff(int cursorOff) Deprecated. use setCursor(int)
static void	setGlobalAlpha(int alpha) Set the transparency of all controls.
static void	setGlobalColorScheme(int cs) Set the global colour scheme.
static void	setMouseOverEnabled(boolean enable) Enables or disables cursor over component change.
static void	setWindowAlpha(processing.core.PApplet app, int alpha) Set the transparency level for all controls drawn by the given PApplet.
static void	setWindowColorScheme(processing.core.PApplet app, int cs) Set the colour scheme for all the controls drawn by the given PApplet.
static void	showMessage(processing.core.PApplet owner, java.lang.String message, java.lang.String title, int messageType) Display a simple message dialog window.
static void	usePre35Fonts() Versions of G4P prior to 3.5 used logical fonts for the controls.

Methods inherited from class java.lang.Object

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

Constructor Detail

G4P

public G4P()

Method Detail

getPrettyVersion

public static java.lang.String getPrettyVersion()

return the pretty version of the library.

getVersion

public static java.lang.String getVersion()

return the version of the library used by Processing

registerSketch

public static void registerSketch(processing.core.PApplet app)

Used to register the main sketch window with G4P. This is ignored if any G4P controls or windows have already been created because the act of creating a control will do this for you.
Some libraries such as PeasyCam change the transformation matrix when initiated. In which case either a G4P control should be created or this method called before creating a PeasyCam object.

Parameters:

app -

setGlobalColorScheme

public static void setGlobalColorScheme(int cs)

Set the global colour scheme. This will change the local colour scheme for every control.

Parameters:

cs - colour scheme to use (0-15)

usePre35Fonts

public static void usePre35Fonts()

Versions of G4P prior to 3.5 used logical fonts for the controls. So if you have old sketches then the text may look different with this and later versions of G4P.
If this is causing a problem then call this method before creating any controls.

setWindowColorScheme

public static void setWindowColorScheme(processing.core.PApplet app,
                        int cs)

Set the colour scheme for all the controls drawn by the given PApplet. This will override any previous colour scheme for these controls.

Parameters:

app -

cs -

setGlobalAlpha

public static void setGlobalAlpha(int alpha)

Set the transparency of all controls. If the alpha level for a control falls below G4P.ALPHA_BLOCK then it will no longer respond to mouse and keyboard events.

Parameters:

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

setWindowAlpha

public static void setWindowAlpha(processing.core.PApplet app,
                  int alpha)

Set the transparency level for all controls drawn by the given PApplet. If the alpha level for a control falls below G4P.ALPHA_BLOCK then it will no longer respond to mouse and keyboard events.

Parameters:

app -

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

setCtrlMode

public static void setCtrlMode(GControlMode mode)

Change the way position and size parameters are interpreted when a control is created. or added to another control e.g. GPanel.
There are 3 modes.

 PApplet.CORNER  (x, y, w, h) 

 PApplet.CORNERS         (x0, y0, x1, y1) 

 PApplet.CENTER  (cx, cy, w, h) 

Parameters:

mode - illegal values are ignored leaving the mode unchanged

getCtrlMode

public static GControlMode getCtrlMode()

Get the control creation mode @see ctrlMode(int mode)

Returns:

the current control mode

messagesEnabled

public static void messagesEnabled(boolean enable)

G4P has a range of support messages eg
if you create a GUI component without an event handler or,
a slider where the visible size of the slider is less than the difference between min and max values.
This method allows the user to enable (default) or disable this option. If disable then it should be called before any GUI components are created.
If you are adding your own event handlers then I suggest that you disable messages.

Parameters:

enable -

setMouseOverEnabled

public static void setMouseOverEnabled(boolean enable)

Enables or disables cursor over component change.
Calls to this method are ignored if no G4P controls have been created.

Parameters:

enable - true to enable cursor change over components.

mouseWheelDirection

public static void mouseWheelDirection(int dir)

Determines how the direction of the mouse wheel rotation is interpreted for sliders and knobs. This value applies to all sliders and knobs.
The default value is FORWARD

Parameters:

dir - FORWARD or REVERSE, illegal values are ignored

mouseWheelScrollbarDirection

public static void mouseWheelScrollbarDirection(int dir)

Determines how the direction of the mouse wheel rotation is interpreted for sliders. This value applies to all sliders.
The default value is FORWARD

Parameters:

dir - FORWARD or REVERSE, illegal values are ignored

setCursorOff

@Deprecated
public static void setCursorOff(int cursorOff)

Deprecated. use setCursor(int)

setCursor

public static void setCursor(int cursorOff)

Set the cursor shape to be used when the mouse is not over a G4P control for the entire application including secondary windows.

Parameters:

cursorOff - the cursor shape.

getCursor

public static int getCursor()

Get the cursor shape used when the mouse is not over a G4P control set for the

getCursorOff

@Deprecated
public static int getCursorOff()

Deprecated. use getCursor()

getOpenWindowsAsList

public static java.util.ArrayList<GWindow> getOpenWindowsAsList(java.util.ArrayList<GWindow> list)

Get a list of all open GWindow objects even if minimised or invisible.
If an ArrayList is provided then its contents are cleared before adding references to all open GWindow objects. If an ArrayList is not provided then a new ArrayList will be created.
This method never returns null, if there are no open windows the list will be of size zero.

Parameters:

list - an optional ArrayList to use. In null will create a new ArrayList.

Returns:

an ArrayList of references to all open GWindow objects.

getOpenWindowsAsArray

public static GWindow[] getOpenWindowsAsArray()

Get an array of GWindow objects even if minimised or invisible.
This method never returns null, if there are no open windows the array will be of length zero.

Returns:

an array of references to all open GWindow objects.

isWindowOpen

public static boolean isWindowOpen(GWindow window)

Use this to check whether a GWindow window is still open (as far as G4P is concerned).

Parameters:

window - the window we are interested in

Returns:

true if G4P still thinks it is open

selectColor

public static int selectColor()

This will open a version of the Java Swing color chooser dialog. The dialog's UI is dependent on the OS and JVM implementation running.
If you click on Cancel then it returns the last color previously selected.

Returns:

the ARGB colour as a 32 bit integer (as used in Processing).

selectColor

public static int selectColor(java.awt.Color color)

This will open a version of the Java Swing color chooser dialog. The dialog's UI is dependent on the OS and JVM implementation running.
If you click on Cancel then it returns the last color previously selected.

Parameters:

color - the color to start the dialog

Returns:

the ARGB colour as a 32 bit integer (as used in Processing).

selectColor

public static int selectColor(int red,
              int green,
              int blue)

This will open a version of the Java Swing color chooser dialog. The dialog's UI is dependent on the OS and JVM implementation running.
If you click on Cancel then it returns the last color previously selected.

Parameters:

red - red channel value (0-255)

green - green channel value (0-255)

blue - red channel value (0-255)

Returns:

the ARGB colour as a 32 bit integer (as used in Processing).

selectFolder

public static java.lang.String selectFolder(java.lang.String prompt)

Select a folder from the local file system.

Parameters:

prompt - the frame text for the chooser

Returns:

the absolute path name for the selected folder, or null if action cancelled.

selectInput

public static java.lang.String selectInput(java.lang.String prompt)

Select a file for input from the local file system.

Parameters:

prompt - the frame text for the chooser

Returns:

the absolute path name for the selected folder, or null if action cancelled.

selectInput

public static java.lang.String selectInput(java.lang.String prompt,
                           java.lang.String startFolder)

Select a file for input from the local file system.

Parameters:

prompt - the frame text for the chooser

startFolder - the location to start the dialog box

Returns:

the absolute path name for the selected folder, or null if action cancelled.

selectInput

public static java.lang.String selectInput(java.lang.String prompt,
                           java.lang.String types,
                           java.lang.String typeDesc)

Select a file for input from the local file system.
This version allows the dialog window to filter the output based on file extensions. This is not available on all platforms, if not then it is ignored.
It is definitely available on Linux systems because it uses the standard Swing JFileFinder component.

Parameters:

prompt - the frame text for the chooser

types - a comma separated list of file extensions e.g. "png,gif,jpg,jpeg"

typeDesc - simple textual description of the file types e.g. "Image files"

Returns:

the absolute path name for the selected folder, or null if action cancelled.

selectInput

public static java.lang.String selectInput(java.lang.String prompt,
                           java.lang.String types,
                           java.lang.String typeDesc,
                           java.lang.String startFolder)

Select a file for input from the local file system.
This version allows the dialog window to filter the output based on file extensions. This is not available on all platforms, if not then it is ignored.
It is definitely available on Linux systems because it uses the standard Swing JFileFinder component.

Parameters:

prompt - the frame text for the chooser

types - a comma separated list of file extensions e.g. "png,gif,jpg,jpeg"

typeDesc - simple textual description of the file types e.g. "Image files"

startFolder - the folder where the dialog starts (uses default if null or not a folder)

Returns:

the absolute path name for the selected folder, or null if action cancelled.

selectOutput

public static java.lang.String selectOutput(java.lang.String prompt)

Select a file for output from the local file system.

Parameters:

prompt - the frame text for the chooser

Returns:

the absolute path name for the selected folder, or null if action is cancelled.

selectOutput

public static java.lang.String selectOutput(java.lang.String prompt,
                            java.lang.String startFolder)

Select a file for output from the local file system.

Parameters:

prompt - the frame text for the chooser

startFolder - the folder where the dialog starts (uses default if null or not a folder)

Returns:

the absolute path name for the selected folder, or null if action is cancelled.

selectOutput

public static java.lang.String selectOutput(java.lang.String prompt,
                            java.lang.String types,
                            java.lang.String typeDesc)

Select a file for output from the local file system.
This version allows the dialog window to filter the output based on file extensions. This is not available on all platforms, if not then it is ignored.
It is definitely available on Linux systems because it uses the standard swing JFileFinder component.

Parameters:

prompt - the frame text for the chooser

types - a comma separated list of file extensions e.g. "png,jpf,tiff"

typeDesc - simple textual description of the file types e.g. "Image files"

Returns:

the absolute path name for the selected folder, or null if action cancelled.

selectOutput

public static java.lang.String selectOutput(java.lang.String prompt,
                            java.lang.String types,
                            java.lang.String typeDesc,
                            java.lang.String startFolder)

Select a file for output from the local file system.
This version allows the dialog window to filter the output based on file extensions. This is not available on all platforms, if not then it is ignored.
It is definitely available on Linux systems because it uses the standard swing JFileFinder component.

Parameters:

prompt - the frame text for the chooser

types - a comma separated list of file extensions e.g. "png,jpf,tiff"

typeDesc - simple textual description of the file types e.g. "Image files"

startFolder - the folder where the dialog starts (uses default if null or not a folder)

Returns:

the absolute path name for the selected folder, or null if action cancelled.

showMessage

public static void showMessage(processing.core.PApplet owner,
               java.lang.String message,
               java.lang.String title,
               int messageType)

Display a simple message dialog window.
The actual UI will depend on the platform your application is running on.
The message type should be one of the following
G4P.PLAIN, G4P.ERROR, G4P.INFO, G4P.WARNING, G4P.QUERY

Parameters:

owner - the control responsible for this dialog.

message - the text to be displayed in the main area of the dialog

title - the text to appear in the dialog's title bar.

messageType - the message type

selectOption

public static int selectOption(processing.core.PApplet owner,
               java.lang.String message,
               java.lang.String title,
               int messageType,
               int optionType)

Display a simple message dialog window.
The actual UI will depend on the platform your application is running on.
The message type should be one of the following
G4P.PLAIN, G4P.ERROR, G4P.INFO, G4P.WARNING, G4P.QUERY
The option type should be one of the following
G4P.YES_NO, G4P.YES_NO_CANCEL, G4P.OK_CANCEL
This method returns a value to indicate which button was clicked. It will be one of the following
G4P.OK, G4P.YES, G4P.NO, G4P.CANCEL, G4P.CLOSED
Some comments on the returned value:

• G4P.OK and G4P.YES have the same integer value so can be used interchangeably.
• G4P.CLOSED maybe returned if the dialog box is closed although on some systems G4P.NO or G4P.CANCEL may be returned instead.
• It is better to test for a positive response because they have the same value.
• If you must test for a negative response use !G4P.OK or !G4P.YES

Parameters:

owner - the control responsible for this dialog.

message - the text to be displayed in the main area of the dialog

title - the text to appear in the dialog's title bar.

messageType - the message type

optionType -

Returns:

which button was clicked