blob: 8acded3cd36034cf3631215a11378a65f8b7d7dc (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
/*****************************************************************************
* Copyright (c) 2010 CEA LIST.
*
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
*
* Yann Tanguy (CEA LIST) yann.tanguy@cea.fr - Initial API and implementation
*
*****************************************************************************/
package org.eclipse.papyrus.infra.services.edit.internal;
import org.eclipse.gmf.runtime.common.core.command.ICommand;
import org.eclipse.gmf.runtime.emf.type.core.IClientContext;
import org.eclipse.gmf.runtime.emf.type.core.IElementType;
import org.eclipse.gmf.runtime.emf.type.core.requests.IEditCommandRequest;
import org.eclipse.papyrus.infra.services.edit.service.IElementEditService;
/**
* <pre>
*
* This class implements {@link IElementEditService}.
*
* @see org.eclipse.papyrus.infra.services.edit.service.IElementEditService
*
* This class is the service in charge of providing edit command for
* a specific type of element.
*
* This class relies for a large part on the GMF ExtensibleType framework,
* mostly as a wrapper of {@link IElementType} for Papyrus. No added value
* for Papyrus is expected in using this wrapper, except the fact that it ensures
* Papyrus shared {@link IClientContext} is always explicitly used or set in
* request while retrieving commands.
*
* </pre>
*/
public class ElementEditService implements IElementEditService {
/** The registered {@link IElementType} used to provide edit commands. */
protected IElementType elementType;
/** Papyrus shared {@link IClientContext} */
protected IClientContext sharedClientContext;
/**
* <pre>
*
* Constructor.
*
* @param elementType the {@link IElementType} this service will use to provide edit commands
* @param sharedClientContext the shared {@link IClientContext}
*
* </pre>
*/
public ElementEditService(IElementType elementType, IClientContext sharedClientContext) {
super();
this.elementType = elementType;
this.sharedClientContext = sharedClientContext;
}
/**
* <pre>
*
* This method creates an edit command in response to an edit request.
* This method directly uses the ElementType framework (through {@link IElementType} api,
* making sure that the Papyrus shared {@link IClientContext} is explicitly set in the request.
*
* @see org.eclipse.papyrus.infra.services.edit.service.IElementEditService#getEditCommand(org.eclipse.gmf.runtime.emf.type.core.requests.IEditCommandRequest)
*
* @param request the edit request
* @return the edit command corresponding to the edit request
*
* </pre>
*/
@Override
public ICommand getEditCommand(IEditCommandRequest request) {
// Make sure the share client context in passed in the request
request.setClientContext(sharedClientContext);
// Retrieve the desired edit command using GMF ExtensibleType API
ICommand editCommand = elementType.getEditCommand(request);
return editCommand;
}
/**
* <pre>
*
* Get the display name of the element type.
*
* @see org.eclipse.papyrus.infra.services.edit.service.IElementEditService#getDisplayName()
*
* @return the display name of the {@link IElementType} used by current service.
*
* </pre>
*/
@Override
public String getDisplayName() {
return elementType.getDisplayName();
}
/**
*
* @see org.eclipse.core.runtime.IAdaptable#getAdapter(java.lang.Class)
*
* @param adapter
* @return the adapted object
*/
@Override
public Object getAdapter(Class adapter) {
if (adapter == IElementType.class) {
return elementType;
}
return null;
}
/**
* <pre>
*
* Test if current service can provide an edit command in response to the request.
*
* @see org.eclipse.papyrus.infra.services.edit.service.IElementEditService#canEdit(org.eclipse.gmf.runtime.emf.type.core.requests.IEditCommandRequest)
*
* @param req the edit request to test
* @return true is this service can provide edit command for the request
*
* </pre>
*/
@Override
public boolean canEdit(IEditCommandRequest req) {
// Make sure the share client context in passed in the request
req.setClientContext(sharedClientContext);
return elementType.canEdit(req);
}
}
|
