Package org.eclipse.gef.mvc.fx.ui.parts
Class HistoryBasedDirtyStateProvider
- java.lang.Object
-
- org.eclipse.gef.mvc.fx.ui.parts.HistoryBasedDirtyStateProvider
-
- All Implemented Interfaces:
IDirtyStateProvider
,IDisposable
public class HistoryBasedDirtyStateProvider extends java.lang.Object implements IDirtyStateProvider, IDisposable
A support class to handle the dirty state of aWorkbenchPart
that uses anIOperationHistory
and anIUndoContext
.
-
-
Constructor Summary
Constructors Constructor Description HistoryBasedDirtyStateProvider(IOperationHistory operationHistory, IUndoContext undoContext)
Creates a newHistoryBasedDirtyStateProvider
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected IOperationHistoryListener
createOperationHistoryListener()
Returns theIOperationHistoryListener
that is to be used to update the dirty state of this editor.javafx.beans.property.ReadOnlyBooleanProperty
dirtyProperty()
A read-only property that provides the current dirty state.void
dispose()
protected boolean
isContentsRelated(IUndoableOperation operation)
Tests whether the givenIUndoableOperation
is relevant for the dirty-state of the editor.boolean
isDirty()
Returns the dirty state of this support.void
markNonDirty()
Notifies the provider to mark the current state as being unchanged with respect to the saved state.
-
-
-
Constructor Detail
-
HistoryBasedDirtyStateProvider
public HistoryBasedDirtyStateProvider(IOperationHistory operationHistory, IUndoContext undoContext)
Creates a newHistoryBasedDirtyStateProvider
.- Parameters:
operationHistory
- TheIOperationHistory
to use.undoContext
- TheIUndoContext
to evaluate.
-
-
Method Detail
-
createOperationHistoryListener
protected IOperationHistoryListener createOperationHistoryListener()
Returns theIOperationHistoryListener
that is to be used to update the dirty state of this editor.- Returns:
- The
IOperationHistoryListener
that is to be used to update the dirty state of this editor.
-
dirtyProperty
public javafx.beans.property.ReadOnlyBooleanProperty dirtyProperty()
Description copied from interface:IDirtyStateProvider
A read-only property that provides the current dirty state.- Specified by:
dirtyProperty
in interfaceIDirtyStateProvider
- Returns:
- A read-only boolean property.
-
dispose
public void dispose()
- Specified by:
dispose
in interfaceIDisposable
-
isContentsRelated
protected boolean isContentsRelated(IUndoableOperation operation)
Tests whether the givenIUndoableOperation
is relevant for the dirty-state of the editor.- Parameters:
operation
- TheIUndoableOperation
to test.- Returns:
true
if the operation encapsulates a dirty-state relevant change,false
otherwise.
-
isDirty
public boolean isDirty()
Description copied from interface:IDirtyStateProvider
Returns the dirty state of this support.- Specified by:
isDirty
in interfaceIDirtyStateProvider
- Returns:
true
if the source is dirty,false
otherwise.
-
markNonDirty
public void markNonDirty()
Description copied from interface:IDirtyStateProvider
Notifies the provider to mark the current state as being unchanged with respect to the saved state.- Specified by:
markNonDirty
in interfaceIDirtyStateProvider
-
-