Deprecated API

Contents

• Deprecated Classes
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors

Deprecated Classes

Class and Description
org.eclipse.nebula.widgets.nattable.edit.ActiveCellEditorRegistry Storing the editor in a global registry has certain drawbacks as outlined in the documentation and the bug report. In order to resolve that the active editor is now an instance field of the table. The methods provided in here to register or retrieve the editor are available on the table itself. Therefore this registry is obsolete and should not be used any more.
org.eclipse.nebula.widgets.nattable.ui.matcher.BodyCellEditorMouseEventMatcher
org.eclipse.nebula.widgets.nattable.edit.action.CellEditDragMode since 1.6 the intention of this drag mode is obsolete. The correct handling is done inside DragModeEventHandler
org.eclipse.nebula.widgets.nattable.group.config.ColumnGroupMenuItemProviders Use MenuItemProviders or the PopupMenuBuilder directly
org.eclipse.nebula.widgets.nattable.extension.glazedlists.GlazedListsDataProvider Use a default ListDataProvider instead as the performance boost can not be verified with current Java and GlazedLists implementations and as this implementation is not thread-safe it introduces more issues than it tries to solve.
org.eclipse.nebula.widgets.nattable.selection.RowSelectionPreserver Use SelectionLayer.setSelectionModel(new RowSelectionModel(...)) instead
org.eclipse.nebula.widgets.nattable.selection.event.SelectionLayerStructuralChangeEventHandler ISelectionModel is now itself a ILayerEventHandler

Deprecated Fields

Field and Description
org.eclipse.nebula.widgets.nattable.fillhandle.action.FillHandleDragMode.startIndex
org.eclipse.nebula.widgets.nattable.extension.nebula.richtext.RichTextCellEditor.toolbarConfiguration Only exists for backwards compatibility to avoid API breakage. The RichTextEditorConfiguration should be used instead!

Deprecated Methods

Method and Description
org.eclipse.nebula.widgets.nattable.selection.SelectionLayerPainter.applyBorderStyle(GC, IConfigRegistry) Use SelectionLayerPainter.getBorderStyle(org.eclipse.nebula.widgets.nattable.config.IConfigRegistry) instead.
org.eclipse.nebula.widgets.nattable.fillhandle.FillHandleLayerPainter.applyCopyBorderStyle(GC, IConfigRegistry)
org.eclipse.nebula.widgets.nattable.formula.CopySelectionLayerPainter.applyCopyBorderStyle(GC, IConfigRegistry)
org.eclipse.nebula.widgets.nattable.fillhandle.FillHandleLayerPainter.applyHandleBorderStyle(GC, IConfigRegistry) Use FillHandleLayerPainter.getHandleRegionBorderStyle(org.eclipse.nebula.widgets.nattable.config.IConfigRegistry) instead.
org.eclipse.nebula.widgets.nattable.fillhandle.FillHandleLayerPainter.applyHandleStyle(GC, IConfigRegistry) Use FillHandleLayerPainter.getHandleColor(org.eclipse.nebula.widgets.nattable.config.IConfigRegistry) and FillHandleLayerPainter.getHandleBorderStyle(org.eclipse.nebula.widgets.nattable.config.IConfigRegistry) instead.
org.eclipse.nebula.widgets.nattable.tree.TreeRowModel.clear() Since this is not specified by the ITreeRowModel interface, this method shouldn't be used directly and therefore be removed.
org.eclipse.nebula.widgets.nattable.extension.glazedlists.tree.GlazedListTreeData.collapse(int) expand/collapse operations should be performed on ITreeRowModel!
org.eclipse.nebula.widgets.nattable.extension.glazedlists.tree.GlazedListTreeData.collapse(T) expand/collapse operations should be performed on ITreeRowModel!
org.eclipse.nebula.widgets.nattable.extension.glazedlists.tree.GlazedListTreeData.collapseAll() expand/collapse operations should be performed on ITreeRowModel!
org.eclipse.nebula.widgets.nattable.edit.command.EditUtils.commitAndCloseActiveEditor() Has been replaced by NatTable.commitAndCloseActiveCellEditor(). The active editor is now managed by the table itself. Therefore the static helpers to access the editor should not be used any more.
org.eclipse.nebula.widgets.nattable.layer.SizeConfig.correctPercentageValues(int, int) Use SizeConfig.correctPercentageValues(double, int)
org.eclipse.nebula.widgets.nattable.painter.layer.GridLineCellLayerPainter.drawGridLines(ILayer, GC, Rectangle, IConfigRegistry) Use GridLineCellLayerPainter.drawGridLines(ILayer, GC, Rectangle, IConfigRegistry, List) with specifying the label stack
org.eclipse.nebula.widgets.nattable.ui.mode.AbstractModeEventHandler.eventOnSameCell(MouseEvent, MouseEvent) Use MouseEventHelper.eventOnSameCell(org.eclipse.nebula.widgets.nattable.layer.ILayer, MouseEvent, MouseEvent) instead
org.eclipse.nebula.widgets.nattable.extension.glazedlists.tree.GlazedListTreeData.expand(int) expand/collapse operations should be performed on ITreeRowModel!
org.eclipse.nebula.widgets.nattable.extension.glazedlists.tree.GlazedListTreeData.expand(T) expand/collapse operations should be performed on ITreeRowModel!
org.eclipse.nebula.widgets.nattable.extension.glazedlists.tree.GlazedListTreeData.expandAll() expand/collapse operations should be performed on ITreeRowModel!
org.eclipse.nebula.widgets.nattable.tree.ITreeData.formatDataForDepth(int, int) formatting of data should be done by the exporter or a display converter
org.eclipse.nebula.widgets.nattable.extension.glazedlists.tree.GlazedListTreeData.formatDataForDepth(int, int)
org.eclipse.nebula.widgets.nattable.tree.ITreeData.formatDataForDepth(int, T) formatting of data should be done by the exporter or a display converter
org.eclipse.nebula.widgets.nattable.extension.glazedlists.tree.GlazedListTreeData.formatDataForDepth(int, T)
org.eclipse.nebula.widgets.nattable.edit.ActiveCellEditorRegistry.getActiveCellEditor() replaced by NatTable.getActiveCellEditor().
org.eclipse.nebula.widgets.nattable.extension.glazedlists.groupBy.GroupByDataLayer.getElementsInGroup(GroupByObject) Use GroupByDataLayer.getItemsInGroup(GroupByObject)
org.eclipse.nebula.widgets.nattable.util.GUIHelper.getImage(ImageData) This method does not work correctly since it uses Object.toString()
org.eclipse.nebula.widgets.nattable.tree.TreeLayer.getIndentedTreeImagePainter() since 1.1 the configured TreeImagePainter should be used instead of the hard referenced one
org.eclipse.nebula.widgets.nattable.tree.ITreeRowModel.getObjectAtIndexAndDepth(int, int) formatting should be done in the IExportFormatter
org.eclipse.nebula.widgets.nattable.tree.AbstractTreeRowModel.getObjectAtIndexAndDepth(int, int)
org.eclipse.nebula.widgets.nattable.grid.layer.ColumnHeaderLayer.getSelectionLayer()
org.eclipse.nebula.widgets.nattable.tree.TreeLayer.getTreeImagePainter() since 1.1 the configured TreeImagePainter should be used instead of the hard referenced one
org.eclipse.nebula.widgets.nattable.edit.command.EditUtils.isCellEditable(ILayer, IConfigRegistry, PositionCoordinate) Use EditUtils.isCellEditable(PositionCoordinate, IConfigRegistry) as PositionCoordinate already contains the layer to which the coordinates match. The redundant layer parameter is not needed and can lead to failures in case the positions do not match it.
org.eclipse.nebula.widgets.nattable.extension.glazedlists.tree.GlazedListTreeData.isExpanded(int) expand/collapse operations should be performed on ITreeRowModel!
org.eclipse.nebula.widgets.nattable.extension.glazedlists.tree.GlazedListTreeData.isExpanded(T) expand/collapse operations should be performed on ITreeRowModel!
org.eclipse.nebula.widgets.nattable.edit.ActiveCellEditorRegistry.registerActiveCellEditor(ICellEditor) replaced by firing the CellEditorCreatedEvent
org.eclipse.nebula.widgets.nattable.filterrow.combobox.FilterRowComboBoxDataProvider.removeCacheUdpateListener(IFilterRowComboUpdateListener) typo in method, use FilterRowComboBoxDataProvider.removeCacheUpdateListener(IFilterRowComboUpdateListener)
org.eclipse.nebula.widgets.nattable.painter.cell.decorator.CellPainterDecorator.setBaseCellPainterSpansWholeCell(boolean) use setPaintDecorationDependent() instead, note that the semantic is different
org.eclipse.nebula.widgets.nattable.edit.editor.TextCellEditor.setErrorDecorationText(String) The error decoration text is dynamically set by the RenderErrorHandling if a ConversionFailedException or a ValidationFailedException is thrown. A value set via this method will be overridden.
org.eclipse.nebula.widgets.nattable.selection.event.SelectionLayerStructuralChangeEventHandler.setSelectionModel(ISelectionModel) This handler doesn't make use of the ISelectionModel anymore, therefore setting another ISelectionModel will have no effect
org.eclipse.nebula.widgets.nattable.extension.glazedlists.groupBy.GroupByDataLayer.setSortModel(ISortModel) use GroupByDataLayer.initializeTreeComparator(ISortModel, IUniqueIndexLayer, boolean)
org.eclipse.nebula.widgets.nattable.edit.ActiveCellEditorRegistry.unregisterActiveCellEditor() The explicit unregistering is not needed any more. The instance will automatically be set to null if the editor gets disposed.

Deprecated Constructors

Constructor and Description
org.eclipse.nebula.widgets.nattable.ui.menu.BodyMenuConfiguration(NatTable, ILayer) use the constructor without bodyLayer parameter
org.eclipse.nebula.widgets.nattable.group.painter.ColumnGroupHeaderTextPainter(ColumnGroupModel) Use constructor without ColumnGroupModel reference
org.eclipse.nebula.widgets.nattable.group.painter.ColumnGroupHeaderTextPainter(ColumnGroupModel, ICellPainter) Use constructor without ColumnGroupModel reference
org.eclipse.nebula.widgets.nattable.group.painter.ColumnGroupHeaderTextPainter(ColumnGroupModel, ICellPainter, boolean, boolean) Use constructor without ColumnGroupModel reference
org.eclipse.nebula.widgets.nattable.group.painter.ColumnGroupHeaderTextPainter(ColumnGroupModel, ICellPainter, CellEdgeEnum) Use constructor without ColumnGroupModel reference
org.eclipse.nebula.widgets.nattable.group.painter.ColumnGroupHeaderTextPainter(ColumnGroupModel, ICellPainter, CellEdgeEnum, boolean, int, boolean) Use constructor without ColumnGroupModel reference
org.eclipse.nebula.widgets.nattable.reorder.event.ColumnReorderEvent(ILayer, int, int, boolean) Use constructor with explicit index parameters.
org.eclipse.nebula.widgets.nattable.reorder.event.ColumnReorderEvent(ILayer, List<Integer>, int, boolean) Use constructor with explicit index parameters.
org.eclipse.nebula.widgets.nattable.selection.event.ColumnSelectionEvent(SelectionLayer, int) Replaced by ColumnSelectionEvent.ColumnSelectionEvent(SelectionLayer, int, boolean, boolean)
org.eclipse.nebula.widgets.nattable.group.config.DefaultRowGroupHeaderLayerConfiguration(IRowGroupModel<T>) use constructor without IRowGroupModel as it is not needed anymore
org.eclipse.nebula.widgets.nattable.tree.painter.IndentedTreeImagePainter(ITreeRowModel<?>) Use constructor without ITreeRowModel parameter
org.eclipse.nebula.widgets.nattable.tree.painter.IndentedTreeImagePainter(ITreeRowModel<?>, int) Use constructor without ITreeRowModel parameter
org.eclipse.nebula.widgets.nattable.tree.painter.IndentedTreeImagePainter(ITreeRowModel<?>, int, TreeImagePainter) Use constructor without ITreeRowModel parameter
org.eclipse.nebula.widgets.nattable.edit.event.InlineCellEditEvent(ILayer, PositionCoordinate, Composite, IConfigRegistry, Object) use constructor without layer parameter
org.eclipse.nebula.widgets.nattable.extension.nebula.richtext.RichTextCellEditor(ToolbarConfiguration) Use a constructor with RichTextEditorConfiguration parameter
org.eclipse.nebula.widgets.nattable.extension.nebula.richtext.RichTextCellEditor(ToolbarConfiguration, int) Use a constructor with RichTextEditorConfiguration parameter
org.eclipse.nebula.widgets.nattable.group.painter.RowGroupHeaderTextPainter(IRowGroupModel) Use constructor without IRowGroupModel reference
org.eclipse.nebula.widgets.nattable.group.painter.RowGroupHeaderTextPainter(IRowGroupModel, ICellPainter) Use constructor without IRowGroupModel reference
org.eclipse.nebula.widgets.nattable.reorder.event.RowReorderEvent(ILayer, int, int, boolean) Use constructor with explicit index parameters.
org.eclipse.nebula.widgets.nattable.reorder.event.RowReorderEvent(ILayer, List<Integer>, int, boolean) Use constructor with explicit index parameters.
org.eclipse.nebula.widgets.nattable.selection.event.RowSelectionEvent(SelectionLayer, Collection<Integer>, int) Replaced by RowSelectionEvent.RowSelectionEvent(SelectionLayer, Collection, int, boolean, boolean)
org.eclipse.nebula.widgets.nattable.selection.SelectionLayer(IUniqueIndexLayer, ISelectionModel, boolean, boolean) the ISelectionModel is now itself an ILayerEventHandler
org.eclipse.nebula.widgets.nattable.selection.event.SelectionLayerStructuralChangeEventHandler(SelectionLayer, ISelectionModel) This handler doesn't make use of the ISelectionModel anymore, therefore setting another ISelectionModel will have no effect
org.eclipse.nebula.widgets.nattable.viewport.command.ShowCellInViewportCommand(ILayer, int, int) The layer parameter is not used anymore, use the constructor without the ILayer parameter.
org.eclipse.nebula.widgets.nattable.viewport.command.ShowCellInViewportCommand(ShowCellInViewportCommand) Since 1.6 this constructor is not needed anymore as the command is a context free command.
org.eclipse.nebula.widgets.nattable.viewport.command.ShowColumnInViewportCommand(ILayer, int) The layer parameter is not used anymore, use the constructor without the ILayer parameter.
org.eclipse.nebula.widgets.nattable.viewport.command.ShowColumnInViewportCommand(ShowColumnInViewportCommand) Since 1.6 this constructor is not needed anymore as the command is a context free command.
org.eclipse.nebula.widgets.nattable.viewport.command.ShowRowInViewportCommand(ILayer, int) The layer parameter is not used anymore, use the constructor without the ILayer parameter.
org.eclipse.nebula.widgets.nattable.viewport.command.ShowRowInViewportCommand(ShowRowInViewportCommand) Since 1.6 this constructor is not needed anymore as the command is a context free command.
org.eclipse.nebula.widgets.nattable.tree.painter.TreeImagePainter(ITreeRowModel<?>) Use constructor without ITreeRowModel parameter
org.eclipse.nebula.widgets.nattable.tree.painter.TreeImagePainter(ITreeRowModel<?>, Image, Image, Image) Use constructor without ITreeRowModel parameter