org.eclipse.ui.ISaveablePart Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2000, 2015 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.ui;
import org.eclipse.core.runtime.IProgressMonitor;
/**
* Workbench parts implement or adapt to this interface to participate in the
* enablement and execution of the Save and Save As
* actions.
*
* @since 2.1
* @see org.eclipse.ui.IEditorPart
*/
public interface ISaveablePart {
/**
* The property id for isDirty.
*/
int PROP_DIRTY = IWorkbenchPartConstants.PROP_DIRTY;
/**
* Saves the contents of this part.
*
* If the save is successful, the part should fire a property changed event
* reflecting the new dirty state (PROP_DIRTY property).
*
*
* If the save is cancelled through user action, or for any other reason, the
* part should invoke setCancelled on the
* IProgressMonitor to inform the caller.
*
*
* This method is long-running; progress and cancellation are provided by the
* given progress monitor.
*
*
* @param monitor the progress monitor
*/
void doSave(IProgressMonitor monitor);
/**
* Saves the contents of this part to another object.
*
* Implementors are expected to open a "Save As" dialog where the user will be
* able to select a new name for the contents. After the selection is made, the
* contents should be saved to that new name. During this operation a
* IProgressMonitor should be used to indicate progress.
*
*
* If the save is successful, the part fires a property changed event reflecting
* the new dirty state (PROP_DIRTY property).
*
*/
void doSaveAs();
/**
* Returns whether the contents of this part have changed since the last save
* operation. If this value changes the part must fire a property listener event
* with PROP_DIRTY.
*
* Note: this method is called often on a part open or part activation
* switch, for example by actions to determine their enabled status.
*
*
* @return true if the contents have been modified and need saving,
* and false if they have not changed since the last save
*/
boolean isDirty();
/**
* Returns whether the "Save As" operation is supported by this part.
*
* @return true if "Save As" is supported, and false
* if not supported
*/
boolean isSaveAsAllowed();
/**
* Returns whether the contents of this part should be saved when the part is
* closed.
*
* @return true if the contents of the part should be saved on
* close, and false if the contents are expendable
*/
boolean isSaveOnCloseNeeded();
}