|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IEditHelperAdvice
Provides 'before' and 'after' editing behaviour for modifying model elements.
Clients should not implement this interface directly. They should instead
subclass AbstractEditHelperAdvice
and
override the methods for the specific requests that they provide advice for.
Method Summary | |
---|---|
boolean |
approveRequest(IEditCommandRequest request)
Approves the edit gesture described in the request . |
void |
configureRequest(IEditCommandRequest request)
Configures the request . |
ICommand |
getAfterEditCommand(IEditCommandRequest request)
Gets a command to be executed after the base editing behaviour. |
ICommand |
getBeforeEditCommand(IEditCommandRequest request)
Gets a command to be executed before the base editing behaviour. |
Method Detail |
---|
ICommand getBeforeEditCommand(IEditCommandRequest request)
request
- the request
null
if I do not provide
'before' behaviour.ICommand getAfterEditCommand(IEditCommandRequest request)
request
- the request
null
if I do not provide
'after' behaviour.void configureRequest(IEditCommandRequest request)
request
. Advisors may modify the request
parameters in this method. This method is consulted before the request is
approved by approveRequest(IEditCommandRequest)
and before the
edit command is constructed.
request
- the edit request to be configured.boolean approveRequest(IEditCommandRequest request)
request
. This
method will be consulted before the edit command is constructed, but
after configureRequest(IEditCommandRequest)
has been called on
all applicable advice.
request
- the edit request
true
if the edit request is approved,
false
otherwise. No edit command will be
constructed if the request is not approved.
|
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.