org.eclipse.emf.ecp.view.internal.table.nebula.grid

Class GridPasteKeyListener

java.lang.Object

org.eclipse.emf.ecp.view.internal.table.nebula.grid.GridPasteKeyListener

All Implemented Interfaces:

EventListener, org.eclipse.swt.events.KeyListener, org.eclipse.swt.internal.SWTEventListener

public class GridPasteKeyListener
extends Object
implements org.eclipse.swt.events.KeyListener

KeyListener for the paste action on a Grid control.

Since:

1.10

Author:

Alexandra Buzila, Mathias Schaefer

Constructor Summary

Constructors

Constructor and Description
GridPasteKeyListener(org.eclipse.swt.widgets.Display display, VControl vControl, EMFFormsDatabindingEMF dataBinding, EStructuralFeatureValueConverterService converterService, EMFFormsLocalizationService localizationService, boolean selectPastedCells) Constructor.

Method Summary

Modifier and Type	Method and Description
protected boolean	canBePasted(org.eclipse.emf.ecore.EStructuralFeature feature, String cellValue, org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EStructuralFeature.Setting setting) Checks whether a given value may be pasted.
protected String	extractDiagnosticMessage(org.eclipse.emf.common.util.Diagnostic diag, org.eclipse.emf.ecore.EStructuralFeature feature, String value) Creates the message for the given Diagnostic which will be displayed to the user.
protected VControl	getControl()
protected EStructuralFeatureValueConverterService	getConverterService()
protected boolean	isEObjectReadOnly(org.eclipse.emf.ecore.EObject eObject) Called by pasteContents(Point, Grid, String) to determine whether the values of an EObject should be changed at all.
protected boolean	isSettingReadOnly(org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EStructuralFeature feature, Object convertedValue) Called by pasteContents(Point, Grid, String) to determine whether a setting should be changed at all.
void	keyPressed(org.eclipse.swt.events.KeyEvent e)
void	keyReleased(org.eclipse.swt.events.KeyEvent e)
protected String	modifyCellValue(String cellValueSplit) This method is called by pasteContents(Point, Grid, String) with the determined value for a cell.
List<org.eclipse.swt.graphics.Point>	pasteContents(org.eclipse.swt.graphics.Point startItem, org.eclipse.nebula.widgets.grid.Grid grid, String contents) Performs the paste operation.
void	pasteSelection(org.eclipse.nebula.widgets.grid.Grid grid, String contents) Pastes the given contents in the grid.
protected void	postPasteContents() This method get called by pasteContents(Point, Grid, String) directely after the paste is done but before showErrors(List) is called.
protected void	prePasteContents() This method gets called by pasteContents(Point, Grid, String) before it will start to loop over the to be pasted values and begins the pasting.
protected void	setValue(org.eclipse.core.databinding.observable.value.IObservableValue value, Object convertedValue) Sets the given converted value on the observable value.
protected void	showErrors(List<String> msgs) Shows the errors to the user.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.swt.events.KeyListener

keyPressedAdapter, keyReleasedAdapter

Constructor Detail

GridPasteKeyListener

public GridPasteKeyListener(org.eclipse.swt.widgets.Display display,
                            VControl vControl,
                            EMFFormsDatabindingEMF dataBinding,
                            EStructuralFeatureValueConverterService converterService,
                            EMFFormsLocalizationService localizationService,
                            boolean selectPastedCells)

Constructor.

Parameters:

display - the Display on which to allocate this command's Clipboard.

vControl - the VTableControl.

dataBinding - EMFFormsDatabindingEMF

converterService - EStructuralFeatureValueConverterService

localizationService - EMFFormsLocalizationService

selectPastedCells - whether to select the pasted cells

Method Detail

keyPressed

public void keyPressed(org.eclipse.swt.events.KeyEvent e)

Specified by:

keyPressed in interface org.eclipse.swt.events.KeyListener

keyReleased

public void keyReleased(org.eclipse.swt.events.KeyEvent e)

Specified by:

keyReleased in interface org.eclipse.swt.events.KeyListener

pasteSelection

public void pasteSelection(org.eclipse.nebula.widgets.grid.Grid grid,
                           String contents)

Pastes the given contents in the grid.

Parameters:

grid - the target Grid

contents - the contents to paste

pasteContents

public List<org.eclipse.swt.graphics.Point> pasteContents(org.eclipse.swt.graphics.Point startItem,
                                                          org.eclipse.nebula.widgets.grid.Grid grid,
                                                          String contents)

Performs the paste operation.

Parameters:

startItem - the start item

grid - the grid

contents - the pasted contents

Returns:

the pasted cells

prePasteContents

protected void prePasteContents()

This method gets called by pasteContents(Point, Grid, String) before it will start to loop over the to be pasted values and begins the pasting. Clients may use this to notify the user about the paste, setting global variables, showing progress, etc.

postPasteContents

protected void postPasteContents()

This method get called by pasteContents(Point, Grid, String) directely after the paste is done but before showErrors(List) is called. Please note that the call comes from a finally block meaning that the paste process may have been stoped by an unhandled exception beforehand. Clients may use this clean up things done in prePasteContents() for example.

modifyCellValue

protected String modifyCellValue(String cellValueSplit)

This method is called by pasteContents(Point, Grid, String) with the determined value for a cell. Clients may override this method in order to trim the string or change its formatting.

Parameters:

cellValueSplit - the cell value determined from the clipboard for the cell.

Returns:

the string to use

isEObjectReadOnly

protected boolean isEObjectReadOnly(org.eclipse.emf.ecore.EObject eObject)

Called by pasteContents(Point, Grid, String) to determine whether the values of an EObject should be changed at all.

Parameters:

eObject - the EObject in question

Returns:

true if paste for this object should be skipped, false otherwise

isSettingReadOnly

protected boolean isSettingReadOnly(org.eclipse.emf.ecore.EObject eObject,
                                    org.eclipse.emf.ecore.EStructuralFeature feature,
                                    Object convertedValue)

Called by pasteContents(Point, Grid, String) to determine whether a setting should be changed at all.

Parameters:

eObject - the EObject in question

feature - the Feature in question

convertedValue - the converted cell value

Returns:

true if paste for this setting should be skipped, false otherwise

showErrors

protected void showErrors(List<String> msgs)

Shows the errors to the user.

Parameters:

msgs - the collected messages, may be empty if no errors

canBePasted

protected boolean canBePasted(org.eclipse.emf.ecore.EStructuralFeature feature,
                              String cellValue,
                              org.eclipse.emf.ecore.EObject eObject,
                              org.eclipse.emf.ecore.EStructuralFeature.Setting setting)

Checks whether a given value may be pasted.

Parameters:

feature - the feature of the eObject

cellValue - the cell value to be pasted

eObject - the parent EObject

setting - EStructuralFeature.Setting

Returns:

true, if the value may be pasted, false otherwise

setValue

protected void setValue(org.eclipse.core.databinding.observable.value.IObservableValue value,
                        Object convertedValue)

Sets the given converted value on the observable value.

Parameters:

value - the observable value

convertedValue - the converted value

extractDiagnosticMessage

protected String extractDiagnosticMessage(org.eclipse.emf.common.util.Diagnostic diag,
                                          org.eclipse.emf.ecore.EStructuralFeature feature,
                                          String value)

Creates the message for the given Diagnostic which will be displayed to the user.

Parameters:

diag - the diagnostic with the original error message

feature - the validated feature

value - the validated value

Returns:

the display string

getConverterService

protected EStructuralFeatureValueConverterService getConverterService()

Returns:

the EStructuralFeatureValueConverterService

getControl

protected VControl getControl()

Returns:

the VControl