at.bestsolution.framework.grid.swt

Class SWTGridTable<R>

java.lang.Object

at.bestsolution.framework.grid.swt.SWTGridTable<R>

Type Parameters:

R - the row type

All Implemented Interfaces:

XGrid<R,XGridContentProvider<R>>, XGridTable<R>

public class SWTGridTable<R>
extends java.lang.Object
implements XGridTable<R>

An SWT implementation of the table

Property Summary

Type	Property and Description
@NonNull Property<XGridContentProvider<R>>	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/interfaces inherited from interface at.bestsolution.framework.grid.XGrid

XGrid.SelectionMode

Field Summary

Fields

Modifier and Type	Field and Description
protected @NonNull org.eclipse.nebula.widgets.grid.Grid	nebulaGrid

Constructor Summary

Constructors

Constructor and Description
SWTGridTable(org.eclipse.swt.widgets.Composite parent, int style) SWT Grid

Method Summary

Modifier and Type	Method and Description
@NonNull Property<XGridContentProvider<R>>	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 at.bestsolution.framework.grid.swt.internal.SWTGridContentHandler<R>	getContentHandler()
@NonNull java.lang.Object[][]	getData() export shown data
org.eclipse.nebula.widgets.grid.Grid	getNebulaGrid()
@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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Detail

selectionMode

public @NonNull Property<XGrid.SelectionMode> selectionModeProperty

Specified by:

selectionModeProperty in interface XGrid<R,XGridContentProvider<R>>

Returns:

the property

defaultSort

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

Specified by:

defaultSortProperty in interface XGrid<R,XGridContentProvider<R>>

Returns:

the default sort property

contentProvider

public @NonNull Property<XGridContentProvider<R>> contentProviderProperty

Specified by:

contentProviderProperty in interface XGrid<R,XGridContentProvider<R>>

Returns:

the content provider

selection

public @NonNull Property<XSelection<R>> selectionProperty

Specified by:

selectionProperty in interface XGrid<R,XGridContentProvider<R>>

Returns:

the default selection

locale

public @NonNull Property<java.util.Locale> localeProperty

Specified by:

localeProperty in interface XGrid<R,XGridContentProvider<R>>

Returns:

the locale property

elementComparer

public @NonNull Property<ElementComparer<R>> elementComparerProperty

Specified by:

elementComparerProperty in interface XGrid<R,XGridContentProvider<R>>

Returns:

the property

metaDataFunction

public @NonNull Property<RowMetaDataFunction<R>> metaDataFunctionProperty

Specified by:

metaDataFunctionProperty in interface XGrid<R,XGridContentProvider<R>>

Returns:

the property

Field Detail

nebulaGrid

protected @NonNull org.eclipse.nebula.widgets.grid.Grid nebulaGrid

Constructor Detail

SWTGridTable

public SWTGridTable(org.eclipse.swt.widgets.Composite parent,
                    int style)

SWT Grid

Parameters:

parent - parent composite

style - SWT style

Method Detail

createColumn

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

Description copied from interface: XGrid

Create a column

Specified by:

createColumn in interface XGrid<R,XGridContentProvider<R>>

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

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

Description copied from interface: XGrid

Create a column which presents boolean values as check box

Specified by:

createCheckedColumn in interface XGrid<R,XGridContentProvider<R>>

Parameters:

id - the id of the column

cellValueFunction - the cell value function

Returns:

column instance

See Also:

XGridColumn.cellValueFunctionProperty()

selectionModeProperty

public @NonNull Property<XGrid.SelectionMode> selectionModeProperty()

Description copied from interface: XGrid

The selection mode.

Default XGrid.SelectionMode.SINGLE_ROW

Specified by:

selectionModeProperty in interface XGrid<R,XGridContentProvider<R>>

Returns:

the property

defaultSortProperty

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

Description copied from interface: XGrid

The default sort.

Default null

Specified by:

defaultSortProperty in interface XGrid<R,XGridContentProvider<R>>

Returns:

the default sort property

contentProviderProperty

public @NonNull Property<XGridContentProvider<R>> contentProviderProperty()

Description copied from interface: XGrid

The default content provider

Default null

Specified by:

contentProviderProperty in interface XGrid<R,XGridContentProvider<R>>

Returns:

the content provider

selectionProperty

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

Description copied from interface: XGrid

The selection property

Default an empty selection

Specified by:

selectionProperty in interface XGrid<R,XGridContentProvider<R>>

Returns:

the default selection

localeProperty

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

Description copied from interface: XGrid

The current locale used by the grid

Default Locale.getDefault()

Specified by:

localeProperty in interface XGrid<R,XGridContentProvider<R>>

Returns:

the locale property

elementComparerProperty

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

Description copied from interface: XGrid

The element comparer property

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

Specified by:

elementComparerProperty in interface XGrid<R,XGridContentProvider<R>>

Returns:

the property

getNebulaGrid

public org.eclipse.nebula.widgets.grid.Grid getNebulaGrid()

Returns:

the nebulaGrid widget

getColumns

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

Specified by:

getColumns in interface XGrid<R,XGridContentProvider<R>>

Returns:

grid columns

dispose

public void dispose()

Description copied from interface: XGrid

dispose grid

Specified by:

dispose in interface XGrid<R,XGridContentProvider<R>>

metaDataFunctionProperty

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

Description copied from interface: XGrid

Function consulted to retrieve row meta data

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

Specified by:

metaDataFunctionProperty in interface XGrid<R,XGridContentProvider<R>>

Returns:

the property

getContentHandler

public @NonNull at.bestsolution.framework.grid.swt.internal.SWTGridContentHandler<R> getContentHandler()

Returns:

the content handler

getData

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

Description copied from interface: XGrid

export shown data

if the content is empty an empty array will be exported

Specified by:

getData in interface XGrid<R,XGridContentProvider<R>>

Returns:

data