org.eclipse.emfforms.internal.swt.table

Class DefaultTableControlSWTCustomization

java.lang.Object

org.eclipse.emfforms.internal.swt.table.DefaultTableControlSWTCustomization

All Implemented Interfaces:

ButtonBarBuilder, DNDProvider, NewElementCreator<Object,org.eclipse.swt.widgets.Button>, TableViewerCompositeBuilder, TableViewerCreator<org.eclipse.jface.viewers.AbstractTableViewer>, TableViewerSWTCustomization

public class DefaultTableControlSWTCustomization
extends Object
implements TableViewerSWTCustomization

The default implementation of the TableViewerSWTCustomization.

Author:

Alexandra Buzila, Johannes Faltermeier

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.emfforms.spi.swt.table.TableViewerSWTCustomization

TableViewerSWTCustomization.ColumnDescription

Constructor Summary

Constructors

Constructor and Description
DefaultTableControlSWTCustomization()

Method Summary

Modifier and Type	Method and Description
void	addColumn(TableViewerSWTCustomization.ColumnDescription columnDescription) Adds a column to the table.
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.
Object	createNewElement(org.eclipse.swt.widgets.Button button) Gets called when a button is pressed which needs to create a new element which gets added to the list.
org.eclipse.jface.viewers.AbstractTableViewer	createTableViewer(org.eclipse.swt.widgets.Composite parent) Creates the AbstractTableViewer.
void	fillButtonComposite(org.eclipse.swt.widgets.Composite buttonComposite, org.eclipse.jface.viewers.AbstractTableViewer viewer) This method is called to fill the given Composite with all required buttons.
Optional<org.eclipse.swt.widgets.Composite>	getButtonComposite() Called after TableViewerCompositeBuilder.createCompositeLayout(Composite).
List<TableViewerSWTCustomization.ColumnDescription>	getColumns() Returns the column descriptions which will be used to create actual 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.
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	setButtonBarBuilder(ButtonBarBuilder builder) Allows the exchange the default ButtonBarBuilder.
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	setNewElementCreator(NewElementCreator<Object,org.eclipse.swt.widgets.Button> creator) Allows the exchange the default NewElementCreator.
void	setTableViewerCompositeBuilder(TableViewerCompositeBuilder builder) Allows the exchange the default TableViewerCompositeBuilder.
void	setTableViewerCreator(TableViewerCreator<? extends org.eclipse.jface.viewers.AbstractTableViewer> 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 org.eclipse.jface.viewers.AbstractTableViewer createTableViewer(org.eclipse.swt.widgets.Composite parent)

Description copied from interface: TableViewerCreator

Creates the AbstractTableViewer.

Specified by:

createTableViewer in interface TableViewerCreator<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

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

Returns:

the IContentProvider which will be set on the viewer

fillButtonComposite

public void fillButtonComposite(org.eclipse.swt.widgets.Composite buttonComposite,
                                org.eclipse.jface.viewers.AbstractTableViewer viewer)

Description copied from interface: ButtonBarBuilder

This method is called to fill the given Composite with all required buttons.

Specified by:

fillButtonComposite in interface ButtonBarBuilder

Parameters:

buttonComposite - the button bar

viewer - the AbstractTableViewer

createNewElement

public Object createNewElement(org.eclipse.swt.widgets.Button button)

Description copied from interface: ButtonBarBuilder

Gets called when a button is pressed which needs to create a new element which gets added to the list.

Specified by:

createNewElement in interface ButtonBarBuilder

Specified by:

createNewElement in interface NewElementCreator<Object,org.eclipse.swt.widgets.Button>

Parameters:

button - the button which was pressed

Returns:

the new element

getColumns

public List<TableViewerSWTCustomization.ColumnDescription> getColumns()

Description copied from interface: TableViewerSWTCustomization

Returns the column descriptions which will be used to create actual columns.

Specified by:

getColumns in interface TableViewerSWTCustomization

Returns:

the ColumnDescriptions

setTableViewerCompositeBuilder

public void setTableViewerCompositeBuilder(TableViewerCompositeBuilder builder)

Allows the exchange the default TableViewerCompositeBuilder.

Parameters:

builder - the TableViewerCompositeBuilder

setTableViewerCreator

public void setTableViewerCreator(TableViewerCreator<? extends org.eclipse.jface.viewers.AbstractTableViewer> 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

setButtonBarBuilder

public void setButtonBarBuilder(ButtonBarBuilder builder)

Allows the exchange the default ButtonBarBuilder.

Parameters:

builder - the ButtonBarBuilder

addColumn

public void addColumn(TableViewerSWTCustomization.ColumnDescription columnDescription)

Adds a column to the table.

Parameters:

columnDescription - the ColumnDescription

setNewElementCreator

public void setNewElementCreator(NewElementCreator<Object,org.eclipse.swt.widgets.Button> creator)

Allows the exchange the default NewElementCreator. This may only be used if the button bar builder was not exchanged.

Parameters:

creator - the NewElementCreator

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