ColumnConfiguration (ecp-parent 1.21.0-SNAPSHOT API)

All Known Implementing Classes:

ColumnConfigurationImpl
```
public interface ColumnConfiguration
```
A ColumnConfiguration is used to configure how a viewer column shall be created and how it behaves during runtime.

Author:

Johannes Faltermeier, Mat Hansen

Field Summary

Fields
Modifier and Type	Field and Description
`static Set<Feature>`	`ALL_FEATURES` All configurable features.
`static String`	`COLUMN_ID` Data key for column id.
`static String`	`DMR` Data key for a domain model reference.
`static Feature`	`FEATURE_COLUMN_FILTER` Feature toggle for column filter support.
`static Feature`	`FEATURE_COLUMN_HIDE_SHOW` Feature toggle for column hide/show support.
`static Feature`	`FEATURE_COLUMN_REGEX_FILTER` Feature toggle for column filter support.
`static Feature[]`	`FEATURES` Deprecated. Since 1.21, use the immutable `ALL_FEATURES` set instead of this, which can be modified in place.
`static String`	`ID` Column data configuration key.
`static String`	`MIN_WIDTH` Data key for the minimum width of the column.
`static int`	`NO_WEIGHT` Constant indicating that `getWeight()` has no value.
`static String`	`RESIZABLE` Data key for resizable columns.
`static String`	`WEIGHT` Data key for column weight.

Method Summary

All Methods Instance Methods Abstract Methods
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.

- Field Detail
  - FEATURE_COLUMN_HIDE_SHOW
```
static final Feature FEATURE_COLUMN_HIDE_SHOW
```
    Feature toggle for column hide/show support. Can be enabled on a per-column basis.
  - FEATURE_COLUMN_FILTER
```
static final Feature FEATURE_COLUMN_FILTER
```
    Feature toggle for column filter support.
  - FEATURE_COLUMN_REGEX_FILTER
```
static final Feature FEATURE_COLUMN_REGEX_FILTER
```
    Feature toggle for column filter support.
  - ALL_FEATURES
```
static final Set<Feature> ALL_FEATURES
```
    All configurable features.
    
    Since:
    
    1.21
  - FEATURES
```
@Deprecated
static final Feature[] FEATURES
```
    Deprecated. Since 1.21, use the immutable ALL_FEATURES set instead of this, which can be modified in place.
    
    All configurable features.
  - ID
```
static final String ID
```
    Column data configuration key.
    
    See Also:
    
    Constant Field Values
  - RESIZABLE
```
static final String RESIZABLE
```
    Data key for resizable columns.
    
    See Also:
    
    Constant Field Values
  - WEIGHT
```
static final String WEIGHT
```
    Data key for column weight.
    
    See Also:
    
    Constant Field Values
  - NO_WEIGHT
```
static final int NO_WEIGHT
```
    Constant indicating that getWeight() has no value.
    
    See Also:
    
    Constant Field Values
  - MIN_WIDTH
```
static final String MIN_WIDTH
```
    Data key for the minimum width of the column.
    
    See Also:
    
    Constant Field Values
  - COLUMN_ID
```
static final String COLUMN_ID
```
    Data key for column id.
    
    See Also:
    
    Constant Field Values
  - DMR
```
static final String DMR
```
    Data key for a domain model reference.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getEnabledFeatures
```
Set<Feature> getEnabledFeatures()
```
    Returns a static array of enabled features.
    
    Returns:
    
    array of enabled features.
  - 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
  - getConfigurationCallbacks
```
List<ConfigurationCallback<org.eclipse.jface.viewers.AbstractTableViewer,org.eclipse.jface.viewers.ViewerColumn>> getConfigurationCallbacks()
```
    Get the list of additional ConfigurationCallbacks.
    
    Returns:
    
    list of ConfigurationCallbacks.
  - visible
```
Property<Boolean> visible()
```
    Toggle the visible state of the column.
    
    Returns:
    
    visible property
  - showFilterControl
```
Property<Boolean> showFilterControl()
```
    Toggle the visible state of the filter control.
    
    Returns:
    
    visible property
  - matchFilter
```
Property<Object> matchFilter()
```
    Set a filter on the current column.
    
    Returns:
    
    visible property
  - dispose
```
void dispose()
```
    Dispose this configuration and all its properties.

Interface ColumnConfiguration

Field Summary

Method Summary

Field Detail

FEATURE_COLUMN_HIDE_SHOW

FEATURE_COLUMN_FILTER

FEATURE_COLUMN_REGEX_FILTER

ALL_FEATURES

FEATURES

ID

RESIZABLE

WEIGHT

NO_WEIGHT

MIN_WIDTH

COLUMN_ID

DMR

Method Detail

getEnabledFeatures

isResizeable

isMoveable

getStyleBits

getWeight

getMinWidth

getColumnText

getColumnTooltip

createLabelProvider

createEditingSupport

getColumnImage

getData

setData

getData

getConfigurationCallbacks

visible

showFilterControl

matchFilter

dispose