g4p_controls.GSpinner Class Reference

Inheritance diagram for g4p_controls.GSpinner:

Public Member Functions
boolean	dec ()
void	draw ()
PGraphics	getSnapshot ()
int	getValue ()
	GSpinner (PApplet theApplet, float p0, float p1, float p2, float p3)
	GSpinner (PApplet theApplet, float p0, float p1, float p2, float p3, float buttonWidth)
void	handleDec (GButton button, GEvent event)
void	handleInc (GButton button, GEvent event)
boolean	inc ()
void	keyEvent (KeyEvent e)
void	mouseEvent (MouseEvent event)
void	pre ()
void	setLimits (int init, int low, int high, int delta)
void	setStyledText (StyledString ss)
void	setText (String text)
void	setValue (int newValue)
Public Member Functions inherited from g4p_controls.GEditableTextControl
void	addStyle (TextAttribute attr, Object value)
void	addStyle (TextAttribute attr, Object value, int charStart, int charEnd)
void	cancelSelection ()
void	clearSelectionStyle ()
void	clearStyles ()
void	clearStyles (int charStart, int charEnd)
void	dispose ()
void	flashCaret (GTimer timer)
	GEditableTextControl (PApplet theApplet, float p0, float p1, float p2, float p3)
	GEditableTextControl (PApplet theApplet, float p0, float p1, float p2, float p3, int scrollbars)
String	getPromptText ()
String	getSelectedText ()
StyledString	getStyledText ()
String	getText ()
int	getWrapWidth ()
boolean	hasSelection ()
void	hsbEventHandler (GScrollbar scrollbar, GEvent event)
boolean	isTextEditEnabled ()
void	keyEvent (KeyEvent e)
boolean	loadText (String fname)
boolean	saveText (String fname)
void	setFocus (boolean focus)
void	setFont (Font font)
void	setJustify (boolean justify)
void	setLocalColorScheme (int cs)
void	setPromptText (String ptext)
void	setSelectedTextStyle (TextAttribute style, Object value)
void	setTabManager (GTabManager tm)
void	setTextEditEnabled (boolean enableTextEdit)
void	setWrapWidth (int wrapWidth)
void	vsbEventHandler (GScrollbar scrollbar, GEvent event)
Public Member Functions inherited from g4p_controls.GTextBase
void	forceBufferUpdate ()
StyledString	getStyledText ()
String	getText ()
	GTextBase (PApplet theApplet, float p0, float p1, float p2, float p3)
boolean	loadText (String fname)
boolean	saveText (String fname)
void	setFont (Font font)
void	setStyledText (StyledString ss)
void	setText (String text)
void	setText (String text, GAlign horz, GAlign vert)
void	setTextAlign (GAlign horz, GAlign vert)
void	setTextBold ()
void	setTextBold (int start, int end)
void	setTextItalic ()
void	setTextItalic (int start, int end)
void	setTextPlain ()
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 ()
void	setTabManager (GTabManager tm)

Protected Member Functions
boolean	changeText ()
void	keyPressedProcess (int keyCode, char keyChar, boolean shiftDown, boolean ctrlDown)
void	keyTypedProcess (int keyCode, char keyChar, boolean shiftDown, boolean ctrlDown)
void	loseFocus (GAbstractControl grabber)
void	updateBuffer ()
Protected Member Functions inherited from g4p_controls.GEditableTextControl
void	calculateCaretPos (TextLayoutHitInfo tlhi)
boolean	changeText ()
float	getScrollAmount ()
void	keyPressedProcess (int keyCode, char keyChar, boolean shiftDown, boolean ctrlDown)
void	keyTypedProcess (int keyCode, char keyChar, boolean shiftDown, boolean ctrlDown)
void	loseFocus (GAbstractControl grabber)
boolean	moveCaretEndOfLine (TextLayoutHitInfo currPos)
boolean	moveCaretLeft (TextLayoutHitInfo currPos)
boolean	moveCaretRight (TextLayoutHitInfo currPos)
boolean	moveCaretStartOfLine (TextLayoutHitInfo currPos)
void	takeFocus ()
Protected Member Functions inherited from g4p_controls.GTextBase
void	addAttributeImpl (TextAttribute style, Object value)
void	addAttributeImpl (TextAttribute style, Object value, int s, int e)
void	calcTextZone ()
void	displayText (Graphics2D g2d, LinkedList< TextLayoutInfo > lines)
void	displayText (Graphics2D g2d, LinkedList< TextLayoutInfo > lines, Color fore)
void	resizeToFit ()
void	resizeToFit (GControlMode mode)
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)

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 Attributes inherited from g4p_controls.GEditableTextControl
int	adjust = 0
boolean	autoHide = false
GTimer	caretFlasher
float	caretX
float	caretY
int	endChar = -1
TextLayoutHitInfo	endTLHI = new TextLayoutHitInfo()
GeneralPath	gpTextDisplayArea
GScrollbar	hsb
boolean	keepCursorInView = false
int	nbr = 0
int	pos = endChar
StyledString	promptText = null
float	ptx
float	pty
final int	scrollbarPolicy
boolean	selectionChanged = false
boolean	showCaret = false
int	startChar = -1
TextLayoutHitInfo	startTLHI = new TextLayoutHitInfo()
boolean	textChanged = false
float	th
float	tw
float	tx
float	ty
GScrollbar	vsb
int	wrapWidth = Integer.MAX_VALUE
Protected Attributes inherited from g4p_controls.GTextBase
Font	localFont = G4P.displayFont
float	PAD = 2
StyledString	stext = new StyledString("")
GAlign	textAlignH = GAlign.LEFT
GAlign	textAlignV = GAlign.MIDDLE
Zone	textZone = new Zone()
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

The spinner control can be used to enter any positive or negative integer value either through the keyboard, the up/down spinner buttons or the mouse wheel when over the control.

After creating the spinner the user can set the initial value to display and the minimum and maximum permitted values. The user also specifies the increment/decrement value to apply when using the spinner buttons or mouse wheel to change the value.

When entering numbers from the keyboard the - key can be pressed at any time to negate the current value.

Author

Peter Lager

Constructor & Destructor Documentation

GSpinner() [1/2]

g4p_controls.GSpinner.GSpinner	(	PApplet	theApplet,
		float	p0,
		float	p1,
		float	p2,
		float	p3
	)

Create a spinner control that accepts user keyboard input.
The button width will be 16px

Parameters

theApplet	the main sketch or GWindow control for this control
p0	x position based on control mode
p1	y position based on control mode
p2	x position or width based on control mode
p3	y position or height based on control mode
buttonWidth	the width of the spinner buttons

GSpinner() [2/2]

g4p_controls.GSpinner.GSpinner	(	PApplet	theApplet,
		float	p0,
		float	p1,
		float	p2,
		float	p3,
		float	buttonWidth
	)

Create a spinner control that accepts user keyboard input.
The button width must be ≥ 16 px

Parameters

theApplet	the main sketch or GWindow control for this control
p0	x position based on control mode
p1	y position based on control mode
p2	x position or width based on control mode
p3	y position or height based on control mode
buttonWidth	the width of the spinner buttons

Member Function Documentation

changeText()

boolean g4p_controls.GSpinner.changeText ( )

protected

Reimplemented from g4p_controls.GEditableTextControl.

dec()

boolean g4p_controls.GSpinner.dec

(

)

Decrement the current value. It will be constrained to the current range limits

Returns

true if the value changes

draw()

void g4p_controls.GSpinner.draw

(

)

Reimplemented from g4p_controls.GAbstractControl.

getSnapshot()

PGraphics g4p_controls.GSpinner.getSnapshot

(

)

This method should be used sparingly since it is heavy on resources.

Returns

a PGraphics object showing current state of the control (ignoring rotation)

Reimplemented from g4p_controls.GAbstractControl.

getValue()

int g4p_controls.GSpinner.getValue

(

)

Returns

the current value

handleDec()

void g4p_controls.GSpinner.handleDec	(	GButton	button,
		GEvent	event
	)

Do not call this method instead use dec()
This method is used internally by the spinner button.

handleInc()

void g4p_controls.GSpinner.handleInc	(	GButton	button,
		GEvent	event
	)

Do not call this method instead use inc()

inc()

boolean g4p_controls.GSpinner.inc

(

)

Increment the current value. It will be constrained to the current range limits

Returns

true if the value changes

keyEvent()

void g4p_controls.GSpinner.keyEvent

(

KeyEvent

e

)

Reimplemented from g4p_controls.GEditableTextControl.

keyPressedProcess()

void g4p_controls.GSpinner.keyPressedProcess ( int  keyCode, char  keyChar, boolean  shiftDown, boolean  ctrlDown  )

protected

Reimplemented from g4p_controls.GEditableTextControl.

keyTypedProcess()

void g4p_controls.GSpinner.keyTypedProcess ( int  keyCode, char  keyChar, boolean  shiftDown, boolean  ctrlDown  )

protected

Reimplemented from g4p_controls.GEditableTextControl.

loseFocus()

void g4p_controls.GSpinner.loseFocus ( GAbstractControl  grabber )

protected

Give up focus but if the text is only made from spaces then set it to null text.
Fire focus events for the GTextField and GTextArea controls

Reimplemented from g4p_controls.GEditableTextControl.

mouseEvent()

void g4p_controls.GSpinner.mouseEvent

(

MouseEvent

event

)

Reimplemented from g4p_controls.GAbstractControl.

pre()

void g4p_controls.GSpinner.pre

(

)

Reimplemented from g4p_controls.GAbstractControl.

setLimits()

void g4p_controls.GSpinner.setLimits	(	int	init,
		int	low,
		int	high,
		int	delta
	)

Set the limits for this spinner control.
The range limits are swapped if high &lt low
The initial value will be constrained to the range ≥ low and ≤ high.
The increment / decrement value will not be allowed to exceed the range i.e. high - low

Parameters

init	the initial value to display
low	the lowest valid value
high	the highest valid value
delta	the inc/decrement value

setStyledText()

void g4p_controls.GSpinner.setStyledText

(

StyledString

ss

)

This method is ignored for this control

Reimplemented from g4p_controls.GTextBase.

setText()

void g4p_controls.GSpinner.setText

(

String

text

)

This method is ignored for this control

Reimplemented from g4p_controls.GTextBase.

setValue()

void g4p_controls.GSpinner.setValue

(

int

newValue

)

Sets the current value to be displayed. It will be constrained to the current range limits.

Parameters

v	the new value to display

updateBuffer()

void g4p_controls.GSpinner.updateBuffer ( )

protected

If the buffer is invalid then redraw it.

@TODO need to use palette for colours

Reimplemented from g4p_controls.GAbstractControl.