Class ChangeContentsOperation
java.lang.Object
org.eclipse.core.commands.operations.AbstractOperation
org.eclipse.gef.mvc.fx.operations.ChangeContentsOperation
- All Implemented Interfaces:
IUndoableOperation,ITransactionalOperation
The
ChangeContentsOperation can be used to change the content objects
stored in the IViewer.contentsProperty().-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionChangeContentsOperation(String label, IViewer viewer, List<? extends Object> contents) Creates a newChangeContentsOperationfor changing the contents of the givenIViewerto the specified list of objects.ChangeContentsOperation(IViewer viewer) Constructs a newChangeContentsOperationthat can be used to change the contents of the givenIViewer.ChangeContentsOperation(IViewer viewer, List<? extends Object> contents) Creates a newChangeContentsOperationfor changing the contents of the givenIViewerto the specified list of objects. -
Method Summary
Modifier and TypeMethodDescriptionexecute(IProgressMonitor monitor, IAdaptable info) Returns the list containing the initial contents by reference.Returns the list containing the new contents by reference.booleanReturnstrueif thisITransactionalOperationis actually changing model data (instead of only affecting the visualization).booleanisNoOp()Returnstrueif thisITransactionalOperationhas no effect (in comparison to its initial state).redo(IProgressMonitor monitor, IAdaptable info) voidsetNewContents(List<? extends Object> newContents) Sets the final contents to the given list.undo(IProgressMonitor monitor, IAdaptable info) Methods inherited from class org.eclipse.core.commands.operations.AbstractOperation
addContext, canExecute, canRedo, canUndo, dispose, getContexts, getLabel, hasContext, removeContext, setLabel, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.eclipse.core.commands.operations.IUndoableOperation
addContext, canExecute, canRedo, canUndo, dispose, getContexts, getLabel, hasContext, removeContext
-
Field Details
-
DEFAULT_LABEL
"Change Contents"
The default label for this operation (i.e. used if no label is specified).- See Also:
-
-
Constructor Details
-
ChangeContentsOperation
Constructs a newChangeContentsOperationthat can be used to change the contents of the givenIViewer.The operation is initialized as a no-op, i.e. the initial viewer contents are also used as the final viewer contents.
The final contents can later be set using the
setNewContents(List)method.- Parameters:
viewer- TheIViewerof which theIViewer.contentsProperty()is to be changed.
-
ChangeContentsOperation
Creates a newChangeContentsOperationfor changing the contents of the givenIViewerto the specified list of objects.- Parameters:
viewer- TheIViewerof which theIViewer.contentsProperty()is to be changed.contents- The new content objects to store in theIViewer.contentsProperty().
-
ChangeContentsOperation
Creates a newChangeContentsOperationfor changing the contents of the givenIViewerto the specified list of objects. The given label is used as the label of the operation.- Parameters:
label- The label of the operation.viewer- TheIViewerof which theIViewer.contentsProperty()is to be changed.contents- The new content objects to store in theIViewer.contentsProperty().
-
-
Method Details
-
execute
- Specified by:
executein interfaceIUndoableOperation- Specified by:
executein classAbstractOperation- Throws:
ExecutionException
-
getInitialContents
Returns the list containing the initial contents by reference.- Returns:
- the list containing the initial contents by reference.
-
getNewContents
Returns the list containing the new contents by reference.- Returns:
- the list containing the new contents by reference.
-
isContentRelevant
public boolean isContentRelevant()Description copied from interface:ITransactionalOperationReturnstrueif thisITransactionalOperationis actually changing model data (instead of only affecting the visualization). Otherwise returnsfalse. The content relevance of anITransactionalOperationcan be checked to determine if the execution of the operation will affect the model, for example, to set an editor's dirty flag.- Specified by:
isContentRelevantin interfaceITransactionalOperation- Returns:
trueif thisITransactionalOperationis actually changing model data, otherwisefalse.
-
isNoOp
public boolean isNoOp()Description copied from interface:ITransactionalOperationReturnstrueif thisITransactionalOperationhas no effect (in comparison to its initial state). Otherwise returnsfalse.- Specified by:
isNoOpin interfaceITransactionalOperation- Returns:
trueif thisITransactionalOperationhas no effect, otherwisefalse.
-
redo
- Specified by:
redoin interfaceIUndoableOperation- Specified by:
redoin classAbstractOperation- Throws:
ExecutionException
-
setNewContents
Sets the final contents to the given list.- Parameters:
newContents- The new final contents.
-
undo
- Specified by:
undoin interfaceIUndoableOperation- Specified by:
undoin classAbstractOperation- Throws:
ExecutionException
-