org.eclipse.emfforms.spi.swt.table

Class ColumnConfigurationImpl

java.lang.Object

org.eclipse.emfforms.spi.swt.table.ColumnConfigurationImpl

All Implemented Interfaces:

ColumnConfiguration

public final class ColumnConfigurationImpl
extends Object
implements ColumnConfiguration

Implementation of the ColumnConfiguration.

Author:

Johannes Faltermeier, Mat Hansen

Field Summary

Fields inherited from interface org.eclipse.emfforms.spi.swt.table.ColumnConfiguration

ALL_FEATURES, COLUMN_ID, DMR, FEATURE_COLUMN_FILTER, FEATURE_COLUMN_HIDE_SHOW, FEATURE_COLUMN_REGEX_FILTER, FEATURES, ID, MIN_WIDTH, NO_WEIGHT, RESIZABLE, WEIGHT

Constructor Summary

Constructors

Constructor and Description

ColumnConfigurationImpl(Set<Feature> enabledFeatures, boolean resizeable, boolean moveable, int styleBits, int weight, int minWidth, org.eclipse.core.databinding.observable.value.IObservableValue columnText, org.eclipse.core.databinding.observable.value.IObservableValue tooltipText, CellLabelProviderFactory labelProviderFactory, EditingSupportCreator editingSupport, org.eclipse.swt.graphics.Image image, Map<String,Object> data, List<ConfigurationCallback<org.eclipse.jface.viewers.AbstractTableViewer,org.eclipse.jface.viewers.ViewerColumn>> configurationCallbacks) Constructs a new ColumnConfiguration.

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.
void	dispose() Dispose this configuration and all its properties.
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.
List<ConfigurationCallback<org.eclipse.jface.viewers.AbstractTableViewer,org.eclipse.jface.viewers.ViewerColumn>>	getConfigurationCallbacks() Get the list of additional ConfigurationCallbacks.
Map<String,Object>	getData() Get the underlying data map.
Object	getData(String key) Get an arbitrary element from the data map.
Set<Feature>	getEnabledFeatures() Returns a static array of enabled features.
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.
Property<Object>	matchFilter() Set a filter on the current column.
void	setData(Map<String,Object> data) Add the contents of the given map to the data map.
Property<Boolean>	showFilterControl() Toggle the visible state of the filter control.
Property<Boolean>	visible() Toggle the visible state of the column.

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnConfigurationImpl

public ColumnConfigurationImpl(Set<Feature> enabledFeatures,
                               boolean resizeable,
                               boolean moveable,
                               int styleBits,
                               int weight,
                               int minWidth,
                               org.eclipse.core.databinding.observable.value.IObservableValue columnText,
                               org.eclipse.core.databinding.observable.value.IObservableValue tooltipText,
                               CellLabelProviderFactory labelProviderFactory,
                               EditingSupportCreator editingSupport,
                               org.eclipse.swt.graphics.Image image,
                               Map<String,Object> data,
                               List<ConfigurationCallback<org.eclipse.jface.viewers.AbstractTableViewer,org.eclipse.jface.viewers.ViewerColumn>> configurationCallbacks)

Constructs a new ColumnConfiguration.

Parameters:

enabledFeatures - list of enabled features

resizeable - resizeable

moveable - moveable

styleBits - styleBits

weight - weight

minWidth - minWidth

columnText - columnText

tooltipText - tooltipText

labelProviderFactory - labelProvider

editingSupport - editingSupport. May be null to indicate that there is no editing support

Method Detail

getEnabledFeatures

public Set<Feature> getEnabledFeatures()

Description copied from interface: ColumnConfiguration

Returns a static array of enabled features.

Specified by:

getEnabledFeatures in interface ColumnConfiguration

Returns:

array of enabled features.

isResizeable

public boolean isResizeable()

Description copied from interface: ColumnConfiguration

true if resizeable, false otherwise.

Specified by:

isResizeable in interface ColumnConfiguration

Returns:

whether the column is resizeable

isMoveable

public boolean isMoveable()

Description copied from interface: ColumnConfiguration

true if moveable, false otherwise.

Specified by:

isMoveable in interface ColumnConfiguration

Returns:

whether the column is moveable

getStyleBits

public int getStyleBits()

Description copied from interface: ColumnConfiguration

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

Specified by:

getStyleBits in interface ColumnConfiguration

Returns:

the SWT style bits for the column

getWeight

public int getWeight()

Description copied from interface: ColumnConfiguration

The weight of the column.

Specified by:

getWeight in interface ColumnConfiguration

Returns:

the weight of the column

getMinWidth

public int getMinWidth()

Description copied from interface: ColumnConfiguration

The minimal width of the column.

Specified by:

getMinWidth in interface ColumnConfiguration

Returns:

the min width of the column in pixels

getColumnText

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

Description copied from interface: ColumnConfiguration

The header text for the column.

Specified by:

getColumnText in interface ColumnConfiguration

Returns:

the column header text

getColumnTooltip

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

Description copied from interface: ColumnConfiguration

The column header tooltip text.

Specified by:

getColumnTooltip in interface ColumnConfiguration

Returns:

the column header tooltip

createLabelProvider

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

Description copied from interface: ColumnConfiguration

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

Specified by:

createLabelProvider in interface ColumnConfiguration

Parameters:

columnViewer - the column viewer

Returns:

the label provider

createEditingSupport

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

Description copied from interface: ColumnConfiguration

Called to setup the EditingSupport for the viewer.

Specified by:

createEditingSupport in interface ColumnConfiguration

Parameters:

columnViewer - the AbstractTableViewer

Returns:

the editing support for the column, if present

getColumnImage

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

Description copied from interface: ColumnConfiguration

The image of the column.

Specified by:

getColumnImage in interface ColumnConfiguration

Returns:

the column image, if present

setData

public void setData(Map<String,Object> data)

Description copied from interface: ColumnConfiguration

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

Specified by:

setData in interface ColumnConfiguration

Parameters:

data - object

getData

public Object getData(String key)

Description copied from interface: ColumnConfiguration

Get an arbitrary element from the data map.

Specified by:

getData in interface ColumnConfiguration

Parameters:

key - (see constants)

Returns:

object

getData

public Map<String,Object> getData()

Description copied from interface: ColumnConfiguration

Get the underlying data map.

Specified by:

getData in interface ColumnConfiguration

Returns:

data map object

getConfigurationCallbacks

public List<ConfigurationCallback<org.eclipse.jface.viewers.AbstractTableViewer,org.eclipse.jface.viewers.ViewerColumn>> getConfigurationCallbacks()

Description copied from interface: ColumnConfiguration

Get the list of additional ConfigurationCallbacks.

Specified by:

getConfigurationCallbacks in interface ColumnConfiguration

Returns:

list of ConfigurationCallbacks.

visible

public Property<Boolean> visible()

Description copied from interface: ColumnConfiguration

Toggle the visible state of the column.

Specified by:

visible in interface ColumnConfiguration

Returns:

visible property

showFilterControl

public Property<Boolean> showFilterControl()

Description copied from interface: ColumnConfiguration

Toggle the visible state of the filter control.

Specified by:

showFilterControl in interface ColumnConfiguration

Returns:

visible property

matchFilter

public Property<Object> matchFilter()

Description copied from interface: ColumnConfiguration

Set a filter on the current column.

Specified by:

matchFilter in interface ColumnConfiguration

Returns:

visible property

dispose

public void dispose()

Description copied from interface: ColumnConfiguration

Dispose this configuration and all its properties.

Specified by:

dispose in interface ColumnConfiguration