controlP5
Class DropdownList

java.lang.Object
  controlP5.ControllerGroup
      controlP5.ControlGroup
          controlP5.DropdownList

All Implemented Interfaces:

ControllerInterface, ControlListener, ControlP5Constants

public class DropdownList
extends ControlGroup

Field Summary

Fields inherited from interface controlP5.ControlP5Constants

acceptClassList, ACTION_BROADCAST, ACTION_ENTER, ACTION_LEAVE, ACTION_PRESSED, ACTION_RELEASED, ACTION_RELEASEDOUTSIDE, ACTIVE, ALL, ALT, ARC, ARRAY, BACKSPACE, BASELINE, BITFONT, BOOLEAN, BOTTOM, BOTTOM_OUTSIDE, CAPTIONLABEL, CENTER, COMMANDKEY, CONTROL, controlEventClass, CUSTOM, DECREASE, DEFAULT, DELETE, DONE, DOWN, ELLIPSE, ENTER, ESCAPE, EVENT, eventMethod, FADEIN, FADEOUT, FIELD, FLOAT, HALF_PI, HIDE, HIGHLIGHT, HORIZONTAL, IDLE, IMAGE, INACTIVE, INCREASE, INTEGER, INVALID, KEYCONTROL, LEFT, LEFT_OUTSIDE, LINE, LOAD, MENU, METHOD, MOVE, MULTIPLES, OVER, PI, PRESSED, PRINT, RELEASE, RESET, RIGHT, RIGHT_OUTSIDE, SAVE, SHIFT, SINGLE, SINGLE_COLUMN, SINGLE_ROW, SPRITE, STRING, SWITCH, SWITCH_BACK, SWITCH_FORE, TAB, TOP, TOP_OUTSIDE, TRANSITION_WAIT_FADEIN, TWO_PI, UP, VALUELABEL, VERBOSE, VERTICAL, WAIT

Method Summary

DropdownList	actAsPulldownMenu(boolean theValue) Enables a ListBox to act as a pulldown menu.
ListBoxItem	addItem(java.lang.String theName, int theValue) Adds an item to the ListBox.
DropdownList	addItems(java.util.List theItems)
DropdownList	addItems(java.util.List theItems, int theOffset)
DropdownList	addItems(java.lang.String[] theItems) adds a list of items from a string array.
void	beginItems()
DropdownList	clear() Removes all items from a list box
void	endItems()
ListBoxItem	getItem(Controller theButton) returns a ListBoxItem based on its Button reference.
ListBoxItem	getItem(int theIndex) returns a listBoxItem by index in the list of items.
ListBoxItem	getItem(java.lang.String theItemName) TODO faulty returns a listBoxItem by name.
java.lang.String[][]	getListBoxItems()
float	getScrollPosition()
DropdownList	hideScrollbar()
boolean	isScrollable()
boolean	isScrollbarEnabled()
DropdownList	removeItem(java.lang.String theItemName) Removes an item from the ListBox using the unique name of the item given when added to the list.
DropdownList	scroll(float theValue) scroll the scrollList remotely.
void	scrolled(int theStep)
DropdownList	setColor(CColor theColor)
DropdownList	setColorActive(int theColor)
DropdownList	setColorBackground(int theColor)
DropdownList	setColorForeground(int theColor)
DropdownList	setColorLabel(int theColor)
DropdownList	setColorValue(int theColor)
DropdownList	setHeight(int theHeight)
DropdownList	setIndex(int theIndex)
DropdownList	setItemHeight(int theHeight)
DropdownList	setListBoxItems(java.lang.String[][] l)
DropdownList	setScrollbarVisible(boolean theValue)
DropdownList	setSize(int theWidth, int theHeight)
DropdownList	setValue(float theValue)
DropdownList	setWidth(int theWidth)
DropdownList	showScrollbar()
DropdownList	toUpperCase(boolean theFlag)
DropdownList	updateListBoxItems()

Methods inherited from class controlP5.ControlGroup

activateEvent, addCloseButton, addListener, controlEvent, getBackgroundHeight, getBarHeight, getInfo, hideBar, isBarVisible, listenerSize, mousePressed, removeCloseButton, removeListener, setBackgroundColor, setBackgroundHeight, setBarHeight, showBar, stringValue, toString, updateInternalEvents

Methods inherited from class controlP5.ControllerGroup

add, addCanvas, addDrawable, bringToFront, bringToFront, close, disableCollapse, enableCollapse, getAbsolutePosition, getAddress, getArrayValue, getCaptionLabel, getColor, getController, getHeight, getId, getName, getPosition, getProperty, getProperty, getStringValue, getTab, getValue, getValueLabel, getWidth, getWindow, hide, isCollapse, isMouseOver, isMoveable, isOpen, isUpdate, isVisible, moveTo, moveTo, moveTo, moveTo, moveTo, moveTo, moveTo, moveTo, moveTo, open, registerProperty, registerProperty, remove, remove, remove, removeCanvas, removeProperty, removeProperty, setAddress, setArrayValue, setGroup, setGroup, setId, setLabel, setMouseOver, setMoveable, setOpen, setPosition, setPosition, setStringValue, setTab, setTab, setTab, setUpdate, setVisible, show, updateAbsolutePosition

Methods inherited from class java.lang.Object

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

Methods inherited from interface controlP5.ControllerInterface

continuousUpdateEvents, draw, getParent, getPickingColor, init, keyEvent, parent, setAbsolutePosition, setMousePressed, update, updateEvents

Method Detail

actAsPulldownMenu

public DropdownList actAsPulldownMenu(boolean theValue)

Enables a ListBox to act as a pulldown menu. Alternatively use class PulldownMenu instead.

addItem

public ListBoxItem addItem(java.lang.String theName,
                           int theValue)

Adds an item to the ListBox.

Parameters:

theName - String

theValue - int

See Also:

controlP5.ListBox#removeItem(String,int)

addItems

public DropdownList addItems(java.util.List theItems)

addItems

public DropdownList addItems(java.util.List theItems,
                             int theOffset)

addItems

public DropdownList addItems(java.lang.String[] theItems)

adds a list of items from a string array. when iterating through the array, the index of each item will be used as value.

Parameters:

theItems -

beginItems

public void beginItems()

clear

public DropdownList clear()

Removes all items from a list box

endItems

public void endItems()

getItem

public ListBoxItem getItem(Controller theButton)

returns a ListBoxItem based on its Button reference.

Parameters:

theButton -

Returns:

getItem

public ListBoxItem getItem(int theIndex)

returns a listBoxItem by index in the list of items.

Parameters:

theIndex -

Returns:

getItem

public ListBoxItem getItem(java.lang.String theItemName)

TODO faulty returns a listBoxItem by name.

Parameters:

theItemName -

Returns:

getListBoxItems

public java.lang.String[][] getListBoxItems()

getScrollPosition

public float getScrollPosition()

hideScrollbar

public DropdownList hideScrollbar()

isScrollable

public boolean isScrollable()

isScrollbarEnabled

public boolean isScrollbarEnabled()

removeItem

public DropdownList removeItem(java.lang.String theItemName)

Removes an item from the ListBox using the unique name of the item given when added to the list.

Parameters:

theItemName - String

See Also:

ListBox.addItem(String,int)

scroll

public DropdownList scroll(float theValue)

scroll the scrollList remotely. values must range between 0 and 1.

scrolled

public void scrolled(int theStep)

setColor

public DropdownList setColor(CColor theColor)

Specified by:

setColor in interface ControllerInterface

Overrides:

setColor in class ControllerGroup

setColorActive

public DropdownList setColorActive(int theColor)

Specified by:

setColorActive in interface ControllerInterface

Overrides:

setColorActive in class ControllerGroup

setColorBackground

public DropdownList setColorBackground(int theColor)

Specified by:

setColorBackground in interface ControllerInterface

Overrides:

setColorBackground in class ControllerGroup

setColorForeground

public DropdownList setColorForeground(int theColor)

Specified by:

setColorForeground in interface ControllerInterface

Overrides:

setColorForeground in class ControllerGroup

setColorLabel

public DropdownList setColorLabel(int theColor)

Specified by:

setColorLabel in interface ControllerInterface

Overrides:

setColorLabel in class ControllerGroup

setColorValue

public DropdownList setColorValue(int theColor)

Specified by:

setColorValue in interface ControllerInterface

Overrides:

setColorValue in class ControllerGroup

setHeight

public DropdownList setHeight(int theHeight)

Overrides:

setHeight in class ControllerGroup

Returns:

ControllerGroup

setIndex

public DropdownList setIndex(int theIndex)

setItemHeight

public DropdownList setItemHeight(int theHeight)

setListBoxItems

public DropdownList setListBoxItems(java.lang.String[][] l)

setScrollbarVisible

public DropdownList setScrollbarVisible(boolean theValue)

setSize

public DropdownList setSize(int theWidth,
                            int theHeight)

setValue

public DropdownList setValue(float theValue)

Description copied from class: ControllerGroup

Specified by:

setValue in interface ControllerInterface

Overrides:

setValue in class ControllerGroup

setWidth

public DropdownList setWidth(int theWidth)

Overrides:

setWidth in class ControllerGroup

Returns:

ControllerGroup

showScrollbar

public DropdownList showScrollbar()

toUpperCase

public DropdownList toUpperCase(boolean theFlag)

updateListBoxItems

public DropdownList updateListBoxItems()