g4p_controls.GCScheme Class Reference

Inheritance diagram for g4p_controls.GCScheme:

Static Public Member Functions
static void	changePalette (int schemeNbr, int[] colors)
static void	changePaletteColor (int schemeNbr, int colorNbr, int color)
static void	copyPalette (int srcSchemeNbr, int dstSchemeNbr)
static Color[]	getJavaColor (int schemeNo)
static int[]	getPalette (int schemeNbr)
static void	makeColorSchemes ()
static void	savePalettes (PApplet app)
static void	savePalettes (PApplet app, String filename)

Static Protected Member Functions
static void	makeColorSchemes (PApplet app)

Additional Inherited Members
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

Detailed Description

Defines a number of color schemes for the GUI components.
G4P supports 16 colour schemes and each scheme has a palette of 16 colours.

When G4P is used it loads an image file with all the colors used by the various colour schemes.
First it will search for a file containing a user defined scheme (user_gui_palette.png) and if it can't find it, will use the library default scheme (default_gui_palette.png).

Author

Peter Lager

Member Function Documentation

changePalette()

static void g4p_controls.GCScheme.changePalette ( int  schemeNbr, int[]  colors  )

static

Change a colour scheme to use the colours passed in the third parameter.
Colour scheme numbers 0-7 inclusive are the default colour schemes and schemes 8-15 inclusive are undefined by G4P.
This method will override the previous scheme and will affect all controls using the scheme.

Parameters

schemeNbr	the scheme number
colors	the colours to use in this palette.

changePaletteColor()

static void g4p_controls.GCScheme.changePaletteColor ( int  schemeNbr, int  colorNbr, int  color  )

static

Change a single colour within an existing scheme

Parameters

schemeNbr	the scheme number
colorNbr	the palette index number for the colour
color	ARGB colour value

copyPalette()

static void g4p_controls.GCScheme.copyPalette ( int  srcSchemeNbr, int  dstSchemeNbr  )

static

Copies the colours from the source scheme to the destination scheme.

Parameters

srcSchemeNbr	source scheme number (0-15)
dstSchemeNbr	destination scheme number (0-15)

getJavaColor()

static Color[] g4p_controls.GCScheme.getJavaColor ( int  schemeNo )

static

DO NOT CALL THIS METHOD

This method is only to be used by GUI Builder.

Parameters

schemeNo

the colour scheme ID

Returns

an array of java.awt.Color values that make up the colour scheme.

getPalette()

static int[] g4p_controls.GCScheme.getPalette ( int  schemeNbr )

static

Set the color scheme to one of the preset schemes BLUE / GREEN / RED / PURPLE / YELLOW / CYAN / BROWN or if you have created your own schemes following the instructions at gui4processing.lagers.org.uk/colorscheme.html then you can enter the appropriate numeric value of the scheme.

Parameters

schemeNbr

scheme number (0-15)

Returns

the color scheme based on the scheme number

makeColorSchemes() [1/2]

static void g4p_controls.GCScheme.makeColorSchemes ( )

static

DO NOT CALL THIS METHOD

This method is only to be used by GUI Builder.

makeColorSchemes() [2/2]

static void g4p_controls.GCScheme.makeColorSchemes ( PApplet  app )

staticprotected

Called every time we create a control. The palettes will be made when the first control is created.

This method is called by

Parameters

app	the PApplet using this scheme

savePalettes() [1/2]

static void g4p_controls.GCScheme.savePalettes ( PApplet  app )

static

Save the current colour schemes as an image in the sketch's data folder. The file will be called

"user_gui_palette.png"

Parameters

app	the PApplet object

savePalettes() [2/2]

static void g4p_controls.GCScheme.savePalettes ( PApplet  app, String  filename  )

static

Save the current colour schemes as an image in the sketch's data folder.

Parameters

app	the PApplet object
filename	the name of the image file to use