org.eclipse.emfforms.spi.swt.table

Interface TableViewerSWTCustomization.ColumnDescription

All Known Implementing Classes:

ColumnDescriptionImpl

Enclosing interface:

TableViewerSWTCustomization

public static interface TableViewerSWTCustomization.ColumnDescription

A ColumnDescription is used to describe how a viewer column shall be created.

Author:

Johannes Faltermeier

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_WEIGHT Constant indicating that getWeight() has no value.

Method Summary

Modifier and Type	Method and Description
Optional<org.eclipse.jface.viewers.EditingSupport>	createEditingSupport(org.eclipse.jface.viewers.AbstractTableViewer columnViewer) Called to setup the EditingSupport for the viewer.
org.eclipse.jface.viewers.CellLabelProvider	createLabelProvider(org.eclipse.jface.viewers.AbstractTableViewer columnViewer) The cell label provider which will be set on the column.
Optional<org.eclipse.swt.graphics.Image>	getColumnImage() The image of the column.
org.eclipse.core.databinding.observable.value.IObservableValue	getColumnText() The header text for the column.
org.eclipse.core.databinding.observable.value.IObservableValue	getColumnTooltip() The column header tooltip text.
Map<String,Object>	getData() Get the underlying data map.
Object	getData(String key) Get an arbitrary element from the data map.
int	getMinWidth() The minimal width of the column.
int	getStyleBits() The SWT style bits which will be used to create the column.
int	getWeight() The weight of the column.
boolean	isMoveable() true if moveable, false otherwise.
boolean	isResizeable() true if resizeable, false otherwise.
void	setData(Map<String,Object> data) Add the contents of the given map to the data map.

Field Detail

NO_WEIGHT

static final int NO_WEIGHT

Constant indicating that getWeight() has no value.

See Also:

Constant Field Values

Method Detail

isResizeable

boolean isResizeable()

true if resizeable, false otherwise.

Returns:

whether the column is resizeable

isMoveable

boolean isMoveable()

true if moveable, false otherwise.

Returns:

whether the column is moveable

getStyleBits

int getStyleBits()

The SWT style bits which will be used to create the column.

Returns:

the SWT style bits for the column

getWeight

int getWeight()

The weight of the column.

Returns:

the weight of the column

getMinWidth

int getMinWidth()

The minimal width of the column.

Returns:

the min width of the column in pixels

getColumnText

org.eclipse.core.databinding.observable.value.IObservableValue getColumnText()

The header text for the column.

Returns:

the column header text

getColumnTooltip

org.eclipse.core.databinding.observable.value.IObservableValue getColumnTooltip()

The column header tooltip text.

Returns:

the column header tooltip

createLabelProvider

org.eclipse.jface.viewers.CellLabelProvider createLabelProvider(org.eclipse.jface.viewers.AbstractTableViewer columnViewer)

The cell label provider which will be set on the column.

Parameters:

columnViewer - the column viewer

Returns:

the label provider

createEditingSupport

Optional<org.eclipse.jface.viewers.EditingSupport> createEditingSupport(org.eclipse.jface.viewers.AbstractTableViewer columnViewer)

Called to setup the EditingSupport for the viewer.

Parameters:

columnViewer - the AbstractTableViewer

Returns:

the editing support for the column, if present

getColumnImage

Optional<org.eclipse.swt.graphics.Image> getColumnImage()

The image of the column.

Returns:

the column image, if present

getData

Object getData(String key)

Get an arbitrary element from the data map.

Parameters:

key - (see constants)

Returns:

object

setData

void setData(Map<String,Object> data)

Add the contents of the given map to the data map.

Parameters:

data - object

getData

Map<String,Object> getData()

Get the underlying data map.

Returns:

data map object