org.eclipse.gef4.mvc.operations

Class ChangeFocusOperation<VR>

java.lang.Object

org.eclipse.core.commands.operations.AbstractOperation

org.eclipse.gef4.mvc.operations.ChangeFocusOperation<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 ChangeFocusOperation<VR>
extends AbstractOperation

The ChangeFocusOperation can be used to change the FocusModel of an IViewer.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ChangeFocusOperation(IViewer<VR> viewer, IContentPart<VR,? extends VR> newFocused) Creates a new ChangeFocusOperation to assign focus to the given newFocused IContentPart within the given IViewer.
ChangeFocusOperation(IViewer<VR> viewer, IContentPart<VR,? extends VR> oldFocused, IContentPart<VR,? extends VR> newFocused) Creates a new ChangeFocusOperation to assign focus to the given newFocused IContentPart within the given IViewer.
ChangeFocusOperation(java.lang.String label, IViewer<VR> viewer, IContentPart<VR,? extends VR> oldFocused, IContentPart<VR,? extends VR> newFocused) Creates a new ChangeFocusOperation to assign focus to the given newFocused IContentPart 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-focus"
 

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

See Also:

Constant Field Values

Constructor Detail

ChangeFocusOperation

public ChangeFocusOperation(IViewer<VR> viewer,
                            IContentPart<VR,? extends VR> newFocused)

Creates a new ChangeFocusOperation to assign focus to the given newFocused IContentPart within the given IViewer.

Parameters:

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

newFocused - The IContentPart to which focus will be assigned.

ChangeFocusOperation

public ChangeFocusOperation(IViewer<VR> viewer,
                            IContentPart<VR,? extends VR> oldFocused,
                            IContentPart<VR,? extends VR> newFocused)

Creates a new ChangeFocusOperation to assign focus to the given newFocused IContentPart within the given IViewer. When the operation is undone, focus is assigned to the given oldFocused IContentPart.

Parameters:

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

oldFocused - The IContentPart to which focus will be assigned when undoing this operation.

newFocused - The IContentPart to which focus will be assigned.

ChangeFocusOperation

public ChangeFocusOperation(java.lang.String label,
                            IViewer<VR> viewer,
                            IContentPart<VR,? extends VR> oldFocused,
                            IContentPart<VR,? extends VR> newFocused)

Creates a new ChangeFocusOperation to assign focus to the given newFocused IContentPart within the given IViewer. When the operation is undone, focus is assigned to the given oldFocused IContentPart. The given label is used as the label for the operation.

Parameters:

label - The operation's label.

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

oldFocused - The IContentPart to which focus will be assigned when undoing this operation.

newFocused - The IContentPart to which focus will be assigned.

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