Package net.ssehub.easy.producer.ui.confModel

Class AbstractExpandableGUIVariable

java.lang.Object

net.ssehub.easy.producer.ui.confModel.GUIVariable

net.ssehub.easy.producer.ui.confModel.AbstractExpandableGUIVariable

All Implemented Interfaces:

java.lang.Comparable<GUIVariable>, IGUIConfigurableElement

Direct Known Subclasses:

CompoundGUIVariable, ContainerGUIVariable

abstract class AbstractExpandableGUIVariable
extends GUIVariable

Super class for variables, which contain nested elements and can be expanded.

Author:

El-Sharkawy

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<GUIVariable>	nested

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractExpandableGUIVariable(IDecisionVariable variable, org.eclipse.swt.widgets.Composite parent, GUIConfiguration parentConfig, GUIVariable varParent)	Sole constructor for this class.

Method Summary

Modifier and Type	Method	Description
protected void	createNestedVariables()	Creates nested GUIVariables for this variable.
GUIVariable	extend()	Creates a new empty nested value/variable if supported.
org.eclipse.jface.viewers.CellEditor	getCellEditor(org.eclipse.swt.widgets.Composite parent)	Returns a CellEditor for a table.
GUIEditor	getEditor()	Returns the (non-cell) editor for this variable.
GUIVariable	getNestedElement(int index)	Returns a nested element specified by the given index.
int	getNestedElementsCount()	Returns the number of nested elements.
protected Value	getValueAssignment(java.lang.Object value)	Converts the given object into a Value.
boolean	isExpandable()	Returns whether is variable can be expanded.
protected GUIVariable	replace(GUIVariable nestedVariable, Value value)	Replaces a variable to reflect the new value (of a more or less specific type).
void	setValue(java.lang.Object value)	Sets the value of the wrapped IDecisionVariable.

Methods inherited from class net.ssehub.easy.producer.ui.confModel.GUIVariable

addErrorMessage, compareTo, freeze, getAssignmentState, getComment, getComposite, getConfiguration, getErrorMessages, getHistory, getName, getNestedDepth, getNullLabel, getParent, getTooltip, getTopLevelParent, getType, getValue, getValueText, getVariable, hasErrors, hasNullValue, hasValue, isAnnotated, isEditable, isExtendable, isFreezable, isFrozen, isTopLevelDeclaration, remove, removeErrorMessages, replaceValue, setEmptyValue, setNULLValue, setVariable, toString, unfreeze

Methods inherited from class java.lang.Object

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

Field Detail

nested

private java.util.List<GUIVariable> nested

Constructor Detail

AbstractExpandableGUIVariable

protected AbstractExpandableGUIVariable(IDecisionVariable variable,
                                        org.eclipse.swt.widgets.Composite parent,
                                        GUIConfiguration parentConfig,
                                        GUIVariable varParent)

Sole constructor for this class.

Parameters:

variable - The IDecisionVariable represented by this GUIVariable

parent - The controlling composite, needed for the creation of CellEditors

parentConfig - The GUIConfiguration holding this GUIVariable

varParent - The parent GUIVariable holding this variable. Can be null if and only if this variable is a top level variable stored inside the configuration.

Method Detail

getNestedElementsCount

public int getNestedElementsCount()

Description copied from class: GUIVariable

Returns the number of nested elements. The return value should be 0 unless this IDecisionVariable is an AbstractExpandableGUIVariable.

Overrides:

getNestedElementsCount in class GUIVariable

Returns:

An integer value greater or equal to 0.

createNestedVariables

protected void createNestedVariables()

Creates nested GUIVariables for this variable. This method should be called inside the constructor and if the number of nested variables has been changed, e.g. a nested sequence item has been added to this variable.

getCellEditor

public final org.eclipse.jface.viewers.CellEditor getCellEditor(org.eclipse.swt.widgets.Composite parent)

Description copied from class: GUIVariable

Returns a CellEditor for a table.

Specified by:

getCellEditor in class GUIVariable

Parameters:

parent - The GUI component where this GUIVariable and, thus, its editor are displayed.

Returns:

CellEditor to configure the enclosed IDecisionVariable

getEditor

public GUIEditor getEditor()

Description copied from class: GUIVariable

Returns the (non-cell) editor for this variable. The editor shall be ready to use, i.e., properly initialized.

Specified by:

getEditor in class GUIVariable

Returns:

the editor, may be null if the variable shall not be displayed / being edited

setValue

public void setValue(java.lang.Object value)

Description copied from class: GUIVariable

Sets the value of the wrapped IDecisionVariable.

Overrides:

setValue in class GUIVariable

Parameters:

value - The value to be set.

getValueAssignment

protected final Value getValueAssignment(java.lang.Object value)
                                  throws ValueDoesNotMatchTypeException

Description copied from class: GUIVariable

Converts the given object into a Value.

Specified by:

getValueAssignment in class GUIVariable

Parameters:

value - An object given by the Eclipse GUI.

Returns:

A Value representation of the object, maybe null.

Throws:

ValueDoesNotMatchTypeException - in case of value cannot be converted to the related data type of the wrapped IDecisionVariable.

getNestedElement

public GUIVariable getNestedElement(int index)

Description copied from class: GUIVariable

Returns a nested element specified by the given index.

Overrides:

getNestedElement in class GUIVariable

Parameters:

index - The 0-based index of the nested element.

Returns:

The specified nestedvariable.

isExpandable

public final boolean isExpandable()

Returns whether is variable can be expanded. Subclasses may override this method.

Overrides:

isExpandable in class GUIVariable

Returns:

true if this variable is expandable, otherwise false.

extend

public GUIVariable extend()

Description copied from class: GUIVariable

Creates a new empty nested value/variable if supported. This method shall only be called by the set and sequence variables.

Overrides:

extend in class GUIVariable

Returns:

the new empty variable or null if nothing happened, e.g., not GUIVariable.isExtendable().

replace

protected GUIVariable replace(GUIVariable nestedVariable,
                              Value value)
                       throws ConfigurationException

Description copied from class: GUIVariable

Replaces a variable to reflect the new value (of a more or less specific type).

Overrides:

replace in class GUIVariable

Parameters:

nestedVariable - the variable to be replaced (may affect top-level GUI variables)

value - the new value carrying the type

Returns:

the new variable or nestedVariable

Throws:

ConfigurationException - in case that configuring the variable is not possible