@DefaultProperty(value="listData") public class ListView extends Component
Modifier and Type | Class and Description |
---|---|
static interface |
ListView.ItemBindMapping
Translates between item position and bind context data during data binding.
|
static interface |
ListView.ItemEditor
List view item editor interface.
|
static interface |
ListView.ItemRenderer
Renderer interface to customize the appearance of items in a ListView. |
static interface |
ListView.ListDataBindMapping
Translates between list and bind context data during data binding.
|
static class |
ListView.SelectMode
Enumeration defining supported selection modes.
|
static interface |
ListView.Skin
List view skin interface.
|
Component.DecoratorSequence, Component.StyleDictionary, Component.UserDataDictionary
Constructor and Description |
---|
ListView()
Creates a list view populated with an empty array list.
|
ListView(List<?> listData)
Creates a list view populated with the given list data.
|
Modifier and Type | Method and Description |
---|---|
boolean |
addSelectedIndex(int index)
Adds a single index to the selection.
|
Sequence<Span> |
addSelectedRange(int start,
int end)
Adds a range of indexes to the selection.
|
Sequence<Span> |
addSelectedRange(Span range)
Adds a range of indexes to the selection.
|
void |
clear()
Clears any bound values in the component.
|
void |
clearCheckmarks()
Clears the checked state of all checked items.
|
void |
clearSelection()
Clears the selection.
|
ImmutableList<Integer> |
getCheckedIndexes()
Returns the indexes of currently checked items.
|
ListView.ItemBindMapping |
getCheckedItemsBindMapping() |
BindType |
getCheckedItemsBindType() |
String |
getCheckedItemsKey() |
boolean |
getCheckmarksEnabled()
Returns the current check mode.
|
Filter<?> |
getDisabledCheckmarkFilter()
Returns the disabled checkmark filter, which determines which checkboxes
are interactive and which are not.
|
Filter<?> |
getDisabledItemFilter()
Returns the disabled item filter.
|
int |
getFirstSelectedIndex()
Returns the first selected index.
|
int |
getItemAt(int y)
Returns the index of the item at a given location.
|
Bounds |
getItemBounds(int index)
Returns the bounding area of a given item.
|
ListView.ItemEditor |
getItemEditor()
Returns the editor used to edit items in this list.
|
int |
getItemIndent()
Returns the item indent.
|
ListView.ItemRenderer |
getItemRenderer()
Returns the item renderer used for items in this list.
|
int |
getLastSelectedIndex()
Returns the last selected index.
|
List<?> |
getListData()
Returns the list data.
|
ListView.ListDataBindMapping |
getListDataBindMapping() |
BindType |
getListDataBindType() |
String |
getListDataKey()
Returns name of the key that is used in context binding.
|
ListenerList<ListViewBindingListener> |
getListViewBindingListeners() |
ListenerList<ListViewItemListener> |
getListViewItemListeners()
Returns the list view item listener list.
|
ListenerList<ListViewItemStateListener> |
getListViewItemStateListeners()
Returns the list view item state listener list.
|
ListenerList<ListViewListener> |
getListViewListeners()
Returns the list view listener list.
|
ListenerList<ListViewSelectionListener> |
getListViewSelectionListeners()
Returns the list view selection detail listener list.
|
int |
getSelectedIndex()
Returns the currently selected index, even when in multi-select mode.
|
Object |
getSelectedItem() |
ListView.ItemBindMapping |
getSelectedItemBindMapping() |
BindType |
getSelectedItemBindType() |
String |
getSelectedItemKey() |
Sequence<?> |
getSelectedItems() |
ListView.ItemBindMapping |
getSelectedItemsBindMapping() |
BindType |
getSelectedItemsBindType() |
String |
getSelectedItemsKey() |
ImmutableList<Span> |
getSelectedRanges()
Returns the currently selected ranges.
|
ListView.SelectMode |
getSelectMode()
Returns the current selection mode.
|
boolean |
isCheckmarkDisabled(int index)
Tells whether or not an item's checkmark is disabled.
|
boolean |
isItemChecked(int index)
Returns an item's checked state.
|
boolean |
isItemDisabled(int index)
Returns an item's disabled state.
|
boolean |
isItemSelected(int index)
Returns the selection state of a given index.
|
void |
load(Object context)
Copies bound values from the bind context to the component.
|
boolean |
removeSelectedIndex(int index)
Removes a single index from the selection.
|
Sequence<Span> |
removeSelectedRange(int start,
int end)
Removes a range of indexes from the selection.
|
Sequence<Span> |
removeSelectedRange(Span range)
Removes a range of indexes from the selection.
|
void |
selectAll()
Selects all items in the list.
|
void |
setCheckedItemsBindMapping(ListView.ItemBindMapping checkedItemsBindMapping) |
void |
setCheckedItemsBindType(BindType checkedItemsBindType) |
void |
setCheckedItemsKey(String checkedItemsKey) |
void |
setCheckmarksEnabled(boolean checkmarksEnabled)
Enables or disables checkmarks.
|
void |
setDisabledCheckmarkFilter(Filter<?> disabledCheckmarkFilter)
Sets the disabled checkmark filter, which determines which checkboxes
are interactive and which are not.
|
void |
setDisabledItemFilter(Filter<?> disabledItemFilter)
Sets the disabled item filter.
|
void |
setItemChecked(int index,
boolean checked)
Sets an item's checked state.
|
void |
setItemEditor(ListView.ItemEditor itemEditor)
Sets the editor used to edit items in this list.
|
void |
setItemRenderer(ListView.ItemRenderer itemRenderer)
Sets the item renderer to be used for items in this list.
|
void |
setListData(List<?> listData)
Sets the list data.
|
void |
setListData(String listData)
Sets the list data.
|
void |
setListData(URL listData)
Sets the list data.
|
void |
setListDataBindMapping(ListView.ListDataBindMapping listDataBindMapping) |
void |
setListDataBindType(BindType listDataBindType) |
void |
setListDataKey(String listDataKey)
Set the name of the key that is used in context binding.
|
void |
setSelectedIndex(int index)
Sets the selection to a single index.
|
void |
setSelectedItem(Object item) |
void |
setSelectedItemBindMapping(ListView.ItemBindMapping selectedItemBindMapping) |
void |
setSelectedItemBindType(BindType selectedItemBindType) |
void |
setSelectedItemKey(String selectedItemKey) |
void |
setSelectedItems(Sequence<Object> items) |
void |
setSelectedItemsBindMapping(ListView.ItemBindMapping selectedItemsBindMapping) |
void |
setSelectedItemsBindType(BindType selectedItemsBindType) |
void |
setSelectedItemsKey(String selectedItemsKey) |
void |
setSelectedRange(int start,
int end)
Sets the selection to a single range.
|
Sequence<Span> |
setSelectedRanges(Sequence<Span> selectedRanges)
Sets the selection to the given range sequence.
|
Sequence<Span> |
setSelectedRanges(String selectedRanges)
Sets the selection to the given range sequence.
|
void |
setSelectMode(ListView.SelectMode selectMode)
Sets the selection mode.
|
protected void |
setSkin(Skin skin)
Sets the skin, replacing any previous skin.
|
void |
store(Object context)
Copies bound values from the component to the bind context.
|
clearFocus, contains, getAncestor, getAncestor, getAttribute, getAutomationID, getBaseline, getBaseline, getBounds, getComponentClassListeners, getComponentDataListeners, getComponentDecoratorListeners, getComponentKeyListeners, getComponentListeners, getComponentMouseButtonListeners, getComponentMouseListeners, getComponentMouseWheelListeners, getComponentStateListeners, getComponentStyleListeners, getComponentTooltipListeners, getCursor, getDecoratedBounds, getDecorators, getDisplay, getDragSource, getDropTarget, getFocusedComponent, getGraphics, getHeight, getHeightLimits, getLocation, getMaximumHeight, getMaximumWidth, getMenuHandler, getMinimumHeight, getMinimumWidth, getMouseLocation, getName, getNamedStyles, getParent, getPreferredHeight, getPreferredHeight, getPreferredSize, getPreferredWidth, getPreferredWidth, getSize, getSkin, getStyles, getTooltipDelay, getTooltipText, getTooltipWrapText, getTypedStyles, getUserData, getVisibleArea, getVisibleArea, getVisibleArea, getWidth, getWidthLimits, getWindow, getX, getY, indexBoundsCheck, installSkin, invalidate, isBlocked, isEnabled, isFocusable, isFocused, isMouseOver, isOpaque, isPreferredHeightSet, isPreferredSizeSet, isPreferredWidthSet, isShowing, isValid, isVisible, keyPressed, keyReleased, keyTyped, layout, mapPointFromAncestor, mapPointFromAncestor, mapPointToAncestor, mapPointToAncestor, mouseClick, mouseDown, mouseMove, mouseOut, mouseOver, mouseUp, mouseWheel, paint, reenterMouse, repaint, repaint, repaint, repaint, repaint, repaint, requestFocus, scrollAreaToVisible, scrollAreaToVisible, setAttribute, setAutomationID, setCursor, setDragSource, setDropTarget, setEnabled, setFocused, setHeight, setHeightLimits, setHeightLimits, setLocation, setLocation, setMaximumHeight, setMaximumWidth, setMenuHandler, setMinimumHeight, setMinimumWidth, setName, setParent, setPreferredHeight, setPreferredSize, setPreferredSize, setPreferredWidth, setSize, setSize, setStyleName, setStyleNames, setStyleNames, setStyles, setStyles, setTooltipDelay, setTooltipText, setTooltipWrapText, setVisible, setWidth, setWidthLimits, setWidthLimits, setX, setY, toString, transferFocus, validate
public ListView()
public ListView(List<?> listData)
Note that the default renderer uses (as last option) the toString method on list elements, so override it to return whatever you want to display in the ListView, or implement your own custom renderer.
listData
- The data to set.ListViewItemRenderer
public List<?> getListData()
public void setListData(List<?> listData)
listData
- The data to be presented by the list view.public final void setListData(String listData)
listData
- A JSON string (must begin with [ and end with ])
denoting the data to be presented by the list view.public void setListData(URL listData)
listData
- A URL referring to a JSON file containing the data to be presented by
the list view.protected void setSkin(Skin skin)
Component
public ListView.ItemRenderer getItemRenderer()
public void setItemRenderer(ListView.ItemRenderer itemRenderer)
itemRenderer
- The item renderer for the list.public ListView.ItemEditor getItemEditor()
public void setItemEditor(ListView.ItemEditor itemEditor)
itemEditor
- The item editor for the list.public int getSelectedIndex()
public void setSelectedIndex(int index)
index
- The index to select, or -1 to clear the selection.public void setSelectedRange(int start, int end)
start
- end
- public ImmutableList<Span> getSelectedRanges()
public Sequence<Span> setSelectedRanges(Sequence<Span> selectedRanges)
selectedRanges
- public final Sequence<Span> setSelectedRanges(String selectedRanges)
selectedRanges
- A JSON-formatted string containing the ranges to select.IllegalArgumentException
- if the range string is null
or
if it can't be parsed as a JSON list.setSelectedRanges(Sequence)
public int getFirstSelectedIndex()
public int getLastSelectedIndex()
public boolean addSelectedIndex(int index)
index
- The index to add.public Sequence<Span> addSelectedRange(int start, int end)
start
- The first index in the range.end
- The last index in the range.IllegalStateException
- if the ListView
is not in multi-selection mode.public Sequence<Span> addSelectedRange(Span range)
range
- The range to add.IllegalArgumentException
- if the range is null
.public boolean removeSelectedIndex(int index)
index
- The index to remove.public Sequence<Span> removeSelectedRange(int start, int end)
start
- The start of the range to remove.end
- The end of the range to remove.IllegalStateException
- if the ListView
is not in multi-selection mode.public Sequence<Span> removeSelectedRange(Span range)
range
- The range to remove.public void selectAll()
public void clearSelection()
public boolean isItemSelected(int index)
index
- The index whose selection state is to be tested.public Object getSelectedItem()
public void setSelectedItem(Object item)
public Sequence<?> getSelectedItems()
public ListView.SelectMode getSelectMode()
public void setSelectMode(ListView.SelectMode selectMode)
selectMode
- The new selection mode.public boolean getCheckmarksEnabled()
public void setCheckmarksEnabled(boolean checkmarksEnabled)
checkmarksEnabled
- Whether checkmarks are enabled for each item.public boolean isItemChecked(int index)
index
- Index of item to interrogate.public void setItemChecked(int index, boolean checked)
index
- Index of item.checked
- New value for the item's checked state.IllegalStateException
- if checkmarks are not enabled.public ImmutableList<Integer> getCheckedIndexes()
public void clearCheckmarks()
public boolean isCheckmarkDisabled(int index)
index
- The index of the item whose disabled checkmark state is to be tested.public Filter<?> getDisabledCheckmarkFilter()
Note: this filter is only relevant if
checkmarksEnabled
is set to true.
public void setDisabledCheckmarkFilter(Filter<?> disabledCheckmarkFilter)
Note: this filter is only relavent if
checkmarksEnabled
is set to true.
enabled.
disabledCheckmarkFilter
- The disabled checkmark filter, or null for no disabled
checkmark filterpublic boolean isItemDisabled(int index)
index
- The index of the item whose disabled state is to be tested.public Filter<?> getDisabledItemFilter()
public void setDisabledItemFilter(Filter<?> disabledItemFilter)
disabledItemFilter
- The disabled item filter, or null for no disabled item filter.public String getListDataKey()
public void setListDataKey(String listDataKey)
listDataKey
- The key to set.public BindType getListDataBindType()
public void setListDataBindType(BindType listDataBindType)
public ListView.ListDataBindMapping getListDataBindMapping()
public void setListDataBindMapping(ListView.ListDataBindMapping listDataBindMapping)
public String getSelectedItemKey()
public void setSelectedItemKey(String selectedItemKey)
public BindType getSelectedItemBindType()
public void setSelectedItemBindType(BindType selectedItemBindType)
public ListView.ItemBindMapping getSelectedItemBindMapping()
public void setSelectedItemBindMapping(ListView.ItemBindMapping selectedItemBindMapping)
public String getSelectedItemsKey()
public void setSelectedItemsKey(String selectedItemsKey)
public BindType getSelectedItemsBindType()
public void setSelectedItemsBindType(BindType selectedItemsBindType)
public ListView.ItemBindMapping getSelectedItemsBindMapping()
public void setSelectedItemsBindMapping(ListView.ItemBindMapping selectedItemsBindMapping)
public String getCheckedItemsKey()
public void setCheckedItemsKey(String checkedItemsKey)
public BindType getCheckedItemsBindType()
public void setCheckedItemsBindType(BindType checkedItemsBindType)
public ListView.ItemBindMapping getCheckedItemsBindMapping()
public void setCheckedItemsBindMapping(ListView.ItemBindMapping checkedItemsBindMapping)
public void load(Object context)
Component
public void store(Object context)
Component
public void clear()
Component
public int getItemAt(int y)
y
- The y-coordinate of the item to identify.public Bounds getItemBounds(int index)
index
- The item index.public int getItemIndent()
public ListenerList<ListViewListener> getListViewListeners()
public ListenerList<ListViewItemListener> getListViewItemListeners()
public ListenerList<ListViewItemStateListener> getListViewItemStateListeners()
public ListenerList<ListViewSelectionListener> getListViewSelectionListeners()
public ListenerList<ListViewBindingListener> getListViewBindingListeners()