org.eclipse.emfforms.spi.swt.table

Class TableViewerSWTBuilder

java.lang.Object

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

Direct Known Subclasses:

GridTableViewerSWTBuilder

public class TableViewerSWTBuilder
extends Object

Builder class for creating a TableViewerComposite.

Author:

Alexandra Buzila, Johannes Faltermeier

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(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, org.eclipse.jface.viewers.CellLabelProvider labelProvider) Adds a read-only column.
TableViewerSWTBuilder	addColumn(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, org.eclipse.jface.viewers.CellLabelProvider labelProvider, EditingSupportCreator editingSupport) Adds a column.
TableViewerSWTBuilder	addColumn(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, org.eclipse.jface.viewers.CellLabelProvider labelProvider, EditingSupportCreator editingSupport, org.eclipse.swt.graphics.Image image) Adds a column.
TableViewerSWTBuilder	addColumn(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 labelProvider, EditingSupportCreator editingSupport, org.eclipse.swt.graphics.Image image) Adds a column.
TableViewerSWTBuilder	addColumn(boolean resizeable, boolean moveable, int styleBits, int weight, int minWidth, String columnText, String tooltipText, org.eclipse.jface.viewers.CellLabelProvider labelProvider) Adds a read-only column.
TableViewerSWTBuilder	addColumn(boolean resizeable, boolean moveable, int styleBits, int weight, int minWidth, String columnText, String tooltipText, org.eclipse.jface.viewers.CellLabelProvider labelProvider, EditingSupportCreator editingSupport) Adds a column.
TableViewerSWTBuilder	addColumn(boolean resizeable, boolean moveable, int styleBits, int weight, int minWidth, String columnText, String tooltipText, org.eclipse.jface.viewers.CellLabelProvider labelProvider, EditingSupportCreator editingSupport, org.eclipse.swt.graphics.Image image) Adds a column.
TableViewerSWTBuilder	addColumn(org.eclipse.core.databinding.observable.value.IObservableValue columnText, org.eclipse.core.databinding.observable.value.IObservableValue tooltipText, org.eclipse.jface.viewers.CellLabelProvider labelProvider) Adds a read-only column.
TableViewerSWTBuilder	addColumn(org.eclipse.core.databinding.observable.value.IObservableValue columnText, org.eclipse.core.databinding.observable.value.IObservableValue tooltipText, org.eclipse.jface.viewers.CellLabelProvider labelProvider, EditingSupportCreator editingSupport) Adds a column.
TableViewerSWTBuilder	addColumn(String columnText, String tooltipText, org.eclipse.jface.viewers.CellLabelProvider labelProvider) Adds a read-only column.
TableViewerSWTBuilder	addColumn(String columnText, String tooltipText, org.eclipse.jface.viewers.CellLabelProvider labelProvider, EditingSupportCreator editingSupport) Adds a column.
AbstractTableViewerComposite	create() Call this method after all desired customizations have been passed to the builder.
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 creator) Use this method to create the actual TableViewer.
protected org.eclipse.swt.widgets.Composite	getComposite()
protected DefaultTableControlSWTCustomization	getCustomization()
protected Object	getInput()
protected int	getSwtStyleBits()
protected org.eclipse.core.databinding.observable.value.IObservableValue	getTitle()
protected org.eclipse.core.databinding.observable.value.IObservableValue	getTooltip()
void	setData(String key, Object value) Add an arbitrary key/value pair.

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

protected DefaultTableControlSWTCustomization 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 creator)

Use this method to create the actual TableViewer.

The default implementation will create a viewer with the SWT.MULTI, SWT.V_SCROLL, SWT.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

setData

public void setData(String key,
                    Object value)

Add an arbitrary key/value pair.

Parameters:

key - literal

value - object

addColumn

public TableViewerSWTBuilder addColumn(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 labelProvider,
                                       EditingSupportCreator editingSupport,
                                       org.eclipse.swt.graphics.Image image)

Adds a column.

Parameters:

resizeable - whether the column is resizeable or not

moveable - whether the column is moveable or not

styleBits - the style bits for the column

weight - the weight of the column

minWidth - the min width in pixels

columnText - the column text

tooltipText - the tooltip text

labelProvider - the label provider

editingSupport - the editing support

image - the column image

Returns:

self

addColumn

public TableViewerSWTBuilder addColumn(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,
                                       org.eclipse.jface.viewers.CellLabelProvider labelProvider,
                                       EditingSupportCreator editingSupport,
                                       org.eclipse.swt.graphics.Image image)

Adds a column.

Parameters:

resizeable - whether the column is resizeable or not

moveable - whether the column is moveable or not

styleBits - the style bits for the column

weight - the weight of the column

minWidth - the min width in pixels

columnText - the column text

tooltipText - the tooltip text

labelProvider - the label provider

editingSupport - the editing support

image - the column image

Returns:

self

addColumn

public TableViewerSWTBuilder addColumn(boolean resizeable,
                                       boolean moveable,
                                       int styleBits,
                                       int weight,
                                       int minWidth,
                                       String columnText,
                                       String tooltipText,
                                       org.eclipse.jface.viewers.CellLabelProvider labelProvider,
                                       EditingSupportCreator editingSupport,
                                       org.eclipse.swt.graphics.Image image)

Adds a column.

Parameters:

resizeable - whether the column is resizeable or not

moveable - whether the column is moveable or not

styleBits - the style bits for the column

weight - the weight of the column

minWidth - the min width in pixels

columnText - the column text

tooltipText - the tooltip text

labelProvider - the label provider

editingSupport - the editing support

image - the column image

Returns:

self

addColumn

public TableViewerSWTBuilder addColumn(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,
                                       org.eclipse.jface.viewers.CellLabelProvider labelProvider,
                                       EditingSupportCreator editingSupport)

Adds a column.

Parameters:

resizeable - whether the column is resizeable or not

moveable - whether the column is moveable or not

styleBits - the style bits for the column

weight - the weight of the column

minWidth - the min width in pixels

columnText - the column text

tooltipText - the tooltip text

labelProvider - the label provider

editingSupport - the editing support

Returns:

self

addColumn

public TableViewerSWTBuilder addColumn(boolean resizeable,
                                       boolean moveable,
                                       int styleBits,
                                       int weight,
                                       int minWidth,
                                       String columnText,
                                       String tooltipText,
                                       org.eclipse.jface.viewers.CellLabelProvider labelProvider,
                                       EditingSupportCreator editingSupport)

Adds a column.

Parameters:

resizeable - whether the column is resizeable or not

moveable - whether the column is moveable or not

styleBits - the style bits for the column

weight - the weight of the column

minWidth - the min width in pixels

columnText - the column text

tooltipText - the tooltip text

labelProvider - the label provider

editingSupport - the editing support

Returns:

self

addColumn

public TableViewerSWTBuilder addColumn(org.eclipse.core.databinding.observable.value.IObservableValue columnText,
                                       org.eclipse.core.databinding.observable.value.IObservableValue tooltipText,
                                       org.eclipse.jface.viewers.CellLabelProvider labelProvider,
                                       EditingSupportCreator editingSupport)

Adds a column. The column is resizeable, not moveable, uses the SWT.NONE style bit, has a weight of 100 and a min width of 0 pixel.

Parameters:

columnText - the column text

tooltipText - the tooltip text

labelProvider - the label provider

editingSupport - the editing support

Returns:

self

addColumn

public TableViewerSWTBuilder addColumn(String columnText,
                                       String tooltipText,
                                       org.eclipse.jface.viewers.CellLabelProvider labelProvider,
                                       EditingSupportCreator editingSupport)

Adds a column. The column is resizeable, not moveable, uses the SWT.NONE style bit, has a weight of 100 and a min width of 0 pixel.

Parameters:

columnText - the column text

tooltipText - the tooltip text

labelProvider - the label provider

editingSupport - the editing support

Returns:

self

addColumn

public TableViewerSWTBuilder addColumn(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,
                                       org.eclipse.jface.viewers.CellLabelProvider labelProvider)

Adds a read-only column.

Parameters:

resizeable - whether the column is resizeable or not

moveable - whether the column is moveable or not

styleBits - the style bits for the column

weight - the weight of the column

minWidth - the min width in pixels

columnText - the column text

tooltipText - the tooltip text

labelProvider - the label provider

Returns:

self

addColumn

public TableViewerSWTBuilder addColumn(boolean resizeable,
                                       boolean moveable,
                                       int styleBits,
                                       int weight,
                                       int minWidth,
                                       String columnText,
                                       String tooltipText,
                                       org.eclipse.jface.viewers.CellLabelProvider labelProvider)

Adds a read-only column.

Parameters:

resizeable - whether the column is resizeable or not

moveable - whether the column is moveable or not

styleBits - the style bits for the column

weight - the weight of the column

minWidth - the min width in pixels

columnText - the column text

tooltipText - the tooltip text

labelProvider - the label provider

Returns:

self

addColumn

public TableViewerSWTBuilder addColumn(org.eclipse.core.databinding.observable.value.IObservableValue columnText,
                                       org.eclipse.core.databinding.observable.value.IObservableValue tooltipText,
                                       org.eclipse.jface.viewers.CellLabelProvider labelProvider)

Adds a read-only column. The column is resizeable, not moveable, uses the SWT.NONE style bit, has a weight of 100 and a min width of 0 pixel.

Parameters:

columnText - the column text

tooltipText - the tooltip text

labelProvider - the label provider

Returns:

self

addColumn

public TableViewerSWTBuilder addColumn(String columnText,
                                       String tooltipText,
                                       org.eclipse.jface.viewers.CellLabelProvider labelProvider)

Adds a read-only column. The column is resizeable, not moveable, uses the SWT.NONE style bit, has a weight of 100 and a min width of 0 pixel.

Parameters:

columnText - the column text

tooltipText - the tooltip text

labelProvider - the label provider

Returns:

self

create

public AbstractTableViewerComposite create()

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