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

Class ConfigurationTableEditorFactory

java.lang.Object

net.ssehub.easy.producer.ui.productline_editor.ConfigurationTableEditorFactory

All Implemented Interfaces:

ConfigurationEditorFactory.IConfigurationEditorCreator

public class ConfigurationTableEditorFactory
extends java.lang.Object
implements ConfigurationEditorFactory.IConfigurationEditorCreator

An UI element factory (preliminary).

Author:

Holger Eichelberger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ConfigurationTableEditorFactory.ConfigTableEditor	Just for now as the constructor of the target class is protected.
private static class	ConfigurationTableEditorFactory.DelegatingGuiVariable	Implements a delegating GuiVariable for externally created editors, so that they can be handled like EASy variables.
static interface	ConfigurationTableEditorFactory.IEditorCreator	An extensible editor creator for tailoring the general EASy mechanism.
static interface	ConfigurationTableEditorFactory.UIChangeListener	A listener called when variables are changed.
static class	ConfigurationTableEditorFactory.UIConfiguration	A UI configuration class wrapping the internally used configuration instance.
static class	ConfigurationTableEditorFactory.UIParameter	Defines a simple UI parameter with name and default value.

Field Summary

Fields

Modifier and Type	Field	Description
private static java.util.Map<java.lang.String,ConfigurationTableEditorFactory.IEditorCreator>	CREATORS

Constructor Summary

Constructors

Constructor	Description
ConfigurationTableEditorFactory()

Method Summary

Modifier and Type	Method	Description
org.eclipse.jface.viewers.ViewerFilter	createAttributeFilter(java.lang.String attributeNameRegEx, java.lang.String valueRegEx, boolean showAllNestedElements)	Creates a simple attribute filter.
static org.eclipse.jface.viewers.CellEditor	createCellEditor(ConfigurationTableEditorFactory.UIConfiguration config, IDecisionVariable variable)	Creates a cell editor element for the given decision variable.
static org.eclipse.jface.viewers.CellEditor	createCellEditor(ConfigurationTableEditorFactory.UIConfiguration config, IDecisionVariable variable, java.util.List<IRangeRestriction> restrictors)	Creates a cell editor element for the given decision variable.
private static org.eclipse.jface.viewers.CellEditor	createCellEditor(ConfigurationTableEditorFactory.UIConfiguration config, IDecisionVariable variable, ConfigurationTableEditorFactory.IEditorCreator creator)	Tries to create a form editor control from an editor creator.
static ConfigurationTableEditorFactory.UIConfiguration	createConfiguration(Configuration config, IEASyEditorPage parent)	Creates a configuration instance holding UI configuration elements without parameters.
static ConfigurationTableEditorFactory.UIConfiguration	createConfiguration(Configuration config, IEASyEditorPage parent, java.util.Map<ConfigurationTableEditorFactory.UIParameter,java.lang.Object> parameter)	Creates a configuration instance holding UI configuration elements.
static org.eclipse.jface.viewers.TreeViewer	createConfigurationTableEditor(Configuration configuration, IEASyEditorPage parent)	Creates a configuration table editor.
static org.eclipse.swt.widgets.Control	createEditor(ConfigurationTableEditorFactory.UIConfiguration config, IDecisionVariable variable)	Creates a form editor element for the given decision variable.
static org.eclipse.swt.widgets.Control	createEditor(ConfigurationTableEditorFactory.UIConfiguration config, IDecisionVariable variable, java.util.List<IRangeRestriction> restrictors)	Creates a form editor element for the given decision variable.
private static org.eclipse.swt.widgets.Control	createEditor(ConfigurationTableEditorFactory.UIConfiguration config, IDecisionVariable variable, ConfigurationTableEditorFactory.IEditorCreator creator)	Tries to create a form editor control from an editor creator.
org.eclipse.jface.viewers.TreeViewer	createEditor(Configuration config, org.eclipse.swt.widgets.Composite parent)	Creates a configuration editor.
org.eclipse.jface.viewers.ViewerFilter	createNameFilter(java.lang.String nameRegEx, boolean showAllNestedElements)	Creates a name filter.
org.eclipse.jface.viewers.ViewerFilter	createNonFrozenFilter(boolean showAllNestedElements)	Creates a filter that shows only non-frozen elements.
static void	createUpdatableCellEditors(boolean updatable)	Defines whether updatable cell editors shall be created if possible.
static DisplayNameProvider	getDisplayNameProvider()	Returns the current display name provider.
static void	registerEditorCreator(java.lang.String key, ConfigurationTableEditorFactory.IEditorCreator creator)	Registers an editor creator, i.e., a plugin that supersedes the EASy way of creating editors for specific cases.
static void	setDisplayNameProvider(DisplayNameProvider provider)	Changes the display name provider.

Methods inherited from class java.lang.Object

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

Field Detail

CREATORS

private static final java.util.Map<java.lang.String,ConfigurationTableEditorFactory.IEditorCreator> CREATORS

Constructor Detail

ConfigurationTableEditorFactory

public ConfigurationTableEditorFactory()

Method Detail

createConfigurationTableEditor

public static final org.eclipse.jface.viewers.TreeViewer createConfigurationTableEditor(Configuration configuration,
                                                                                        IEASyEditorPage parent)

Creates a configuration table editor.

Parameters:

configuration - the configuration to be displayed / manipulated

parent - the parent instance

Returns:

the configuration table editor

createConfiguration

public static final ConfigurationTableEditorFactory.UIConfiguration createConfiguration(Configuration config,
                                                                                        IEASyEditorPage parent)

Creates a configuration instance holding UI configuration elements without parameters. The returned instance may be used to create multiple editors.

Parameters:

config - the IVML configuration

parent - the editor parent instance

Returns:

the UI configuration

createConfiguration

public static final ConfigurationTableEditorFactory.UIConfiguration createConfiguration(Configuration config,
                                                                                        IEASyEditorPage parent,
                                                                                        java.util.Map<ConfigurationTableEditorFactory.UIParameter,java.lang.Object> parameter)

Creates a configuration instance holding UI configuration elements. The returned instance may be used to create multiple editors.

Parameters:

config - the IVML configuration

parent - the editor parent instance

parameter - optional parameter (may be null)

Returns:

the UI configuration

createEditor

public static final org.eclipse.swt.widgets.Control createEditor(ConfigurationTableEditorFactory.UIConfiguration config,
                                                                 IDecisionVariable variable)

Creates a form editor element for the given decision variable.

Parameters:

config - the UI configuration containing variable

variable - the variable to return the editor for

Returns:

the editor

createEditor

public static final org.eclipse.swt.widgets.Control createEditor(ConfigurationTableEditorFactory.UIConfiguration config,
                                                                 IDecisionVariable variable,
                                                                 java.util.List<IRangeRestriction> restrictors)

Creates a form editor element for the given decision variable.

Parameters:

config - the UI configuration containing variable

variable - the variable to return the editor for

restrictors - Optional list to restrict values of drop down editors

Returns:

the editor

createCellEditor

public static final org.eclipse.jface.viewers.CellEditor createCellEditor(ConfigurationTableEditorFactory.UIConfiguration config,
                                                                          IDecisionVariable variable)

Creates a cell editor element for the given decision variable.

Parameters:

config - the UI configuration containing variable

variable - the variable to return the editor for

Returns:

the editor

createCellEditor

public static final org.eclipse.jface.viewers.CellEditor createCellEditor(ConfigurationTableEditorFactory.UIConfiguration config,
                                                                          IDecisionVariable variable,
                                                                          java.util.List<IRangeRestriction> restrictors)

Creates a cell editor element for the given decision variable.

Parameters:

config - the UI configuration containing variable

variable - the variable to return the editor for

restrictors - Optional list to restrict values of drop down editors

Returns:

the editor

createEditor

private static final org.eclipse.swt.widgets.Control createEditor(ConfigurationTableEditorFactory.UIConfiguration config,
                                                                  IDecisionVariable variable,
                                                                  ConfigurationTableEditorFactory.IEditorCreator creator)

Tries to create a form editor control from an editor creator.

Parameters:

config - the UI configuration

variable - the variable to create the editor for

creator - the creator to ask for the creation (may be null)

Returns:

the editor or null if the given creator does not create the editor

createCellEditor

private static final org.eclipse.jface.viewers.CellEditor createCellEditor(ConfigurationTableEditorFactory.UIConfiguration config,
                                                                           IDecisionVariable variable,
                                                                           ConfigurationTableEditorFactory.IEditorCreator creator)

Tries to create a form editor control from an editor creator.

Parameters:

config - the UI configuration

variable - the variable to create the editor for

creator - the creator to ask for the creation (may be null)

Returns:

the editor or null if the given creator does not create the editor

registerEditorCreator

public static final void registerEditorCreator(java.lang.String key,
                                               ConfigurationTableEditorFactory.IEditorCreator creator)

Registers an editor creator, i.e., a plugin that supersedes the EASy way of creating editors for specific cases. Empty keys, null keys or null creators are ignored.

Parameters:

key - (qualified) name or type to react on

creator - the editor creator to register with

setDisplayNameProvider

public static final void setDisplayNameProvider(DisplayNameProvider provider)

Changes the display name provider. [convenience]

Parameters:

provider - the new name provider (considered only if not null)

getDisplayNameProvider

public static final DisplayNameProvider getDisplayNameProvider()

Returns the current display name provider. [convenience]

Returns:

the current display name provider

createUpdatableCellEditors

public static final void createUpdatableCellEditors(boolean updatable)

Defines whether updatable cell editors shall be created if possible.

Parameters:

updatable - if true, updatable cell editors shall be created, false for usual ones

createEditor

public org.eclipse.jface.viewers.TreeViewer createEditor(Configuration config,
                                                         org.eclipse.swt.widgets.Composite parent)

Description copied from interface: ConfigurationEditorFactory.IConfigurationEditorCreator

Creates a configuration editor.

Specified by:

createEditor in interface ConfigurationEditorFactory.IConfigurationEditorCreator

Parameters:

config - the configuration to be shown in the editor

parent - the UI parent

Returns:

the editor

createNameFilter

public org.eclipse.jface.viewers.ViewerFilter createNameFilter(java.lang.String nameRegEx,
                                                               boolean showAllNestedElements)

Description copied from interface: ConfigurationEditorFactory.IConfigurationEditorCreator

Creates a name filter.

Specified by:

createNameFilter in interface ConfigurationEditorFactory.IConfigurationEditorCreator

Parameters:

nameRegEx - a regular expression for including names

showAllNestedElements - if all nested elements or only the selected ones shall be displayed

Returns:

the name filter

createAttributeFilter

public org.eclipse.jface.viewers.ViewerFilter createAttributeFilter(java.lang.String attributeNameRegEx,
                                                                    java.lang.String valueRegEx,
                                                                    boolean showAllNestedElements)

Description copied from interface: ConfigurationEditorFactory.IConfigurationEditorCreator

Creates a simple attribute filter.

Specified by:

createAttributeFilter in interface ConfigurationEditorFactory.IConfigurationEditorCreator

Parameters:

attributeNameRegEx - the name of the attribute as regular expression

valueRegEx - a regular expression to be applied on the text representation of values

showAllNestedElements - if all nested elements or only the selected ones shall be displayed

Returns:

the name filter

createNonFrozenFilter

public org.eclipse.jface.viewers.ViewerFilter createNonFrozenFilter(boolean showAllNestedElements)

Description copied from interface: ConfigurationEditorFactory.IConfigurationEditorCreator

Creates a filter that shows only non-frozen elements.

Specified by:

createNonFrozenFilter in interface ConfigurationEditorFactory.IConfigurationEditorCreator

Parameters:

showAllNestedElements - if all nested elements or only the selected ones shall be displayed

Returns:

the non-frozen filter