ListView (Javadocs: guiSET)

java.lang.Object
- guiSET.core.Control
- - guiSET.core.TextBased
  - - guiSET.core.Container
    - - guiSET.core.VFlowContainer
      - guiSET.core.VScrollContainer
        
        guiSET.core.ListView

```
public class ListView
extends VScrollContainer
```
The list view allows to display easily a lot of items in a vertical list. When adding a String a new ListItem will be created and added. You can also add items that inherit from Control other than ListItems or derived but these will only raise the itemSelected event if they call ListViews (protected) itemPressed(Control) method.

Author:

E-Bow

Nested Class Summary
- Nested classes/interfaces inherited from class guiSET.core.Control
  Control.Constants, Control.ImageMode, Control.Predicate, Control.Predicate1<T>, Control.Predicate2<T,U>, Control.RenderingMethod, Control.Setter<T>

Field Summary
- Fields inherited from class guiSET.core.TextBased
  FONT_SIZE, LINE_HEIGHT, TEXT_ALIGN, TEXT_ALIGN_Y, TEXT_COLOR
- Fields inherited from class guiSET.core.Control
  ALL, ANCHOR_INACTIVE, AUTOSIZE_BOTH, AUTOSIZE_HEIGHT, AUTOSIZE_NONE, AUTOSIZE_WIDTH, BACKGROUND_COLOR, BACKGROUND_COLORS, BORDER, BORDER_COLOR, BORDER_RADIUS, BORDER_WIDTH, BUFFERED_RENDERING, COLORS, defaultRenderingMethod, FILL, FIT, FIT_INSIDE, FOREGROUND_COLOR, HOVER_COLOR, MARGIN, MARGIN_BOTTOM, MARGIN_LEFT, MARGIN_RIGHT, MARGIN_TOP, name, OPACITY, PADDING, PADDING_BOTTOM, PADDING_LEFT, PADDING_RIGHT, PADDING_TOP, PERCENTAGE_MODE, PIXEL_MODE, PRESSED_COLOR, SPACING, TEXT_PROPERTIES, UNBUFFERED_RENDERING

Constructor Summary

Constructors
Constructor and Description

ListView()

ListView(int width, int height)

Constructors
Constructor and Description
`ListView()`
`ListView(int width, int height)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Control... items)` Add items to Container.
`void`	`add(java.lang.String... newItems)` Simple adding method just giving the text as String will create automatically new ListItems.
`void`	`add(java.lang.String newItem)` Simple adding method just giving the text as String will create automatically new ListItems.
`void`	`clear()` Remove all items
`void`	`deselect(Control item)` Deselect an item.
`void`	`deselect(int index)` Deselect an item.
`void`	`deselectAll()` Deselect all items
`int`	`getItemBackgroundColor()`
`boolean`	`getMultiSelect()`
`Control`	`getSelectedItem()` Get most recently selected item.
`java.util.ArrayList<Control>`	`getSelectedItems()` Get all selected items (if multiselect enabled).
`int`	`getSelectionColor()`
`int`	`getSelectionHoverColor()`
`int`	`getSelectionIndex()`
`boolean`	`isMakeItemsFillAvailableWidth()`
`boolean`	`remove(Control item)` Remove a specific item from item list.
`Control`	`remove(int index)` Remove item at position in item list.
`void`	`removeItemSelectListener()`
`void`	`select(Control item)` Select item by reference.
`void`	`select(int index)` Select item with given index.
`void`	`setItemSelectListener(Control.Predicate lambda)` Set a listener lambda for when an item is selected.
`void`	`setItemSelectListener(Control.Predicate1<Control> lambda)` Set a listener lambda for when an item is selected.
`void`	`setItemSelectListener(java.lang.String methodName)`
`void`	`setItemSelectListener(java.lang.String methodName, java.lang.Object target)` Set a listener for when an item is selected.
`void`	`setMakeItemsFillAvailableWidth(boolean makeItemsFillAvailableWidth)`
`void`	`setMultiSelect(boolean multiSelect)` Enable/Disable multiple selections.
`void`	`setNewItemBackgroundColor(int itemBackgroundColor)` Settimg this color will affect all items added afterwards through the `add(String)` method.
`void`	`setSelectedItem(int index)` Set one item to be selected programatically.
`void`	`setSelectionColor(int selectionColor)` Background color for selected items.
`void`	`setSelectionHoverColor(int selectionHoverColor)` Hover color for selected items.
`void`	`sortAlphaNumerically()` Sort items alphanumerically.
`void`	`sortAlphaNumerically(boolean reversed)` Sort items alphanumerically.

Methods inherited from class guiSET.core.VScrollContainer
getAvailableWidth, getFullScrollHeight, getScrollPosition, getScrollSpeed, isSlimScrollHandle, scrollToItem, scrollToItem, setScrollPosition, setScrollSpeed, setSlimScrollHandle

Methods inherited from class guiSET.core.Container
fitContent, getItem, getItems, getNumItems, indexOf, insert, sortItems, traceAbsoluteCoordinates, traceRelativeCoordinates

Methods inherited from class guiSET.core.TextBased
copyStyle, getFont, getFontSize, getLineHeight, getText, getTextAlign, getTextAlignY, getTextColor, isBold, isItalic, isStrikethrough, isUnderlined, setBold, setFont, setFontSize, setForegroundColor, setItalic, setLineHeight, setLineHeightPercent, setStrikethrough, setText, setText, setTextAlign, setTextAlignY, setTextColor, setUnderlined

Methods inherited from class guiSET.core.Control
addAutoAnchors, animate, blur, copyStyle, doForAll, fillParent, fillParent, fillParent, fillParentHeight, fillParentHeight, fillParentWidth, fillParentWidth, focus, forceRepaint, getAnchorMode, getAnchorValue, getAvailableHeight, getBackgroundColor, getBorderColor, getBorderRadius, getBorderWidth, getCursor, getForegroundColor, getHeight, getHoverColor, getImage, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOffsetXToParent, getOffsetXToWindow, getOffsetYToParent, getOffsetYToWindow, getOpacity, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getParent, getPressedColor, getVersionString, getWidth, getX, getY, getZ, isEnabled, isFocusable, isFocused, isPropagationStopped, isVisible, noAutosize, relativeCoordsAreWithin, removeAnchor, removeBoxShadow, removeFocusListener, removeMouseListener, removeResizeListener, setAnchor, setAnchors, setAutosizing, setBackgroundColor, setBorder, setBorder, setBorderColor, setBorderRadius, setBorderWidth, setBoxShadow, setCursor, setEnabled, setFixedSize, setFocusListener, setFocusListener, setFocusListener, setFocusListener, setGradient, setHeight, setHeight, setHoverColor, setImage, setImageMode, setMargin, setMargin, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setMouseListener, setMouseListener, setMouseListener, setMouseListener, setOpacity, setOpacity, setPadding, setPadding, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPercentageAnchor, setPercentageAnchors, setPixelAnchor, setPixelAnchors, setPosition, setPressedColor, setResizeListener, setResizeListener, setResizeListener, setResizeListener, setSize, setVisibility, setVisible, setWidth, setWidth, setX, setY, setZ, stopPropagation, unfocus

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ListView
```
public ListView()
```
  - ListView
```
public ListView(int width,
                int height)
```
- Method Detail
  - deselect
```
public void deselect(int index)
```
    Deselect an item.
    
    Parameters:
    
    index - index of item to deselect. Throws no error if index is bad.
  - deselect
```
public void deselect(Control item)
```
    Deselect an item.
    
    Parameters:
    
    item - item to deselect.
  - deselectAll
```
public void deselectAll()
```
    Deselect all items
  - select
```
public void select(int index)
```
    Select item with given index. If multiselect is not activated then this will deselect all other selected items. Throws no error if index is bad.
    
    Parameters:
    
    index - index in listviews item list
  - select
```
public void select(Control item)
```
    Select item by reference. If multiselect is not activated then this will deselect all other selected items.
    
    Parameters:
    
    item - item to select
  - setSelectedItem
```
public void setSelectedItem(int index)
```
    Set one item to be selected programatically. Also deselecting all previously selected items.
    
    Parameters:
    
    index - index in listviews item list
  - add
```
public void add(java.lang.String... newItems)
```
    Simple adding method just giving the text as String will create automatically new ListItems.
    
    Parameters:
    
    newItems - arbitrary number of item texts
  - add
```
public void add(java.lang.String newItem)
```
    Simple adding method just giving the text as String will create automatically new ListItems.
    
    Parameters:
    
    newItem - item text
  - add
```
public void add(Control... items)
```
    Description copied from class: Container
    
    Add items to Container. Containers that don't layout their items automatically like i.e. VFlowContainer or VScrollContainer sort them by z-index!
    
    Overrides:
    
    add in class Container
    
    Parameters:
    
    items - arbitrary number of items.
  - clear
```
public void clear()
```
    Remove all items
    
    Overrides:
    
    clear in class Container
  - remove
```
public Control remove(int index)
```
    Remove item at position in item list.
    
    Overrides:
    
    remove in class Container
    
    Parameters:
    
    index - position
    
    Returns:
    
    the removed item
  - remove
```
public boolean remove(Control item)
```
    Remove a specific item from item list.
    
    Overrides:
    
    remove in class Container
    
    Parameters:
    
    item - item to remove.
    
    Returns:
    
    true if the item has actually been removed
  - sortAlphaNumerically
```
public void sortAlphaNumerically()
```
    Sort items alphanumerically.
  - sortAlphaNumerically
```
public void sortAlphaNumerically(boolean reversed)
```
    Sort items alphanumerically. If argument is false then the items are sorted backwards.
    
    Parameters:
    
    reversed - sort reversed
  - setNewItemBackgroundColor
```
public void setNewItemBackgroundColor(int itemBackgroundColor)
```
    Settimg this color will affect all items added afterwards through the add(String) method.
    
    Parameters:
    
    itemBackgroundColor - background color for new items
  - setSelectionColor
```
public void setSelectionColor(int selectionColor)
```
    Background color for selected items.
    
    Parameters:
    
    selectionColor - selection color
  - setSelectionHoverColor
```
public void setSelectionHoverColor(int selectionHoverColor)
```
    Hover color for selected items.
    
    Parameters:
    
    selectionHoverColor - selection hover color
  - setMultiSelect
```
public void setMultiSelect(boolean multiSelect)
```
    Enable/Disable multiple selections.
    
    Parameters:
    
    multiSelect - multiSelect
  - setMakeItemsFillAvailableWidth
```
public void setMakeItemsFillAvailableWidth(boolean makeItemsFillAvailableWidth)
```
  - getItemBackgroundColor
```
public int getItemBackgroundColor()
```
  - getSelectionColor
```
public int getSelectionColor()
```
  - getSelectionHoverColor
```
public int getSelectionHoverColor()
```
  - getSelectedItem
```
public Control getSelectedItem()
```
    Get most recently selected item.
    
    Returns:
    
    selected item
  - getSelectionIndex
```
public int getSelectionIndex()
```
  - getSelectedItems
```
public java.util.ArrayList<Control> getSelectedItems()
```
    Get all selected items (if multiselect enabled).
    
    Returns:
    
    selected items
  - getMultiSelect
```
public boolean getMultiSelect()
```
  - isMakeItemsFillAvailableWidth
```
public boolean isMakeItemsFillAvailableWidth()
```
  - setItemSelectListener
```
public void setItemSelectListener(java.lang.String methodName,
                                  java.lang.Object target)
```
    Set a listener for when an item is selected. Event arguments: the Control whose state has changed
    
    Parameters:
    
    methodName - methodName
    
    target - target
  - setItemSelectListener
```
public void setItemSelectListener(java.lang.String methodName)
```
  - setItemSelectListener
```
public void setItemSelectListener(Control.Predicate1<Control> lambda)
```
    Set a listener lambda for when an item is selected. The event passes the item that has been selected. Event arguments: the Control whose state has changed
    
    Parameters:
    
    lambda - lambda expression with Control parameter
  - setItemSelectListener
```
public void setItemSelectListener(Control.Predicate lambda)
```
    Set a listener lambda for when an item is selected. Event arguments: none
    
    Parameters:
    
    lambda - lambda expression
  - removeItemSelectListener
```
public void removeItemSelectListener()
```

Class ListView

Nested Class Summary

Nested classes/interfaces inherited from class guiSET.core.Control

Field Summary

Fields inherited from class guiSET.core.TextBased

Fields inherited from class guiSET.core.Control

Constructor Summary

Method Summary

Methods inherited from class guiSET.core.VScrollContainer

Methods inherited from class guiSET.core.Container

Methods inherited from class guiSET.core.TextBased

Methods inherited from class guiSET.core.Control

Methods inherited from class java.lang.Object

Constructor Detail

ListView

ListView

Method Detail

deselect

deselect

deselectAll

select

select

setSelectedItem

add

add

add

clear

remove

remove

sortAlphaNumerically

sortAlphaNumerically

setNewItemBackgroundColor

setSelectionColor

setSelectionHoverColor

setMultiSelect

setMakeItemsFillAvailableWidth

getItemBackgroundColor

getSelectionColor

getSelectionHoverColor

getSelectedItem

getSelectionIndex

getSelectedItems

getMultiSelect

isMakeItemsFillAvailableWidth

setItemSelectListener

setItemSelectListener

setItemSelectListener

setItemSelectListener

removeItemSelectListener