com.ibm.productivity.tools.ui.views.operations
Interface CloseOperation

All Superinterfaces:
Operation

public interface CloseOperation
extends Operation

Defines the operation to close a document in RichDocumentView.

Since:
8.0.1

Method Summary
 boolean isPrompt()
          Gets whether there is a dialog to prompt the client when the document in RichDocumentView is modified before closing.
 void setPrompt(boolean prompt)
          Sets whether there is a dialog to prompt the client when the document in RichDocumentView is modified before closing.
 

Method Detail

isPrompt

boolean isPrompt()
Gets whether there is a dialog to prompt the client when the document in RichDocumentView is modified before closing.


If the value is true, it means that when the operation is started and if the document is modified, a window displays to prompt the user to save the document.


Returns:
true if there should be a prompt before closing, false otherwise

setPrompt

void setPrompt(boolean prompt)
Sets whether there is a dialog to prompt the client when the document in RichDocumentView is modified before closing.


If the value is true, it means that when the operation is started and if the document is modified, a window displays to prompt the user to save the document.


The user can set the value before the operation is started.


Parameters:
prompt - true when there should be a prompt before closing, false otherwise