g4p_controls

Class GDropList

java.lang.Object

g4p_controls.GAbstractControl

g4p_controls.GTextBase

g4p_controls.GDropList

All Implemented Interfaces:

GConstants, processing.core.PConstants

public class GDropList
extends GTextBase

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

Nested Class Summary

Nested classes/interfaces inherited from class g4p_controls.GAbstractControl

GAbstractControl.Z_Order

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL_METHOD
static int	CLIP_RUN
static int	COMBI_MODES
static java.lang.String	DEFAULT_SLIDER_STYLE
static int	DRAG_CONTROL
static int	DRAW_METHOD
static char	EOL
static int	EXCP_IN_HANDLER
static int[][]	grid
static int	GROUP_CONTROL_METHOD
static int	I_CL
static int	I_COVERED
static int	I_CR
static int	I_INSIDE
static int	I_MODES
static int	I_NONE
static int	I_TL
static int	I_TR
static int	INVALID_PAPPLET
static int	INVALID_TYPE
static int	KEY_METHOD
static int	MERGE_RUNS
static int	MISSING
static int	MOUSE_METHOD
static int	NONEXISTANT
static int	OFF_CONTROL
static int	OVER_CONTROL
static java.awt.BasicStroke	pen_1_0
static java.awt.BasicStroke	pen_2_0
static java.awt.BasicStroke	pen_3_0
static java.awt.BasicStroke	pen_4_0
static int	POST_METHOD
static int	PRE_METHOD
static int	PRESS_CONTROL
static int	SCROLLBAR_HORIZONTAL
static int	SCROLLBAR_VERTICAL
static java.lang.String	SLIDER_STYLES
static int	TINT_FOR_ALPHA
static int	TPAD2
static int	TPAD4
static int	TPAD6
static int	TPAD8
static float	WHEEL_DELTA
static float	WHEEL_STICK_FACTOR
static int	Z_PANEL
static int	Z_SLIPPY
static int	Z_SLIPPY_EXPANDS
static int	Z_STICKY

Fields inherited from class g4p_controls.GAbstractControl

tag, tagNo

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

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

Constructor Summary

Constructors

Constructor and Description
GDropList(processing.core.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.
GDropList(processing.core.PApplet theApplet, float p0, float p1, float p2, float p3, int viewListMaxSize) Create a drop down list component with a specified list size.
GDropList(processing.core.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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addItem(java.lang.String name) Add an item to the end of the list.
void	buttonShowListHandler(GButton button, GEvent event) This method should not be called by the user.
void	draw()
int	getSelectedIndex() Get the index position of the selected item
java.lang.String	getSelectedText() Get the text for the selected item
processing.core.PGraphics	getSnapshot() This method should be used sparingly since it is heavy on resources.
boolean	insertItem(int idx, java.lang.String name) Insert an item at the specified position in the list.
boolean	isOver(float x, float y) Determines if a particular pixel position is over this control taking into account whether it is collapsed or not.
void	mouseEvent(processing.event.MouseEvent event)
boolean	removeItem(int idx) Remove an item from the list.
void	setItems(java.util.List<java.lang.String> list, int selected)
void	setItems(java.lang.String[] array, int selected) Use this to set or change the list of items to appear in the list.
void	setLocalColorScheme(int cs) Sets the local colour scheme for this control
void	setSelected(int selected) Set the currently selected item from the droplist by index position.
void	vsbEventHandler(g4p_controls.GScrollbar scrollbar, GEvent event) This method should not be called by the user.

Methods inherited from class g4p_controls.GTextBase

forceBufferUpdate, getStyledText, getText, loadText, saveText, setFont, setStyledText, setText, setTextBold, setTextBold, setTextItalic, setTextItalic, setTextPlain

Methods inherited from class g4p_controls.GAbstractControl

addControl, addControl, addControl, addControls, addEventHandler, dispose, getCursorOver, getCX, getCY, getHeight, getLocalColorScheme, getPApplet, getParent, getWidth, getX, getY, hasFocus, isDragging, isEnabled, isOpaque, isVisible, keyEvent, markForDisposal, moveTo, moveTo, post, pre, saveSnapshot, saveSnapshot, setAlpha, setAlpha, setCursorOver, setEnabled, setFocus, setLocalColor, setLocalColorScheme, setOpaque, setRotation, setRotation, setVisible, toString

Methods inherited from class java.lang.Object

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

Field Detail

SLIDER_STYLES

public static final java.lang.String SLIDER_STYLES

See Also:

Constant Field Values

DEFAULT_SLIDER_STYLE

public static final java.lang.String DEFAULT_SLIDER_STYLE

See Also:

Constant Field Values

DRAW_METHOD

public static final int DRAW_METHOD

See Also:

Constant Field Values

MOUSE_METHOD

public static final int MOUSE_METHOD

See Also:

Constant Field Values

PRE_METHOD

public static final int PRE_METHOD

See Also:

Constant Field Values

KEY_METHOD

public static final int KEY_METHOD

See Also:

Constant Field Values

POST_METHOD

public static final int POST_METHOD

See Also:

Constant Field Values

ALL_METHOD

public static final int ALL_METHOD

See Also:

Constant Field Values

GROUP_CONTROL_METHOD

public static final int GROUP_CONTROL_METHOD

See Also:

Constant Field Values

MISSING

public static final int MISSING

See Also:

Constant Field Values

NONEXISTANT

public static final int NONEXISTANT

See Also:

Constant Field Values

INVALID_TYPE

public static final int INVALID_TYPE

See Also:

Constant Field Values

INVALID_PAPPLET

public static final int INVALID_PAPPLET

See Also:

Constant Field Values

EXCP_IN_HANDLER

public static final int EXCP_IN_HANDLER

See Also:

Constant Field Values

OFF_CONTROL

public static final int OFF_CONTROL

See Also:

Constant Field Values

OVER_CONTROL

public static final int OVER_CONTROL

See Also:

Constant Field Values

PRESS_CONTROL

public static final int PRESS_CONTROL

See Also:

Constant Field Values

DRAG_CONTROL

public static final int DRAG_CONTROL

See Also:

Constant Field Values

TINT_FOR_ALPHA

public static final int TINT_FOR_ALPHA

See Also:

Constant Field Values

I_NONE

public static final int I_NONE

See Also:

Constant Field Values

I_TL

public static final int I_TL

See Also:

Constant Field Values

I_TR

public static final int I_TR

See Also:

Constant Field Values

I_CL

public static final int I_CL

See Also:

Constant Field Values

I_CR

public static final int I_CR

See Also:

Constant Field Values

I_INSIDE

public static final int I_INSIDE

See Also:

Constant Field Values

I_COVERED

public static final int I_COVERED

See Also:

Constant Field Values

I_MODES

public static final int I_MODES

See Also:

Constant Field Values

MERGE_RUNS

public static final int MERGE_RUNS

See Also:

Constant Field Values

CLIP_RUN

public static final int CLIP_RUN

See Also:

Constant Field Values

COMBI_MODES

public static final int COMBI_MODES

See Also:

Constant Field Values

grid

public static final int[][] grid

pen_1_0

public static final java.awt.BasicStroke pen_1_0

pen_2_0

public static final java.awt.BasicStroke pen_2_0

pen_3_0

public static final java.awt.BasicStroke pen_3_0

pen_4_0

public static final java.awt.BasicStroke pen_4_0

TPAD2

public static final int TPAD2

See Also:

Constant Field Values

TPAD4

public static final int TPAD4

See Also:

Constant Field Values

TPAD6

public static final int TPAD6

See Also:

Constant Field Values

TPAD8

public static final int TPAD8

See Also:

Constant Field Values

SCROLLBAR_VERTICAL

public static final int SCROLLBAR_VERTICAL

See Also:

Constant Field Values

SCROLLBAR_HORIZONTAL

public static final int SCROLLBAR_HORIZONTAL

See Also:

Constant Field Values

WHEEL_DELTA

public static final float WHEEL_DELTA

See Also:

Constant Field Values

WHEEL_STICK_FACTOR

public static final float WHEEL_STICK_FACTOR

See Also:

Constant Field Values

EOL

public static final char EOL

See Also:

Constant Field Values

Z_STICKY

public static final int Z_STICKY

See Also:

Constant Field Values

Z_SLIPPY

public static final int Z_SLIPPY

See Also:

Constant Field Values

Z_SLIPPY_EXPANDS

public static final int Z_SLIPPY_EXPANDS

See Also:

Constant Field Values

Z_PANEL

public static final int Z_PANEL

See Also:

Constant Field Values

Constructor Detail

GDropList

public GDropList(processing.core.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 applet that will display this component.

p0 -

p1 -

p2 -

p3 -

GDropList

public GDropList(processing.core.PApplet theApplet,
         float p0,
         float p1,
         float p2,
         float p3,
         int viewListMaxSize)

Create a drop down list component with a specified list size.
IMPORTANT
After creating the control use setItems to initialise the list.

Parameters:

theApplet -

p0 -

p1 -

p2 -

p3 -

viewListMaxSize - the maximum number of element to appear in the drop down list

GDropList

public GDropList(processing.core.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 -

p0 -

p1 -

p2 -

p3 -

listSize - the maximum number of elements to appear in the drop down list

buttonWidth - the width in pixels for the show-list button

Method Detail

setItems

public void setItems(java.lang.String[] array,
            int selected)

Use this to set or change the list of 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 then or empty then then no changes are made.

Parameters:

array -

selected -

setItems

public void setItems(java.util.List<java.lang.String> list,
            int selected)

removeItem

public boolean 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

insertItem

public boolean insertItem(int idx,
                 java.lang.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

addItem

public boolean addItem(java.lang.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

setSelected

public void setSelected(int selected)

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

Parameters:

selected -

getSelectedIndex

public int getSelectedIndex()

Get the index position of the selected item

getSelectedText

public java.lang.String getSelectedText()

Get the text for the selected item

setLocalColorScheme

public void setLocalColorScheme(int cs)

Sets the local colour scheme for this control

Overrides:

setLocalColorScheme in class GAbstractControl

Parameters:

cs - the colour scheme to use (0-15 incl.)

isOver

public boolean isOver(float x,
             float y)

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

Overrides:

isOver in class GAbstractControl

Returns:

true if the position is over.

mouseEvent

public void mouseEvent(processing.event.MouseEvent event)

Overrides:

mouseEvent in class GAbstractControl

draw

public void draw()

Overrides:

draw in class GAbstractControl

getSnapshot

public processing.core.PGraphics getSnapshot()

Description copied from class: GAbstractControl

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

Overrides:

getSnapshot in class GAbstractControl

Returns:

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

vsbEventHandler

public void vsbEventHandler(g4p_controls.GScrollbar scrollbar,
                   GEvent event)

This method should not be called by the user. It is for internal library use only.

buttonShowListHandler

public void buttonShowListHandler(GButton button,
                         GEvent event)

This method should not be called by the user. It is for internal library use only.