at.bestsolution.framework.grid

Interface XGrid<R,CP extends XGridContentProvider<R>>

Type Parameters:

R - the row type

CP - the content provider type

All Known Subinterfaces:

XGridTable<R>

All Known Implementing Classes:

SWTGridTable

public interface XGrid<R,CP extends XGridContentProvider<R>>

Base interface of grid

Since:

1.0

Property Summary

Type	Property and Description
@NonNull Property<CP>	contentProvider The default content provider
@NonNull Property<java.util.Comparator<R>>	defaultSort The default sort.
@NonNull Property<ElementComparer<R>>	elementComparer The element comparer property
@NonNull Property<java.util.Locale>	locale The current locale used by the grid
@NonNull Property<RowMetaDataFunction<R>>	metaDataFunction Function consulted to retrieve row meta data
@NonNull Property<XGrid.SelectionMode>	selectionMode The selection mode.
@NonNull Property<XSelection<R>>	selection The selection property

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	XGrid.SelectionMode Selection mode

Method Summary

Modifier and Type	Method and Description
@NonNull Property<CP>	contentProviderProperty() The default content provider
@NonNull XGridColumn<R,java.lang.Boolean>	createCheckedColumn(java.lang.String id, @NonNull java.util.function.Function<R,java.lang.Boolean> cellValueFunction) Create a column which presents boolean values as check box
<C> @NonNull XGridColumn<R,C>	createColumn(java.lang.String id, @NonNull java.util.function.Function<R,C> cellValueFunction) Create a column
@NonNull Property<java.util.Comparator<R>>	defaultSortProperty() The default sort.
void	dispose() dispose grid
@NonNull Property<ElementComparer<R>>	elementComparerProperty() The element comparer property
@NonNull java.util.List<XGridColumn<R,?>>	getColumns()
@NonNull java.lang.Object[][]	getData() export shown data
@NonNull Property<java.util.Locale>	localeProperty() The current locale used by the grid
@NonNull Property<RowMetaDataFunction<R>>	metaDataFunctionProperty() Function consulted to retrieve row meta data
@NonNull Property<XGrid.SelectionMode>	selectionModeProperty() The selection mode.
@NonNull Property<XSelection<R>>	selectionProperty() The selection property

Property Detail

selectionMode

@NonNull Property<XGrid.SelectionMode> selectionModeProperty

The selection mode.

Default XGrid.SelectionMode.SINGLE_ROW

defaultSort

@NonNull Property<java.util.Comparator<R>> defaultSortProperty

The default sort.

Default null

locale

@NonNull Property<java.util.Locale> localeProperty

The current locale used by the grid

Default Locale.getDefault()

contentProvider

@NonNull Property<CP extends XGridContentProvider<R>> contentProviderProperty

The default content provider

Default null

selection

@NonNull Property<XSelection<R>> selectionProperty

The selection property

Default an empty selection

elementComparer

@NonNull Property<ElementComparer<R>> elementComparerProperty

The element comparer property

Default implementation provides #hashCode() and #equals(Object) of R

metaDataFunction

@NonNull Property<RowMetaDataFunction<R>> metaDataFunctionProperty

Function consulted to retrieve row meta data

Property value is initialized with a default function who returns no meta data

Method Detail

createColumn

<C> @NonNull XGridColumn<R,C> createColumn(java.lang.String id,
                                           @NonNull java.util.function.Function<R,C> cellValueFunction)

Create a column

Type Parameters:

C - the cell type

Parameters:

id - the id of the column

cellValueFunction - the cell value function

Returns:

column instance

See Also:

XGridColumn.cellValueFunctionProperty()

createCheckedColumn

@NonNull XGridColumn<R,java.lang.Boolean> createCheckedColumn(java.lang.String id,
                                                              @NonNull java.util.function.Function<R,java.lang.Boolean> cellValueFunction)

Create a column which presents boolean values as check box

Parameters:

id - the id of the column

cellValueFunction - the cell value function

Returns:

column instance

See Also:

XGridColumn.cellValueFunctionProperty()

selectionModeProperty

@NonNull Property<XGrid.SelectionMode> selectionModeProperty()

The selection mode.

Default XGrid.SelectionMode.SINGLE_ROW

defaultSortProperty

@NonNull Property<java.util.Comparator<R>> defaultSortProperty()

The default sort.

Default null

localeProperty

@NonNull Property<java.util.Locale> localeProperty()

The current locale used by the grid

Default Locale.getDefault()

contentProviderProperty

@NonNull Property<CP> contentProviderProperty()

The default content provider

Default null

selectionProperty

@NonNull Property<XSelection<R>> selectionProperty()

The selection property

Default an empty selection

elementComparerProperty

@NonNull Property<ElementComparer<R>> elementComparerProperty()

The element comparer property

Default implementation provides #hashCode() and #equals(Object) of R

getColumns

@NonNull java.util.List<XGridColumn<R,?>> getColumns()

Returns:

list of columns

metaDataFunctionProperty

@NonNull Property<RowMetaDataFunction<R>> metaDataFunctionProperty()

Function consulted to retrieve row meta data

Property value is initialized with a default function who returns no meta data

dispose

void dispose()

dispose grid

getData

@NonNull java.lang.Object[][] getData()

export shown data

if the content is empty an empty array will be exported

Returns:

data