org.eclipse.emf.ecp.view.spi.table.nebula.grid

Class GridControlSWTRenderer

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

org.eclipse.emf.ecp.view.spi.table.nebula.grid.GridControlSWTRenderer

All Implemented Interfaces:

RootDomainModelChangeListener

Direct Known Subclasses:

GridControlDetailPanelRenderer

public class GridControlSWTRenderer
extends TableControlSWTRenderer

Since:

1.10

Author:

Jonas Helming

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GridControlSWTRenderer.CustomGridTableViewer Custom Nebula Grid table viewer to expose getViewerRowFromItem() method.
protected class	GridControlSWTRenderer.GridTableControlSWTRendererTableViewerCreator TableViewerCreator for the table control swt renderer.

Nested classes/interfaces inherited from class org.eclipse.emf.ecp.view.spi.table.swt.TableControlSWTRenderer

TableControlSWTRenderer.AutoSortModelChangeListener, TableControlSWTRenderer.CompactVerticallyTableControlSWTRendererCompositeBuilder, TableControlSWTRenderer.ECPCellLabelProvider, TableControlSWTRenderer.ECPTableViewerComparator, TableControlSWTRenderer.TableControlComparator, TableControlSWTRenderer.TableControlEditingSupportAndLabelProvider, TableControlSWTRenderer.TableControlSWTRendererCompositeBuilder, TableControlSWTRenderer.TableControlSWTRendererTableViewerCreator

Field Summary

Fields inherited from class org.eclipse.emf.ecp.view.spi.table.swt.TableControlSWTRenderer

FIXED_COLUMNS, TABLE_CUSTOM_VARIANT, VALIDATION_PREFERRED_SIZE

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

CUSTOM_VARIANT

Constructor Summary

Constructors

Constructor and Description

GridControlSWTRenderer(VTableControl vElement, ViewModelContext viewContext, ReportService reportService, EMFFormsDatabindingEMF emfFormsDatabinding, EMFFormsLabelProvider emfFormsLabelProvider, VTViewTemplateProvider vtViewTemplateProvider, ImageRegistryService imageRegistryService, EMFFormsEditSupport emfFormsEditSupport, EStructuralFeatureValueConverterService converterService, EMFFormsLocalizationService localizationService) Default constructor.

Method Summary

Modifier and Type	Method and Description
protected int	computeRequiredHeight(Integer visibleLines) Returns the height in pixels required to display the given number of table items.
protected TableViewerSWTBuilder	createTableViewerSWTBuilder(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, org.eclipse.jface.viewers.ViewerComparator comparator, TableActionBar<? extends org.eclipse.jface.viewers.AbstractTableViewer> actionBar) Creates a new TableViewerSWTBuilder.
protected org.eclipse.swt.widgets.Item[]	getColumns() Returns an array of items which are the columns in the table.
protected EStructuralFeatureValueConverterService	getConverterService()
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 EMFFormsLocalizationService	getLocalizationService()
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 TableViewerCreator<org.eclipse.nebula.jface.gridviewer.GridTableViewer>	getTableViewerCreator() Creates a new instance of the TableViewerCreator to be used.
protected org.eclipse.swt.widgets.ScrollBar	getVerticalBar() Returns the receiver's vertical scroll bar if it has one, and null if it does not.

Methods inherited from class org.eclipse.emf.ecp.view.spi.table.swt.TableControlSWTRenderer

addAdditionalColumns, addButtonsToButtonBar, addRow, applyEnable, applyReadOnly, applyUnchangeableFeature, applyValidation, applyValidation, canEditObject, compare, configureActions, createActionBar, createCellEditor, createCellLabelProvider, createControlComposite, createDefaultBackgroundStyleProperty, createDefaultFontPropertiesStyleProperty, createDefaultTableStyleProperty, createDefaultTableValidationStyleProperty, createLabel, createTableViewerComparator, createTableViewerCompositeBuilder, createTableViewerSWTBuilder, createViewerActionContext, deleteRows, deleteRowUserConfirmDialog, dispose, getAddButton, getBackgroundStyleProperty, getColumnDomainModelReferences, getColumnFeature, getControlForAction, getDMRToMultiReference, getEMFFormsDatabinding, getEnumeratorComparator, getFontPropertiesStyleProperty, getGridDescription, getImage, getImage, getKeyBindingsForAction, getRemoveButton, getSettingFromObservable, getSortColumnFeature, getSWTColor, getTableHeightHint, getTableStyleProperty, getTableValidationStyleProperty, getTableViewer, getTableViewerComposite, postRefresh, postRefresh, renderControl, renderTableControl, reveal, rootDomainModelChanged, setSortColumnFeature, setTableViewer, shouldCreateCellEditor, updateActionBar, viewerSelectionChanged

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

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

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

applyVisible, canReveal, finalizeRendering, getControls, getDefaultFontName, ignoreEnableOnReadOnly, init, isRenderingFinished, preInit, scrollToReveal, scrollToReveal, setControlEnabled

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

checkRenderer, getRenderer, getReportService, getVElement, getViewModelContext, register

Methods inherited from class java.lang.Object

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

Constructor Detail

GridControlSWTRenderer

@Inject
public GridControlSWTRenderer(VTableControl vElement,
                                      ViewModelContext viewContext,
                                      ReportService reportService,
                                      EMFFormsDatabindingEMF emfFormsDatabinding,
                                      EMFFormsLabelProvider emfFormsLabelProvider,
                                      VTViewTemplateProvider vtViewTemplateProvider,
                                      ImageRegistryService imageRegistryService,
                                      EMFFormsEditSupport emfFormsEditSupport,
                                      EStructuralFeatureValueConverterService converterService,
                                      EMFFormsLocalizationService localizationService)

Default constructor.

Parameters:

vElement - the view model element to be rendered

viewContext - the view context

emfFormsDatabinding - The EMFFormsDatabindingEMF

emfFormsLabelProvider - The EMFFormsLabelProvider

reportService - The ReportService

vtViewTemplateProvider - The VTViewTemplateProvider

imageRegistryService - The ImageRegistryService

emfFormsEditSupport - The EMFFormsEditSupport

converterService - the EStructuralFeatureValueConverterService

localizationService - the EMFFormsLocalizationService

Since:

1.11

Method Detail

getTableViewerCreator

protected TableViewerCreator<org.eclipse.nebula.jface.gridviewer.GridTableViewer> getTableViewerCreator()

Description copied from class: TableControlSWTRenderer

Creates a new instance of the TableViewerCreator to be used.

Overrides:

getTableViewerCreator in class TableControlSWTRenderer

Returns:

the TableViewerCreator

createTableViewerSWTBuilder

protected TableViewerSWTBuilder createTableViewerSWTBuilder(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,
                                                            org.eclipse.jface.viewers.ViewerComparator comparator,
                                                            TableActionBar<? extends org.eclipse.jface.viewers.AbstractTableViewer> actionBar)

Description copied from class: TableControlSWTRenderer

Creates a new TableViewerSWTBuilder.

Overrides:

createTableViewerSWTBuilder in class TableControlSWTRenderer

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; has no effect if move up/down functionality is enabled

actionBar - the ActionBar

Returns:

the TableViewerSWTBuilder

getSelectionIndex

protected int getSelectionIndex()

Description copied from class: TableControlSWTRenderer

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

Overrides:

getSelectionIndex in class TableControlSWTRenderer

Returns:

the index of the selected item

getColumns

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

Description copied from class: TableControlSWTRenderer

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

Overrides:

getColumns in class TableControlSWTRenderer

Returns:

the columns of the table

getHorizontalBar

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

Description copied from class: TableControlSWTRenderer

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

Overrides:

getHorizontalBar in class TableControlSWTRenderer

Returns:

the horizontal scroll bar (or null)

getVerticalBar

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

Description copied from class: TableControlSWTRenderer

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

Overrides:

getVerticalBar in class TableControlSWTRenderer

Returns:

the vertical scroll bar (or null)

computeRequiredHeight

protected int computeRequiredHeight(Integer visibleLines)

Description copied from class: TableControlSWTRenderer

Returns the height in pixels required to display the given number of table items. If the visible items are not specified, the height required to display all the table items is returned.

Overrides:

computeRequiredHeight in class TableControlSWTRenderer

Parameters:

visibleLines - the number of visible table items

Returns:

the required height

getConverterService

protected EStructuralFeatureValueConverterService getConverterService()

Returns:

the EStructuralFeatureValueConverterService

getLocalizationService

protected EMFFormsLocalizationService getLocalizationService()

Returns:

the EMFFormsLocalizationService