Package org.eclipse.emfforms.spi.swt.table

Class ColumnConfigurationBuilder

java.lang.Object

org.eclipse.emfforms.spi.swt.table.AbstractFeatureAwareBuilder<ColumnConfigurationBuilder>

org.eclipse.emfforms.spi.swt.table.ColumnConfigurationBuilder

public final class ColumnConfigurationBuilder
extends AbstractFeatureAwareBuilder<ColumnConfigurationBuilder>

Builder for ColumnConfigurations.

Author:

Mat Hansen

Method Summary

Modifier and Type	Method	Description
ColumnConfiguration	build()	Create a new ColumnConfiguration using the current builder state.
ColumnConfigurationBuilder	callback(ConfigurationCallback<org.eclipse.jface.viewers.AbstractTableViewer,org.eclipse.jface.viewers.ViewerColumn> callback)	Add a column configuration callback.
ColumnConfigurationBuilder	dataMap(java.util.Map<java.lang.String,java.lang.Object> data)	Add a pre-initialized data map.
ColumnConfigurationBuilder	dataMapEntry(java.lang.String key, java.lang.Object value)	Add a data map entry.
ColumnConfigurationBuilder	editingSupportCreator(EditingSupportCreator editingSupportCreator)	Add an editing support creator.
static ColumnConfigurationBuilder	from(TableViewerSWTBuilder viewerBuilder)	Returns a new TableConfigurationBuilder initialized using an existing viewer builder.
protected java.util.Set<Feature>	getEnabledFeatures()	Deprecated. Since 1.21, use the showHide(boolean) and similar builder methods, instead
java.util.Set<Feature>	getSupportedFeatures()	Deprecated. Since 1.21, use the showHide(boolean) and similar builder methods, instead
ColumnConfigurationBuilder	image(org.eclipse.swt.graphics.Image image)	Add a column image.
ColumnConfigurationBuilder	labelProvider(org.eclipse.jface.viewers.CellLabelProvider labelProvider)	Add a label provider.
ColumnConfigurationBuilder	labelProviderFactory(CellLabelProviderFactory labelProviderFactory)	Add a label provider factory.
ColumnConfigurationBuilder	minWidth(int minWidth)	Add a minimal width.
ColumnConfigurationBuilder	moveable(boolean moveable)	Makes the column moveable.
ColumnConfigurationBuilder	regexFilter(boolean regexFilter)	Set whether support for users to show a regular expression filter is installed.
ColumnConfigurationBuilder	resizable(boolean resizable)	Makes the column resizable.
ColumnConfigurationBuilder	showHide(boolean showHide)	Set whether support for users to show and hide the column is installed.
ColumnConfigurationBuilder	styleBits(int styleBits)	Add SWT style bits.
ColumnConfigurationBuilder	substringFilter(boolean substringFilter)	Set whether support for users to show a simple substring-matching filter is installed.
ColumnConfigurationBuilder	text(java.lang.String text)	Add a static text.
ColumnConfigurationBuilder	text(org.eclipse.core.databinding.observable.value.IObservableValue textObservable)	Add a text observable.
ColumnConfigurationBuilder	tooltip(java.lang.String tooltip)	Add a static tooltip.
ColumnConfigurationBuilder	tooltip(org.eclipse.core.databinding.observable.value.IObservableValue tooltipObservable)	Add a tooltip observable.
static ColumnConfigurationBuilder	usingConfiguration(ColumnConfiguration columnConfiguration)	Returns a new ColumnConfigurationBuilder initialized using an existing configuration.
static ColumnConfigurationBuilder	usingDefaults()	Returns a new ColumnConfigurationBuilder initialized using default values.
ColumnConfigurationBuilder	weight(int weight)	Add column weight.

Methods inherited from class org.eclipse.emfforms.spi.swt.table.AbstractFeatureAwareBuilder

disableFeature, enableFeature, getBuilder, inheritFeatures, isFeatureEnabled, isFeatureSupported

Methods inherited from class java.lang.Object

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

Method Detail

usingDefaults

public static ColumnConfigurationBuilder usingDefaults()

Returns a new ColumnConfigurationBuilder initialized using default values.

Returns:

self

usingConfiguration

public static ColumnConfigurationBuilder usingConfiguration(ColumnConfiguration columnConfiguration)

Returns a new ColumnConfigurationBuilder initialized using an existing configuration.

Parameters:

columnConfiguration - a ColumnConfiguration to use

Returns:

self

from

public static ColumnConfigurationBuilder from(TableViewerSWTBuilder viewerBuilder)

Returns a new TableConfigurationBuilder initialized using an existing viewer builder.

Parameters:

viewerBuilder - a TableViewerSWTBuilder to transform to a configuration builder

Returns:

the new configuration builder

Since:

1.21

getSupportedFeatures

@Deprecated
public java.util.Set<Feature> getSupportedFeatures()

Deprecated.

Since 1.21, use the showHide(boolean) and similar builder methods, instead

Description copied from class: AbstractFeatureAwareBuilder

Returns the list of supported features.

Specified by:

getSupportedFeatures in class AbstractFeatureAwareBuilder<ColumnConfigurationBuilder>

Returns:

array of supported features

See Also:

showHide(boolean), substringFilter(boolean), regexFilter(boolean)

getEnabledFeatures

@Deprecated
protected java.util.Set<Feature> getEnabledFeatures()

Deprecated.

Since 1.21, use the showHide(boolean) and similar builder methods, instead

Description copied from class: AbstractFeatureAwareBuilder

Return the list of enabled features.

Specified by:

getEnabledFeatures in class AbstractFeatureAwareBuilder<ColumnConfigurationBuilder>

Returns:

list of enabled features

See Also:

showHide(boolean), substringFilter(boolean), regexFilter(boolean)

showHide

public ColumnConfigurationBuilder showHide(boolean showHide)

Set whether support for users to show and hide the column is installed.

Parameters:

showHide - true to enable showing and hiding; false to disable it

Returns:

this builder, for fluent chaining

Since:

1.21

substringFilter

public ColumnConfigurationBuilder substringFilter(boolean substringFilter)

Set whether support for users to show a simple substring-matching filter is installed.

Parameters:

substringFilter - true to enable the substring filter; false to disable it

Returns:

this builder, for fluent chaining

Since:

1.21

regexFilter

public ColumnConfigurationBuilder regexFilter(boolean regexFilter)

Set whether support for users to show a regular expression filter is installed.

Parameters:

regexFilter - true to enable the regex filter; false to disable it

Returns:

this builder, for fluent chaining

Since:

1.21

resizable

public ColumnConfigurationBuilder resizable(boolean resizable)

Makes the column resizable.

Parameters:

resizable - true for resizable columns

Returns:

self

moveable

public ColumnConfigurationBuilder moveable(boolean moveable)

Makes the column moveable.

Parameters:

moveable - true for movable columns

Returns:

self

styleBits

public ColumnConfigurationBuilder styleBits(int styleBits)

Add SWT style bits.

Parameters:

styleBits - the SWT style bits

Returns:

self

weight

public ColumnConfigurationBuilder weight(int weight)

Add column weight.

Parameters:

weight - the weight

Returns:

self

minWidth

public ColumnConfigurationBuilder minWidth(int minWidth)

Add a minimal width.

Parameters:

minWidth - the minimal width

Returns:

self

text

public ColumnConfigurationBuilder text(org.eclipse.core.databinding.observable.value.IObservableValue textObservable)

Add a text observable.

Parameters:

textObservable - the column text observable

Returns:

self

text

public ColumnConfigurationBuilder text(java.lang.String text)

Add a static text.

Parameters:

text - the column text

Returns:

self

tooltip

public ColumnConfigurationBuilder tooltip(org.eclipse.core.databinding.observable.value.IObservableValue tooltipObservable)

Add a tooltip observable.

Parameters:

tooltipObservable - the tooltip observable

Returns:

self

tooltip

public ColumnConfigurationBuilder tooltip(java.lang.String tooltip)

Add a static tooltip.

Parameters:

tooltip - the tooltip

Returns:

self

labelProviderFactory

public ColumnConfigurationBuilder labelProviderFactory(CellLabelProviderFactory labelProviderFactory)

Add a label provider factory.

Parameters:

labelProviderFactory - the label provider factory

Returns:

self

labelProvider

public ColumnConfigurationBuilder labelProvider(org.eclipse.jface.viewers.CellLabelProvider labelProvider)

Add a label provider.

Parameters:

labelProvider - the label provider

Returns:

self

editingSupportCreator

public ColumnConfigurationBuilder editingSupportCreator(EditingSupportCreator editingSupportCreator)

Add an editing support creator.

Parameters:

editingSupportCreator - the editing support creator

Returns:

self

image

public ColumnConfigurationBuilder image(org.eclipse.swt.graphics.Image image)

Add a column image.

Parameters:

image - the image

Returns:

self

dataMap

public ColumnConfigurationBuilder dataMap(java.util.Map<java.lang.String,java.lang.Object> data)

Add a pre-initialized data map.

Parameters:

data - the data map

Returns:

self

dataMapEntry

public ColumnConfigurationBuilder dataMapEntry(java.lang.String key,
                                               java.lang.Object value)

Add a data map entry.

Parameters:

key - the data map key

value - the data map value

Returns:

self

callback

public ColumnConfigurationBuilder callback(ConfigurationCallback<org.eclipse.jface.viewers.AbstractTableViewer,org.eclipse.jface.viewers.ViewerColumn> callback)

Add a column configuration callback.

Parameters:

callback - the callback

Returns:

self

build

public ColumnConfiguration build()

Create a new ColumnConfiguration using the current builder state.

Returns:

the ColumnConfiguration