G4P (GUI for Processing)  4.3.8
A set of GUI controls for your Processing sketch.
 All Classes Functions Variables Pages
g4p_controls.GDropList Class Reference
Inheritance diagram for g4p_controls.GDropList:

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 (String[] array, int selected)
 
void setItems (List< String > list, 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 setTextBold (int start, int end)
 
void setTextBold ()
 
void setTextItalic (int start, int end)
 
void setTextItalic ()
 
void setTextPlain ()
 
- Public Member Functions inherited from g4p_controls.GAbstractControl
void addControl (GAbstractControl c, float x, float y, float angle)
 
void addControl (GAbstractControl c, float x, float y)
 
void addControl (GAbstractControl c)
 
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 ()
 
PGraphics getSnapshot ()
 
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 ()
 
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 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)
 
- Protected Member Functions inherited from g4p_controls.GAbstractControl
void addToParent (GAbstractControl p)
 
void calcTransformedOrigin (float px, float py)
 
void createEventHandler (Object handlerObj, String methodName, Class[] param_classes, String[] param_names)
 
void fireEvent (Object...objects)
 
int focusObjectZ ()
 
PGraphics getBuffer ()
 
int getCurrHotSpot ()
 
AffineTransform getTransform (AffineTransform aff)
 
boolean isAvailable ()
 
boolean isDisplayable (int ascii)
 
boolean isSuitableForGroupControl (GAbstractControl control)
 
void loseFocus (GAbstractControl grabber)
 
void makeBuffer ()
 
void resize (int w, int h)
 
void setAvailable (boolean avail)
 
void setTextRenderingHints (Graphics2D g2d, int hint)
 
void setZ (int parentZ)
 
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
 
StyledString stext = new StyledString("")
 
- Protected Attributes inherited from g4p_controls.GAbstractControl
int alphaLevel = G4P.globalAlpha
 
PGraphicsJava2D buffer = null
 
boolean bufferInvalid = true
 
LinkedList< GAbstractControlchildren = null
 
int currSpot = -1
 
int cursorOver = HAND
 
float cx
 
boolean dragging = false
 
Method eventHandlerMethod = null
 
String eventHandlerMethodName
 
Object eventHandlerObject = null
 
float halfWidth
 
HotSpot[] hotspots = null
 
int localColorScheme = G4P.globalColorScheme
 
boolean opaque = false
 
float ox
 
Color[] palette = null
 
GAbstractControl parent = null
 
int registeredMethods = 0
 
float rotAngle
 
double[] temp = new double[2]
 
float width
 
PApplet winApp
 
float x
 
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 float epsilon = 0.001f
 

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
 
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
 
- Public Attributes inherited from g4p_controls.GConstantsInternal
int ALL_METHOD = 0x0000001f
 
int CLIP_RUN = 512
 
int COMBI_MODES = 768
 
String DEFAULT_SLIDER_STYLE = "grey_blue"
 
int DRAG_CONTROL = 3
 
int DRAW_METHOD = 0x00000001
 
char EOL = '\n'
 
int EXCP_IN_HANDLER = 0xff000005
 
int[][] grid
 
int GROUP_CONTROL_METHOD = DRAW_METHOD | MOUSE_METHOD | KEY_METHOD
 
int I_CL = 4
 
int I_COVERED = 32
 
int I_CR = 8
 
int I_INSIDE = 16
 
int I_MODES = 63
 
int I_NONE = 0
 
int I_TL = 1
 
int I_TR = 2
 
int INVALID_PAPPLET = 0xff000004
 
int INVALID_TYPE = 0xff000003
 
int KEY_METHOD = 0x00000008
 
int MERGE_RUNS = 256
 
int MISSING = 0xff000001
 
int MOUSE_METHOD = 0x00000002
 
int NONEXISTANT = 0xff000002
 
int OFF_CONTROL = 0
 
int OVER_CONTROL = 1
 
BasicStroke pen_1_0 = new BasicStroke(1, BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND)
 
BasicStroke pen_2_0 = new BasicStroke(2, BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND)
 
BasicStroke pen_3_0 = new BasicStroke(3, BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND)
 
BasicStroke pen_4_0 = new BasicStroke(4, BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND)
 
int POST_METHOD = 0x00000010
 
int PRE_METHOD = 0x00000004
 
int PRESS_CONTROL = 2
 
int SCROLLBAR_HORIZONTAL = GConstants.SCROLLBARS_HORIZONTAL_ONLY
 
int SCROLLBAR_VERTICAL = GConstants.SCROLLBARS_VERTICAL_ONLY
 
String SLIDER_STYLES = "|grey_blue|blue18px|green_red20px|purple18px|red_yellow18px|"
 
int TINT_FOR_ALPHA = 255
 
int TPAD2 = 2
 
int TPAD4 = 4
 
int TPAD6 = 6
 
int TPAD8 = 8
 
float WHEEL_DELTA = 0.01f
 
float WHEEL_STICK_FACTOR = 0.51f
 
int Z_PANEL = 1024
 
int Z_SLIPPY = 24
 
int Z_SLIPPY_EXPANDS = 48
 
int Z_STICKY = 0
 

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

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
theAppletthe main sketch or GWindow control for this control
p0x position based on control mode
p1y position based on control mode
p2x position or width based on control mode
p3y position or height based on control mode
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
theAppletthe main sketch or GWindow control for this control
p0x position based on control mode
p1y position based on control mode
p2x position or width based on control mode
p3y position or height based on control mode
listSizethe maximum number of element to appear in the drop down list
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
theAppletthe main sketch or GWindow control for this control
p0x position based on control mode
p1y position based on control mode
p2x position or width based on control mode
p3y position or height based on control mode
listSizethe maximum number of elements to appear in the drop down list
buttonWidththe width in pixels for the show-list button

Member Function Documentation

boolean g4p_controls.GDropList.addItem ( String  name)

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

Parameters
nametext of the item to add (null values ignored)
Returns
true if add is successfully added else false
int g4p_controls.GDropList.getSelectedIndex ( )
Returns
the index of the selected item
String g4p_controls.GDropList.getSelectedText ( )
Returns
the text of the selected item
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
idxindex of the item to remove
nametext of the item to insert (null values ignored)
Returns
true if item is successfully inserted else false
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
xthe x value for the position to be tested
ythe y value for the position to be tested
Returns
true if [x,y] is over the control else false
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

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
idxindex of the item to remove
Returns
true if item is successfully removed else false
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
arraythe text to appear in the dropdown list elements
selectedthe index of the selected element
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
listthe text to appear in the dropdown list elements
selectedthe index of the selected element
void g4p_controls.GDropList.setLocalColorScheme ( int  cs)

Sets the local colour scheme for this control

Parameters
cscolour scheme ID
void g4p_controls.GDropList.setSelected ( int  selected)

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

Parameters
selectedthe index of the element to be selected