ListField (litiengine 0.4.19 API)

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 shownRows, int shownColumns, boolean sliderInside, Spritesheet entrySprite, Spritesheet buttonSprite)` Creates a 2D vertical list field.
`ListField(double x, double y, double width, double height, java.lang.Object[][] content, int shownRows, int shownColumns, Spritesheet entrySprite, Spritesheet buttonSprite)` Creates a 2D vertical list field.
`ListField(double x, double y, double width, double height, java.lang.Object[] content, int shownRows, boolean sliderInside, Spritesheet entrySprite, Spritesheet buttonSprite)` Creates a vertical list field.
`ListField(double x, double y, double width, double height, java.lang.Object[] content, int shownRows, Spritesheet entrySprite, Spritesheet buttonSprite)` Creates a vertical list field.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`deselect()` Resets the ListField's selection to `null`.
`Spritesheet`	`getButtonSprite()`
`java.util.List<java.util.function.IntConsumer>`	`getChangeConsumer()`
`java.lang.Object[][]`	`getContent()`
`Spritesheet`	`getEntrySprite()`
`int`	`getHorizontalLowerBound()`
`HorizontalSlider`	`getHorizontalSlider()`
`java.util.List<ImageComponent>`	`getListEntry(int column)` Returns all list items of a specified column.
`int`	`getMaxRows()` Returns the number of rows of the tallest column.
`int`	`getNumberOfShownColumns()`
`int`	`getNumberOfShownRows()`
`ImageComponent`	`getSelectedComponent()`
`java.lang.Object`	`getSelectedObject()`
`int`	`getSelectionColumn()` Returns the selected column.
`int`	`getSelectionRow()` Returns the selected row.
`int`	`getVerticalLowerBound()`
`VerticalSlider`	`getVerticalSlider()`
`boolean`	`isArrowKeyNavigation()`
`boolean`	`isEntireColumnSelected()` See `setSelectEntireColumn(boolean)`
`boolean`	`isEntireRowSelected()` See `setSelectEntireRow(boolean)`
`boolean`	`isSliderInside()` Verify if sliders are set to be inside the ListField.
`void`	`onChange(java.util.function.IntConsumer c)`
`void`	`refresh()`
`void`	`render(java.awt.Graphics2D g)` Renders the visual contents of this instance onto the provided graphics context.
`void`	`setArrowKeyNavigation(boolean arrowKeyNavigation)`
`void`	`setButtonSprite(Spritesheet buttonSprite)`
`void`	`setEntrySprite(Spritesheet entrySprite)`
`void`	`setForwardMouseEvents(int column, boolean forwardMouseEvents)`
`void`	`setHorizontalLowerBound(int lowerBound)`
`void`	`setSelectEntireColumn(boolean selectEntireColumn)` If set to true, selecting a element will show a selection of the entire column on which that element is on.
`void`	`setSelectEntireRow(boolean selectEntireRow)` If set to true, selecting a element will show a selection of the entire row on which that element is on.
`void`	`setSelection(int column, int row)`
`void`	`setVerticalLowerBound(int lowerBound)`
`void`	`slideDown()` Slides the ListField down by one row.
`void`	`slideUp()` Slides the ListField up by one row.

Methods inherited from class de.gurkenlabs.litiengine.gui.GuiComponent
drawTextShadow, getAppearance, getAppearanceDisabled, getAppearanceHovered, getBoundingBox, getClickConsumer, getComponentId, getComponents, getCurrentAppearance, getFont, getHeight, getHorizontalTextMargin, getHoverConsumer, getHoverSound, getLocation, getMouseDraggedConsumer, getMouseEnterConsumer, getMouseLeaveConsumer, getMouseMovedConsumer, getMousePressedConsumer, getMouseReleasedConsumer, getMouseWheelConsumer, getName, getShape, getTag, getText, getTextAlign, getTextAngle, getTextShadowColor, getTextToRender, getTextX, 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, prepare, setDimension, setEnabled, setFont, setFontSize, setForwardMouseEvents, setHeight, setHorizontalTextMargin, setHovered, setHoverSound, setLocation, setLocation, setName, setSelected, setTag, setText, setTextAlign, setTextAngle, setTextShadow, setTextShadowColor, setTextX, setTextY, setVisible, setWidth, setX, setY, suspend, 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 shownRows,
                 Spritesheet entrySprite,
                 Spritesheet buttonSprite)
```
    Creates a vertical list field.
    
    The content of this list field can only be accessed through the first column (column 0).
    Examples:
    content[0][0] - ok
    content[0][1] - ok
    content[0][8] - ok
    content[1][5] - NOK
    content[2][0] - NOK
    
    Parameters:
    
    x - The x-coordinate of the ListField.
    
    y - The y-coordinate of the ListField.
    
    width - The width of the ListField.
    
    height - The height of the ListField.
    
    content - The 1 dimension array to show in the ListField.
    
    shownRows - The number of rows/elements to display before the user needs to scroll for more possible rows/elements.
    
    entrySprite - The entrySprite.
    
    buttonSprite - The buttonSprite.
    
    See Also:
    
    ListField(double, double, double, double, Object[], int, boolean, Spritesheet, Spritesheet)
  - ListField
```
public ListField(double x,
                 double y,
                 double width,
                 double height,
                 java.lang.Object[] content,
                 int shownRows,
                 boolean sliderInside,
                 Spritesheet entrySprite,
                 Spritesheet buttonSprite)
```
    Creates a vertical list field.
    
    The content of this list field can only be accessed through the first column (column 0).
    Examples:
    content[0][0] - ok
    content[0][1] - ok
    content[0][8] - ok
    content[1][5] - NOK
    content[2][0] - NOK
    
    Parameters:
    
    x - The x-coordinate of the ListField.
    
    y - The y-coordinate of the ListField.
    
    width - The width of the ListField.
    
    height - The height of the ListField.
    
    content - The 1 dimension array to show in the ListField.
    
    shownRows - The number of rows/elements to display before the user needs to scroll for more possible rows/elements.
    
    sliderInside - If set to true, sliders will show inside the ListField. This can be used, for example, if the ListField's width matches the screen's width.
    
    entrySprite - The entrySprite.
    
    buttonSprite - The buttonSprite.
  - ListField
```
public ListField(double x,
                 double y,
                 double width,
                 double height,
                 java.lang.Object[][] content,
                 int shownRows,
                 int shownColumns,
                 Spritesheet entrySprite,
                 Spritesheet buttonSprite)
```
    Creates a 2D vertical list field.
    
    The given content should be arranged as columns of elements.
    Examples:
    content[0][0] - column 0, row 0
    content[0][1] - column 0, row 1
    content[2][8] - column 2, row 8
    
    Parameters:
    
    x - The x-coordinate of the ListField.
    
    y - The y-coordinate of the ListField.
    
    width - The width of the ListField.
    
    height - The height of the ListField.
    
    content - The 2 dimension array to show in the ListField.
    
    shownRows - The number of rows to display before the user needs to scroll for more possible rows.
    
    shownColumns - The number of columns to display before the user needs to scroll for more possible columns.
    
    entrySprite - The entrySprite.
    
    buttonSprite - The buttonSprite.
    
    See Also:
    
    ListField(double, double, double, double, Object[][], int, int, boolean, Spritesheet, Spritesheet)
  - ListField
```
public ListField(double x,
                 double y,
                 double width,
                 double height,
                 java.lang.Object[][] content,
                 int shownRows,
                 int shownColumns,
                 boolean sliderInside,
                 Spritesheet entrySprite,
                 Spritesheet buttonSprite)
```
    Creates a 2D vertical list field.
    
    The given content should be arranged as columns of elements.
    Examples:
    content[0][0] - column 0, row 0
    content[0][1] - column 0, row 1
    content[2][8] - column 2, row 8
    
    Parameters:
    
    x - The x-coordinate of the ListField.
    
    y - The y-coordinate of the ListField.
    
    width - The width of the ListField.
    
    height - The height of the ListField.
    
    content - The 2 dimension array to show in the ListField.
    
    shownRows - The number of rows to display before the user needs to scroll for more possible rows.
    
    shownColumns - The number of columns to display before the user needs to scroll for more possible columns.
    
    sliderInside - If set to true, sliders will show inside the ListField. This can be used, for example, if the ListField's width matches the screen's width.
    
    entrySprite - The entrySprite.
    
    buttonSprite - The buttonSprite.
- Method Detail
  - deselect
```
public void deselect()
```
    Resets the ListField's selection to null.
    The ListField will then show no selection.
  - getButtonSprite
```
public Spritesheet getButtonSprite()
```
  - getChangeConsumer
```
public java.util.List<java.util.function.IntConsumer> getChangeConsumer()
```
  - getContent
```
public java.lang.Object[][] getContent()
```
  - getEntrySprite
```
public Spritesheet getEntrySprite()
```
  - getHorizontalLowerBound
```
public int getHorizontalLowerBound()
```
  - getHorizontalSlider
```
public HorizontalSlider getHorizontalSlider()
```
  - getListEntry
```
public java.util.List<ImageComponent> getListEntry(int column)
```
    Returns all list items of a specified column.
    
    Parameters:
    
    column - the column
    
    Returns:
    
    a list of items
  - getMaxRows
```
public int getMaxRows()
```
    Returns the number of rows of the tallest column.
    
    Returns:
    
    int representing the length of the tallest column
  - getNumberOfShownRows
```
public int getNumberOfShownRows()
```
  - getNumberOfShownColumns
```
public int getNumberOfShownColumns()
```
  - getSelectedComponent
```
public ImageComponent getSelectedComponent()
```
  - getSelectedObject
```
public java.lang.Object getSelectedObject()
```
  - getSelectionColumn
```
public int getSelectionColumn()
```
    Returns the selected column.
    
    Returns:
    
    number of the column; -1 if isEntireRowSelected() is true
  - getSelectionRow
```
public int getSelectionRow()
```
    Returns the selected row.
    
    Returns:
    
    number of the row
  - getVerticalLowerBound
```
public int getVerticalLowerBound()
```
  - getVerticalSlider
```
public VerticalSlider getVerticalSlider()
```
  - isArrowKeyNavigation
```
public boolean isArrowKeyNavigation()
```
  - onChange
```
public void onChange(java.util.function.IntConsumer c)
```
  - refresh
```
public void refresh()
```
  - render
```
public void render(java.awt.Graphics2D g)
```
    Description copied from interface: IRenderable
    
    Renders the visual contents of this instance onto the provided graphics context.
    If an Entity implements this interface, this method will be called right after the entity was rendered from the environment. Allowing for a custom rendering mechanism.
    
    This interface can be implemented in general by anything that should be rendered to the game's screen.
    
    Specified by:
    
    render in interface IRenderable
    
    Overrides:
    
    render in class GuiComponent
    
    Parameters:
    
    g - The current graphics object onto which this instance will render its visual contents.
    
    See Also:
    
    RenderEngine.renderEntity(Graphics2D, de.gurkenlabs.litiengine.entities.IEntity)
  - setArrowKeyNavigation
```
public void setArrowKeyNavigation(boolean arrowKeyNavigation)
```
  - setButtonSprite
```
public void setButtonSprite(Spritesheet buttonSprite)
```
  - setEntrySprite
```
public void setEntrySprite(Spritesheet entrySprite)
```
  - setForwardMouseEvents
```
public void setForwardMouseEvents(int column,
                                  boolean forwardMouseEvents)
```
  - setHorizontalLowerBound
```
public void setHorizontalLowerBound(int lowerBound)
```
  - setSelection
```
public void setSelection(int column,
                         int row)
```
  - setSelectEntireColumn
```
public void setSelectEntireColumn(boolean selectEntireColumn)
```
    If set to true, selecting a element will show a selection of the entire column on which that element is on. Without taking account of its row.
    
    Set to false as default.
    
    Parameters:
    
    selectEntireColumn - a boolean
  - setSelectEntireRow
```
public void setSelectEntireRow(boolean selectEntireRow)
```
    If set to true, selecting a element will show a selection of the entire row on which that element is on. Without taking account of its column.
    
    Set to false as default.
    
    Parameters:
    
    selectEntireRow - a boolean
  - setVerticalLowerBound
```
public void setVerticalLowerBound(int lowerBound)
```
  - isEntireColumnSelected
```
public boolean isEntireColumnSelected()
```
    See setSelectEntireColumn(boolean)
    
    Returns:
    
    true if selection is set to select the entire column; false otherwise
  - isEntireRowSelected
```
public boolean isEntireRowSelected()
```
    See setSelectEntireRow(boolean)
    
    Returns:
    
    true if selection is set to select the entire row; false otherwise
  - isSliderInside
```
public boolean isSliderInside()
```
    Verify if sliders are set to be inside the ListField.
    
    Returns:
    
    true if slider is set to be inside the ListField; false otherwise
  - slideUp
```
public void slideUp()
```
    Slides the ListField up by one row.
  - slideDown
```
public void slideDown()
```
    Slides the ListField down by one row.

Class ListField

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

ListField

ListField

ListField

ListField

Method Detail

deselect

getButtonSprite

getChangeConsumer

getContent

getEntrySprite

getHorizontalLowerBound

getHorizontalSlider

getListEntry

getMaxRows

getNumberOfShownRows

getNumberOfShownColumns

getSelectedComponent

getSelectedObject

getSelectionColumn

getSelectionRow

getVerticalLowerBound

getVerticalSlider

isArrowKeyNavigation

onChange

refresh

render

setArrowKeyNavigation

setButtonSprite

setEntrySprite

setForwardMouseEvents

setHorizontalLowerBound

setSelection

setSelectEntireColumn

setSelectEntireRow

setVerticalLowerBound

isEntireColumnSelected

isEntireRowSelected

isSliderInside

slideUp

slideDown