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

Class GridTableViewerComposite

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Control

org.eclipse.swt.widgets.Scrollable

org.eclipse.swt.widgets.Composite

org.eclipse.emfforms.spi.swt.table.AbstractTableViewerComposite<org.eclipse.nebula.jface.gridviewer.GridTableViewer>

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

All Implemented Interfaces:

org.eclipse.swt.graphics.Drawable

public class GridTableViewerComposite
extends AbstractTableViewerComposite<org.eclipse.nebula.jface.gridviewer.GridTableViewer>

A Composite containing a GridTableViewer.

Author:

Jonas Helming

Field Summary

Fields inherited from class org.eclipse.swt.widgets.Control

handle

Constructor Summary

Constructors

Constructor and Description
GridTableViewerComposite(org.eclipse.swt.widgets.Composite parent, int style, Object inputObject, TableViewerSWTCustomization customization, org.eclipse.core.databinding.observable.value.IObservableValue title, org.eclipse.core.databinding.observable.value.IObservableValue tooltip) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addColumnListener(org.eclipse.swt.events.ControlListener columnlistener) Adds a new column listener.
protected void	configureContextMenu(org.eclipse.nebula.jface.gridviewer.GridTableViewer tableViewer) Configures the context menu for the given TableViewer instance.
protected void	configureViewerFilters(org.eclipse.nebula.jface.gridviewer.GridTableViewer tableViewer) Configures viewer filters for the given TableViewer instance.
protected org.eclipse.jface.viewers.ViewerColumn	createColumn(ColumnConfiguration config, org.eclipse.emf.databinding.EMFDataBindingContext emfDataBindingContext, org.eclipse.nebula.jface.gridviewer.GridTableViewer tableViewer) Creates a new ViewerColumn.
protected org.eclipse.jface.layout.AbstractColumnLayout	createLayout(org.eclipse.swt.widgets.Composite viewerComposite) Sets the layout of the given Composite.
protected org.eclipse.nebula.jface.gridviewer.GridTableViewer	createTableViewer(TableViewerSWTCustomization<org.eclipse.nebula.jface.gridviewer.GridTableViewer> customization, org.eclipse.swt.widgets.Composite viewerComposite) Creates the table viewer.
void	dispose()
org.eclipse.swt.widgets.Widget[]	getColumns() Returns the list of columns of the table viewer.
Feature	getFilteringMode() Query the currently active filtering mode, if filtering is engaged.
TableControl	getTableControl() Returns the TableControl.
org.eclipse.nebula.jface.gridviewer.GridTableViewer	getTableViewer()
void	setComparator(TableViewerComparator comparator, List<Integer> sortableColumns) Sets the comparator of the table viewer.
void	setCompareColumn(int columnIndex) Allow to set an initial sort.
void	setFilteringMode(Feature filteringFeature) Set the currently active filtering mode.

Methods inherited from class org.eclipse.emfforms.spi.swt.table.AbstractTableViewerComposite

createColumnViewerActivationStrategy, getActionBar, getColumnConfiguration, getEnabledFeatures, getValidationControls, viewerSelectionChanged

Methods inherited from class org.eclipse.swt.widgets.Composite

changed, checkSubclass, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList

Methods inherited from class org.eclipse.swt.widgets.Scrollable

computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar

Methods inherited from class org.eclipse.swt.widgets.Control

addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getTextDirection, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, requestLayout, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setTextDirection, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, addListener, checkWidget, getData, getData, getDisplay, getListeners, getStyle, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.swt.graphics.Drawable

isAutoScalable

Constructor Detail

GridTableViewerComposite

public GridTableViewerComposite(org.eclipse.swt.widgets.Composite parent,
                                int style,
                                Object inputObject,
                                TableViewerSWTCustomization customization,
                                org.eclipse.core.databinding.observable.value.IObservableValue title,
                                org.eclipse.core.databinding.observable.value.IObservableValue tooltip)

Default constructor.

Parameters:

parent - the parent Composite

style - the style bits

inputObject - the input object

customization - the TableViewerSWTCustomization

title - the title

tooltip - the tooltip

Method Detail

dispose

public void dispose()

Overrides:

dispose in class AbstractTableViewerComposite<org.eclipse.nebula.jface.gridviewer.GridTableViewer>

getTableViewer

public org.eclipse.nebula.jface.gridviewer.GridTableViewer getTableViewer()

Specified by:

getTableViewer in class AbstractTableViewerComposite<org.eclipse.nebula.jface.gridviewer.GridTableViewer>

Returns:

the AbstractTableViewer

createTableViewer

protected org.eclipse.nebula.jface.gridviewer.GridTableViewer createTableViewer(TableViewerSWTCustomization<org.eclipse.nebula.jface.gridviewer.GridTableViewer> customization,
                                                                                org.eclipse.swt.widgets.Composite viewerComposite)

Description copied from class: AbstractTableViewerComposite

Creates the table viewer.

Specified by:

createTableViewer in class AbstractTableViewerComposite<org.eclipse.nebula.jface.gridviewer.GridTableViewer>

Parameters:

customization - the TableViewerSWTCustomization to use

viewerComposite - the parent composite

Returns:

the table viewer

configureContextMenu

protected void configureContextMenu(org.eclipse.nebula.jface.gridviewer.GridTableViewer tableViewer)

Description copied from class: AbstractTableViewerComposite

Configures the context menu for the given TableViewer instance.

Overrides:

configureContextMenu in class AbstractTableViewerComposite<org.eclipse.nebula.jface.gridviewer.GridTableViewer>

Parameters:

tableViewer - the table viewer to configure

configureViewerFilters

protected void configureViewerFilters(org.eclipse.nebula.jface.gridviewer.GridTableViewer tableViewer)

Description copied from class: AbstractTableViewerComposite

Configures viewer filters for the given TableViewer instance.

Overrides:

configureViewerFilters in class AbstractTableViewerComposite<org.eclipse.nebula.jface.gridviewer.GridTableViewer>

Parameters:

tableViewer - the table viewer to configure

createLayout

protected org.eclipse.jface.layout.AbstractColumnLayout createLayout(org.eclipse.swt.widgets.Composite viewerComposite)

Description copied from class: AbstractTableViewerComposite

Sets the layout of the given Composite.

Specified by:

createLayout in class AbstractTableViewerComposite<org.eclipse.nebula.jface.gridviewer.GridTableViewer>

Parameters:

viewerComposite - the target composite

Returns:

the applied layout

getColumns

public org.eclipse.swt.widgets.Widget[] getColumns()

Description copied from class: AbstractTableViewerComposite

Returns the list of columns of the table viewer.

Specified by:

getColumns in class AbstractTableViewerComposite<org.eclipse.nebula.jface.gridviewer.GridTableViewer>

Returns:

the list of columns

addColumnListener

public void addColumnListener(org.eclipse.swt.events.ControlListener columnlistener)

Description copied from class: AbstractTableViewerComposite

Adds a new column listener.

Specified by:

addColumnListener in class AbstractTableViewerComposite<org.eclipse.nebula.jface.gridviewer.GridTableViewer>

Parameters:

columnlistener - the listener to add

getTableControl

public TableControl getTableControl()

Description copied from class: AbstractTableViewerComposite

Returns the TableControl.

Specified by:

getTableControl in class AbstractTableViewerComposite<org.eclipse.nebula.jface.gridviewer.GridTableViewer>

Returns:

the table control

createColumn

protected org.eclipse.jface.viewers.ViewerColumn createColumn(ColumnConfiguration config,
                                                              org.eclipse.emf.databinding.EMFDataBindingContext emfDataBindingContext,
                                                              org.eclipse.nebula.jface.gridviewer.GridTableViewer tableViewer)

Description copied from class: AbstractTableViewerComposite

Creates a new ViewerColumn.

Specified by:

createColumn in class AbstractTableViewerComposite<org.eclipse.nebula.jface.gridviewer.GridTableViewer>

Parameters:

config - the column description to use

emfDataBindingContext - the data binding context to use

tableViewer - the parent AbstractTableViewer

Returns:

the viewer column

setComparator

public void setComparator(TableViewerComparator comparator,
                          List<Integer> sortableColumns)

Description copied from class: AbstractTableViewerComposite

Sets the comparator of the table viewer.

Specified by:

setComparator in class AbstractTableViewerComposite<org.eclipse.nebula.jface.gridviewer.GridTableViewer>

Parameters:

comparator - the TableViewerComparator to set

sortableColumns - the list of columns that can be sorted

getFilteringMode

public Feature getFilteringMode()

Query the currently active filtering mode, if filtering is engaged.

Returns:

one the filtering features indicating the filtering mode that is active, or null if the grid is not filtered

Since:

1.21

See Also:

setFilteringMode(Feature), ColumnConfiguration.FEATURE_COLUMN_FILTER, ColumnConfiguration.FEATURE_COLUMN_REGEX_FILTER

setFilteringMode

public void setFilteringMode(Feature filteringFeature)

Set the currently active filtering mode.

Parameters:

filteringFeature - one the filtering features indicating the filtering mode that is active, or null if the grid is not to be filtered

Throws:

IllegalStateException - if the composite is not yet initialized

IllegalArgumentException - if the filteringFeature is not supported by my table configuration (null, excepted, of course)

Since:

1.21

See Also:

getFilteringMode(), ColumnConfiguration.FEATURE_COLUMN_FILTER, ColumnConfiguration.FEATURE_COLUMN_REGEX_FILTER

setCompareColumn

public void setCompareColumn(int columnIndex)

Description copied from class: AbstractTableViewerComposite

Allow to set an initial sort.

Specified by:

setCompareColumn in class AbstractTableViewerComposite<org.eclipse.nebula.jface.gridviewer.GridTableViewer>

Parameters:

columnIndex - The column to sort