org.eclipse.emfforms.spi.swt.table

Class TableConfigurationBuilder

java.lang.Object

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

org.eclipse.emfforms.spi.swt.table.TableConfigurationBuilder

public final class TableConfigurationBuilder
extends AbstractFeatureAwareBuilder<TableConfigurationBuilder>

Builder for TableConfigurations.

Author:

Mat Hansen

Method Summary

Modifier and Type	Method and Description
TableConfiguration	build() Creates a new TableConfiguration based on the current builder state.
TableConfigurationBuilder	columnRegexFilter(boolean columnRegexFilter) Set whether support for users to show a regular expression filter on columns is installed.
TableConfigurationBuilder	columnSubstringFilter(boolean columnSubstringFilter) Set whether support for users to show a simple substring-matching filter on columns is installed.
TableConfigurationBuilder	dataMapEntry(String key, Object value) Add a data map entry.
static TableConfigurationBuilder	from(TableViewerSWTBuilder viewerBuilder) Returns a new TableConfigurationBuilder initialized using an existing viewer builder.
protected Set<Feature>	getEnabledFeatures() Deprecated. Since 1.21, use the showHideColumns(boolean) and similar builder methods, instead
Set<Feature>	getSupportedFeatures() Deprecated. Since 1.21, use the showHideColumns(boolean) and similar builder methods, instead
TableConfigurationBuilder	showHideColumns(boolean showHideColumns) Set whether support for users to show and hide columns is installed.
static TableConfigurationBuilder	usingConfiguration(TableConfiguration tableConfiguration) Returns a new TableConfigurationBuilder initialized using an existing configuration.
static TableConfigurationBuilder	usingDefaults() Returns a new TableConfigurationBuilder initialized using default values.

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 TableConfigurationBuilder usingDefaults()

Returns a new TableConfigurationBuilder initialized using default values.

Returns:

self

usingConfiguration

public static TableConfigurationBuilder usingConfiguration(TableConfiguration tableConfiguration)

Returns a new TableConfigurationBuilder initialized using an existing configuration.

Parameters:

tableConfiguration - a TableConfiguration to use

Returns:

self

from

public static TableConfigurationBuilder 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 Set<Feature> getSupportedFeatures()

Deprecated. Since 1.21, use the showHideColumns(boolean) and similar builder methods, instead

Description copied from class: AbstractFeatureAwareBuilder

Returns the list of supported features.

Specified by:

getSupportedFeatures in class AbstractFeatureAwareBuilder<TableConfigurationBuilder>

Returns:

array of supported features

See Also:

showHideColumns(boolean), columnSubstringFilter(boolean), columnRegexFilter(boolean)

getEnabledFeatures

@Deprecated
protected Set<Feature> getEnabledFeatures()

Deprecated. Since 1.21, use the showHideColumns(boolean) and similar builder methods, instead

Description copied from class: AbstractFeatureAwareBuilder

Return the list of enabled features.

Specified by:

getEnabledFeatures in class AbstractFeatureAwareBuilder<TableConfigurationBuilder>

Returns:

list of enabled features

See Also:

showHideColumns(boolean), columnSubstringFilter(boolean), columnRegexFilter(boolean)

showHideColumns

public TableConfigurationBuilder showHideColumns(boolean showHideColumns)

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

Parameters:

showHideColumns - true to enable showing and hiding of columns; false to disable it

Returns:

this builder, for fluent chaining

Since:

1.21

columnSubstringFilter

public TableConfigurationBuilder columnSubstringFilter(boolean columnSubstringFilter)

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

Parameters:

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

Returns:

this builder, for fluent chaining

Since:

1.21

columnRegexFilter

public TableConfigurationBuilder columnRegexFilter(boolean columnRegexFilter)

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

Parameters:

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

Returns:

this builder, for fluent chaining

Since:

1.21

dataMapEntry

public TableConfigurationBuilder dataMapEntry(String key,
                                              Object value)

Add a data map entry.

Parameters:

key - the data map key

value - the data map value

Returns:

self

build

public TableConfiguration build()

Creates a new TableConfiguration based on the current builder state.

Returns:

the TableConfiguration