1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/**********************************************************************
Copyright (c) 2000, 2002 IBM Corp. and others.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Common Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/cpl-v10.html
Contributors:
IBM Corporation - Initial implementation
**********************************************************************/
package org.eclipse.ui.texteditor;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IStatus;
/**
* Extension interface for <code>IDocumentProvider</code>. It adds the following
* functions:
* <ul>
* <li> dealing with immutable domain elements
* <li> state validation
* <li> persistent status of domain element operations
* <li> extended synchronization support
* </ul>
* @since 2.0
*/
public interface IDocumentProviderExtension {
/**
* Returns whether the document provider thinks that the given element is read-only.
* If this method returns <code>true</code>, <code>saveDocument</code> could fail.
* This method does not say anything about the document constructed from the given
* element. If the given element is not connected to this document provider, the return
* value 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.
*
* @param element the element
* @return <code>true</code> if the given element is read-only, <code>false</code> otherwise
*/
boolean isReadOnly(Object element);
/**
* Returns whether the document provider thinks that the given element can persistently be modified.
* This is orthogonal to <code>isReadOnly</code> 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.
*
* @param element the element
* @return <code>true</code> if the given element is modifiable, <code>false</code> otherwise
*/
boolean isModifiable(Object element);
/**
* Validates the state of the given element. This method may change the "real" state of the
* element. If using, it also updates the internal caches, so that this method may also change
* the results returned by <code>isReadOnly</code> and <code>isModifiable</code>. If the
* given element is not connected to this document provider, the effect is undefined.
*
* @param element the element
* @param computationContext the context in which the computation is performed, e.g., a SWT shell
* @exception CoreException if validating fails
*/
void validateState(Object element, Object computationContext) throws CoreException;
/**
* Returns whether the state of the given element has been validated.
*
* @param element the element
*/
boolean isStateValidated(Object element);
/**
* Updates the state cache for the given element. This method may change the result returned
* by <code>isReadOnly</code> and <code>isModifiable</code>. If the given element is not
* connected to this document provider, the effect is undefined.
*
* @param element the element
* @exception CoreException if validating fails
*/
void updateStateCache(Object element) throws CoreException;
/**
* Marks the document managed for the given element as saveable. I.e.
* <code>canBeSaved(element)</code> will return <code>true</code>
* afterwards.
*
* @param element the element
*/
void setCanSaveDocument(Object element);
/**
* Returns the status of the given element.
*
* @param element the element
* @return the status of the given element
*/
IStatus getStatus(Object element);
/**
* Synchronizes the document provided for the given element with the
* given element. After that call <code>getSynchronizationTimeStamp</code>
* and <code>getModificationTimeStamp</code> return the same value.
*
* @param element the element
* @exception CoreException if the synchronization could not be performed
*/
void synchronize(Object element) throws CoreException;
}
|
