org.eclipse.emfforms.internal.swt.table

Class DefaultTableControlSWTCustomization<T extends org.eclipse.jface.viewers.AbstractTableViewer>

java.lang.Object

org.eclipse.emfforms.internal.swt.table.DefaultTableControlSWTCustomization<T>

Type Parameters:

T - the concrete table viewer implementation to use

All Implemented Interfaces:

ActionBarProvider<T>, ActionConfigurationProvider, DNDProvider, TableViewerCompositeBuilder, TableViewerCreator<T>, TableViewerSWTCustomization<T>

public class DefaultTableControlSWTCustomization<T extends org.eclipse.jface.viewers.AbstractTableViewer>
extends Object
implements TableViewerSWTCustomization<T>

The default implementation of the TableViewerSWTCustomization.

Author:

Alexandra Buzila, Johannes Faltermeier

Constructor Summary

Constructors

Constructor and Description
DefaultTableControlSWTCustomization()

Method Summary

Modifier and Type	Method and Description
void	addColumn(ColumnConfiguration columnConfiguration) Adds a column to the table.
void	configureTable(TableConfiguration tableConfiguration) Sets the table configuration.
void	createCompositeLayout(org.eclipse.swt.widgets.Composite parent) Called to create the composites.
org.eclipse.jface.viewers.IContentProvider	createContentProvider() Returns the content provider to use.
T	createTableViewer(org.eclipse.swt.widgets.Composite parent) Creates the AbstractTableViewer.
Optional<ActionBar<T>>	getActionBar() Get the action bar instance (if it exists).
Optional<ActionConfiguration>	getActionConfiguration() Returns the action configuration which will be used to register defined key bindings on the viewer.
Optional<org.eclipse.swt.widgets.Composite>	getButtonComposite() Called after TableViewerCompositeBuilder.createCompositeLayout(Composite).
List<ColumnConfiguration>	getColumnConfigurations() Returns the column configurations which will be used to configure columns.
Optional<org.eclipse.jface.viewers.ViewerComparator>	getComparator() Returns the comparator to use.
org.eclipse.swt.dnd.DragSourceListener	getDragListener(org.eclipse.jface.viewers.AbstractTableViewer tableViewer) Returns the DragSourceListener used to setup the drag support for the viewer.
int	getDragOperations() Returns the drag operations bits used to setup the drag support for the viewer.
org.eclipse.swt.dnd.Transfer[]	getDragTransferTypes() Returns the drag transfer types used to setup the drag support for the viewer.
org.eclipse.swt.dnd.DropTargetListener	getDropListener(org.eclipse.jface.viewers.AbstractTableViewer tableViewer) Returns the DragSourceListener used to setup the drop support for the viewer.
int	getDropOperations() Returns the drag operations bits used to setup the drop support for the viewer.
org.eclipse.swt.dnd.Transfer[]	getDropTransferTypes() Returns the drag transfer types used to setup the drop support for the viewer.
TableConfiguration	getTableConfiguration() Returns the table configuration which will be used to configure the table instance.
Optional<org.eclipse.swt.widgets.Label>	getTitleLabel() Called after TableViewerCompositeBuilder.createCompositeLayout(Composite).
Optional<List<org.eclipse.swt.widgets.Control>>	getValidationControls() Called after TableViewerCompositeBuilder.createCompositeLayout(Composite).
org.eclipse.swt.widgets.Composite	getViewerComposite() Called after TableViewerCompositeBuilder.createCompositeLayout(Composite).
boolean	hasDND() Whether DND support should be added to the table.
void	setActionBar(ActionBar<T> actionBar) Allows the customize the ActionBar.
void	setActionConfiguration(ActionConfiguration actionConfiguration) Allows to customize the ActionConfiguration.
void	setContentProvider(org.eclipse.jface.viewers.IContentProvider provider) Allows the exchange the default IContentProvider.
void	setDND(DNDProvider provider) Allows the exchange the default DNDProvider.
void	setTableViewerCompositeBuilder(TableViewerCompositeBuilder builder) Allows the exchange the default TableViewerCompositeBuilder.
void	setTableViewerCreator(TableViewerCreator<T> creator) Allows the exchange the default TableViewerCreator.
void	setViewerComparator(org.eclipse.jface.viewers.ViewerComparator comparator) Allows the exchange the default ViewerComparator.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultTableControlSWTCustomization

public DefaultTableControlSWTCustomization()

Method Detail

createCompositeLayout

public void createCompositeLayout(org.eclipse.swt.widgets.Composite parent)

Description copied from interface: TableViewerCompositeBuilder

Called to create the composites.

Specified by:

createCompositeLayout in interface TableViewerCompositeBuilder

Parameters:

parent - the parent

getTitleLabel

public Optional<org.eclipse.swt.widgets.Label> getTitleLabel()

Description copied from interface: TableViewerCompositeBuilder

Called after TableViewerCompositeBuilder.createCompositeLayout(Composite).

Specified by:

getTitleLabel in interface TableViewerCompositeBuilder

Returns:

the title Label if available

getValidationControls

public Optional<List<org.eclipse.swt.widgets.Control>> getValidationControls()

Description copied from interface: TableViewerCompositeBuilder

Called after TableViewerCompositeBuilder.createCompositeLayout(Composite).

Specified by:

getValidationControls in interface TableViewerCompositeBuilder

Returns:

the list of validation controls.

getButtonComposite

public Optional<org.eclipse.swt.widgets.Composite> getButtonComposite()

Description copied from interface: TableViewerCompositeBuilder

Called after TableViewerCompositeBuilder.createCompositeLayout(Composite).

Specified by:

getButtonComposite in interface TableViewerCompositeBuilder

Returns:

the parent Composite for control-buttons.

getViewerComposite

public org.eclipse.swt.widgets.Composite getViewerComposite()

Description copied from interface: TableViewerCompositeBuilder

Called after TableViewerCompositeBuilder.createCompositeLayout(Composite).

Specified by:

getViewerComposite in interface TableViewerCompositeBuilder

Returns:

the parent Composite for the TableViewer.

createTableViewer

public T createTableViewer(org.eclipse.swt.widgets.Composite parent)

Description copied from interface: TableViewerCreator

Creates the AbstractTableViewer.

Specified by:

createTableViewer in interface TableViewerCreator<T extends org.eclipse.jface.viewers.AbstractTableViewer>

Parameters:

parent - the parent Composite

Returns:

the viewer

getComparator

public Optional<org.eclipse.jface.viewers.ViewerComparator> getComparator()

Description copied from interface: TableViewerSWTCustomization

Returns the comparator to use.

Specified by:

getComparator in interface TableViewerSWTCustomization<T extends org.eclipse.jface.viewers.AbstractTableViewer>

Returns:

the ViewerComparator which will be set on the viewer, if present

createContentProvider

public org.eclipse.jface.viewers.IContentProvider createContentProvider()

Description copied from interface: TableViewerSWTCustomization

Returns the content provider to use.

Specified by:

createContentProvider in interface TableViewerSWTCustomization<T extends org.eclipse.jface.viewers.AbstractTableViewer>

Returns:

the IContentProvider which will be set on the viewer

getTableConfiguration

public TableConfiguration getTableConfiguration()

Description copied from interface: TableViewerSWTCustomization

Returns the table configuration which will be used to configure the table instance. May be null as long as the configuration is incomplete.

Specified by:

getTableConfiguration in interface TableViewerSWTCustomization<T extends org.eclipse.jface.viewers.AbstractTableViewer>

Returns:

the TableConfiguration

getColumnConfigurations

public List<ColumnConfiguration> getColumnConfigurations()

Description copied from interface: TableViewerSWTCustomization

Returns the column configurations which will be used to configure columns.

Specified by:

getColumnConfigurations in interface TableViewerSWTCustomization<T extends org.eclipse.jface.viewers.AbstractTableViewer>

Returns:

the ColumnConfiguration

setTableViewerCompositeBuilder

public void setTableViewerCompositeBuilder(TableViewerCompositeBuilder builder)

Allows the exchange the default TableViewerCompositeBuilder.

Parameters:

builder - the TableViewerCompositeBuilder

setTableViewerCreator

public void setTableViewerCreator(TableViewerCreator<T> creator)

Allows the exchange the default TableViewerCreator.

Parameters:

creator - the TableViewerCreator

setViewerComparator

public void setViewerComparator(org.eclipse.jface.viewers.ViewerComparator comparator)

Allows the exchange the default ViewerComparator.

Parameters:

comparator - the ViewerComparator

setContentProvider

public void setContentProvider(org.eclipse.jface.viewers.IContentProvider provider)

Allows the exchange the default IContentProvider.

Parameters:

provider - the IContentProvider

setActionBar

public void setActionBar(ActionBar<T> actionBar)

Allows the customize the ActionBar.

Parameters:

actionBar - the ActionBar

getActionBar

public Optional<ActionBar<T>> getActionBar()

Get the action bar instance (if it exists).

Specified by:

getActionBar in interface ActionBarProvider<T extends org.eclipse.jface.viewers.AbstractTableViewer>

Returns:

the actionBar

configureTable

public void configureTable(TableConfiguration tableConfiguration)

Sets the table configuration.

Parameters:

tableConfiguration - the TableConfiguration

addColumn

public void addColumn(ColumnConfiguration columnConfiguration)

Adds a column to the table.

Parameters:

columnConfiguration - the ColumnDescription

getActionConfiguration

public Optional<ActionConfiguration> getActionConfiguration()

Description copied from interface: ActionConfigurationProvider

Returns the action configuration which will be used to register defined key bindings on the viewer.

Specified by:

getActionConfiguration in interface ActionConfigurationProvider

Returns:

the ActionConfiguration, if any

setActionConfiguration

public void setActionConfiguration(ActionConfiguration actionConfiguration)

Allows to customize the ActionConfiguration.

Parameters:

actionConfiguration - The ActionConfiguration

See Also:

getActionConfiguration()

setDND

public void setDND(DNDProvider provider)

Allows the exchange the default DNDProvider.

Parameters:

provider - the DNDProvider

hasDND

public boolean hasDND()

Description copied from interface: DNDProvider

Whether DND support should be added to the table.

Specified by:

hasDND in interface DNDProvider

Returns:

true if DND will be added, based on the other methods of this interface, or false if DND should not be added

getDragOperations

public int getDragOperations()

Description copied from interface: DNDProvider

Returns the drag operations bits used to setup the drag support for the viewer.

Specified by:

getDragOperations in interface DNDProvider

Returns:

the drag operations

getDragTransferTypes

public org.eclipse.swt.dnd.Transfer[] getDragTransferTypes()

Description copied from interface: DNDProvider

Returns the drag transfer types used to setup the drag support for the viewer.

Specified by:

getDragTransferTypes in interface DNDProvider

Returns:

the drag transfer types

getDragListener

public org.eclipse.swt.dnd.DragSourceListener getDragListener(org.eclipse.jface.viewers.AbstractTableViewer tableViewer)

Description copied from interface: DNDProvider

Returns the DragSourceListener used to setup the drag support for the viewer.

Specified by:

getDragListener in interface DNDProvider

Parameters:

tableViewer - the AbstractTableViewer

Returns:

the listener

getDropOperations

public int getDropOperations()

Description copied from interface: DNDProvider

Returns the drag operations bits used to setup the drop support for the viewer.

Specified by:

getDropOperations in interface DNDProvider

Returns:

the drop operations

getDropTransferTypes

public org.eclipse.swt.dnd.Transfer[] getDropTransferTypes()

Description copied from interface: DNDProvider

Returns the drag transfer types used to setup the drop support for the viewer.

Specified by:

getDropTransferTypes in interface DNDProvider

Returns:

the drop transfer types

getDropListener

public org.eclipse.swt.dnd.DropTargetListener getDropListener(org.eclipse.jface.viewers.AbstractTableViewer tableViewer)

Description copied from interface: DNDProvider

Returns the DragSourceListener used to setup the drop support for the viewer.

Specified by:

getDropListener in interface DNDProvider

Parameters:

tableViewer - the AbstractTableViewer

Returns:

the listener