Package net.ssehub.easy.producer.ui.productline_editor.configuration

Class ConfigurationTableEditor

java.lang.Object

org.eclipse.jface.viewers.Viewer

org.eclipse.jface.viewers.ContentViewer

org.eclipse.jface.viewers.StructuredViewer

org.eclipse.jface.viewers.ColumnViewer

org.eclipse.jface.viewers.AbstractTreeViewer

org.eclipse.jface.viewers.TreeViewer

net.ssehub.easy.producer.ui.productline_editor.configuration.ConfigurationTableEditor

All Implemented Interfaces:

IGUIConfigChangeListener, IGUIConfigurationContainer, IConfigurationChangeListener, org.eclipse.jface.viewers.IInputProvider, org.eclipse.jface.viewers.IInputSelectionProvider, org.eclipse.jface.viewers.IPostSelectionProvider, org.eclipse.jface.viewers.ISelectionProvider

Direct Known Subclasses:

AttributeValuesPage.AttributeTableEditor, ConfigurationTableEditorFactory.ConfigTableEditor

public class ConfigurationTableEditor
extends org.eclipse.jface.viewers.TreeViewer
implements IGUIConfigChangeListener, IConfigurationChangeListener, IGUIConfigurationContainer

The table for editing the configuration, without surrounding buttons or other stuff.

Author:

El-Sharkawy

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConfigurationTableEditor.IUpdateListener	A listener which is called when the editor performs (async) updates.

Nested classes/interfaces inherited from class org.eclipse.jface.viewers.StructuredViewer

org.eclipse.jface.viewers.StructuredViewer.ColorAndFontCollector, org.eclipse.jface.viewers.StructuredViewer.ColorAndFontCollectorWithProviders

Field Summary

Fields

Modifier and Type	Field	Description
private Configuration	config
private GUIConfiguration	guiConfig
private ConfigurationTableEditor.IUpdateListener	listener
private IEASyEditorPage	parentPage

Fields inherited from class org.eclipse.jface.viewers.AbstractTreeViewer

ALL_LEVELS

Fields inherited from class org.eclipse.jface.viewers.Viewer

WIDGET_DATA_KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConfigurationTableEditor(Configuration configuration, IEASyEditorPage parent)	Sole constructor for this editor.

Method Summary

Modifier and Type	Method	Description
void	changed(GUIConfiguration changedConfiguration)	Will be called when something inside the GUIConfiguration was changed.
void	close()	On-close method for this table editor, release allocated ressources.
void	configurationRefreshed(Configuration config)	Notification that the whole configuration was refreshed, e.g.
protected org.eclipse.jface.viewers.CellLabelProvider	createColumnLabelProvider()	Creates a label provider for a column.
private void	createContextMenu()	Creates a context menu inside the cells.
private void	createProductEditorTableColumns()	Method creates the columns for the product table.
private void	execOnParent(java.lang.Runnable runnable, boolean async)	Executes a runnable on the parent display.
protected java.lang.String[]	getColumnTitles()	Returns the titles of the columns.
protected int[]	getColumnWidths()	Returns the widths of the columns.
Configuration	getConfig()	Returns the configuration instance.
GUIConfiguration	getGuiConfig()	Returns the GUI configuration instance.
int	getItemCount()	Returns the number of items.
void	imtemsChanged(GUIConfiguration changedConfiguration)	Will be called when something inside the GUIConfiguration was changed.
void	itemChanged(Configuration config, IDecisionVariable changedVariable, Value oldValue)	Notification that a DecisionVariable changed inside the Configuration.
void	refresh()
void	setUpdateListener(ConfigurationTableEditor.IUpdateListener listener)	Changes the update listener.
void	stateChanged(Configuration config, IDecisionVariable changedVariable)	Notification that the state of a DecisionVariable has been changed inside the Configuration.
void	updateItem(GUIVariable variable)	Informs the container that a single item has changed (not added/deleted).

Methods inherited from class org.eclipse.jface.viewers.TreeViewer

addTreeListener, assertContentProviderType, createViewerEditor, disassociate, doGetColumnCount, editElement, getChild, getChildren, getColumnViewerOwner, getControl, getExpanded, getItemAt, getItemCount, getItemCount, getItems, getLabelProvider, getParentElement, getParentItem, getRawChildren, getSelection, getTree, getViewerRowFromItem, handleTreeCollapse, handleTreeExpand, hookControl, internalAdd, internalInitializeTree, internalRefreshStruct, isExpandable, mapElement, newItem, remove, removeAll, replace, setChildCount, setContentProvider, setExpanded, setHasChildren, setSelection, setSelection, showItem, updatePlus

Methods inherited from class org.eclipse.jface.viewers.AbstractTreeViewer

add, add, addSelectionListener, addTreeListener, associate, buildLabel, collapseAll, collapseToLevel, createChildren, createTreeItem, doFindInputItem, doFindItem, doUpdateItem, doUpdateItem, expandAll, expandAll, expandToLevel, expandToLevel, expandToLevel, expandToLevel, fireTreeCollapsed, fireTreeExpanded, getAutoExpandLevel, getChildren, getExpandedElements, getExpandedState, getExpandedTreePaths, getNextItem, getPreviousItem, getSelection, getSelectionFromWidget, getSortedChildren, getStructuredSelection, getTreePathFromItem, getVisibleExpandedElements, handleDoubleSelect, indexForElement, inputChanged, insert, internalCollapseToLevel, internalExpand, internalExpandToLevel, internalFindItems, internalGetWidgetToSelect, internalIsInputOrEmptyPath, internalRefresh, internalRefresh, internalRefresh, internalRemove, internalRemove, isSameSelection, labelProviderChanged, remove, remove, remove, removeTreeListener, reveal, scrollDown, scrollUp, setAutoExpandLevel, setExpandedElements, setExpandedState, setExpandedTreePaths, setExpandPreCheckFilters, setSelectionToWidget, setSelectionToWidget, updateChildren

Methods inherited from class org.eclipse.jface.viewers.ColumnViewer

applyEditorValue, cancelEditing, checkBusy, getCell, getCellEditors, getCellModifier, getColumnProperties, getColumnViewerEditor, getItem, getLabelProvider, getViewerRow, handleDispose, hookEditingSupport, isBusy, isCellEditorActive, refresh, refresh, setBusy, setCellEditors, setCellModifier, setColumnProperties, setColumnViewerEditor, setLabelProvider, triggerEditorActivationEvent, update

Methods inherited from class org.eclipse.jface.viewers.StructuredViewer

addDoubleClickListener, addDragSupport, addDropSupport, addFilter, addOpenListener, addPostSelectionChangedListener, assertElementsNotNull, equals, filter, findItem, findItems, fireDoubleClick, fireOpen, firePostSelectionChanged, getColorAndFontCollector, getComparator, getComparer, getFilteredChildren, getFilters, getRoot, getSorter, handleInvalidSelection, handleLabelProviderChanged, handleOpen, handlePostSelect, handleSelect, hasFilters, internalUpdate, needsRefilter, preservingSelection, refresh, refreshItem, removeDoubleClickListener, removeFilter, removeOpenListener, removePostSelectionChangedListener, resetFilters, setComparator, setComparer, setFilters, setInput, setSorter, setUseHashlookup, testFindItem, testFindItems, unmapAllElements, unmapElement, unmapElement, update, updateItem, updateSelection, usingElementMap

Methods inherited from class org.eclipse.jface.viewers.ContentViewer

getContentProvider, getInput

Methods inherited from class org.eclipse.jface.viewers.Viewer

addHelpListener, addSelectionChangedListener, fireHelpRequested, fireSelectionChanged, getData, handleHelpRequest, removeHelpListener, removeSelectionChangedListener, setData, setSelection

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.ssehub.easy.producer.ui.productline_editor.configuration.IGUIConfigurationContainer

addFilter, removeFilter, setFilters

Methods inherited from interface org.eclipse.jface.viewers.ISelectionProvider

addSelectionChangedListener, removeSelectionChangedListener, setSelection

Field Detail

config

private Configuration config

guiConfig

private GUIConfiguration guiConfig

parentPage

private IEASyEditorPage parentPage

listener

private ConfigurationTableEditor.IUpdateListener listener

Constructor Detail

ConfigurationTableEditor

protected ConfigurationTableEditor(Configuration configuration,
                                   IEASyEditorPage parent)

Sole constructor for this editor.

Parameters:

configuration - The configuration which should be edited in this editor.

parent - The IEASyEditorPage holding this table.

Method Detail

setUpdateListener

public void setUpdateListener(ConfigurationTableEditor.IUpdateListener listener)

Changes the update listener.

Parameters:

listener - the new update listener (may be null)

createColumnLabelProvider

protected org.eclipse.jface.viewers.CellLabelProvider createColumnLabelProvider()

Creates a label provider for a column. [customization]

Returns:

the label provider instance (need to comply with getColumnWidths() and getColumnTitles()

getColumnTitles

protected java.lang.String[] getColumnTitles()

Returns the titles of the columns. [customization]

Returns:

the titles of the columns (need to comply with getColumnWidths() and createColumnLabelProvider()

getColumnWidths

protected int[] getColumnWidths()

Returns the widths of the columns. [customization]

Returns:

the widths of the columns (need to comply with getColumnTitles() and createColumnLabelProvider()

createProductEditorTableColumns

private void createProductEditorTableColumns()

Method creates the columns for the product table.

createContextMenu

private void createContextMenu()

Creates a context menu inside the cells. Part of the constructor.

refresh

public void refresh()

Overrides:

refresh in class org.eclipse.jface.viewers.StructuredViewer

changed

public void changed(GUIConfiguration changedConfiguration)

Description copied from interface: IGUIConfigChangeListener

Will be called when something inside the GUIConfiguration was changed.

Specified by:

changed in interface IGUIConfigChangeListener

Parameters:

changedConfiguration - A reference of the GUIConfiguration which was changed.

itemChanged

public void itemChanged(Configuration config,
                        IDecisionVariable changedVariable,
                        Value oldValue)

Description copied from interface: IConfigurationChangeListener

Notification that a DecisionVariable changed inside the Configuration.

Specified by:

itemChanged in interface IConfigurationChangeListener

Parameters:

config - The Configuration where the change occurred.

changedVariable - The DecisionVariable which changed.

oldValue - the old value of changedVariable before the change

execOnParent

private void execOnParent(java.lang.Runnable runnable,
                          boolean async)

Executes a runnable on the parent display.

Parameters:

runnable - the runnable to be executed

async - whether execution shall happen asynchronously or synchronously

configurationRefreshed

public void configurationRefreshed(Configuration config)

Description copied from interface: IConfigurationChangeListener

Notification that the whole configuration was refreshed, e.g. because the project was reparsed.

Specified by:

configurationRefreshed in interface IConfigurationChangeListener

Parameters:

config - The configuration which was refreshed.

close

public void close()

On-close method for this table editor, release allocated ressources.

imtemsChanged

public void imtemsChanged(GUIConfiguration changedConfiguration)

Description copied from interface: IGUIConfigChangeListener

Will be called when something inside the GUIConfiguration was changed. Contrary to IGUIConfigChangeListener.changed(GUIConfiguration), this method should be used if only the view shall be updated.

Specified by:

imtemsChanged in interface IGUIConfigChangeListener

Parameters:

changedConfiguration - A reference of the GUIConfiguration which was changed.

getItemCount

public int getItemCount()

Returns the number of items.

Returns:

the number of items

getGuiConfig

public GUIConfiguration getGuiConfig()

Description copied from interface: IGUIConfigurationContainer

Returns the GUI configuration instance.

Specified by:

getGuiConfig in interface IGUIConfigurationContainer

Returns:

the GUI configuration instance

getConfig

public Configuration getConfig()

Description copied from interface: IGUIConfigurationContainer

Returns the configuration instance.

Specified by:

getConfig in interface IGUIConfigurationContainer

Returns:

the configuration instance

stateChanged

public void stateChanged(Configuration config,
                         IDecisionVariable changedVariable)

Description copied from interface: IConfigurationChangeListener

Notification that the state of a DecisionVariable has been changed inside the Configuration.

Specified by:

stateChanged in interface IConfigurationChangeListener

Parameters:

config - The Configuration where the change occurred.

changedVariable - The DecisionVariable which changed.

updateItem

public void updateItem(GUIVariable variable)

Description copied from interface: IGUIConfigurationContainer

Informs the container that a single item has changed (not added/deleted). This is much more efficient than to refresh the whole container and in case of an editor, does not force to collapse open items.

Specified by:

updateItem in interface IGUIConfigurationContainer

Parameters:

variable - The item which has been modified (not added or deleted).