at.bestsolution.framework.grid

Interface XGridColumn<R,C>

Type Parameters:

R - the row type

C - the column type

All Known Implementing Classes:

SWTCheckedGridColumn, SWTGridColumn

public interface XGridColumn<R,C>

Column of a grid

Since:

1.0

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
@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

Modifier and Type	Interface and Description
static class	XGridColumn.Alignment Column alignment
static class	XGridColumn.AutoFilterType Type of the auto filters
static class	XGridColumn.Sorting Column sorting
static class	XGridColumn.SortingBehavior Column sorting behavior

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
@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.
java.lang.Object	getExportValue(R element) get export value for the given element using exportValueFunctionProperty()
@NonNull XGrid<R,XGridContentProvider<R>>	getGrid() Grid which contains this column
@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
@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

Property Detail

label

@NonNull Property<java.lang.String> labelProperty

The label property

notPresentableValuePresentation

@NonNull Property<java.lang.String> notPresentableValuePresentationProperty

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

icon

@NonNull Property<java.net.URI> iconProperty

The icon to display

maxWidth

@NonNull Property<java.lang.Integer> maxWidthProperty

The maximum width.

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

minWidth

@NonNull Property<java.lang.Integer> minWidthProperty

The minimum width

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

autoWidth

@NonNull Property<java.lang.Boolean> autoWidthProperty

Calculate the width from the content

Default is Boolean.FALSE

cellValueFunction

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

The provider of the cell value

textFunction

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

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 notPresentableValuePresentationProperty() will be provided

iconFunction

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

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

Default provider returns null for the icon uri

autoFilterType

@NonNull Property<XGridColumn.AutoFilterType> autoFilterTypeProperty

The auto filter type

Default filter type XGridColumn.AutoFilterType.NONE

sorting

@NonNull Property<XGridColumn.Sorting> sortingProperty

The sorting type

Default sorting XGridColumn.Sorting.NONE

sortingBehavior

@NonNull Property<XGridColumn.SortingBehavior> sortingBehaviorProperty

The sorting behavior type

Default sorting behavior XGridColumn.SortingBehavior.UP_DOWN

alignment

@NonNull Property<XGridColumn.Alignment> alignmentProperty

The alignment

Default alignment XGridColumn.Alignment.LEFT

autoFilterMatcherFunction

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

The auto filter matcher used to match elements

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

autoFilterDataSupplier

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

Provides predefined filter values

Default supplier provides an empty list

autoFilterTextFunction

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

Converts cell values for presentation in the autofilter.

Property value is initially null

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

sorter

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

Property for the sort of this column

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

index

@NonNull Property<java.lang.Integer> indexProperty

Property for the column index

exportValueFunction

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

Converts cell values for data export.

Property value is initially DefaultExportValueFunction

metaDataFunction

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

Function consulted to retrieve cell meta data

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

Method Detail

labelProperty

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

The label property

notPresentableValuePresentationProperty

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

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

iconProperty

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

The icon to display

maxWidthProperty

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

The maximum width.

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

minWidthProperty

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

The minimum width

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

autoWidthProperty

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

Calculate the width from the content

Default is Boolean.FALSE

cellValueFunctionProperty

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

The provider of the cell value

textFunctionProperty

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

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 notPresentableValuePresentationProperty() will be provided

iconFunctionProperty

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

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

Default provider returns null for the icon uri

autoFilterTypeProperty

@NonNull Property<XGridColumn.AutoFilterType> autoFilterTypeProperty()

The auto filter type

Default filter type XGridColumn.AutoFilterType.NONE

sortingProperty

@NonNull Property<XGridColumn.Sorting> sortingProperty()

The sorting type

Default sorting XGridColumn.Sorting.NONE

sortingBehaviorProperty

@NonNull Property<XGridColumn.SortingBehavior> sortingBehaviorProperty()

The sorting behavior type

Default sorting behavior XGridColumn.SortingBehavior.UP_DOWN

alignmentProperty

@NonNull Property<XGridColumn.Alignment> alignmentProperty()

The alignment

Default alignment XGridColumn.Alignment.LEFT

autoFilterMatcherFunctionProperty

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

The auto filter matcher used to match elements

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

autoFilterDataSupplierProperty

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

Provides predefined filter values

Default supplier provides an empty list

autoFilterTextFunctionProperty

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

Converts cell values for presentation in the autofilter.

Property value is initially null

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

sorterProperty

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

Property for the sort of this column

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

indexProperty

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

Property for the column index

exportValueFunctionProperty

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

Converts cell values for data export.

Property value is initially DefaultExportValueFunction

metaDataFunctionProperty

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

Function consulted to retrieve cell meta data

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

getGrid

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

Grid which contains this column

Returns:

containing grid

requestUpdate

void requestUpdate()

request to update column cells

requestUpdate

void requestUpdate(R element)

request to update the cell for a given element

Parameters:

element - the element to update

dispose

void dispose()

dispose column

getExportValue

java.lang.Object getExportValue(R element)

get export value for the given element using exportValueFunctionProperty()

Parameters:

element - the element

Returns:

the export value