org.eclipse.emf.ecp.edit.spi.swt.table

Class MultiStringCellEditor

java.lang.Object

org.eclipse.jface.viewers.CellEditor

org.eclipse.jface.viewers.TextCellEditor

org.eclipse.emf.ecp.edit.spi.swt.table.StringBasedCellEditor

org.eclipse.emf.ecp.edit.spi.swt.table.MultiStringCellEditor

All Implemented Interfaces:

ECPCellEditor

public class MultiStringCellEditor
extends StringBasedCellEditor

A cell Editor to display List of Strings in a cell editor. it allows to enter a list of string using a separator (by default ";").

Since:

1.14

Author:

Jonas Helming

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	MultiStringCellEditor.TargetToModelStrategy

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

org.eclipse.jface.viewers.CellEditor.LayoutData

Field Summary

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

text

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

COPY, CUT, DELETE, FIND, PASTE, REDO, SELECT_ALL, UNDO

Fields inherited from interface org.eclipse.emf.ecp.edit.spi.swt.table.ECPCellEditor

COPY_STRING_ALTERNATIVE, CUSTOM_VARIANT

Constructor Summary

Constructors

Constructor and Description
MultiStringCellEditor(org.eclipse.swt.widgets.Composite parent) The constructor which only takes a parent composite.
MultiStringCellEditor(org.eclipse.swt.widgets.Composite parent, int style) A constructor which takes a parent and the style to use, the style is ignored by this cell editor.

Method Summary

Modifier and Type	Method and Description
protected List<String>	convertStringToList(String value) Convertes a String into a list of Strings using the separator.
int	getColumnWidthWeight() The returned value is used for layouting the table columns.
String	getFormatedString(Object value) This returns the String which will be shown in the table when no cell editor is open.
org.eclipse.swt.graphics.Image	getImage(Object value) This returns the Image which will be shown in the table when no cell editor is open.
int	getMinWidth() Returns the minimum width of the cell editor.
org.eclipse.core.databinding.UpdateValueStrategy	getModelToTargetStrategy(org.eclipse.core.databinding.DataBindingContext databindingContext) This UpdateValueStrategy will be used as the model to target strategy during data binding.
protected String	getSeparator() Returns the separator used to split the input string into entries of the String list.
org.eclipse.core.databinding.UpdateValueStrategy	getTargetToModelStrategy(org.eclipse.core.databinding.DataBindingContext databindingContext) This UpdateValueStrategy will be used as the target to model strategy during data binding.
protected org.eclipse.swt.widgets.Text	getText() returns the Text of the cell editor.
org.eclipse.core.databinding.property.value.IValueProperty	getValueProperty() Returns the IValueProperty for this cell editor which is used by the table to create an IObservableValue.
void	instantiate(org.eclipse.emf.ecore.EStructuralFeature eStructuralFeature, ViewModelContext viewModelContext) Instantiates this cell editor.
void	setEditable(boolean editable) Sets editable state of the cell editor.

Methods inherited from class org.eclipse.emf.ecp.edit.spi.swt.table.StringBasedCellEditor

activate, doSetFocus, fireCancelEditor, isPrintable, withPreSetValidation

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

createControl, dependsOnExternalFocusListener, doGetValue, doSetValue, editOccured, getLayoutData, handleDefaultSelection, isCopyEnabled, isCutEnabled, isDeleteEnabled, isPasteEnabled, isSaveAllEnabled, isSelectAllEnabled, keyReleaseOccured, performCopy, performCut, performDelete, performPaste, performSelectAll

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

activate, addListener, addPropertyChangeListener, create, deactivate, deactivate, dispose, fireApplyEditorValue, fireEditorValueChanged, fireEnablementChanged, focusLost, getControl, getDoubleClickTimeout, getErrorMessage, getStyle, getValidator, getValue, isActivated, isCorrect, isDirty, isFindEnabled, isRedoEnabled, isUndoEnabled, isValueValid, markDirty, performFind, performRedo, performUndo, removeListener, removePropertyChangeListener, setErrorMessage, setFocus, setStyle, setValidator, setValue, setValueValid, valueChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.emf.ecp.edit.spi.swt.table.ECPCellEditor

getStyle

Constructor Detail

MultiStringCellEditor

public MultiStringCellEditor(org.eclipse.swt.widgets.Composite parent)

The constructor which only takes a parent composite.

Parameters:

parent - the Composite to use as a parent.

MultiStringCellEditor

public MultiStringCellEditor(org.eclipse.swt.widgets.Composite parent,
                             int style)

A constructor which takes a parent and the style to use, the style is ignored by this cell editor.

Parameters:

parent - the Composite to use as a parent

style - the SWT style to set

Method Detail

convertStringToList

protected List<String> convertStringToList(String value)

Convertes a String into a list of Strings using the separator.

Parameters:

value - the String to split

Returns:

the list of sub string

getSeparator

protected String getSeparator()

Returns the separator used to split the input string into entries of the String list.

Returns:

the separator as a String

getValueProperty

public org.eclipse.core.databinding.property.value.IValueProperty getValueProperty()

Returns the IValueProperty for this cell editor which is used by the table to create an IObservableValue.

Returns:

the IValueProperty for this cell editor

See Also:

ECPCellEditor.getValueProperty()

instantiate

public void instantiate(org.eclipse.emf.ecore.EStructuralFeature eStructuralFeature,
                        ViewModelContext viewModelContext)

Instantiates this cell editor. This allows the cell editor to use ViewModelServices.

Parameters:

eStructuralFeature - the EStructuralFeature displayed in this cell editor

viewModelContext - the ViewModelContext used for the current view

See Also:

ECPCellEditor.instantiate(org.eclipse.emf.ecore.EStructuralFeature, org.eclipse.emf.ecp.view.spi.context.ViewModelContext)

getFormatedString

public String getFormatedString(Object value)

This returns the String which will be shown in the table when no cell editor is open.

Parameters:

value - the Object to get the formated String for

Returns:

the formated String

See Also:

ECPCellEditor.getFormatedString(java.lang.Object)

getColumnWidthWeight

public int getColumnWidthWeight()

The returned value is used for layouting the table columns. The value is a relative column weight. A column containing text has a weight of 100. Please consider this when defining you weight. E.g if you return 200 your column will be twice the width of a text column.

Returns:

the relative column width

See Also:

ECPCellEditor.getColumnWidthWeight()

getTargetToModelStrategy

public org.eclipse.core.databinding.UpdateValueStrategy getTargetToModelStrategy(org.eclipse.core.databinding.DataBindingContext databindingContext)

This UpdateValueStrategy will be used as the target to model strategy during data binding.

Parameters:

databindingContext - The DataBindingContext used by this strategy

Returns:

the strategy

See Also:

ECPCellEditor.getTargetToModelStrategy(org.eclipse.core.databinding.DataBindingContext)

getModelToTargetStrategy

public org.eclipse.core.databinding.UpdateValueStrategy getModelToTargetStrategy(org.eclipse.core.databinding.DataBindingContext databindingContext)

This UpdateValueStrategy will be used as the model to target strategy during data binding.

Parameters:

databindingContext - The DataBindingContext used by this strategy

Returns:

the strategy

See Also:

ECPCellEditor.getModelToTargetStrategy(org.eclipse.core.databinding.DataBindingContext)

getText

protected org.eclipse.swt.widgets.Text getText()

returns the Text of the cell editor.

Returns:

a Text

setEditable

public void setEditable(boolean editable)

Sets editable state of the cell editor.

Parameters:

editable - true if editable, false otherwise

See Also:

ECPCellEditor.setEditable(boolean)

getImage

public org.eclipse.swt.graphics.Image getImage(Object value)

This returns the Image which will be shown in the table when no cell editor is open.

Parameters:

value - the Object to get the Image for

Returns:

the image

See Also:

ECPCellEditor.getImage(java.lang.Object)

getMinWidth

public int getMinWidth()

Returns the minimum width of the cell editor.

Returns:

the minimum width

See Also:

ECPCellEditor.getMinWidth()