com.bonzaiengine.ui.widget

Class List<T>

java.lang.Object

com.bonzaiengine.ui.widget.Widget

com.bonzaiengine.ui.widget.Panel

com.bonzaiengine.ui.widget.List<T>

All Implemented Interfaces:

IScrollable

public class List<T>
extends Panel
implements IScrollable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	List.ElementState

Nested classes/interfaces inherited from class com.bonzaiengine.ui.widget.Widget

Widget.NotifyEvent

Constructor Summary

Constructors

Constructor and Description
List()

Method Summary

Modifier and Type	Method and Description
void	actionOn(UI ui, InputEvent e, int index)
boolean	addActionListener(ActionListener listener)
boolean	addChangeListener(ChangeListener listener)
void	addElement(T o)
void	ensureVisible(int index) If parent is ScrollPane, ensure
void	ensureVisible(T element)
static <E,T> IElementWidget<List<E>,T>	getDefaultElementWidget()
T	getElement(int index)
int	getNumElements()
int	getNumElementsPerRow()
T	getSelectedElement()
int	getSelectedIndex()
int	getStepForHorizontalScrolling()
int	getStepForVerticalScrolling()
int	indexOf(T element)
boolean	isElementEnabled(int index)
boolean	isValueAdjusting()
boolean	removeActionListener(ActionListener listener)
boolean	removeChangeListener(ChangeListener listener)
void	setElementEnabled(int index, boolean enabled)
void	setElements(java.lang.Iterable<T> list)
void	setElements(T... list)
void	setElementWidget(IElementWidget<List<T>,T> elementWidget)
void	setNumElementsPerRow(int numElementsPerRow)
void	setSelectedElement(T element)
void	setSelectedIndex(int index)

Methods inherited from class com.bonzaiengine.ui.widget.Panel

add, find, find, getLayout, getNumWidgets, getWidget, getWidget, isAccurateMouseOver, isOver, isOverlappingRendering, keyPressed, keyReleased, mouseDragged, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, remove, removeAll, setAccurateMouseOver, setLayout, setOverlappingRendering, update

Methods inherited from class com.bonzaiengine.ui.widget.Widget

addAnimator, addFocusListener, addKeyListener, addMouseFocusListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, focusTraversal, forceSize, getBackground, getBackgroundBorder, getBackgroundColor, getBackgroundFocus, getBackgroundOver, getBackgroundPress, getBorderSize, getConstraint, getDisableFade, getHeight, getHeightOnScreen, getInsets, getInsetsBottom, getInsetsHeight, getInsetsLeft, getInsetsRight, getInsetsTop, getInsetsWidth, getLocation, getLocationAnchor, getLocationOnScreen, getLocationRef, getLocationRef2, getLocationRefAnchor, getLocationX, getLocationXOnScreen, getLocationY, getLocationYOnScreen, getMaxHeight, getMaxWidth, getMenuPopup, getMinHeight, getMinHeightWidget, getMinWidth, getMinWidthWidget, getName, getOpacity, getParent, getPopup, getRoot, getStyle, getTooltip, getViewport, getViewportInternal, getWidth, getWidthOnScreen, hasFocus, isAutoPackHeight, isAutoPackWidth, isEnabled, isEnabledHerited, isEventsOnExternalDrag, isExternalDrag, isFocusable, isMouseDown, isMouseOver, isMouseOverOrDown, isVisible, isVisibleAndEnabledHerited, isVisibleHerited, mouseClicked, mouseEntered, mouseExited, refreshFocus, removeAnimator, removeFocusListener, removeKeyListener, removeMouseFocusListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, render, requestFocus, setAutoPack, setAutoPackHeight, setAutoPackWidth, setBackground, setBackgroundBorder, setBackgroundColor, setBackgroundFocus, setBackgroundOver, setBackgroundPress, setBorderSize, setCatchAllEvents, setDisableFade, setEnabled, setEventsOnExternalDrag, setExternalDrag, setFocusable, setFocusOwner, setInsets, setInsets, setLocation, setLocation, setLocationAnchor, setLocationAndAnchorInViewport, setLocationRef, setLocationRef2, setLocationRefAnchor, setMaxSize, setMaxSize, setMenuPopup, setMinSize, setMinSize, setName, setOpacity, setPopup, setSize, setSize, setStyle, setTooltip, setVisible, toString, uiFireAction

Methods inherited from class java.lang.Object

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

Constructor Detail

List

public List()

Method Detail

getDefaultElementWidget

public static <E,T> IElementWidget<List<E>,T> getDefaultElementWidget()

addActionListener

public final boolean addActionListener(ActionListener listener)

removeActionListener

public final boolean removeActionListener(ActionListener listener)

addChangeListener

public final boolean addChangeListener(ChangeListener listener)

removeChangeListener

public final boolean removeChangeListener(ChangeListener listener)

getStepForVerticalScrolling

public final int getStepForVerticalScrolling()

Specified by:

getStepForVerticalScrolling in interface IScrollable

Returns:

the scroll step in pixels, or -1 if not applicable (use default instead)

getStepForHorizontalScrolling

public final int getStepForHorizontalScrolling()

Specified by:

getStepForHorizontalScrolling in interface IScrollable

Returns:

the scroll step in pixels, or -1 if not applicable (use default instead)

setElements

@SafeVarargs
public final void setElements(T... list)

Parameters:

list - new object list

setElements

public final void setElements(java.lang.Iterable<T> list)

Parameters:

list - new object list

addElement

public final void addElement(T o)

indexOf

public final int indexOf(T element)

getSelectedElement

public final T getSelectedElement()

Returns:

the selected object

getElement

public final T getElement(int index)

getNumElements

public final int getNumElements()

getNumElementsPerRow

public int getNumElementsPerRow()

setNumElementsPerRow

public void setNumElementsPerRow(int numElementsPerRow)

setSelectedElement

public final void setSelectedElement(T element)

setSelectedIndex

public final void setSelectedIndex(int index)

Parameters:

index - index of the object to select

setElementEnabled

public final void setElementEnabled(int index,
                                    boolean enabled)

isElementEnabled

public final boolean isElementEnabled(int index)

ensureVisible

public final void ensureVisible(int index)

If parent is ScrollPane, ensure

ensureVisible

public final void ensureVisible(T element)

getSelectedIndex

public final int getSelectedIndex()

Returns:

the index of the object selected

isValueAdjusting

public final boolean isValueAdjusting()

Returns:

true is the value set by user input (events)

setElementWidget

public void setElementWidget(IElementWidget<List<T>,T> elementWidget)

actionOn

public void actionOn(UI ui,
                     InputEvent e,
                     int index)