org.eclipse.emf.ecp.view.spi.table.swt

Class TableControlSWTRenderer

java.lang.Object

org.eclipse.emf.ecp.view.model.common.AbstractRenderer<VELEMENT>

org.eclipse.emfforms.spi.swt.core.AbstractSWTRenderer<VCONTROL>

org.eclipse.emf.ecp.view.spi.core.swt.AbstractControlSWTRenderer<VTableControl>

org.eclipse.emf.ecp.view.spi.table.swt.TableControlSWTRenderer

All Implemented Interfaces:

RootDomainModelChangeListener

Direct Known Subclasses:

GridControlSWTRenderer, TableControlDetailDialogSWTRenderer, TableControlDetailPanelRenderer, TableControlRCPRenderer

public class TableControlSWTRenderer
extends AbstractControlSWTRenderer<VTableControl>

SWT Renderer for Table Control.

Author:

Eugen Neufeld, Johannes Faltermeier

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TableControlSWTRenderer.ECPCellLabelProvider ECP specific cell label provider that does also implement IColorProvider in order to correctly.
protected class	TableControlSWTRenderer.ECPTableViewerComparator The ViewerComparator for this table which allows 3 states for sort order: none, up and down.
protected class	TableControlSWTRenderer.TableControlSWTRendererButtonBarBuilder ButtonBarBuilder for the table control swt renderer.
protected class	TableControlSWTRenderer.TableControlSWTRendererTableViewerCreator TableViewerCreator for the table control swt renderer.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	FIXED_COLUMNS
protected static String	TABLE_CUSTOM_VARIANT

Fields inherited from class org.eclipse.emfforms.spi.swt.core.AbstractSWTRenderer

CUSTOM_VARIANT

Constructor Summary

Constructors

Constructor and Description
TableControlSWTRenderer(VTableControl vElement, ViewModelContext viewContext, ReportService reportService, EMFFormsDatabindingEMF emfFormsDatabinding, EMFFormsLabelProvider emfFormsLabelProvider, VTViewTemplateProvider vtViewTemplateProvider, ImageRegistryService imageRegistryService, EMFFormsEditSupport emfFormsEditSupport) Default constructor.

Method Summary

Modifier and Type	Method and Description
protected int	addAdditionalColumns(TableViewerSWTBuilder tableViewerSWTBuilder) Override this method to add additional static columns at the beginning of the table.
protected int	addButtonsToButtonBar(org.eclipse.swt.widgets.Composite buttonComposite) Allows to add additional buttons to the button bar of the table control.
protected void	addRow(org.eclipse.emf.ecore.EClass clazz, org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EStructuralFeature structuralFeature) This method is called to add a new entry in the domain model and thus to create a new row in the table.
protected void	applyEnable() Allows implementers to set a control to enabled.
protected void	applyReadOnly() Marks a controls as readonly.
protected void	applyValidation() Allows implementers to display the validation state of the control.
protected int	compare(org.eclipse.jface.viewers.Viewer viewer, Object e1, Object e2, int direction, int propertyIndex) Get called by the TableControlSWTRenderer.ECPTableViewerComparator in order to compare the given objects.
protected org.eclipse.jface.viewers.CellEditor	createCellEditor(org.eclipse.emf.ecore.EObject tempInstance, org.eclipse.emf.ecore.EStructuralFeature feature, org.eclipse.swt.widgets.Composite table) This is called in order to setup the editing support for a table column.
protected org.eclipse.swt.widgets.Composite	createControlComposite(org.eclipse.swt.widgets.Composite composite) Creates and returns the composite which will be the parent for the table viewer.
protected void	deleteRows(List<org.eclipse.emf.ecore.EObject> deletionList, org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EStructuralFeature structuralFeature) This is called by #deleteRowUserConfirmDialog(List) after the user confirmed to delete the selected elements.
protected void	deleteRowUserConfirmDialog(List<org.eclipse.emf.ecore.EObject> deletionList, org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EStructuralFeature structuralFeature, org.eclipse.swt.widgets.Button addButton, org.eclipse.swt.widgets.Button removeButton) This method shows a user confirmation dialog when the user attempts to delete a row in the table.
protected void	dispose() Disposes all resources used by the renderer.
protected org.eclipse.swt.widgets.Button	getAddButton() Returns the add button created by the framework.
protected VTBackgroundStyleProperty	getBackgroundStyleProperty() Returns the VTBackgroundStyleProperty.
protected org.eclipse.swt.widgets.Item[]	getColumns() Returns an array of items which are the columns in the table.
protected VDomainModelReference	getDMRToMultiReference()
protected EMFFormsDatabindingEMF	getEMFFormsDatabinding() The EMFFormsDatabinding to use.
protected VTFontPropertiesStyleProperty	getFontPropertiesStyleProperty() Returns the VTFontPropertiesStyleProperty.
SWTGridDescription	getGridDescription(SWTGridDescription gridDescription) Returns the GridDescription for this Renderer.
protected org.eclipse.swt.widgets.ScrollBar	getHorizontalBar() Returns the receiver's horizontal scroll bar if it has one, and null if it does not.
protected org.eclipse.swt.graphics.Image	getImage(String path) Retrieve images from the ImageRegistryService using a bundle relative path.
protected org.eclipse.swt.graphics.Image	getImage(URL url) Retrieve images from the ImageRegistryService using an URL.
protected org.eclipse.swt.widgets.Button	getRemoveButton() Returns the remove button created by the framework.
protected int	getSelectionIndex() Returns the zero-relative index of the item which is currently selected in the receiver, or -1 if no item is selected.
protected org.eclipse.swt.graphics.Color	getSWTColor(String colorHex) Returns the Color specified by the provided String.
protected int	getTableHeightHint() Returns the preferred height for the table.
protected org.eclipse.jface.viewers.AbstractTableViewer	getTableViewer() Returns the table viewer.
protected TableViewerCreator<? extends org.eclipse.jface.viewers.AbstractTableViewer>	getTableViewerCreator() Creates a new instance of the TableViewerCreator to be used.
protected TableViewerSWTBuilder	getTableViewerSWTBuilder(org.eclipse.swt.widgets.Composite parent, org.eclipse.core.databinding.observable.list.IObservableList list, org.eclipse.core.databinding.observable.value.IObservableValue labelText, org.eclipse.core.databinding.observable.value.IObservableValue labelTooltipText, TableViewerCompositeBuilder compositeBuilder, org.eclipse.jface.databinding.viewers.ObservableListContentProvider cp, TableControlSWTRenderer.ECPTableViewerComparator comparator, TableControlSWTRenderer.TableControlSWTRendererButtonBarBuilder tableControlSWTRendererButtonBarBuilder2) Creates a new TableViewerSWTBuilder.
protected org.eclipse.swt.widgets.ScrollBar	getVerticalBar() Returns the receiver's vertical scroll bar if it has one, and null if it does not.
protected org.eclipse.swt.widgets.Control	renderControl(SWTGridCell gridCell, org.eclipse.swt.widgets.Composite parent) Renders the passed VElement.
protected void	rootDomainModelChanged() This method is called in AbstractControlSWTRenderer.notifyChange() when the root domain model of the view model context changes.
protected void	setTableViewer(org.eclipse.jface.viewers.AbstractTableViewer tableViewer) Sets the table viewer.
protected void	viewerSelectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent event) This method gets called when the selection on the TableViewer (see getTableViewer()) has changed.

Methods inherited from class org.eclipse.emf.ecp.view.spi.core.swt.AbstractControlSWTRenderer

canHandleControlProcessor, createLabel, createValidationIcon, defaultHandleControlProcessor, defaultHandleControlProcessorForCell, getDataBindingContext, getEditingDomain, getEMFFormsLabelProvider, getModelValue, getValidationBackgroundColor, getValidationForegroundColor, getValidationIcon, getVTViewTemplateProvider, hasLeftLabelAlignment, notifyChange, postInit, render

Methods inherited from class org.eclipse.emfforms.spi.swt.core.AbstractSWTRenderer

applyVisible, finalizeRendering, getControls, getDefaultFontName, init, preInit, setControlEnabled

Methods inherited from class org.eclipse.emf.ecp.view.model.common.AbstractRenderer

checkRenderer, getReportService, getVElement, getViewModelContext

Methods inherited from class java.lang.Object

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

Field Detail

FIXED_COLUMNS

protected static final String FIXED_COLUMNS

Since:

1.10

See Also:

Constant Field Values

TABLE_CUSTOM_VARIANT

protected static final String TABLE_CUSTOM_VARIANT

Since:

1.10

See Also:

Constant Field Values

Constructor Detail

TableControlSWTRenderer

@Inject
public TableControlSWTRenderer(VTableControl vElement,
                                       ViewModelContext viewContext,
                                       ReportService reportService,
                                       EMFFormsDatabindingEMF emfFormsDatabinding,
                                       EMFFormsLabelProvider emfFormsLabelProvider,
                                       VTViewTemplateProvider vtViewTemplateProvider,
                                       ImageRegistryService imageRegistryService,
                                       EMFFormsEditSupport emfFormsEditSupport)

Default constructor.

Parameters:

vElement - the view model element to be rendered

viewContext - the view context

emfFormsDatabinding - The EMFFormsDatabinding

emfFormsLabelProvider - The EMFFormsLabelProvider

reportService - The ReportService

vtViewTemplateProvider - The VTViewTemplateProvider

imageRegistryService - The ImageRegistryService

emfFormsEditSupport - The EMFFormsEditSupport

Since:

1.8

Method Detail

getGridDescription

public SWTGridDescription getGridDescription(SWTGridDescription gridDescription)

Description copied from class: AbstractSWTRenderer

Returns the GridDescription for this Renderer.

Specified by:

getGridDescription in class AbstractSWTRenderer<VTableControl>

Parameters:

gridDescription - the current SWTGridDescription

Returns:

the number of controls per row

getEMFFormsDatabinding

protected EMFFormsDatabindingEMF getEMFFormsDatabinding()

Description copied from class: AbstractControlSWTRenderer

The EMFFormsDatabinding to use.

Overrides:

getEMFFormsDatabinding in class AbstractControlSWTRenderer<VTableControl>

Returns:

The EMFFormsDatabinding

renderControl

protected org.eclipse.swt.widgets.Control renderControl(SWTGridCell gridCell,
                                                        org.eclipse.swt.widgets.Composite parent)
                                                 throws NoRendererFoundException,
                                                        NoPropertyDescriptorFoundExeption

Description copied from class: AbstractSWTRenderer

Renders the passed VElement.

Specified by:

renderControl in class AbstractSWTRenderer<VTableControl>

Parameters:

gridCell - the GridCell of the control to render

parent - the Composite to render on

Returns:

the rendered Control

Throws:

NoRendererFoundException - this is thrown when a renderer cannot be found

NoPropertyDescriptorFoundExeption - this is thrown when no property descriptor can be found

getTableViewerSWTBuilder

protected TableViewerSWTBuilder getTableViewerSWTBuilder(org.eclipse.swt.widgets.Composite parent,
                                                         org.eclipse.core.databinding.observable.list.IObservableList list,
                                                         org.eclipse.core.databinding.observable.value.IObservableValue labelText,
                                                         org.eclipse.core.databinding.observable.value.IObservableValue labelTooltipText,
                                                         TableViewerCompositeBuilder compositeBuilder,
                                                         org.eclipse.jface.databinding.viewers.ObservableListContentProvider cp,
                                                         TableControlSWTRenderer.ECPTableViewerComparator comparator,
                                                         TableControlSWTRenderer.TableControlSWTRendererButtonBarBuilder tableControlSWTRendererButtonBarBuilder2)

Creates a new TableViewerSWTBuilder.

Parameters:

parent - the parent Composite

list - the input object

labelText - the title

labelTooltipText - the tooltip

compositeBuilder - the TableViewerCompositeBuilder

cp - the content provider

comparator - the ViewerComparator

tableControlSWTRendererButtonBarBuilder2 - the ButtonBarBuilder

Returns:

the TableViewerSWTBuilder

Since:

1.10

getTableViewerCreator

protected TableViewerCreator<? extends org.eclipse.jface.viewers.AbstractTableViewer> getTableViewerCreator()

Creates a new instance of the TableViewerCreator to be used.

Returns:

the TableViewerCreator

Since:

1.10

addAdditionalColumns

protected int addAdditionalColumns(TableViewerSWTBuilder tableViewerSWTBuilder)

Override this method to add additional static columns at the beginning of the table.

Parameters:

tableViewerSWTBuilder - the builder

Returns:

the number of columns added

Since:

1.9

getSelectionIndex

protected int getSelectionIndex()

Returns the zero-relative index of the item which is currently selected in the receiver, or -1 if no item is selected.

Returns:

the index of the selected item

Since:

1.10

getColumns

protected org.eclipse.swt.widgets.Item[] getColumns()

Returns an array of items which are the columns in the table.

Returns:

the columns of the table

Since:

1.10

getHorizontalBar

protected org.eclipse.swt.widgets.ScrollBar getHorizontalBar()

Returns the receiver's horizontal scroll bar if it has one, and null if it does not.

Returns:

the horizontal scroll bar (or null)

Since:

1.10

getVerticalBar

protected org.eclipse.swt.widgets.ScrollBar getVerticalBar()

Returns the receiver's vertical scroll bar if it has one, and null if it does not.

Returns:

the vertical scroll bar (or null)

Since:

1.10

getDMRToMultiReference

protected final VDomainModelReference getDMRToMultiReference()

Returns:

the VDomainModelReference which ends at the table setting

Since:

1.10

addButtonsToButtonBar

protected int addButtonsToButtonBar(org.eclipse.swt.widgets.Composite buttonComposite)

Allows to add additional buttons to the button bar of the table control.

The default implementation does not add additional buttons.

Parameters:

buttonComposite - the composite where the buttons are added

Returns:

the total number of buttons added

createControlComposite

protected org.eclipse.swt.widgets.Composite createControlComposite(org.eclipse.swt.widgets.Composite composite)

Creates and returns the composite which will be the parent for the table viewer.

Parameters:

composite - the parent composite including the title/button bar

Returns:

the parent for the table viewer

getTableHeightHint

protected int getTableHeightHint()

Returns the preferred height for the table. This will be passed to the layoutdata.

Returns:

the height in px

getTableViewer

protected org.eclipse.jface.viewers.AbstractTableViewer getTableViewer()

Returns the table viewer.

Returns:

the viewer

Since:

1.10

setTableViewer

protected void setTableViewer(org.eclipse.jface.viewers.AbstractTableViewer tableViewer)

Sets the table viewer.

Parameters:

tableViewer - the viewer

Since:

1.10

viewerSelectionChanged

protected void viewerSelectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent event)

This method gets called when the selection on the TableViewer (see getTableViewer()) has changed.

If you override this method make sure to call super.

Parameters:

event - the SelectionChangedEvent

getImage

protected org.eclipse.swt.graphics.Image getImage(URL url)

Retrieve images from the ImageRegistryService using an URL.

Parameters:

url - The URL pointing to the image

Returns:

The retrieved Image

Since:

1.6

getImage

protected org.eclipse.swt.graphics.Image getImage(String path)

Retrieve images from the ImageRegistryService using a bundle relative path.

Parameters:

path - The bundle relative path pointing to the image

Returns:

The retrieved Image

Since:

1.6

getBackgroundStyleProperty

protected VTBackgroundStyleProperty getBackgroundStyleProperty()

Returns the VTBackgroundStyleProperty.

Returns:

the VTBackgroundStyleProperty

Since:

1.10

getFontPropertiesStyleProperty

protected VTFontPropertiesStyleProperty getFontPropertiesStyleProperty()

Returns the VTFontPropertiesStyleProperty.

Returns:

the VTFontPropertiesStyleProperty

Since:

1.10

getSWTColor

protected org.eclipse.swt.graphics.Color getSWTColor(String colorHex)

Returns the Color specified by the provided String.

Parameters:

colorHex - the Hex String describing the color

Returns:

the Color

Since:

1.10

createCellEditor

protected org.eclipse.jface.viewers.CellEditor createCellEditor(org.eclipse.emf.ecore.EObject tempInstance,
                                                                org.eclipse.emf.ecore.EStructuralFeature feature,
                                                                org.eclipse.swt.widgets.Composite table)

This is called in order to setup the editing support for a table column.

Parameters:

tempInstance - the temporary input instance of the table

feature - the feature of the column

table - the table/parent

Returns:

the cell editor

Since:

1.10

deleteRowUserConfirmDialog

protected void deleteRowUserConfirmDialog(List<org.eclipse.emf.ecore.EObject> deletionList,
                                          org.eclipse.emf.ecore.EObject eObject,
                                          org.eclipse.emf.ecore.EStructuralFeature structuralFeature,
                                          org.eclipse.swt.widgets.Button addButton,
                                          org.eclipse.swt.widgets.Button removeButton)

This method shows a user confirmation dialog when the user attempts to delete a row in the table.

Parameters:

deletionList - the list of selected EObjects to delete

eObject - The containment reference EObject

structuralFeature - The containment reference EStructuralFeature

addButton - the add button

removeButton - the remove button

Since:

1.6

deleteRows

protected void deleteRows(List<org.eclipse.emf.ecore.EObject> deletionList,
                          org.eclipse.emf.ecore.EObject eObject,
                          org.eclipse.emf.ecore.EStructuralFeature structuralFeature)

This is called by #deleteRowUserConfirmDialog(List) after the user confirmed to delete the selected elements.

Parameters:

deletionList - the list of EObjects to delete

eObject - The containment reference EObject

structuralFeature - The containment reference EStructuralFeature

Since:

1.6

addRow

protected void addRow(org.eclipse.emf.ecore.EClass clazz,
                      org.eclipse.emf.ecore.EObject eObject,
                      org.eclipse.emf.ecore.EStructuralFeature structuralFeature)

This method is called to add a new entry in the domain model and thus to create a new row in the table. The element to create is defined by the provided class. You can override this method but you have to call super nonetheless.

Parameters:

clazz - the EClass defining the EObject to create

eObject - The containment reference EObject

structuralFeature - The containment reference EStructuralFeature

Since:

1.6

applyValidation

protected void applyValidation()

Description copied from class: AbstractSWTRenderer

Allows implementers to display the validation state of the control. The default implementation does nothing.

Overrides:

applyValidation in class AbstractSWTRenderer<VTableControl>

getAddButton

protected org.eclipse.swt.widgets.Button getAddButton()

Returns the add button created by the framework.

Returns:

the addButton

Since:

1.6

getRemoveButton

protected org.eclipse.swt.widgets.Button getRemoveButton()

Returns the remove button created by the framework.

Returns:

the removeButton

Since:

1.6

applyEnable

protected void applyEnable()

Allows implementers to set a control to enabled.

Overrides:

applyEnable in class AbstractControlSWTRenderer<VTableControl>

See Also:

AbstractSWTRenderer.applyEnable()

applyReadOnly

protected void applyReadOnly()

Marks a controls as readonly.

Overrides:

applyReadOnly in class AbstractSWTRenderer<VTableControl>

See Also:

AbstractSWTRenderer.applyReadOnly()

dispose

protected void dispose()

Disposes all resources used by the renderer. Don't forget to call super.dispose if overwriting this method.

Overrides:

dispose in class AbstractControlSWTRenderer<VTableControl>

See Also:

AbstractSWTRenderer.dispose()

compare

protected int compare(org.eclipse.jface.viewers.Viewer viewer,
                      Object e1,
                      Object e2,
                      int direction,
                      int propertyIndex)

Get called by the TableControlSWTRenderer.ECPTableViewerComparator in order to compare the given objects.

Parameters:

viewer - the tavle viewer

e1 - the first object of the comparison

e2 - the second object of the comparison

propertyIndex - index of the selection column. the index is aligned with the index of the associated column domain model reference

direction - SWT.NONE, SWT.UP or SWT.DOWN according to the indication displayed at the table column.

Returns:

a negative number if the first element is less than the second element; the value 0 if the first element is equal to the second element; and a positive number if the first element is greater than the second element

Since:

1.8

rootDomainModelChanged

protected void rootDomainModelChanged()
                               throws DatabindingFailedException

Description copied from class: AbstractControlSWTRenderer

This method is called in AbstractControlSWTRenderer.notifyChange() when the root domain model of the view model context changes.

Overrides:

rootDomainModelChanged in class AbstractControlSWTRenderer<VTableControl>

Throws:

DatabindingFailedException - If the databinding failed