de.gurkenlabs.litiengine.gui

Class ListField

java.lang.Object

de.gurkenlabs.litiengine.gui.GuiComponent

de.gurkenlabs.litiengine.gui.ListField

All Implemented Interfaces:

IRenderable, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

public class ListField
extends GuiComponent

The Class ListField.

Field Summary

Fields inherited from class de.gurkenlabs.litiengine.gui.GuiComponent

ICON_FONT

Constructor Summary

Constructors

Constructor and Description
ListField(double x, double y, double width, double height, java.lang.Object[] content, int shownElements, Spritesheet entrySprite, Spritesheet buttonSprite)

Method Summary

Modifier and Type	Method and Description
Spritesheet	getButtonSprite()
java.util.List<java.util.function.Consumer<java.lang.Integer>>	getChangeConsumer()
java.lang.Object[]	getContentArray()
Spritesheet	getEntrySprite()
java.util.List<ImageComponent>	getListEntries() Gets the all list items.
ImageComponent	getListEntry(int listIndex) Gets the list item.
int	getLowerBound()
int	getNumberOfShownElements()
ImageComponent	getSelectedComponent()
java.lang.Object	getSelectedObject()
int	getSelection() Gets the selection.
VerticalSlider	getSlider()
boolean	isArrowKeyNavigation()
void	onChange(java.util.function.Consumer<java.lang.Integer> c)
void	prepare()
void	refresh()
void	render(java.awt.Graphics2D g)
void	setArrowKeyNavigation(boolean arrowKeyNavigation)
void	setButtonSprite(Spritesheet buttonSprite)
void	setEntrySprite(Spritesheet entrySprite)
void	setLowerBound(int lowerBound)
void	setSelection(int selection)
void	suspend() Suspend.

Methods inherited from class de.gurkenlabs.litiengine.gui.GuiComponent

drawTextShadow, getAppearance, getAppearanceDisabled, getAppearanceHovered, getBoundingBox, getClickConsumer, getComponentId, getComponents, getFont, getHeight, getHoverConsumer, getHoverSound, getLocation, getMouseDraggedConsumer, getMouseEnterConsumer, getMouseLeaveConsumer, getMouseMovedConsumer, getMousePressedConsumer, getMouseReleasedConsumer, getMouseWheelConsumer, getName, getTag, getText, getTextAlign, getTextAngle, getTextShadowColor, getTextToRender, getTextX, getTextXMargin, getTextY, getWidth, getX, getY, initializeComponents, isEnabled, isForwardMouseEvents, isHovered, isPressed, isSelected, isSuspended, isVisible, mouseClicked, mouseDragged, mouseEntered, mouseEventShouldBeForwarded, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, onClicked, onHovered, onMouseDragged, onMouseEnter, onMouseLeave, onMouseMoved, onMousePressed, onMouseReleased, onMouseWheelScrolled, onTextChanged, setDimension, setEnabled, setFont, setFontSize, setForwardMouseEvents, setHeight, setHovered, setHoverSound, setLocation, setLocation, setName, setSelected, setTag, setText, setTextAlignment, setTextAngle, setTextShadow, setTextShadowColor, setTextX, setTextXMargin, setTextY, setVisible, setWidth, setX, setY, toggleSelection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListField

public ListField(double x,
                 double y,
                 double width,
                 double height,
                 java.lang.Object[] content,
                 int shownElements,
                 Spritesheet entrySprite,
                 Spritesheet buttonSprite)

Method Detail

getButtonSprite

public Spritesheet getButtonSprite()

getChangeConsumer

public java.util.List<java.util.function.Consumer<java.lang.Integer>> getChangeConsumer()

getContentArray

public java.lang.Object[] getContentArray()

getEntrySprite

public Spritesheet getEntrySprite()

getListEntries

public java.util.List<ImageComponent> getListEntries()

Gets the all list items.

Returns:

the all list items

getListEntry

public ImageComponent getListEntry(int listIndex)

Gets the list item.

Parameters:

listIndex - the list index

Returns:

the list item

getLowerBound

public int getLowerBound()

getNumberOfShownElements

public int getNumberOfShownElements()

getSelectedComponent

public ImageComponent getSelectedComponent()

getSelectedObject

public java.lang.Object getSelectedObject()

getSelection

public int getSelection()

Gets the selection.

Returns:

the selection

getSlider

public VerticalSlider getSlider()

isArrowKeyNavigation

public boolean isArrowKeyNavigation()

onChange

public void onChange(java.util.function.Consumer<java.lang.Integer> c)

suspend

public void suspend()

Description copied from class: GuiComponent

Suspend.

Overrides:

suspend in class GuiComponent

prepare

public void prepare()

Overrides:

prepare in class GuiComponent

refresh

public void refresh()

render

public void render(java.awt.Graphics2D g)

Specified by:

render in interface IRenderable

Overrides:

render in class GuiComponent

setArrowKeyNavigation

public void setArrowKeyNavigation(boolean arrowKeyNavigation)

setButtonSprite

public void setButtonSprite(Spritesheet buttonSprite)

setEntrySprite

public void setEntrySprite(Spritesheet entrySprite)

setLowerBound

public void setLowerBound(int lowerBound)

setSelection

public void setSelection(int selection)