g4p_controls.GSlider Class Reference

Inheritance diagram for g4p_controls.GSlider:

Public Member Functions
	GSlider (PApplet theApplet, float p0, float p1, float p2, float p3, float tr_width)
void	setEnabled (boolean enable)
Public Member Functions inherited from g4p_controls.GLinearTrackControl
void	draw ()
float	getTrackOffset ()
String	getValueS ()
	GLinearTrackControl (PApplet theApplet, float p0, float p1, float p2, float p3)
void	mouseEvent (MouseEvent event)
void	setShowTicks (boolean showTicks)
void	setTextOrientation (int orient)
void	setTickLabels (String[] tickLabels)
void	setTrackOffset (float offset)
Public Member Functions inherited from g4p_controls.GValueControl
float	getEasing ()
float	getEndLimit ()
int	getNbrTicks ()
int	getPrecision ()
float	getStartLimit ()
String	getUnit ()
float	getValueF ()
int	getValueI ()
String	getValueS ()
int	getValueType ()
	GValueControl (PApplet theApplet, float p0, float p1, float p2, float p3)
boolean	isShowLimits ()
boolean	isShowTicks ()
boolean	isShowValue ()
boolean	isStickToTicks ()
void	pre ()
void	setEasing (float easeBy)
void	setLimits (float initValue, float start, float end)
void	setLimits (float start, float end)
void	setLimits (int initValue, int start, int end)
void	setLimits (int start, int end)
void	setNbrTicks (int noOfTicks)
void	setNumberFormat (int numberFormat)
void	setNumberFormat (int numberFormat, int precision)
void	setNumberFormat (int numberFormat, int precision, String unit)
void	setPrecision (int nd)
void	setShowDecor (boolean opaque, boolean ticks, boolean value, boolean limits)
void	setShowLimits (boolean showLimits)
void	setShowTicks (boolean showTicks)
void	setShowValue (boolean showValue)
void	setStickToTicks (boolean stickToTicks)
void	setUnits (String units)
void	setValue (float v)
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 ()

Protected Member Functions
void	updateBuffer ()
void	updateDueToValueChanging ()
Protected Member Functions inherited from g4p_controls.GLinearTrackControl
float	calcTrackOffset ()
void	drawLabels (Graphics2D g2d)
void	drawLimits (Graphics2D g2d)
void	drawValue (Graphics2D g2d)
Protected Member Functions inherited from g4p_controls.GValueControl
float	calcParametricTarget (float pt)
float	findNearestTickValueTo (float p)
String	getNumericDisplayString (float number)
void	setEpsilon ()
void	updateDueToValueChanging ()
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.GLinearTrackControl
int	downHotSpot = -1
StyledString[]	labels
boolean	labelsInvalid = true
Font	localFont = G4P.sliderFont
int	status = OFF_CONTROL
int	textOrientation = ORIENT_TRACK
float	trackDisplayLength
float	trackLength
float	trackOffset
float	trackWidth
Protected Attributes inherited from g4p_controls.GValueControl
float	easing = 1.0f
float	endLimit = 1
boolean	limitsInvalid = true
int	nbrTicks = 2
float	offset
float	parametricPos = 0.5f
float	parametricTarget = 0.5f
int	precision = 2
boolean	showLimits = false
boolean	showTicks = false
boolean	showValue = false
StyledString	ssEndLimit
StyledString	ssStartLimit
StyledString	ssValue
float	startLimit = 0
boolean	stickToTicks = false
String	unit = ""
boolean	valueInvalid = true
int	valueType = DECIMAL
float	wheelDelta = WHEEL_DELTA
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.GLinearTrackControl
static int	THUMB_SPOT = 1
static float	TINSET = 2
static int	TRACK_SPOT = 2
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

A simple graphical slider.

Either drag the thumb or click on the track to change the slider value.

Supports
user defined limits (ascending or descending values)
numeric display for limits and current value
track ticks and stick to ticks

Author

Peter Lager

Constructor & Destructor Documentation

GSlider()

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

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
tr_width	the width of the track in pixels

Member Function Documentation

setEnabled()

void g4p_controls.GSlider.setEnabled

(

boolean

enable

)

Enable or disable the ability of the component to generate mouse events.
GTextField - it also controls key press events
GPanel - controls whether the panel can be moved/collapsed/expanded

Parameters

enable

true to enable else false

Reimplemented from g4p_controls.GAbstractControl.

updateBuffer()

void g4p_controls.GSlider.updateBuffer ( )

protected

Reimplemented from g4p_controls.GAbstractControl.

updateDueToValueChanging()

void g4p_controls.GSlider.updateDueToValueChanging ( )

protected

This should be overridden in child classes so they can perform any class specific actions when the value changes. Override this in GSlider to change the hotshot position.

Reimplemented from g4p_controls.GValueControl.