Inheritance diagram for g4p_controls.GDropList:

[legend]

Public Member Functions
boolean	addItem (String name)

void	buttonShowListHandler (GButton button, GEvent event)

void	draw ()

	GDropList (PApplet theApplet, float p0, float p1, float p2, float p3)

	GDropList (PApplet theApplet, float p0, float p1, float p2, float p3, int listSize)

	GDropList (PApplet theApplet, float p0, float p1, float p2, float p3, int listSize, float buttonWidth)

int	getSelectedIndex ()

String	getSelectedText ()

PGraphics	getSnapshot ()

boolean	insertItem (int idx, String name)

boolean	isOver (float x, float y)

void	mouseEvent (MouseEvent event)

boolean	removeItem (int idx)

void	setItems (List< String > list, int selected)

void	setItems (String[] array, int selected)

void	setLocalColorScheme (int cs)

void	setSelected (int selected)

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 ()

Protected Member Functions
void	loseFocus (GAbstractControl grabber)

void	updateBuffer ()

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)

Protected Attributes
int	currOverItem = lastOverItem

boolean	expanded = false

float	itemHeight

LinkedList< String >	itemlist = new LinkedList<String>()

int	lastOverItem = -1

int	selItem = 0

StyledString	selText

StyledString[]	sitems

int	startItem = 0

int	viewListActualSize = 4

int	viewListSize = VIEW_LIST_DEFAULT_SIZE

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
static final int	BACK_COLOR = 5

static final float	BUTTON_WIDTH = 12

static int	CLOSED_SURFACE = 2

static final int	FORE_COLOR = 2

static final int	ITEM_BACK_COLOR = 6

static final int	ITEM_FORE_COLOR = 3

static int	LIST_SURFACE = 1

static final int	OVER_ITEM_FORE_COLOR = 15

static final int	VIEW_LIST_DEFAULT_SIZE = 4

static final int	VIEW_LIST_MIN_SIZE = 3

Static Protected Attributes inherited from g4p_controls.GAbstractControl
static GAbstractControl	controlToTakeFocus = null

static GAbstractControl	cursorIsOver

static float	epsilon = 0.001f

static GAbstractControl	focusIsWith = null

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

Detailed Description

A drop down list component.

This replaces the GCombo control in pre V3 editions of this library.

The number of items in the list is not restricted but the user can define the maximum number of items to be displayed in the drop list. If there are too many items to display a vertical scroll bar is provide to scroll through all the items.

The vertical size of an individual item is calculated from the overall height specified when creating the control.

Author: Peter Lager

Constructor & Destructor Documentation

◆ GDropList() [1/3]

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

Create a drop down list component with a list size of 4.

IMPORTANT
After creating the control use setItems to initialise the list.

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

◆ GDropList() [2/3]

g4p_controls.GDropList.GDropList	(	PApplet	theApplet,
		float	p0,
		float	p1,
		float	p2,
		float	p3,
		int	listSize
	)

Create a drop down list component with a specified list size.

IMPORTANT
After creating the control use setItems to initialise the list.

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
listSize	the maximum number of element to appear in the drop down list

◆ GDropList() [3/3]

g4p_controls.GDropList.GDropList	(	PApplet	theApplet,
		float	p0,
		float	p1,
		float	p2,
		float	p3,
		int	listSize,
		float	buttonWidth
	)

Create a drop down list component with a specified list size.

The width of the show-list button is constrained between 10pixels and half the control width.

IMPORTANT
After creating the control use setItems to initialise the list.

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
listSize	the maximum number of elements to appear in the drop down list
buttonWidth	the width in pixels for the show-list button

Member Function Documentation

◆ addItem()

boolean g4p_controls.GDropList.addItem ( String name )

Add an item to the end of the list.
No event is fired.

Parameters

name	text of the item to add (null values ignored)

Returns: true if add is successfully added else false

◆ draw()

void g4p_controls.GDropList.draw ( )

Reimplemented from g4p_controls.GAbstractControl.

◆ getSelectedIndex()

int g4p_controls.GDropList.getSelectedIndex ( )

Returns: the index of the selected item

◆ getSelectedText()

String g4p_controls.GDropList.getSelectedText ( )

Returns: the text of the selected item

◆ getSnapshot()

PGraphics g4p_controls.GDropList.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.

◆ insertItem()

boolean g4p_controls.GDropList.insertItem	(	int	idx,
		String	name
	)

Insert an item at the specified position in the list.
If idx is <0 then the list is unchanged.
If idx is ≥ the number of items in the list, it is added to the end.
If idx points to the selected item or an item below it then the selected index value is incremented by 1 but the selected text remains the same.
If idx points to an item above the selected item then the selected item is unchanged.
No event is fired even if the selected index changes.

Parameters

idx	index of the item to remove
name	text of the item to insert (null values ignored)

Returns: true if item is successfully inserted else false

◆ isOver()

boolean g4p_controls.GDropList.isOver	(	float	x,
		float	y
	)

Determines if a particular pixel position is over this control taking into account whether it is collapsed or not.

Parameters

x	the x value for the position to be tested
y	the y value for the position to be tested

Returns: true if [x,y] is over the control else false

◆ loseFocus()

void g4p_controls.GDropList.loseFocus ( GAbstractControl grabber )

protected

For most components there is nothing to do when they lose focus. Override this method in classes that need to do something when they loose focus eg TextField

Reimplemented from g4p_controls.GAbstractControl.

◆ mouseEvent()

void g4p_controls.GDropList.mouseEvent ( MouseEvent event )

Reimplemented from g4p_controls.GAbstractControl.

◆ removeItem()

boolean g4p_controls.GDropList.removeItem ( int idx )

Remove an item from the list.
If idx is not a valid position in the list then the list is unchanged. If idx points to the selected item or an item below it then the selected index value is reduced by 1 but the selected text remains the same.
If idx points to an item above the selected item then the selected item is unchanged.
No event is fired even if the selected index changes.

Parameters

idx	index of the item to remove

Returns: true if item is successfully removed else false

◆ setItems() [1/2]

void g4p_controls.GDropList.setItems	(	List< String >	list,
		int	selected
	)

Use this to set or change the items to appear in the list. If you enter an invalid selection index then it is forced into the valid range.
Null and empty values in the list will be ignored.
If the list is null or empty then then no changes are made.

Parameters

list	the text to appear in the dropdown list elements
selected	the index of the selected element

◆ setItems() [2/2]

void g4p_controls.GDropList.setItems	(	String[]	array,
		int	selected
	)

Use this to set or change the items to appear in the list. If you enter an invalid selection index then it is forced into the valid range.
Null and empty values in the array will be ignored.
If the array is null then or empty then then no changes are made.

Parameters

array	the text to appear in the dropdown list elements
selected	the index of the selected element

◆ setLocalColorScheme()

void g4p_controls.GDropList.setLocalColorScheme ( int cs )

Sets the local colour scheme for this control

Parameters

cs	colour scheme ID

Reimplemented from g4p_controls.GAbstractControl.

◆ setSelected()

void g4p_controls.GDropList.setSelected ( int selected )

Set the currently selected item from the droplist by index position.
Invalid values are ignored.

Parameters

selected the index of the element to be selected

◆ updateBuffer()

void g4p_controls.GDropList.updateBuffer ( )

protected

Reimplemented from g4p_controls.GAbstractControl.

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GDropList() [1/3]

◆ GDropList() [2/3]

◆ GDropList() [3/3]

Member Function Documentation

◆ addItem()

◆ draw()

◆ getSelectedIndex()

◆ getSelectedText()

◆ getSnapshot()

◆ insertItem()

◆ isOver()

◆ loseFocus()

◆ mouseEvent()

◆ removeItem()

◆ setItems() [1/2]

◆ setItems() [2/2]

◆ setLocalColorScheme()

◆ setSelected()

◆ updateBuffer()