org.eclipse.gef4.mvc.operations

Class SetRefreshVisualOperation<VR>

java.lang.Object

org.eclipse.core.commands.operations.AbstractOperation

org.eclipse.gef4.mvc.operations.SetRefreshVisualOperation<VR>

Type Parameters:

VR - The visual root node of the UI toolkit this IVisualPart is used in, e.g. javafx.scene.Node in case of JavaFX.

All Implemented Interfaces:

IUndoableOperation, ITransactionalOperation

public class SetRefreshVisualOperation<VR>
extends AbstractOperation
implements ITransactionalOperation

A SetRefreshVisualOperation is used to set/unset the IVisualPart.isRefreshVisual() flag of a specified IVisualPart . This can be handy to guard other operations from model refreshes.

Constructor Summary

Constructors

Constructor and Description
SetRefreshVisualOperation(IVisualPart<VR,? extends VR> part, boolean from, boolean to) Creates a new SetRefreshVisualOperation for setting the IVisualPart.isRefreshVisual() flag of the given IVisualPart to the to value on execution and to the from value on undoing.

Method Summary

Modifier and Type	Method and Description
IStatus	execute(IProgressMonitor monitor, IAdaptable info)
boolean	isContentRelevant() Returns true if this ITransactionalOperation is actually changing model data (instead of only affecting the visualization).
boolean	isNoOp() Returns true if this ITransactionalOperation has no effect (in comparison to its initial state).
IStatus	redo(IProgressMonitor monitor, IAdaptable info)
IStatus	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, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.core.commands.operations.IUndoableOperation

addContext, canExecute, canRedo, canUndo, dispose, getContexts, getLabel, hasContext, removeContext

Constructor Detail

SetRefreshVisualOperation

public SetRefreshVisualOperation(IVisualPart<VR,? extends VR> part,
                                 boolean from,
                                 boolean to)

Creates a new SetRefreshVisualOperation for setting the IVisualPart.isRefreshVisual() flag of the given IVisualPart to the to value on execution and to the from value on undoing.

Parameters:

part - The IVisualPart of which the IVisualPart.isRefreshVisual() flag is changed.

from - The value to which the flag is changed when undoing this operation.

to - The value to which the flag is changed when executing this operation.

Method Detail

execute

public IStatus execute(IProgressMonitor monitor,
                       IAdaptable info)
                throws ExecutionException

Specified by:

execute in interface IUndoableOperation

Specified by:

execute in class AbstractOperation

Throws:

ExecutionException

isContentRelevant

public boolean isContentRelevant()

Description copied from interface: ITransactionalOperation

Returns true if this ITransactionalOperation is actually changing model data (instead of only affecting the visualization). Otherwise returns false. The content relevancy of an ITransactionalOperation can 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:

isContentRelevant in interface ITransactionalOperation

Returns:

true if this ITransactionalOperation is actually changing model data, otherwise false.

isNoOp

public boolean isNoOp()

Description copied from interface: ITransactionalOperation

Returns true if this ITransactionalOperation has no effect (in comparison to its initial state). Otherwise returns false.

Specified by:

isNoOp in interface ITransactionalOperation

Returns:

true if this ITransactionalOperation has no effect, otherwise false.

redo

public IStatus redo(IProgressMonitor monitor,
                    IAdaptable info)
             throws ExecutionException

Specified by:

redo in interface IUndoableOperation

Specified by:

redo in class AbstractOperation

Throws:

ExecutionException

undo

public IStatus undo(IProgressMonitor monitor,
                    IAdaptable info)
             throws ExecutionException

Specified by:

undo in interface IUndoableOperation

Specified by:

undo in class AbstractOperation

Throws:

ExecutionException