|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IEditCommandRequest
Request for a command to edit a model element. These requests are passed to
IEditHelpers
to obtain commands that will execute the edit
behaviour.
Clients should not implement this interface directly, but should subclass
AbstractEditCommandRequest
instead.
Field Summary | |
---|---|
static java.lang.String |
REPLACE_DEFAULT_COMMAND
Name of the request parameter used to indicate that the default edit command should not be considered. |
Method Summary | |
---|---|
void |
addParameters(java.util.Map newParameters)
Adds newParameters to this request. |
IClientContext |
getClientContext()
Gets the client context for this request. |
java.lang.Object |
getEditHelperContext()
Gets the edit helper context for this request. |
org.eclipse.emf.transaction.TransactionalEditingDomain |
getEditingDomain()
Gets the editing domain in which I am requesting to make model changes. |
java.util.List |
getElementsToEdit()
Gets the elements that will be changed when the work is done for this request. |
java.lang.String |
getLabel()
Gets the request label. |
java.lang.Object |
getParameter(java.lang.String name)
Gets the value for the request parameter named name . |
java.util.Map |
getParameters()
Gets the request parameters keyed on parameter name. |
void |
setClientContext(IClientContext clientContext)
Sets the client context for this request. |
void |
setParameter(java.lang.String name,
java.lang.Object value)
Sets the request parameter named name to
value . |
Field Detail |
---|
static final java.lang.String REPLACE_DEFAULT_COMMAND
Boolean.TRUE
.
Method Detail |
---|
java.lang.String getLabel()
java.lang.Object getEditHelperContext()
IElementType
or an EObject
, or an
IEditHelperContext
. It determines which edit helper should be
used to find a command to do the work in the request.
java.util.List getElementsToEdit()
java.util.Map getParameters()
void setParameter(java.lang.String name, java.lang.Object value)
name
to
value
.
name
- the parameter namevalue
- the parameter valuejava.lang.Object getParameter(java.lang.String name)
name
.
name
- the parameter name
void addParameters(java.util.Map newParameters)
newParameters
to this request.
newParameters
- the parameters to be addedorg.eclipse.emf.transaction.TransactionalEditingDomain getEditingDomain()
void setClientContext(IClientContext clientContext)
clientContext
- the client contextIClientContext getClientContext()
|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp., Borland Software Corp., and others 2005,2006. All rights reserved.