XdevListBox (XDEV Application Framework 6.0.0 API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JList
      - xdev.ui.XdevListBox

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Scrollable, ExtendedList<XdevListBox>, FormularComponent<XdevListBox>, MasterDetailComponent<XdevListBox>, Pageable, PopupRowSelectionHandler, VirtualTableOwner, XdevFocusCycleComponent

Direct Known Subclasses:

XdevNmListBox
```
@BeanSettings(useXdevCustomizer=true)
public class XdevListBox
extends JList
implements ExtendedList<XdevListBox>, XdevFocusCycleComponent, PopupRowSelectionHandler, Pageable
```
The standard listbox in XDEV. Based on JList.

Since:

2.0

Author:

XDEV Software

See Also:

JList, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`XdevListBox.ItemListModelWrapper`
`protected class`	`XdevListBox.XdevCheckBoxListCellRenderer`
`protected class`	`XdevListBox.XdevListCellRenderer`
`protected class`	`XdevListBox.XdevListSelectionModel`

Nested classes/interfaces inherited from class javax.swing.JList
JList.AccessibleJList, JList.DropLocation

Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Nested classes/interfaces inherited from interface xdev.ui.MasterDetailComponent
MasterDetailComponent.DetailHandler

Nested classes/interfaces inherited from interface xdev.ui.FormularComponent
FormularComponent.ValueChangeListener

Field Summary

Fields
Modifier and Type Field and Description

static String CHECKBOX_LIST_PROPERTY

static String EVEN_BACKGROUND_PROPERTY

static String ODD_BACKGROUND_PROPERTY
- Fields inherited from class javax.swing.JList
  HORIZONTAL_WRAP, VERTICAL, VERTICAL_WRAP
- Fields inherited from class javax.swing.JComponent
  listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
- Fields inherited from class java.awt.Component
  accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
- Fields inherited from interface xdev.ui.FormularComponent
  DATA_FIELD_SEPARATOR
- Fields inherited from interface xdev.ui.XdevFocusCycleComponent
  TAB_INDEX_PROPERTY
- Fields inherited from interface java.awt.image.ImageObserver
  ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields
Modifier and Type	Field and Description
`static String`	`CHECKBOX_LIST_PROPERTY`
`static String`	`EVEN_BACKGROUND_PROPERTY`
`static String`	`ODD_BACKGROUND_PROPERTY`

Constructor Summary

Constructors
Constructor and Description
`XdevListBox()` Constructs a `XdevListBox` that is initialized with a default `ListCellRenderer`.
`XdevListBox(boolean checkable)` Constructs a `XdevListBox` that is initialized with a default `ListCellRenderer`.
`XdevListBox(ItemList il)` Constructs a `XdevListBox` that is initialized with the `il` and a default `ListCellRenderer`.
`XdevListBox(ItemList il, boolean checkable)` Constructs a `XdevListBox` that is initialized with the `il` and a default `ListCellRenderer`.
`XdevListBox(ListModel model)` Constructs a `XdevListBox` that is initialized with the `model` and a default `ListCellRenderer`.
`XdevListBox(ListModel model, boolean checkable)` Constructs a `XdevListBox` that is initialized with the `model` and a default `ListCellRenderer`.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addValidator(Validator validator)` Adds a validator to this component
`void`	`addValueChangeListener(FormularComponent.ValueChangeListener l)` Registers a `FormularComponent.ValueChangeListener`.
`void`	`clearModel()` Clears the underlying data model, mostly a `VirtualTable`, and the view.
`protected ListCellRenderer`	`createCheckBoxListCellRenderer()`
`protected ListCellRenderer`	`createDefaultListCellRenderer()`
`protected ListSelectionModel`	`createListSelectionModel()`
`Rectangle`	`getCellBounds(int index0, int index1)`
`String`	`getDataField()` Returns the name of the bound data field of this formular component.
`Color`	`getEvenBackground()` Returns the background `Color` of even rows.
`Operator`	`getFilterOperator()` Returns the operator used in `Formular.createCondition(String)`
`String`	`getFormularName()` Returns the name of the component in the formular context.
`Object`	`getFormularValue()` Returns the value of the component.
`ItemList`	`getItemList()` Returns the `ItemList`, that include the `item` and `data`.
`Color`	`getOddBackground()` Returns the background `Color` of odd rows.
`ListBoxPageControl`	`getPageControl()`
`Dimension`	`getPreferredScrollableViewportSize()`
`Dimension`	`getPreferredSize()`
`int`	`getRowAtPoint(int x, int y)` This method is a alias for `getRowAtPoint(Point)`.
`int`	`getRowAtPoint(Point location)` Returns the row index closest to the given location in the list's coordinate system.
`Object`	`getSelectedData()` Returns the data for the selected value from `ItemList`.
`XdevList<Object>`	`getSelectedDataAsList()` Returns all data of the selected list entries as a list.
`XdevList<Integer>`	`getSelectedIndicesAsList()` Returns a `XdevList` of all of the selected indices, in increasing order.
`Object`	`getSelectedItem()` Returns the item for the selected value from `ItemList`.
`XdevList<Object>`	`getSelectedItemsAsList()` Returns all items of the selected list entries as a list.
`int`	`getSelectedModelIndex()` Returns the modelindex of the selected item.
`int[]`	`getSelectedModelIndices()` Returns the modelindices of the selected items.
`VirtualTable.VirtualTableRow`	`getSelectedVirtualTableRow()` Returns the selected `VirtualTable.VirtualTableRow` of this component, or `null` if nothing is selected.
`VirtualTable.VirtualTableRow[]`	`getSelectedVirtualTableRows()` Returns the selected `VirtualTable.VirtualTableRow`s of this component, or an empty array if nothing is selected.
`int`	`getTabIndex()` Returns the tabindex assigned to this component.
`Validator[]`	`getValidators()` Returns all validators of this component.
`VirtualTable`	`getVirtualTable()` Returns the associated `VirtualTable` of this object.
`void`	`handlePopupRowSelection(int x, int y)` Handles the row selection of and `PopupRowSelectionHandler`.
`boolean`	`hasStateChanged()` Checks if the component's state since the last call of `FormularComponent.saveState()` has changed.
`boolean`	`isCheckBoxList()` Returns `true` if the `items` of this `XdevListBox` were drawn with a checkbox style.
`protected boolean`	`isElementSelectable(Object item)`
`boolean`	`isMultiSelect()` Returns whether the component supports multi selection or not.
`boolean`	`isPagingEnabled()`
`boolean`	`isReadOnly()` Determines whether this component is only used to display values.
`boolean`	`isSomethingSelected()` Verify if a item is selected.
`ItemList`	`modelToItemList(ListModel model)` Create a new `ItemList` based on the provided `model`.
`void`	`refresh()` Reloads the data from the underlying data source with the last executed resp.
`void`	`removeValidator(Validator validator)` Removes a validator from this component
`void`	`restoreState()` Restores the internally saved state of the component.
`void`	`saveState()` Saves the state of the component internally.
`void`	`selectAll()` Select all items in the `XdevListBox`.
`void`	`setCheckBoxList(boolean checkBoxList)` Sets if this list should use checkboxes to render the list entries.
`void`	`setDataField(String dataField)` Sets the name of the bound data field of this formular component.
`void`	`setDetailHandler(MasterDetailComponent.DetailHandler detailHandler)` Sets the handler which controls the corporation of two `MasterDetailComponent`s.
`void`	`setEvenBackground(Color evenBackground)` Sets the background `Color` of even rows.
`void`	`setFilterOperator(Operator filterOperator)` Sets the filter operator used in `Formular.createCondition(String)`
`void`	`setFormularValue(VirtualTable vtRow, int col, Object value)` Deprecated.
`void`	`setFormularValue(VirtualTable vt, Map<String,Object> record)` Sets the value of the component, taking the value(s) of the record according to `FormularComponent.getDataField()`.
`void`	`setItemList(ItemList itemList)` Sets the `ItemList` that represents the contents or "value" of the `ExtendedList` and then clears the list's selection.
`void`	`setMasterValue(VirtualTable vt, Map<String,Object> record)` Sets the value of this component (master), taking the value(s) of the record.
`void`	`setModel(VirtualTable vt, String itemCol, String dataCol)` Updates the underlying model with data from the `VirtualTable` vt.
`void`	`setModel(VirtualTable vt, String itemCol, String dataCol, boolean queryData)` Updates the underlying model with data from the `VirtualTable` vt.
`void`	`setModel(VirtualTable vt, String itemCol, String dataCol, boolean queryData, boolean selectiveQuery)` Updates the underlying model with data from the `VirtualTable` vt.
`void`	`setOddBackground(Color oddBackground)` Sets the background `Color` of odd rows.
`void`	`setPagingEnabled(boolean pagingEnabled)` Turns the paging behavior on or off.
`void`	`setReadOnly(boolean readOnly)` Sets if this form component is only used to display values.
`void`	`setSelectedData(Collection<?> dataList)` Selects all entries with a data in the list `dataList`.
`void`	`setSelectedData(Object o)` Selects the specified data from the `XdevList`.
`void`	`setSelectedIndices(Collection<Integer> indices)` Changes the selection to be the set of indices specified by the given `XdevList`.
`void`	`setSelectedItem(Object o)` Selects the specified item.
`void`	`setSelectedItems(Collection<?> items)` Selects all entries with an item in the list `items`.
`void`	`setSelectedModelIndex(int index)` Selects the item at modelindex `anIndex`.
`void`	`setSelectedModelIndices(int[] indices)` Selects the items at their modelindices position `indices`.
`void`	`setSelectedVirtualTableRow(VirtualTable.VirtualTableRow row)` Selects the row in the list if present.
`void`	`setSelectedVirtualTableRows(VirtualTable.VirtualTableRow[] rows)` Selects the rows in the list if present.
`void`	`setTabIndex(int tabIndex)` Sets the tabindex of this component.
`void`	`setVirtualTable(VirtualTable vt)` Sets the `VirtualTable` containing the valid values for this component.
`void`	`setVisibleRowCount(int visibleRowCount)`
`String`	`toString()`
`void`	`updateModel(Condition condition, Object... params)` Reloads the data form the underlying data source.
`void`	`validateState()` Calls `Validator.validate(Object)` of all registered `Validator`s.
`void`	`validateState(Validation validation)` Calls `Validator.validate(Object)` of all registered `Validator`s.
`boolean`	`verify()` Returns whether the component's value adheres all set constraints.

Methods inherited from class javax.swing.JList
addListSelectionListener, addSelectionInterval, clearSelection, createSelectionModel, ensureIndexIsVisible, fireSelectionValueChanged, getAccessibleContext, getAnchorSelectionIndex, getCellRenderer, getDragEnabled, getDropLocation, getDropMode, getFirstVisibleIndex, getFixedCellHeight, getFixedCellWidth, getLastVisibleIndex, getLayoutOrientation, getLeadSelectionIndex, getListSelectionListeners, getMaxSelectionIndex, getMinSelectionIndex, getModel, getNextMatch, getPrototypeCellValue, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedIndex, getSelectedIndices, getSelectedValue, getSelectedValues, getSelectedValuesList, getSelectionBackground, getSelectionForeground, getSelectionMode, getSelectionModel, getToolTipText, getUI, getUIClassID, getValueIsAdjusting, getVisibleRowCount, indexToLocation, isSelectedIndex, isSelectionEmpty, locationToIndex, paramString, removeListSelectionListener, removeSelectionInterval, setCellRenderer, setDragEnabled, setDropMode, setFixedCellHeight, setFixedCellWidth, setLayoutOrientation, setListData, setListData, setModel, setPrototypeCellValue, setSelectedIndex, setSelectedIndices, setSelectedValue, setSelectionBackground, setSelectionForeground, setSelectionInterval, setSelectionMode, setSelectionModel, setUI, setValueIsAdjusting, updateUI

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

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

Methods inherited from interface xdev.ui.FormularComponent
getClientProperty, isEnabled, isVisible, putClientProperty

- Field Detail
  - CHECKBOX_LIST_PROPERTY
```
public static final String CHECKBOX_LIST_PROPERTY
```
    See Also:
    
    Constant Field Values
  - EVEN_BACKGROUND_PROPERTY
```
public static final String EVEN_BACKGROUND_PROPERTY
```
    See Also:
    
    Constant Field Values
  - ODD_BACKGROUND_PROPERTY
```
public static final String ODD_BACKGROUND_PROPERTY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - XdevListBox
```
public XdevListBox()
```
    Constructs a XdevListBox that is initialized with a default ListCellRenderer.
    
    See Also:
    
    setCheckBoxList(boolean), setItemList(ItemList)
  - XdevListBox
```
public XdevListBox(boolean checkable)
```
    Constructs a XdevListBox that is initialized with a default ListCellRenderer.
    
    Parameters:
    
    checkable - if true the XdevListBox items are initialized with a checkbox style
    
    See Also:
    
    setItemList(ItemList), setCheckBoxList(boolean)
  - XdevListBox
```
public XdevListBox(ItemList il)
```
    Constructs a XdevListBox that is initialized with the il and a default ListCellRenderer.
    
    Parameters:
    
    il - represents the contents or "value" of this XdevListBox
    
    See Also:
    
    setItemList(ItemList), setCheckBoxList(boolean)
  - XdevListBox
```
public XdevListBox(ListModel model)
```
    Constructs a XdevListBox that is initialized with the model and a default ListCellRenderer.
    
    Parameters:
    
    model - the ListModel for this XdevListBox
    
    See Also:
    
    JList.setModel(ListModel), setCheckBoxList(boolean)
  - XdevListBox
```
public XdevListBox(ItemList il,
                   boolean checkable)
```
    Constructs a XdevListBox that is initialized with the il and a default ListCellRenderer.
    
    Parameters:
    
    il - represents the contents or "value" of this XdevListBox
    
    checkable - if true the XdevListBox items are initialized with a checkbox style
    
    See Also:
    
    setCheckBoxList(boolean), setItemList(ItemList)
  - XdevListBox
```
public XdevListBox(ListModel model,
                   boolean checkable)
```
    Constructs a XdevListBox that is initialized with the model and a default ListCellRenderer.
    
    Parameters:
    
    model - the ListModel for this XdevListBox
    
    checkable - if true the XdevListBox items are initialized with a checkbox style
    
    See Also:
    
    setCheckBoxList(boolean), JList.setModel(ListModel)
- Method Detail
  - isElementSelectable
```
protected boolean isElementSelectable(Object item)
```
  - setCheckBoxList
```
public void setCheckBoxList(boolean checkBoxList)
```
    Sets if this list should use checkboxes to render the list entries.
    
    Parameters:
    
    checkBoxList - true if this list should use checkboxes
  - createListSelectionModel
```
protected ListSelectionModel createListSelectionModel()
```
  - createDefaultListCellRenderer
```
protected ListCellRenderer createDefaultListCellRenderer()
```
  - createCheckBoxListCellRenderer
```
protected ListCellRenderer createCheckBoxListCellRenderer()
```
  - isCheckBoxList
```
public boolean isCheckBoxList()
```
    Returns true if the items of this XdevListBox were drawn with a checkbox style.
    
    Returns:
    
    true if the items of this XdevListBox were drawn with a checkbox style, otherwise false.
  - getItemList
```
public ItemList getItemList()
```
    Returns the ItemList, that include the item and data.
    
    Specified by:
    
    getItemList in interface ExtendedList<XdevListBox>
    
    Returns:
    
    the ItemList of this ExtendedList
  - setItemList
```
public void setItemList(ItemList itemList)
```
    Sets the ItemList that represents the contents or "value" of the ExtendedList and then clears the list's selection.
    
    Specified by:
    
    setItemList in interface ExtendedList<XdevListBox>
    
    Parameters:
    
    itemList - ItemList include the item and data
  - modelToItemList
```
public ItemList modelToItemList(ListModel model)
```
    Create a new ItemList based on the provided model. The data are the model's values and the item's are the model's values as String.
    
    Parameters:
    
    model - The ListModel
    
    Returns:
    
    the new ItemList
  - setModel
```
public void setModel(VirtualTable vt,
                     String itemCol,
                     String dataCol)
```
    Updates the underlying model with data from the VirtualTable vt.
    This is a shortcut for setModel(vt,itemCol,dataCol,false)
    
    Specified by:
    
    setModel in interface ExtendedList<XdevListBox>
    
    Parameters:
    
    vt - the VirtualTable containing the data for the model
    
    itemCol - columnname to fill item from or string with variables like "{%SURNAME} {%NAME} - {%AGE}"
    
    dataCol - column name to fill data from, or multiple columns names, comma-separated
    
    See Also:
    
    ItemList.setModel(VirtualTable, String, String), StringUtils.format(String, xdev.util.StringUtils.ParameterProvider)
  - setModel
```
public void setModel(VirtualTable vt,
                     String itemCol,
                     String dataCol,
                     boolean queryData)
```
    Updates the underlying model with data from the VirtualTable vt.
    
    Specified by:
    
    setModel in interface ExtendedList<XdevListBox>
    
    Parameters:
    
    vt - the VirtualTable containing the data for the model
    
    itemCol - columnname to fill item from or string with variables like "{%SURNAME} {%NAME} - {%AGE}"
    
    dataCol - column name to fill data from, or multiple columns names, comma-separated
    
    queryData - if true, the best fitting select for this vt is used
    
    See Also:
    
    ItemList.setModel(VirtualTable, String, String, boolean), StringUtils.format(String, xdev.util.StringUtils.ParameterProvider)
  - setModel
```
public void setModel(VirtualTable vt,
                     String itemCol,
                     String dataCol,
                     boolean queryData,
                     boolean selectiveQuery)
```
    Updates the underlying model with data from the VirtualTable vt.
    
    Specified by:
    
    setModel in interface ExtendedList<XdevListBox>
    
    Parameters:
    
    vt - the VirtualTable containing the data for the model
    
    itemCol - columnname to fill item from or string with variables like "{%SURNAME} {%NAME} - {%AGE}"
    
    dataCol - column name to fill data from, or multiple columns names, comma-separated
    
    queryData - if true, the best fitting select for this vt is used
    
    selectiveQuery - if true, only the used columns are queried
    
    See Also:
    
    ItemList.setModel(VirtualTable, String, String, boolean, boolean), StringUtils.format(String, xdev.util.StringUtils.ParameterProvider)
  - setPagingEnabled
```
public void setPagingEnabled(boolean pagingEnabled)
```
    Turns the paging behavior on or off.
    
    Specified by:
    
    setPagingEnabled in interface Pageable
    
    Parameters:
    
    pagingEnabled - true if the paging should be controlled via the Pageable.getPageControl()
    
    Since:
    
    4.0
    
    See Also:
    
    Pageable.isPagingEnabled()
  - isPagingEnabled
```
public boolean isPagingEnabled()
```
    Specified by:
    
    isPagingEnabled in interface Pageable
    
    Returns:
    
    true if the paging behavior is on, false otherwise
    
    Since:
    
    4.0
    
    See Also:
    
    Pageable.setPagingEnabled(boolean)
  - getPageControl
```
public ListBoxPageControl getPageControl()
```
    Specified by:
    
    getPageControl in interface Pageable
    
    Returns:
    
    the controller object to control the paging of the pageable component
    
    Since:
    
    4.0
  - refresh
```
public void refresh()
```
    Reloads the data from the underlying data source with the last executed resp. default query.
    
    Specified by:
    
    refresh in interface MasterDetailComponent<XdevListBox>
  - updateModel
```
public void updateModel(Condition condition,
                        Object... params)
```
    Reloads the data form the underlying data source.
    The last executed query is extended with condition.
    
    Specified by:
    
    updateModel in interface VirtualTableOwner
    
    Parameters:
    
    condition - The additional filter for the query
    
    params - param objects used in condition
  - clearModel
```
public void clearModel()
```
    Clears the underlying data model, mostly a VirtualTable, and the view.
    
    Specified by:
    
    clearModel in interface MasterDetailComponent<XdevListBox>
  - setEvenBackground
```
public void setEvenBackground(Color evenBackground)
```
    Sets the background Color of even rows.
    
    Parameters:
    
    evenBackground - The background of even rows as type Color.
  - getEvenBackground
```
public Color getEvenBackground()
```
    Returns the background Color of even rows.
    
    Returns:
    
    The background of even rows as type Color.
  - setOddBackground
```
public void setOddBackground(Color oddBackground)
```
    Sets the background Color of odd rows.
    
    Parameters:
    
    oddBackground - The background of odd rows as type Color.
  - getOddBackground
```
public Color getOddBackground()
```
    Returns the background Color of odd rows.
    
    Returns:
    
    The background of odd rows as type Color.
  - selectAll
```
public void selectAll()
```
    Select all items in the XdevListBox.
    
    See Also:
    
    ListSelectionModel.clearSelection(), ListSelectionModel.setSelectionInterval(int, int)
  - isSomethingSelected
```
public boolean isSomethingSelected()
```
    Verify if a item is selected.
    
    Returns:
    
    true if a item is selected, otherwise false.
  - setSelectedIndices
```
public void setSelectedIndices(Collection<Integer> indices)
```
    Changes the selection to be the set of indices specified by the given XdevList. Indices greater than or equal to the model size are ignored. This is a convenience method that clears the selection and then uses addSelectionInterval on the selection model to add the indices. Refer to the documentation of the selection model class being used for details on how values less than 0 are handled.
    
    Parameters:
    
    indices - an XdevList of the indices of the cells to select, non-null
    
    See Also:
    
    JList.setSelectedIndices(int[])
  - getSelectedIndicesAsList
```
public XdevList<Integer> getSelectedIndicesAsList()
```
    Returns a XdevList of all of the selected indices, in increasing order.
    
    Returns:
    
    all of the selected indices, in increasing order, or an empty XdevList if nothing is selected
  - getSelectedModelIndex
```
public int getSelectedModelIndex()
```
    Returns the modelindex of the selected item.
    For example the index of the selected item in it is VirtualTable.
    
    Returns:
    
    an integer specifying the currently selected list item, where 0 specifies the first item in the list; or -1 if no item is selected or if the currently selected item is not in the list
  - getSelectedModelIndices
```
public int[] getSelectedModelIndices()
```
    Returns the modelindices of the selected items.
    For example the indices of the selected items in their model VirtualTable.
    
    Returns:
    
    an integer specifying the currently selected list item, where 0 specifies the first item in the list; or -1 if no item is selected or if the currently selected item is not in the list
  - setSelectedModelIndices
```
public void setSelectedModelIndices(int[] indices)
```
    Selects the items at their modelindices position indices.
    For example the given indices of the items in their model VirtualTable .
    
    Parameters:
    
    indices - an integer specifying the list item to select, where 0 specifies the first item in the list and -1 indicates no selection.
  - setSelectedModelIndex
```
public void setSelectedModelIndex(int index)
```
    Selects the item at modelindex anIndex.
    For example the given index of an item in it is model VirtualTable .
    
    Parameters:
    
    index - an integer specifying the list item to select, where 0 specifies the first item in the list and -1 indicates no selection
  - setSelectedItems
```
public void setSelectedItems(Collection<?> items)
```
    Selects all entries with an item in the list items.
    
    Parameters:
    
    items - the items to select
    
    Since:
    
    3.1
  - getSelectedItem
```
public Object getSelectedItem()
```
    Returns the item for the selected value from ItemList.
    
    Returns:
    
    the item for the selected value from ItemList
  - getSelectedItemsAsList
```
public XdevList<Object> getSelectedItemsAsList()
```
    Returns all items of the selected list entries as a list.
    If nothing is selected an empty list is returned.
    
    Returns:
    
    all selected items or an empty list if nothing is selected.
    
    Since:
    
    3.1
  - setSelectedItem
```
public void setSelectedItem(Object o)
```
    Selects the specified item. The XdevListBox scrolls to the selected item.
    
    Parameters:
    
    o - the item to select
    
    See Also:
    
    JList.setSelectedValue(Object, boolean)
  - getSelectedData
```
public Object getSelectedData()
```
    Returns the data for the selected value from ItemList.
    
    Returns:
    
    the data for the selected value from ItemList
  - getSelectedDataAsList
```
public XdevList<Object> getSelectedDataAsList()
```
    Returns all data of the selected list entries as a list.
    If nothing is selected an empty list is returned.
    
    Returns:
    
    all selected data or an empty list if nothing is selected.
    
    Since:
    
    3.1
  - setSelectedData
```
public void setSelectedData(Object o)
```
    Selects the specified data from the XdevList. If o doesn't exist in the ItemList the selection is cleared.
    
    Parameters:
    
    o - the data to select
    
    See Also:
    
    JList.setSelectedIndex(int)
  - setSelectedData
```
public void setSelectedData(Collection<?> dataList)
```
    Selects all entries with a data in the list dataList.
    
    Parameters:
    
    dataList - the data to select
    
    Since:
    
    3.1
  - getSelectedVirtualTableRow
```
public VirtualTable.VirtualTableRow getSelectedVirtualTableRow()
```
    Returns the selected VirtualTable.VirtualTableRow of this component, or null if nothing is selected.
    
    Specified by:
    
    getSelectedVirtualTableRow in interface MasterDetailComponent<XdevListBox>
    
    Returns:
    
    the selected VirtualTable.VirtualTableRow of this component
  - setSelectedVirtualTableRow
```
public void setSelectedVirtualTableRow(VirtualTable.VirtualTableRow row)
```
    Selects the row in the list if present.
    
    Parameters:
    
    row - the row to select
    
    Since:
    
    3.2
  - getSelectedVirtualTableRows
```
public VirtualTable.VirtualTableRow[] getSelectedVirtualTableRows()
```
    Returns the selected VirtualTable.VirtualTableRows of this component, or an empty array if nothing is selected.
    
    Returns:
    
    the selected VirtualTable.VirtualTableRows of this component
    
    Since:
    
    3.2
  - setSelectedVirtualTableRows
```
public void setSelectedVirtualTableRows(VirtualTable.VirtualTableRow[] rows)
```
    Selects the rows in the list if present.
    
    Parameters:
    
    rows - the rows to select
    
    Since:
    
    3.2
  - getFormularName
```
public String getFormularName()
```
    Returns the name of the component in the formular context.
    
    Specified by:
    
    getFormularName in interface FormularComponent<XdevListBox>
    
    Returns:
    
    the name of the component in the formular context.
  - setDataField
```
public void setDataField(String dataField)
```
    Sets the name of the bound data field of this formular component.
    
    Specified by:
    
    setDataField in interface FormularComponent<XdevListBox>
    
    Parameters:
    
    dataField - the new bound data field
    
    Since:
    
    3.1
  - getDataField
```
public String getDataField()
```
    Returns the name of the bound data field of this formular component.
    
    Specified by:
    
    getDataField in interface FormularComponent<XdevListBox>
    
    Returns:
    
    the name of the bound data field
    
    Since:
    
    3.1
  - setFormularValue
```
@Deprecated
public void setFormularValue(VirtualTable vtRow,
                                         int col,
                                         Object value)
```
    Deprecated.
    
    Sets the value of the component according to the provided value value. The value is formatted using the column format of the provided VirtualTable and columnIndex.
    
    Specified by:
    
    setFormularValue in interface FormularComponent<XdevListBox>
    
    Parameters:
    
    vtRow - VirtualTable to use the format from
    
    col - of the column to use the format from
    
    value - value to set
  - setFormularValue
```
public void setFormularValue(VirtualTable vt,
                             Map<String,Object> record)
```
    Sets the value of the component, taking the value(s) of the record according to FormularComponent.getDataField().
    
    Specified by:
    
    setFormularValue in interface FormularComponent<XdevListBox>
    
    Parameters:
    
    vt - the underlying virtual table
    
    record - the data <column,value>
  - setMasterValue
```
public void setMasterValue(VirtualTable vt,
                           Map<String,Object> record)
```
    Sets the value of this component (master), taking the value(s) of the record.
    Called by the MasterDetailHandler if the client's value has changed.
    
    Specified by:
    
    setMasterValue in interface MasterDetailComponent<XdevListBox>
    
    Parameters:
    
    vt - the underlying virtual table
    
    record - the data <column,value>
    
    Since:
    
    3.2
  - getFormularValue
```
public Object getFormularValue()
```
    Returns the value of the component.
    
    Specified by:
    
    getFormularValue in interface FormularComponent<XdevListBox>
    
    Returns:
    
    the value of the component.
  - saveState
```
public void saveState()
```
    Saves the state of the component internally.
    A saved state can be restored using FormularComponent.restoreState().
    
    Specified by:
    
    saveState in interface FormularComponent<XdevListBox>
  - restoreState
```
public void restoreState()
```
    Restores the internally saved state of the component.
    The state of the component can be saved using FormularComponent.saveState().
    
    Specified by:
    
    restoreState in interface FormularComponent<XdevListBox>
  - hasStateChanged
```
public boolean hasStateChanged()
```
    Checks if the component's state since the last call of FormularComponent.saveState() has changed.
    
    Specified by:
    
    hasStateChanged in interface FormularComponent<XdevListBox>
    
    Returns:
    
    true if the component's state has changed, false otherwise
    
    Since:
    
    3.1
  - isMultiSelect
```
public boolean isMultiSelect()
```
    Returns whether the component supports multi selection or not.
    A component that supports multi selection can have more than one selected item / value.
    
    Specified by:
    
    isMultiSelect in interface FormularComponent<XdevListBox>
    
    Returns:
    
    true if the component supports multi selection, false otherwise.
  - verify
```
public boolean verify()
```
    Returns whether the component's value adheres all set constraints.
    This is a alternative method for FormularComponent.validateState(), but this method returns a boolean depending on the validation's result and doesn't throw an ValidationException.
    
    Specified by:
    
    verify in interface FormularComponent<XdevListBox>
    
    Returns:
    
    true if the value of the component adheres all set constraints; otherwise false.
  - addValidator
```
public void addValidator(Validator validator)
```
    Adds a validator to this component
    
    Specified by:
    
    addValidator in interface FormularComponent<XdevListBox>
    
    Parameters:
    
    validator - the validator to add
    
    Since:
    
    3.1
    
    See Also:
    
    FormularComponent.validateState()
  - removeValidator
```
public void removeValidator(Validator validator)
```
    Removes a validator from this component
    
    Specified by:
    
    removeValidator in interface FormularComponent<XdevListBox>
    
    Parameters:
    
    validator - the validator to remove
    
    Since:
    
    3.1
    
    See Also:
    
    FormularComponent.validateState()
  - getValidators
```
public Validator[] getValidators()
```
    Returns all validators of this component.
    If no validator is present an empty array is returned.
    
    Specified by:
    
    getValidators in interface FormularComponent<XdevListBox>
    
    Returns:
    
    all validators of this component
    
    Since:
    
    3.1
  - validateState
```
public void validateState()
                   throws ValidationException
```
    Calls Validator.validate(Object) of all registered Validators.
    
    Specified by:
    
    validateState in interface FormularComponent<XdevListBox>
    
    Throws:
    
    ValidationException
    
    Since:
    
    3.1
    
    See Also:
    
    FormularComponent.verify()
  - validateState
```
public void validateState(Validation validation)
                   throws ValidationException
```
    Calls Validator.validate(Object) of all registered Validators.
    Every ValidationException is recorded in the validation object, and if Validation.continueValidation(ValidationException) returns false this exception is re-thrown by this method.
    
    Specified by:
    
    validateState in interface FormularComponent<XdevListBox>
    
    Parameters:
    
    validation - the validation process object
    
    Throws:
    
    ValidationException
    
    Since:
    
    3.1
    
    See Also:
    
    FormularComponent.verify()
  - setFilterOperator
```
public void setFilterOperator(Operator filterOperator)
```
    Sets the filter operator used in Formular.createCondition(String)
    
    Specified by:
    
    setFilterOperator in interface FormularComponent<XdevListBox>
    
    Parameters:
    
    filterOperator - the new filter operator
    
    Since:
    
    3.1
  - getFilterOperator
```
public Operator getFilterOperator()
```
    Returns the operator used in Formular.createCondition(String)
    
    Specified by:
    
    getFilterOperator in interface FormularComponent<XdevListBox>
    
    Returns:
    
    the component's filter operator
    
    Since:
    
    3.1
  - setReadOnly
```
public void setReadOnly(boolean readOnly)
```
    Sets if this form component is only used to display values.
    
    Specified by:
    
    setReadOnly in interface FormularComponent<XdevListBox>
    
    Parameters:
    
    readOnly - true to only display values
    
    Since:
    
    3.2
  - isReadOnly
```
public boolean isReadOnly()
```
    Determines whether this component is only used to display values.
    
    Specified by:
    
    isReadOnly in interface FormularComponent<XdevListBox>
    
    Returns:
    
    true if this component is only used to display values.
    
    Since:
    
    3.2
  - setVirtualTable
```
public void setVirtualTable(VirtualTable vt)
```
    Sets the VirtualTable containing the valid values for this component.
    
    Specified by:
    
    setVirtualTable in interface VirtualTableOwner
    
    Since:
    
    4.0
  - getVirtualTable
```
public VirtualTable getVirtualTable()
```
    Returns the associated VirtualTable of this object.
    
    Specified by:
    
    getVirtualTable in interface VirtualTableOwner
    
    Returns:
    
    The associated VirtualTable of this object.
  - addValueChangeListener
```
public void addValueChangeListener(FormularComponent.ValueChangeListener l)
```
    Registers a FormularComponent.ValueChangeListener.
    
    Specified by:
    
    addValueChangeListener in interface FormularComponent<XdevListBox>
    
    Parameters:
    
    l - the listener to register
  - setDetailHandler
```
public void setDetailHandler(MasterDetailComponent.DetailHandler detailHandler)
```
    Sets the handler which controls the corporation of two MasterDetailComponents.
    
    Specified by:
    
    setDetailHandler in interface MasterDetailComponent<XdevListBox>
    
    Parameters:
    
    detailHandler - the new MasterDetailComponent.DetailHandler
  - getPreferredSize
```
public Dimension getPreferredSize()
```
    Overrides:
    
    getPreferredSize in class JComponent
  - getPreferredScrollableViewportSize
```
public Dimension getPreferredScrollableViewportSize()
```
    Specified by:
    
    getPreferredScrollableViewportSize in interface Scrollable
    
    Overrides:
    
    getPreferredScrollableViewportSize in class JList
  - getRowAtPoint
```
public int getRowAtPoint(int x,
                         int y)
```
    This method is a alias for getRowAtPoint(Point).
    
    Parameters:
    
    x - the X coordinate of the row
    
    y - the Y coordinate of the row
    
    Returns:
    
    the row index closest to the given location, or -1
    
    See Also:
    
    JList.locationToIndex(Point)
  - getRowAtPoint
```
public int getRowAtPoint(Point location)
```
    Returns the row index closest to the given location in the list's coordinate system. To determine if the row actually contains the specified location, compare the point against the cell's bounds, as provided by getCellBounds. This method returns -1 if the model is empty
    This is a cover method that delegates to the method of the same name in the list's ListUI. It returns -1 if the list has no ListUI.
    
    Parameters:
    
    location - the coordinates of the point
    
    Returns:
    
    the row index closest to the given location, or -1
    
    See Also:
    
    JList.locationToIndex(Point)
  - setVisibleRowCount
```
public void setVisibleRowCount(int visibleRowCount)
```
    Overrides:
    
    setVisibleRowCount in class JList
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Component
  - getTabIndex
```
public int getTabIndex()
```
    Returns the tabindex assigned to this component. The tabindex defines the position of the component in the focus cycle.
    
    Specified by:
    
    getTabIndex in interface XdevFocusCycleComponent
    
    Returns:
    
    tabindex of this component
  - setTabIndex
```
public void setTabIndex(int tabIndex)
```
    Sets the tabindex of this component. The tabindex defines the position of the component in the focus cycle.
    To exclude this component from the focus cycle set tabindex to -1.
    
    Specified by:
    
    setTabIndex in interface XdevFocusCycleComponent
    
    Parameters:
    
    tabIndex - to be set
  - getCellBounds
```
public Rectangle getCellBounds(int index0,
                               int index1)
```
    Overrides:
    
    getCellBounds in class JList
  - handlePopupRowSelection
```
public void handlePopupRowSelection(int x,
                                    int y)
```
    Handles the row selection of and PopupRowSelectionHandler.
    
    Specified by:
    
    handlePopupRowSelection in interface PopupRowSelectionHandler
    
    Parameters:
    
    x - the x-coordinate where the popup action is invoked.
    
    y - the y-coordinate where the popup action is invoked.
    
    Since:
    
    3.2

Class XdevListBox

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JList

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Nested classes/interfaces inherited from interface xdev.ui.MasterDetailComponent

Nested classes/interfaces inherited from interface xdev.ui.FormularComponent

Field Summary

Fields inherited from class javax.swing.JList

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface xdev.ui.FormularComponent

Fields inherited from interface xdev.ui.XdevFocusCycleComponent

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JList

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Methods inherited from interface xdev.ui.FormularComponent

Field Detail

CHECKBOX_LIST_PROPERTY

EVEN_BACKGROUND_PROPERTY

ODD_BACKGROUND_PROPERTY

Constructor Detail

XdevListBox

XdevListBox

XdevListBox

XdevListBox

XdevListBox

XdevListBox

Method Detail

isElementSelectable

setCheckBoxList

createListSelectionModel

createDefaultListCellRenderer

createCheckBoxListCellRenderer

isCheckBoxList

getItemList

setItemList

modelToItemList

setModel

setModel

setModel

setPagingEnabled

isPagingEnabled

getPageControl

refresh

updateModel

clearModel

setEvenBackground

getEvenBackground

setOddBackground

getOddBackground

selectAll

isSomethingSelected

setSelectedIndices

getSelectedIndicesAsList

getSelectedModelIndex

getSelectedModelIndices

setSelectedModelIndices

setSelectedModelIndex

setSelectedItems

getSelectedItem

getSelectedItemsAsList

setSelectedItem

getSelectedData

getSelectedDataAsList

setSelectedData

setSelectedData

getSelectedVirtualTableRow

setSelectedVirtualTableRow

getSelectedVirtualTableRows

setSelectedVirtualTableRows

getFormularName

setDataField

getDataField