at.bestsolution.framework.grid.swt

Class SWTGridColumn<R,C>

java.lang.Object

at.bestsolution.framework.grid.swt.SWTGridColumn<R,C>

Type Parameters:

R - row type

C - cell value type

All Implemented Interfaces:

XGridColumn<R,C>

Direct Known Subclasses:

SWTCheckedGridColumn

public class SWTGridColumn<R,C>
extends java.lang.Object
implements XGridColumn<R,C>

SWT column implementation

Property Summary

Type	Property and Description
@NonNull Property<XGridColumn.Alignment>	alignment The alignment
@NonNull Property<java.util.function.Supplier<java.util.List<AutoFilterEntry<R,C,java.lang.Object>>>>	autoFilterDataSupplier Provides predefined filter values
Property<java.lang.String>	autoFilterFreeText
@NonNull Property<CellValueMatcherFunction<R,C,java.lang.Object>>	autoFilterMatcherFunction The auto filter matcher used to match elements
@NonNull Property<CellDataFunction<R,C,java.lang.CharSequence>>	autoFilterTextFunction Converts cell values for presentation in the autofilter.
@NonNull Property<XGridColumn.AutoFilterType>	autoFilterType The auto filter type
@NonNull Property<java.lang.Boolean>	autoWidth Calculate the width from the content
@NonNull Property<java.util.function.Function<R,C>>	cellValueFunction The provider of the cell value
@NonNull Property<ExportValueFunction<R,C>>	exportValueFunction Converts cell values for data export.
@NonNull Property<CellDataFunction<R,C,java.net.URI>>	iconFunction The icon provider who converts the cell value to a rendered icon
@NonNull Property<java.net.URI>	icon The icon to display
@NonNull Property<java.lang.Integer>	index Property for the column index
@NonNull Property<java.lang.String>	label The label property
@NonNull Property<java.lang.Integer>	maxWidth The maximum width.
@NonNull Property<CellMetaDataFunction<R,C>>	metaDataFunction Function consulted to retrieve cell meta data
@NonNull Property<java.lang.Integer>	minWidth The minimum width
@NonNull Property<java.lang.String>	notPresentableValuePresentation presentation of not presentable values.
@NonNull Property<java.util.Comparator<R>>	sorter Property for the sort of this column
@NonNull Property<XGridColumn.SortingBehavior>	sortingBehavior The sorting behavior type
@NonNull Property<XGridColumn.Sorting>	sorting The sorting type
@NonNull Property<CellDataFunction<R,C,java.lang.CharSequence>>	textFunction The text provider who converts the cell value to a rendered text

Nested Class Summary

Nested classes/interfaces inherited from interface at.bestsolution.framework.grid.XGridColumn

XGridColumn.Alignment, XGridColumn.AutoFilterType, XGridColumn.Sorting, XGridColumn.SortingBehavior

Constructor Summary

Constructors

Modifier	Constructor and Description
	SWTGridColumn(@NonNull SWTGridTable<R> grid, @NonNull java.util.function.Function<R,C> cellValueFunction) Create a new column
protected	SWTGridColumn(@NonNull SWTGridTable<R> grid, @NonNull java.util.function.Function<R,C> cellValueFunction, int style) Create a new column

Method Summary

Modifier and Type	Method and Description
@NonNull Property<XGridColumn.Alignment>	alignmentProperty() The alignment
@NonNull Property<java.util.function.Supplier<java.util.List<AutoFilterEntry<R,C,java.lang.Object>>>>	autoFilterDataSupplierProperty() Provides predefined filter values
Property<java.lang.String>	autoFilterFreeTextProperty()
@NonNull Property<CellValueMatcherFunction<R,C,java.lang.Object>>	autoFilterMatcherFunctionProperty() The auto filter matcher used to match elements
@NonNull Property<CellDataFunction<R,C,java.lang.CharSequence>>	autoFilterTextFunctionProperty() Converts cell values for presentation in the autofilter.
@NonNull Property<XGridColumn.AutoFilterType>	autoFilterTypeProperty() The auto filter type
@NonNull Property<java.lang.Boolean>	autoWidthProperty() Calculate the width from the content
@NonNull Property<java.util.function.Function<R,C>>	cellValueFunctionProperty() The provider of the cell value
void	dispose() dispose column
@NonNull Property<ExportValueFunction<R,C>>	exportValueFunctionProperty() Converts cell values for data export.
protected void	fillGridItem(@NonNull org.eclipse.nebula.widgets.grid.GridItem item, R element)
@NonNull at.bestsolution.framework.grid.swt.internal.SWTGridContentHandler<R>	getContentHandler()
java.lang.Object	getExportValue(R element) get export value for the given element using XGridColumn.exportValueFunctionProperty()
@NonNull XGrid<R,XGridContentProvider<R>>	getGrid() Grid which contains this column
org.eclipse.nebula.widgets.grid.GridColumn	getNebulaColumn()
@NonNull Property<CellDataFunction<R,C,java.net.URI>>	iconFunctionProperty() The icon provider who converts the cell value to a rendered icon
@NonNull Property<java.net.URI>	iconProperty() The icon to display
@NonNull Property<java.lang.Integer>	indexProperty() Property for the column index
@NonNull Property<java.lang.String>	labelProperty() The label property
boolean	matchesColumnFilter(R element)
@NonNull Property<java.lang.Integer>	maxWidthProperty() The maximum width.
@NonNull Property<CellMetaDataFunction<R,C>>	metaDataFunctionProperty() Function consulted to retrieve cell meta data
@NonNull Property<java.lang.Integer>	minWidthProperty() The minimum width
@NonNull Property<java.lang.String>	notPresentableValuePresentationProperty() presentation of not presentable values.
void	requestUpdate() request to update column cells
void	requestUpdate(R element) request to update the cell for a given element
@NonNull Property<java.util.Comparator<R>>	sorterProperty() Property for the sort of this column
@NonNull Property<XGridColumn.SortingBehavior>	sortingBehaviorProperty() The sorting behavior type
@NonNull Property<XGridColumn.Sorting>	sortingProperty() The sorting type
@NonNull Property<CellDataFunction<R,C,java.lang.CharSequence>>	textFunctionProperty() The text provider who converts the cell value to a rendered text

Methods inherited from class java.lang.Object

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

Property Detail

autoFilterFreeText

public Property<java.lang.String> autoFilterFreeTextProperty

label

public @NonNull Property<java.lang.String> labelProperty

Specified by:

labelProperty in interface XGridColumn<R,C>

Returns:

the label property

icon

public @NonNull Property<java.net.URI> iconProperty

Specified by:

iconProperty in interface XGridColumn<R,C>

Returns:

the icon property

maxWidth

public @NonNull Property<java.lang.Integer> maxWidthProperty

Specified by:

maxWidthProperty in interface XGridColumn<R,C>

Returns:

the max width property

minWidth

public @NonNull Property<java.lang.Integer> minWidthProperty

Specified by:

minWidthProperty in interface XGridColumn<R,C>

Returns:

the min width property

autoWidth

public @NonNull Property<java.lang.Boolean> autoWidthProperty

Specified by:

autoWidthProperty in interface XGridColumn<R,C>

Returns:

the auto width property

cellValueFunction

public @NonNull Property<java.util.function.Function<R,C>> cellValueFunctionProperty

Specified by:

cellValueFunctionProperty in interface XGridColumn<R,C>

Returns:

the provider property

textFunction

public @NonNull Property<CellDataFunction<R,C,java.lang.CharSequence>> textFunctionProperty

Specified by:

textFunctionProperty in interface XGridColumn<R,C>

Returns:

the provider property

iconFunction

public @NonNull Property<CellDataFunction<R,C,java.net.URI>> iconFunctionProperty

Specified by:

iconFunctionProperty in interface XGridColumn<R,C>

Returns:

the provider property

autoFilterType

public @NonNull Property<XGridColumn.AutoFilterType> autoFilterTypeProperty

Specified by:

autoFilterTypeProperty in interface XGridColumn<R,C>

Returns:

the property

autoFilterMatcherFunction

public @NonNull Property<CellValueMatcherFunction<R,C,java.lang.Object>> autoFilterMatcherFunctionProperty

Specified by:

autoFilterMatcherFunctionProperty in interface XGridColumn<R,C>

Returns:

the matcher property

autoFilterDataSupplier

public @NonNull Property<java.util.function.Supplier<java.util.List<AutoFilterEntry<R,C,java.lang.Object>>>> autoFilterDataSupplierProperty

Specified by:

autoFilterDataSupplierProperty in interface XGridColumn<R,C>

Returns:

the provider property

autoFilterTextFunction

public @NonNull Property<CellDataFunction<R,C,java.lang.CharSequence>> autoFilterTextFunctionProperty

Specified by:

autoFilterTextFunctionProperty in interface XGridColumn<R,C>

Returns:

the provider property

sorter

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

Specified by:

sorterProperty in interface XGridColumn<R,C>

Returns:

the provider

alignment

public @NonNull Property<XGridColumn.Alignment> alignmentProperty

Specified by:

alignmentProperty in interface XGridColumn<R,C>

Returns:

the property

index

public @NonNull Property<java.lang.Integer> indexProperty

Specified by:

indexProperty in interface XGridColumn<R,C>

Returns:

column index

sorting

public @NonNull Property<XGridColumn.Sorting> sortingProperty

Specified by:

sortingProperty in interface XGridColumn<R,C>

Returns:

the property

sortingBehavior

public @NonNull Property<XGridColumn.SortingBehavior> sortingBehaviorProperty

Specified by:

sortingBehaviorProperty in interface XGridColumn<R,C>

Returns:

the property

exportValueFunction

public @NonNull Property<ExportValueFunction<R,C>> exportValueFunctionProperty

Specified by:

exportValueFunctionProperty in interface XGridColumn<R,C>

Returns:

the property

metaDataFunction

public @NonNull Property<CellMetaDataFunction<R,C>> metaDataFunctionProperty

Specified by:

metaDataFunctionProperty in interface XGridColumn<R,C>

Returns:

the property

notPresentableValuePresentation

public @NonNull Property<java.lang.String> notPresentableValuePresentationProperty

Specified by:

notPresentableValuePresentationProperty in interface XGridColumn<R,C>

Returns:

the property

Constructor Detail

SWTGridColumn

public SWTGridColumn(@NonNull SWTGridTable<R> grid,
                     @NonNull java.util.function.Function<R,C> cellValueFunction)

Create a new column

Parameters:

grid - the containing grid

cellValueFunction - the value function

SWTGridColumn

protected SWTGridColumn(@NonNull SWTGridTable<R> grid,
                        @NonNull java.util.function.Function<R,C> cellValueFunction,
                        int style)

Create a new column

Parameters:

grid - the containing grid

cellValueFunction - the value function

style - SWT style

Method Detail

autoFilterFreeTextProperty

public Property<java.lang.String> autoFilterFreeTextProperty()

labelProperty

public @NonNull Property<java.lang.String> labelProperty()

Description copied from interface: XGridColumn

The label property

Specified by:

labelProperty in interface XGridColumn<R,C>

Returns:

the label property

iconProperty

public @NonNull Property<java.net.URI> iconProperty()

Description copied from interface: XGridColumn

The icon to display

Specified by:

iconProperty in interface XGridColumn<R,C>

Returns:

the icon property

maxWidthProperty

public @NonNull Property<java.lang.Integer> maxWidthProperty()

Description copied from interface: XGridColumn

The maximum width.

For a fixed width set XGridColumn.maxWidthProperty() and XGridColumn.minWidthProperty() to the same value

Specified by:

maxWidthProperty in interface XGridColumn<R,C>

Returns:

the max width property

minWidthProperty

public @NonNull Property<java.lang.Integer> minWidthProperty()

Description copied from interface: XGridColumn

The minimum width

For a fixed width set XGridColumn.maxWidthProperty() and XGridColumn.minWidthProperty() to the same value

Specified by:

minWidthProperty in interface XGridColumn<R,C>

Returns:

the min width property

autoWidthProperty

public @NonNull Property<java.lang.Boolean> autoWidthProperty()

Description copied from interface: XGridColumn

Calculate the width from the content

Default is Boolean.FALSE

Specified by:

autoWidthProperty in interface XGridColumn<R,C>

Returns:

the auto width property

cellValueFunctionProperty

public @NonNull Property<java.util.function.Function<R,C>> cellValueFunctionProperty()

Description copied from interface: XGridColumn

The provider of the cell value

Specified by:

cellValueFunctionProperty in interface XGridColumn<R,C>

Returns:

the provider property

textFunctionProperty

public @NonNull Property<CellDataFunction<R,C,java.lang.CharSequence>> textFunctionProperty()

Description copied from interface: XGridColumn

The text provider who converts the cell value to a rendered text

Default provider creates a Object.toString() representation of the value

if the cell value is not resolvable (e.g. invalid format configuration), the value of XGridColumn.notPresentableValuePresentationProperty() will be provided

Specified by:

textFunctionProperty in interface XGridColumn<R,C>

Returns:

the provider property

iconFunctionProperty

public @NonNull Property<CellDataFunction<R,C,java.net.URI>> iconFunctionProperty()

Description copied from interface: XGridColumn

The icon provider who converts the cell value to a rendered icon

Default provider returns null for the icon uri

Specified by:

iconFunctionProperty in interface XGridColumn<R,C>

Returns:

the provider property

autoFilterTypeProperty

public @NonNull Property<XGridColumn.AutoFilterType> autoFilterTypeProperty()

Description copied from interface: XGridColumn

The auto filter type

Default filter type XGridColumn.AutoFilterType.NONE

Specified by:

autoFilterTypeProperty in interface XGridColumn<R,C>

Returns:

the property

autoFilterMatcherFunctionProperty

public @NonNull Property<CellValueMatcherFunction<R,C,java.lang.Object>> autoFilterMatcherFunctionProperty()

Description copied from interface: XGridColumn

The auto filter matcher used to match elements

Default matcher use Object.equals(Object) of the cell value

Specified by:

autoFilterMatcherFunctionProperty in interface XGridColumn<R,C>

Returns:

the matcher property

autoFilterDataSupplierProperty

public @NonNull Property<java.util.function.Supplier<java.util.List<AutoFilterEntry<R,C,java.lang.Object>>>> autoFilterDataSupplierProperty()

Description copied from interface: XGridColumn

Provides predefined filter values

Default supplier provides an empty list

Specified by:

autoFilterDataSupplierProperty in interface XGridColumn<R,C>

Returns:

the provider property

autoFilterTextFunctionProperty

public @NonNull Property<CellDataFunction<R,C,java.lang.CharSequence>> autoFilterTextFunctionProperty()

Description copied from interface: XGridColumn

Converts cell values for presentation in the autofilter.

Property value is initially null

If property value is null the XGridColumn.textFunctionProperty() is used.

Specified by:

autoFilterTextFunctionProperty in interface XGridColumn<R,C>

Returns:

the provider property

sorterProperty

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

Description copied from interface: XGridColumn

Property for the sort of this column

Default comparator uses XGridColumn.cellValueFunctionProperty() if cell value is instanceof Comparable and XGridColumn.textFunctionProperty() otherwise

Specified by:

sorterProperty in interface XGridColumn<R,C>

Returns:

the provider

alignmentProperty

public @NonNull Property<XGridColumn.Alignment> alignmentProperty()

Description copied from interface: XGridColumn

The alignment

Default alignment XGridColumn.Alignment.LEFT

Specified by:

alignmentProperty in interface XGridColumn<R,C>

Returns:

the property

indexProperty

public @NonNull Property<java.lang.Integer> indexProperty()

Description copied from interface: XGridColumn

Property for the column index

Specified by:

indexProperty in interface XGridColumn<R,C>

Returns:

column index

sortingProperty

public @NonNull Property<XGridColumn.Sorting> sortingProperty()

Description copied from interface: XGridColumn

The sorting type

Default sorting XGridColumn.Sorting.NONE

Specified by:

sortingProperty in interface XGridColumn<R,C>

Returns:

the property

sortingBehaviorProperty

public @NonNull Property<XGridColumn.SortingBehavior> sortingBehaviorProperty()

Description copied from interface: XGridColumn

The sorting behavior type

Default sorting behavior XGridColumn.SortingBehavior.UP_DOWN

Specified by:

sortingBehaviorProperty in interface XGridColumn<R,C>

Returns:

the property

exportValueFunctionProperty

public @NonNull Property<ExportValueFunction<R,C>> exportValueFunctionProperty()

Description copied from interface: XGridColumn

Converts cell values for data export.

Property value is initially DefaultExportValueFunction

Specified by:

exportValueFunctionProperty in interface XGridColumn<R,C>

Returns:

the property

getGrid

public @NonNull XGrid<R,XGridContentProvider<R>> getGrid()

Description copied from interface: XGridColumn

Grid which contains this column

Specified by:

getGrid in interface XGridColumn<R,C>

Returns:

containing grid

getNebulaColumn

public org.eclipse.nebula.widgets.grid.GridColumn getNebulaColumn()

Returns:

nebula grid column

getContentHandler

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

Returns:

the content handler

fillGridItem

protected void fillGridItem(@NonNull org.eclipse.nebula.widgets.grid.GridItem item,
                            R element)

Parameters:

item - grid item

element - row element

requestUpdate

public void requestUpdate()

Description copied from interface: XGridColumn

request to update column cells

Specified by:

requestUpdate in interface XGridColumn<R,C>

requestUpdate

public void requestUpdate(R element)

Description copied from interface: XGridColumn

request to update the cell for a given element

Specified by:

requestUpdate in interface XGridColumn<R,C>

Parameters:

element - the element to update

dispose

public void dispose()

Description copied from interface: XGridColumn

dispose column

Specified by:

dispose in interface XGridColumn<R,C>

matchesColumnFilter

public boolean matchesColumnFilter(R element)

Parameters:

element - the element

Returns:

true if the given element matches, false otherwise

getExportValue

public java.lang.Object getExportValue(R element)

Description copied from interface: XGridColumn

get export value for the given element using XGridColumn.exportValueFunctionProperty()

Specified by:

getExportValue in interface XGridColumn<R,C>

Parameters:

element - the element

Returns:

the export value

metaDataFunctionProperty

public @NonNull Property<CellMetaDataFunction<R,C>> metaDataFunctionProperty()

Description copied from interface: XGridColumn

Function consulted to retrieve cell meta data

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

Specified by:

metaDataFunctionProperty in interface XGridColumn<R,C>

Returns:

the property

notPresentableValuePresentationProperty

public @NonNull Property<java.lang.String> notPresentableValuePresentationProperty()

Description copied from interface: XGridColumn

presentation of not presentable values.

this may happen if values are not resolvable or cannot be applied to column text functions

The default value is #N/A

Specified by:

notPresentableValuePresentationProperty in interface XGridColumn<R,C>

Returns:

the property