|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDocumentEditor
An interface to be implemented by all the editors displaying a diagram
Method Summary | |
---|---|
void |
close(boolean save)
Closes this text editor after optionally saving changes. |
IDocumentProvider |
getDocumentProvider()
Returns this text editor's document provider. |
boolean |
isEditable()
Returns whether the text in this text editor can be changed by the user. |
boolean |
isEditorInputModifiable()
Returns whether the editor's input can be persistently be modified. |
boolean |
isEditorInputReadOnly()
Returns whether the editor's input is read-only. |
boolean |
validateEditorInputState()
Validates the state of the given editor input. |
Method Detail |
---|
IDocumentProvider getDocumentProvider()
null
if none, e.g. after closing the editorvoid close(boolean save)
save
- true
if unsaved changed should be saved, and
false
if unsaved changed should be discardedboolean isEditable()
true
if it can be edited, and false
if it is read-onlyboolean isEditorInputReadOnly()
isEditable
as it talks about the
editor input, i.e. the domain element, and not about the editor
document.
true
if the editor input is read-onlyboolean isEditorInputModifiable()
ITextEditorExtension.isEditorInputReadOnly
as read-only elements may be modifiable and
writable elements may not be modifiable. If the given element is not connected to this document
provider, the result is undefined. Document providers are allowed to use a cache to answer this
question, i.e. there can be a difference between the "real" state of the element and the return
value.
true
if the editor input is modifiableboolean validateEditorInputState()
true
if the input was validated, false
otherwise
|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp., Borland Software Corp., and others 2005,2006. All rights reserved.