java.lang.Object
- io.github.mmm.ui.api.widget.AbstractUiWidget
- - io.github.mmm.ui.spi.widget.AbstractUiNativeWidget
  - - io.github.mmm.ui.spi.widget.AbstractUiNativeWidgetWrapper<W>
    - - io.github.mmm.ui.fx.widget.FxWidget<W>
      - io.github.mmm.ui.fx.widget.FxWidgetStyleable<W>
        
        io.github.mmm.ui.fx.widget.FxWidgetNode<W>
        
        io.github.mmm.ui.fx.widget.FxActiveWidget<W>
        
        io.github.mmm.ui.fx.widget.FxActiveValidatableWidget<javafx.scene.control.TableView<R>,List<R>>
        
        io.github.mmm.ui.fx.widget.data.FxDataTable<R>

Type Parameters:

R - type of the data for the rows displayed by this widget. Typically a Bean.

All Implemented Interfaces:

EventSource<UiEvent,UiEventListener>, AttributeReadEnabled, AttributeReadId, AttributeReadMultiSelection, AttributeReadSelection<R>, AttributeReadSelections<R>, AttributeReadValid, AttributeReadValue<List<R>>, AttributeReadVisible, AttributeWriteEnabled, AttributeWriteId, AttributeWriteMultiSelection, AttributeWriteReadOnly, AttributeWriteSelection<R>, AttributeWriteSelections<R>, AttributeWriteShowRowNumbers, AttributeWriteTooltip, AttributeWriteValidationFailure, AttributeWriteValue<List<R>>, AttributeWriteValueForUser<List<R>>, AttributeWriteVisible, UiAbstractDataTable<R>, UiAbstractDataWidget<R>, UiDataTable<R>, UiActiveWidget, UiNativeWidget, UiRegularWidget, UiWidget, UiValidatableWidget<List<R>>, UiValuedWidget<List<R>>, UiNativeWidgetWrapper<javafx.scene.control.TableView<R>>
```
public class FxDataTable<R>
extends FxActiveValidatableWidget<javafx.scene.control.TableView<R>,List<R>>
implements UiDataTable<R>
```
Implementation of UiDataTable for JavaFx.

Since:

1.0.0

Nested Class Summary
- Nested classes/interfaces inherited from interface io.github.mmm.ui.api.widget.data.UiAbstractDataTable
  UiAbstractDataTable.FilterHandler<R>
- Nested classes/interfaces inherited from interface io.github.mmm.ui.api.widget.data.UiAbstractDataWidget
  UiAbstractDataWidget.ColumnAdapter<D,C>

Field Summary
- Fields inherited from class io.github.mmm.ui.fx.widget.FxWidget
  CLASS_INVALID, CLASS_READ_ONLY, widget
- Fields inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteMultiSelection
  STYLE_SELECTION
- Fields inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteShowRowNumbers
  ROW_NUMBER_HEADER_TITLE, STYLE_ROW_NUMBER
- Fields inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteValidationFailure
  STYLE_INVALID
- Fields inherited from interface io.github.mmm.ui.api.widget.data.UiAbstractDataWidget
  STYLE
- Fields inherited from interface io.github.mmm.ui.api.widget.UiActiveWidget
  ACCESS_KEY_NONE
- Fields inherited from interface io.github.mmm.ui.api.widget.value.UiValidatableWidget
  STYLE_MANDATORY

Constructor Summary

Constructors
Constructor Description

FxDataTable()
The constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addColumn(UiColumn<R,?> column, int index)`
`<V> UiColumn<R,V>`	`createColumn(TypedPropertyPath<V> property)`
`<V> UiColumn<R,V>`	`createColumn(String title, UiAbstractDataWidget.ColumnAdapter<R,V> adapter)`
`UiColumn<R,?>`	`getColumn(int index)`
`int`	`getColumnCount()`
`R`	`getSelection()`
`List<R>`	`getSelections()`
`List<R>`	`getValueOrThrow()`
`boolean`	`isMultiSelection()`
`boolean`	`isShowRowNumbers()`
`void`	`setFilterHandler(UiAbstractDataTable.FilterHandler<R> filterHandler)`
`void`	`setMultiSelection(boolean multiSelection)`
`void`	`setRowTemplate(R rowTemplate)`
`void`	`setSelection(R selection)`
`void`	`setSelections(Collection<R> selection)`
`void`	`setShowRowNumbers(boolean showRowNumbers)`
`protected void`	`setValueNative(List<R> value)`
`void`	`sort(SortOrder order, UiColumn<R,?>... sortColumns)`	This method sorts the data with the given `SortOrder` according to the specified `UiColumn`s.

Methods inherited from class io.github.mmm.ui.fx.widget.FxActiveValidatableWidget
doSetValidationFailure, getModificationTimestamp, getOriginalValue, getValidator, onFocusChanged, onValueChanged, setMandatory, setOriginalValue, setValidator, setValue

Methods inherited from class io.github.mmm.ui.fx.widget.FxActiveWidget
getAccessKey, isFocused, registerFocusChangeHandler, registerHandlers, setAccessKey, setFocused, setParent

Methods inherited from class io.github.mmm.ui.fx.widget.FxWidgetNode
getTopWidget, setEnabledNative, setIdNative, setReadOnlyNative, setTooltipNative, setVisibleNative

Methods inherited from class io.github.mmm.ui.fx.widget.FxWidgetStyleable
createStyles

Methods inherited from class io.github.mmm.ui.fx.widget.FxWidget
getTopNode, getWidget, onAction, onClose, onFocusChange, onValueChange, setTooltip, setWidget

Methods inherited from class io.github.mmm.ui.spi.widget.AbstractUiNativeWidgetWrapper
createDefaultStyles, getId, getStyles, getTooltip, onStylesChanged, setId, setTooltip

Methods inherited from class io.github.mmm.ui.spi.widget.AbstractUiNativeWidget
addListener, dispose, doDispose, doGetEnabledState, doGetVisibleState, doSetEnabledState, doSetEnabledState, doSetVisibleState, doSetVisibleState, ensureHandlers, fireEvent, getEventAdapter, getParent, getProgrammaticEventType, getReadOnlyFixed, getValidationFailure, hasListeners, isDisposed, isEnabled, isInitiallyVisible, isReadOnly, isValid, isVisible, isVisibleWithoutRoot, removeListener, requireNotDisposed, setEnabled, setProgrammaticEventType, setReadOnly, setReadOnlyFixed, setValidationFailure, setVisible, unwrap, validateDown

Methods inherited from class io.github.mmm.ui.api.widget.AbstractUiWidget
isEmpty, setParent, unwrap

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

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeReadId
getId

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteId
setId

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteSelections
addSelection, addSelections

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteTooltip
getTooltip, setTooltip

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteValidationFailure
getValidationFailure, setValidationFailure, setValidationFailure

Methods inherited from interface io.github.mmm.event.EventSource
addListener, addListener, addWeakListener, removeListener

Methods inherited from interface io.github.mmm.ui.api.widget.data.UiAbstractDataTable
addColumn, addColumn, addColumn, addColumns

Methods inherited from interface io.github.mmm.ui.api.widget.value.UiValidatableWidget
getOriginalValue, getValidator, getValue, isValid, reset, setOriginalValue, setValidator, setValue, setValue, setValueForUser

Methods inherited from interface io.github.mmm.ui.api.widget.UiWidget
cast, dispose, getModificationTimestamp, getParent, getReadOnlyFixed, getStyles, isDisposed, isEnabled, isEnabled, isFocused, isModified, isReadOnly, isVisible, isVisible, setEnabled, setEnabled, setFocused, setReadOnly, setReadOnlyFixed, setVisible, setVisible, validate, validate, validate, validateDown, validateUp

- Constructor Detail
  - FxDataTable
```
public FxDataTable()
```
    The constructor.
- Method Detail
  - getValueOrThrow
```
public List<R> getValueOrThrow()
```
    Specified by:
    
    getValueOrThrow in interface UiValidatableWidget<R>
    
    Returns:
    
    the current value.
  - setValueNative
```
protected void setValueNative(List<R> value)
```
    Specified by:
    
    setValueNative in class FxActiveValidatableWidget<javafx.scene.control.TableView<R>,List<R>>
    
    Parameters:
    
    value - the new value to set in the native widget.
  - setRowTemplate
```
public void setRowTemplate(R rowTemplate)
```
    Specified by:
    
    setRowTemplate in interface UiAbstractDataWidget<R>
    
    Parameters:
    
    rowTemplate - the template instance of a row.
  - createColumn
```
public <V> UiColumn<R,V> createColumn(TypedPropertyPath<V> property)
```
    Specified by:
    
    createColumn in interface UiAbstractDataTable<R>
    
    Type Parameters:
    
    V - type of the cell values of the UiColumn.
    
    Parameters:
    
    property - the property of the row data.
    
    Returns:
    
    the new UiColumn.
  - createColumn
```
public <V> UiColumn<R,V> createColumn(String title,
                                            UiAbstractDataWidget.ColumnAdapter<R,V> adapter)
```
    Specified by:
    
    createColumn in interface UiAbstractDataTable<R>
    
    Type Parameters:
    
    V - type of the cell values of the UiColumn.
    
    Parameters:
    
    title - the column header title.
    
    adapter - the UiAbstractDataWidget.ColumnAdapter giving access to read (and write) the column cell values from the data model.
    
    Returns:
    
    the new UiColumn.
  - getColumnCount
```
public int getColumnCount()
```
    Specified by:
    
    getColumnCount in interface UiAbstractDataTable<R>
    
    Returns:
    
    the number of columns of this data widget.
    
    See Also:
    
    List.size()
  - getColumn
```
public UiColumn<R,?> getColumn(int index)
```
    Specified by:
    
    getColumn in interface UiAbstractDataTable<R>
    
    Parameters:
    
    index - is the index of the requested UiColumn. The index corresponds to the index when the UiColumn has been added. Reordering or hiding columns in the UI has no effect on the index. The value has to be in the range from 0 to UiAbstractDataTable.getColumnCount() - 1.
    
    Returns:
    
    the requested column.
    
    See Also:
    
    List.get(int)
  - addColumn
```
public void addColumn(UiColumn<R,?> column,
                      int index)
```
    Specified by:
    
    addColumn in interface UiAbstractDataTable<R>
    
    Parameters:
    
    column - the UiColumn to add. Has to be created by this data widget.
    
    index - the index where to add the new column.
  - sort
```
public void sort(SortOrder order,
                 UiColumn<R,?>... sortColumns)
```
    Description copied from interface: UiAbstractDataTable
    
    This method sorts the data with the given SortOrder according to the specified UiColumns. The sort priority is from the first UiColumn (primary sort) to the last (least significant sort). In case all values of the first column are unique additional columns will have no effect on sorting.
    
    Specified by:
    
    sort in interface UiAbstractDataTable<R>
    
    Parameters:
    
    order - is the SortOrder.
    
    sortColumns - are the columns of this data-list to sort by.
  - setFilterHandler
```
public void setFilterHandler(UiAbstractDataTable.FilterHandler<R> filterHandler)
```
    Specified by:
    
    setFilterHandler in interface UiAbstractDataTable<R>
    
    Parameters:
    
    filterHandler - the UiAbstractDataTable.FilterHandler to customize the filtering. Allows to override the filtering for individual columns or the entire table. Custom handling may trigger a server-side search and asynchronously update the data in the table.
  - isShowRowNumbers
```
public boolean isShowRowNumbers()
```
    Specified by:
    
    isShowRowNumbers in interface AttributeWriteShowRowNumbers
    
    Returns:
    
    true if line numbers should be shown (a first column is displayed showing a running number starting with 1 for each line/row like in Execl), false otherwise.
  - setShowRowNumbers
```
public void setShowRowNumbers(boolean showRowNumbers)
```
    Specified by:
    
    setShowRowNumbers in interface AttributeWriteShowRowNumbers
    
    Parameters:
    
    showRowNumbers - is the new value of AttributeWriteShowRowNumbers.isShowRowNumbers().
  - getSelection
```
public R getSelection()
```
    Specified by:
    
    getSelection in interface AttributeReadSelection<R>
    
    Returns:
    
    the currently selected element. May be null if no element is selected.
    
    See Also:
    
    AttributeReadSelections.getSelections()
  - setSelection
```
public void setSelection(R selection)
```
    Specified by:
    
    setSelection in interface AttributeWriteSelection<R>
    
    Parameters:
    
    selection - is the new element to select.
    
    See Also:
    
    AttributeReadSelection.getSelection()
  - getSelections
```
public List<R> getSelections()
```
    Specified by:
    
    getSelections in interface AttributeReadSelections<R>
    
    Returns:
    
    the selected element(s). If nothing is selected, the empty List is returned. For best UX a multi-selection is suggested to be managed by checkboxes in front of the elements that allow adding and removing them from the multi-selection. It can still be combined with single-selection that highlights the element that has been clicked last. E.g. to remove or delete multiple elements from a list, the multi-selection can be used while the single-selection will be used to open the details of the last selected element in a master-details view or in a details popup.
  - setSelections
```
public void setSelections(Collection<R> selection)
```
    Specified by:
    
    setSelections in interface AttributeWriteSelections<R>
    
    Parameters:
    
    selection - is the Collection of elements to select.
    
    See Also:
    
    AttributeReadSelections.getSelections()
  - isMultiSelection
```
public boolean isMultiSelection()
```
    Specified by:
    
    isMultiSelection in interface AttributeReadMultiSelection
    
    Returns:
    
    true to allow multi-selection, false to allow only single-selection.
  - setMultiSelection
```
public void setMultiSelection(boolean multiSelection)
```
    Specified by:
    
    setMultiSelection in interface AttributeWriteMultiSelection
    
    Parameters:
    
    multiSelection - the new value of AttributeReadMultiSelection.isMultiSelection(). Should be set once after creation of this widget. Changing selection mode dynamically after attaching this widget and making it visible may not be supported on all platforms.
    
    See Also:
    
    AttributeReadMultiSelection.isMultiSelection()

Class FxDataTable<R>

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.mmm.ui.api.widget.data.UiAbstractDataTable

Nested classes/interfaces inherited from interface io.github.mmm.ui.api.widget.data.UiAbstractDataWidget

Field Summary

Fields inherited from class io.github.mmm.ui.fx.widget.FxWidget

Fields inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteMultiSelection

Fields inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteShowRowNumbers

Fields inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteValidationFailure

Fields inherited from interface io.github.mmm.ui.api.widget.data.UiAbstractDataWidget

Fields inherited from interface io.github.mmm.ui.api.widget.UiActiveWidget

Fields inherited from interface io.github.mmm.ui.api.widget.value.UiValidatableWidget

Constructor Summary

Method Summary

Methods inherited from class io.github.mmm.ui.fx.widget.FxActiveValidatableWidget

Methods inherited from class io.github.mmm.ui.fx.widget.FxActiveWidget

Methods inherited from class io.github.mmm.ui.fx.widget.FxWidgetNode

Methods inherited from class io.github.mmm.ui.fx.widget.FxWidgetStyleable

Methods inherited from class io.github.mmm.ui.fx.widget.FxWidget

Methods inherited from class io.github.mmm.ui.spi.widget.AbstractUiNativeWidgetWrapper

Methods inherited from class io.github.mmm.ui.spi.widget.AbstractUiNativeWidget

Methods inherited from class io.github.mmm.ui.api.widget.AbstractUiWidget

Methods inherited from class java.lang.Object

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeReadId

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteId

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteSelections

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteTooltip

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteValidationFailure

Methods inherited from interface io.github.mmm.event.EventSource

Methods inherited from interface io.github.mmm.ui.api.widget.data.UiAbstractDataTable

Methods inherited from interface io.github.mmm.ui.api.widget.value.UiValidatableWidget

Methods inherited from interface io.github.mmm.ui.api.widget.UiWidget

Constructor Detail

FxDataTable

Method Detail

getValueOrThrow

setValueNative

setRowTemplate

createColumn

createColumn

getColumnCount

getColumn

addColumn

sort

setFilterHandler

isShowRowNumbers

setShowRowNumbers

getSelection

setSelection

getSelections

setSelections

isMultiSelection

setMultiSelection