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 Object
implements IDirtyStateProvider, IDisposable
A support class to handle the dirty state of a
WorkbenchPart that
uses an IOperationHistory and an IUndoContext.-
Property Summary
PropertiesTypePropertyDescriptionjavafx.beans.property.ReadOnlyBooleanPropertyA read-only property that provides the current dirty state. -
Constructor Summary
ConstructorsConstructorDescriptionHistoryBasedDirtyStateProvider(IOperationHistory operationHistory, IUndoContext undoContext) Creates a newHistoryBasedDirtyStateProvider. -
Method Summary
Modifier and TypeMethodDescriptionprotected IOperationHistoryListenerReturns theIOperationHistoryListenerthat is to be used to update the dirty state of this editor.javafx.beans.property.ReadOnlyBooleanPropertyA read-only property that provides the current dirty state.voiddispose()protected booleanisContentsRelated(IUndoableOperation operation) Tests whether the givenIUndoableOperationis relevant for the dirty-state of the editor.booleanisDirty()Gets the value of the property dirty.voidNotifies the provider to mark the current state as being unchanged with respect to the saved state.
-
Property Details
-
dirty
public javafx.beans.property.ReadOnlyBooleanProperty dirtyProperty- Specified by:
dirtyPropertyin interfaceIDirtyStateProvider- Returns:
- A read-only boolean property.
- See Also:
-
-
Constructor Details
-
HistoryBasedDirtyStateProvider
Creates a newHistoryBasedDirtyStateProvider.- Parameters:
operationHistory- TheIOperationHistoryto use.undoContext- TheIUndoContextto evaluate.
-
-
Method Details
-
createOperationHistoryListener
Returns theIOperationHistoryListenerthat is to be used to update the dirty state of this editor.- Returns:
- The
IOperationHistoryListenerthat is to be used to update the dirty state of this editor.
-
dirtyProperty
public javafx.beans.property.ReadOnlyBooleanProperty dirtyProperty()Description copied from interface:IDirtyStateProviderA read-only property that provides the current dirty state.- Specified by:
dirtyPropertyin interfaceIDirtyStateProvider- Returns:
- A read-only boolean property.
- See Also:
-
dispose
public void dispose()- Specified by:
disposein interfaceIDisposable
-
isContentsRelated
Tests whether the givenIUndoableOperationis relevant for the dirty-state of the editor.- Parameters:
operation- TheIUndoableOperationto test.- Returns:
trueif the operation encapsulates a dirty-state relevant change,falseotherwise.
-
isDirty
public boolean isDirty()Gets the value of the property dirty.- Specified by:
isDirtyin interfaceIDirtyStateProvider- Property description:
- Returns:
trueif the source is dirty,falseotherwise.
-
markNonDirty
public void markNonDirty()Description copied from interface:IDirtyStateProviderNotifies the provider to mark the current state as being unchanged with respect to the saved state.- Specified by:
markNonDirtyin interfaceIDirtyStateProvider
-