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

Class BasisGUIVariable

java.lang.Object

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

net.ssehub.easy.producer.ui.confModel.BasisGUIVariable

All Implemented Interfaces:

java.lang.Comparable<GUIVariable>, IGUIConfigurableElement

class BasisGUIVariable
extends GUIVariable

GUI representation of IDecisionVariables which can be configured with a simple text editor.

Author:

El-Sharkawy

Constructor Summary

Constructors

Constructor	Description
BasisGUIVariable(IDecisionVariable variable, org.eclipse.swt.widgets.Composite parent, GUIConfiguration config, GUIVariable varParent)	Sole constructor for this class.

Method Summary

Modifier and Type	Method	Description
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.
java.lang.Object	getValue()	Returns the value of the given IDecisionVariable so that it can be used as return value for the EditingSupport.getValue(Object) method.
protected Value	getValueAssignment(java.lang.Object value)	Converts the given object into a Value.
java.lang.String	getValueText()	Returns a string representation of the current value.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BasisGUIVariable

BasisGUIVariable(IDecisionVariable variable,
                 org.eclipse.swt.widgets.Composite parent,
                 GUIConfiguration config,
                 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

config - The GUIConfiguration holding this BasisGUIVariable

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

getCellEditor

public 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

getValueText

public java.lang.String getValueText()

Description copied from class: GUIVariable

Returns a string representation of the current value. This is used when no cursor is inside the cell (if the user is not editing the variable).

Specified by:

getValueText in class GUIVariable

Returns:

A string representation of the current value or null.

getValueAssignment

protected 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.

getValue

public java.lang.Object getValue()

Description copied from class: GUIVariable

Returns the value of the given IDecisionVariable so that it can be used as return value for the EditingSupport.getValue(Object) method.

Specified by:

getValue in class GUIVariable

Returns:

A value as needed by the Eclipse UI.