org.eclipse.gef4.mvc.operations

Class ChangeHoverOperation<VR>

java.lang.Object

org.eclipse.core.commands.operations.AbstractOperation

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

Type Parameters:

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

All Implemented Interfaces:

IUndoableOperation

public class ChangeHoverOperation<VR>
extends AbstractOperation

The ChangeHoverOperation can be used to change the HoverModel of an IViewer.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_LABEL "change-hover" The default label for this operation (i.e. used if no label is specified).

Constructor Summary

Constructors

Constructor and Description
ChangeHoverOperation(IViewer<VR> viewer, IVisualPart<VR,? extends VR> newHovered) Creates a new ChangeHoverOperation to set the given newHovered IVisualPart as the hovered part within the given IViewer.
ChangeHoverOperation(IViewer<VR> viewer, IVisualPart<VR,? extends VR> oldHovered, IVisualPart<VR,? extends VR> newHovered) Creates a new ChangeHoverOperation to set the given newHovered IVisualPart as the hovered part within the given IViewer.
ChangeHoverOperation(java.lang.String label, IViewer<VR> viewer, IVisualPart<VR,? extends VR> oldHovered, IVisualPart<VR,? extends VR> newHovered) Creates a new ChangeHoverOperation to set the given newHovered IVisualPart as the hovered part within the given IViewer.

Method Summary

Modifier and Type	Method and Description
IStatus	execute(IProgressMonitor monitor, IAdaptable info)
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

Field Detail

DEFAULT_LABEL

public static final java.lang.String DEFAULT_LABEL

 "change-hover"
 

The default label for this operation (i.e. used if no label is specified).

See Also:

Constant Field Values

Constructor Detail

ChangeHoverOperation

public ChangeHoverOperation(IViewer<VR> viewer,
                            IVisualPart<VR,? extends VR> newHovered)

Creates a new ChangeHoverOperation to set the given newHovered IVisualPart as the hovered part within the given IViewer.

Parameters:

viewer - The IViewer for which the HoverModel is to be changed.

newHovered - The IVisualPart which will be marked as hovered.

ChangeHoverOperation

public ChangeHoverOperation(IViewer<VR> viewer,
                            IVisualPart<VR,? extends VR> oldHovered,
                            IVisualPart<VR,? extends VR> newHovered)

Creates a new ChangeHoverOperation to set the given newHovered IVisualPart as the hovered part within the given IViewer. When undoing this operation, the given oldHovered IVisualPart will be set as the hovered part.

Parameters:

viewer - The IViewer for which the HoverModel is to be changed.

oldHovered - The IVisualPart which will be marked as hovered when undoing this operation.

newHovered - The IVisualPart which will be marked as hovered.

ChangeHoverOperation

public ChangeHoverOperation(java.lang.String label,
                            IViewer<VR> viewer,
                            IVisualPart<VR,? extends VR> oldHovered,
                            IVisualPart<VR,? extends VR> newHovered)

Creates a new ChangeHoverOperation to set the given newHovered IVisualPart as the hovered part within the given IViewer. When undoing this operation, the given oldHovered IVisualPart will be set as the hovered part. The given label is used as the label of the operation.

Parameters:

label - The operation's label.

viewer - The IViewer for which the HoverModel is to be changed.

oldHovered - The IVisualPart which will be marked as hovered when undoing this operation.

newHovered - The IVisualPart which will be marked as hovered.

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

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