org.eclipse.emfforms.spi.swt.table

Class TableViewerSWTBuilder

java.lang.Object

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

org.eclipse.emfforms.spi.swt.table.TableViewerSWTBuilder

Direct Known Subclasses:

GridTableViewerSWTBuilder

public class TableViewerSWTBuilder
extends AbstractFeatureAwareBuilder<TableViewerSWTBuilder>

Builder class for creating a TableViewerComposite.

Author:

Alexandra Buzila, Johannes Faltermeier, Mat Hansen

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TableViewerSWTBuilder(org.eclipse.swt.widgets.Composite composite, int swtStyleBits, Object input, org.eclipse.core.databinding.observable.value.IObservableValue title, org.eclipse.core.databinding.observable.value.IObservableValue tooltip)

Method Summary

Modifier and Type	Method and Description
TableViewerSWTBuilder	addColumn(ColumnConfiguration columnConfiguration) Adds a new column.
AbstractTableViewerComposite	build() Call this method after all desired customizations have been passed to the builder.
TableViewerSWTBuilder	configureTable(TableConfiguration tableConfiguration) Configures the current table instance using the given configuration.
TableViewerSWTBuilder	customizeButtons(ButtonBarBuilder builder) Use this method to customize the way the button bar is filled.
TableViewerSWTBuilder	customizeComparator(org.eclipse.jface.viewers.ViewerComparator comparator) Use this method to set a ViewerComparator on the table.
TableViewerSWTBuilder	customizeCompositeStructure(TableViewerCompositeBuilder builder) Use this method to customize the way title, validation, buttons and the tableviewer are arranged.
TableViewerSWTBuilder	customizeContentProvider(org.eclipse.jface.viewers.IContentProvider provider) Use this method to set a different content provider on the viewer.
TableViewerSWTBuilder	customizeDragAndDrop(DNDProvider provider) Use this method to customize drag&drop.
TableViewerSWTBuilder	customizeElementCreation(NewElementCreator<Object,org.eclipse.swt.widgets.Button> creator) Use this method to customize the way new elements are created.
TableViewerSWTBuilder	customizeTableViewerCreation(TableViewerCreator<? extends org.eclipse.jface.viewers.AbstractTableViewer> creator) Use this method to create the actual TableViewer.
protected org.eclipse.swt.widgets.Composite	getComposite()
TableViewerSWTCustomization<?>	getCustomization()
Set<Feature>	getEnabledFeatures() Return the list of enabled features.
protected Object	getInput()
Set<Feature>	getSupportedFeatures() Returns the list of supported features.
protected int	getSwtStyleBits()
protected org.eclipse.core.databinding.observable.value.IObservableValue	getTitle()
protected org.eclipse.core.databinding.observable.value.IObservableValue	getTooltip()

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

Constructor Detail

TableViewerSWTBuilder

protected TableViewerSWTBuilder(org.eclipse.swt.widgets.Composite composite,
                                int swtStyleBits,
                                Object input,
                                org.eclipse.core.databinding.observable.value.IObservableValue title,
                                org.eclipse.core.databinding.observable.value.IObservableValue tooltip)

Parameters:

composite - the parent Composite

swtStyleBits - the swt style bits

input - the input object

title - the title

tooltip - the tooltip

Method Detail

getComposite

protected org.eclipse.swt.widgets.Composite getComposite()

Returns:

the composite

getSwtStyleBits

protected int getSwtStyleBits()

Returns:

the swtStyleBits

getInput

protected Object getInput()

Returns:

the input

getCustomization

public TableViewerSWTCustomization<?> getCustomization()

Returns:

the customization

getTitle

protected org.eclipse.core.databinding.observable.value.IObservableValue getTitle()

Returns:

the title

getTooltip

protected org.eclipse.core.databinding.observable.value.IObservableValue getTooltip()

Returns:

the tooltip

customizeCompositeStructure

public TableViewerSWTBuilder customizeCompositeStructure(TableViewerCompositeBuilder builder)

Use this method to customize the way title, validation, buttons and the tableviewer are arranged.

The default implementation will create a title bar with title to left, a validation label in the middle and a button bar on the right. Below the title bar the viewer will be created

Parameters:

builder - the TableViewerCompositeBuilder

Returns:

self

customizeTableViewerCreation

public TableViewerSWTBuilder customizeTableViewerCreation(TableViewerCreator<? extends org.eclipse.jface.viewers.AbstractTableViewer> creator)

Use this method to create the actual TableViewer.

The default implementation will create a viewer with the SWT#MULTI, SWT#V_SCROLL, FULL_SELECTION and SWT#BORDER style bits. The table will show the header and will show lines.

Parameters:

creator - the TableViewerCreator

Returns:

self

customizeComparator

public TableViewerSWTBuilder customizeComparator(org.eclipse.jface.viewers.ViewerComparator comparator)

Use this method to set a ViewerComparator on the table.

The default implementation does not add a comparator.

Parameters:

comparator - the ViewerComparator

Returns:

self

customizeContentProvider

public TableViewerSWTBuilder customizeContentProvider(org.eclipse.jface.viewers.IContentProvider provider)

Use this method to set a different content provider on the viewer.

The default implementation uses a ObservableListContentProvider.

Parameters:

provider - the IContentProvider to use

Returns:

self

customizeButtons

public TableViewerSWTBuilder customizeButtons(ButtonBarBuilder builder)

Use this method to customize the way the button bar is filled.

The default implementation will add an add and a remove button.

Parameters:

builder - the ButtonBarBuilder

Returns:

self

customizeElementCreation

public TableViewerSWTBuilder customizeElementCreation(NewElementCreator<Object,org.eclipse.swt.widgets.Button> creator)

Use this method to customize the way new elements are created.

This may only be used in conjunction with the DefaultButtonBarBuilder

Parameters:

creator - the creator

Returns:

self

customizeDragAndDrop

public TableViewerSWTBuilder customizeDragAndDrop(DNDProvider provider)

Use this method to customize drag&drop.

The default behaviour disables drag&drop.

Parameters:

provider - the provider

Returns:

self

configureTable

public TableViewerSWTBuilder configureTable(TableConfiguration tableConfiguration)

Configures the current table instance using the given configuration.

Parameters:

tableConfiguration - the TableConfiguration to add

Returns:

self

addColumn

public TableViewerSWTBuilder addColumn(ColumnConfiguration columnConfiguration)

Adds a new column.

Parameters:

columnConfiguration - the ColumnConfiguration to add

Returns:

self

getSupportedFeatures

public Set<Feature> getSupportedFeatures()

Description copied from class: AbstractFeatureAwareBuilder

Returns the list of supported features.

Specified by:

getSupportedFeatures in class AbstractFeatureAwareBuilder<TableViewerSWTBuilder>

Returns:

array of supported features

getEnabledFeatures

public Set<Feature> getEnabledFeatures()

Description copied from class: AbstractFeatureAwareBuilder

Return the list of enabled features.

Specified by:

getEnabledFeatures in class AbstractFeatureAwareBuilder<TableViewerSWTBuilder>

Returns:

list of enabled features

build

public AbstractTableViewerComposite build()

Call this method after all desired customizations have been passed to the builder. The will create a new TableViewerComposite with the desired customizations.

Returns:

the TableViewerComposite