| Method Summary |
|
| public void | aboutToChange(Object element)
The AbstractDocumentProvider implementation of this
IDocumentProvider method does nothing. |
| public void | addElementStateListener(IElementStateListener listener)
|
| protected void | addUnchangedElementListeners(Object element, ElementInfo info)
Called on initial creation and when the dirty state of the element
changes to false. |
| public boolean | canSaveDocument(Object element)
|
| public void | changed(Object element)
The AbstractDocumentProvider implementation of this
IDocumentProvider method does nothing. |
| final public void | connect(Object element)
|
| protected void | connected()
This hook method is called when this provider starts managing documents for
elements. |
| abstract protected IAnnotationModel | createAnnotationModel(Object element)
Creates an annotation model for the given element. |
| abstract protected IDocument | createDocument(Object element)
Creates the document for the given element. |
| protected ElementInfo | createElementInfo(Object element)
Creates a new element info object for the given element.
This method is called from connect when an element info needs
to be created. |
| final public void | disconnect(Object element)
|
| protected void | disconnected()
This hook method is called when this provider stops managing documents for
element. |
| protected void | disposeElementInfo(Object element, ElementInfo info)
Disposes of the given element info object.
This method is called when an element info is disposed. |
| protected void | doResetDocument(Object element, IProgressMonitor monitor)
Executes the actual work of reseting the given elements document. |
| abstract protected void | doSaveDocument(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite)
Performs the actual work of saving the given document provided for the
given element. |
| protected void | doSynchronize(Object element, IProgressMonitor monitor)
Performs the actual work of synchronizing the given element. |
| protected void | doUpdateStateCache(Object element)
Hook method for updating the state of the given element. |
| protected void | doValidateState(Object element, Object computationContext)
Hook method for validating the state of the given element. |
| protected void | executeOperation(DocumentProviderOperation operation, IProgressMonitor monitor)
Executes the given operation in the providers runnable context. |
| protected void | fireElementContentAboutToBeReplaced(Object element)
Informs all registered element state listeners about an impending
replace of the given element's content. |
| protected void | fireElementContentReplaced(Object element)
Informs all registered element state listeners about the just-completed
replace of the given element's content. |
| protected void | fireElementDeleted(Object element)
Informs all registered element state listeners about the deletion
of the given element. |
| protected void | fireElementDirtyStateChanged(Object element, boolean isDirty)
Informs all registered element state listeners about a change in the
dirty state of the given element. |
| protected void | fireElementMoved(Object originalElement, Object movedElement)
Informs all registered element state listeners about a move. |
| protected void | fireElementStateChangeFailed(Object element)
|
| protected void | fireElementStateChanging(Object element)
|
| protected void | fireElementStateValidationChanged(Object element, boolean isStateValidated)
Informs all registered element state listeners about a change in the
state validation of the given element. |
| public IAnnotationModel | getAnnotationModel(Object element)
|
| protected Iterator | getConnectedElements()
Enumerates the elements connected via this document provider. |
| public IContentType | getContentType(Object element)
|
| public IDocument | getDocument(Object element)
|
| protected ElementInfo | getElementInfo(Object element)
Returns the element info object for the given element. |
| public long | getModificationStamp(Object element)
|
| abstract protected IRunnableContext | getOperationRunner(IProgressMonitor monitor)
Returns the runnable context for this document provider. |
| public IProgressMonitor | getProgressMonitor()
|
| protected ISchedulingRule | getResetRule(Object element)
Returns the scheduling rule required for executing
reset on the given element. |
| protected ISchedulingRule | getSaveRule(Object element)
Returns the scheduling rule required for executing
save on the given element. |
| public IStatus | getStatus(Object element)
|
| public long | getSynchronizationStamp(Object element)
|
| protected ISchedulingRule | getSynchronizeRule(Object element)
Returns the scheduling rule required for executing
synchronize on the given element. |
| protected ISchedulingRule | getValidateStateRule(Object element)
Returns the scheduling rule required for executing
validateState on the given element. |
| protected boolean | invalidatesState(Object element, boolean wasReadOnly)
Returns whether the state of the element must be invalidated given its
previous read-only state. |
| public boolean | isDeleted(Object element)
|
| public boolean | isModifiable(Object element)
|
| public boolean | isNotSynchronizedException(Object element, CoreException ex)
|
| public boolean | isReadOnly(Object element)
|
| public boolean | isStateValidated(Object element)
Returns whether validateState has been called for the given element
since the element's state has potentially been invalidated. |
| public boolean | isSynchronized(Object element)
|
| public boolean | mustSaveDocument(Object element)
|
| public void | removeElementStateListener(IElementStateListener listener)
|
| protected void | removeUnchangedElementListeners(Object element, ElementInfo info)
Called when the given element gets dirty. |
| final public void | resetDocument(Object element)
|
| final public void | saveDocument(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite)
|
| public void | setCanSaveDocument(Object element)
|
| public void | setProgressMonitor(IProgressMonitor progressMonitor)
|
| final public void | synchronize(Object element)
|
| final public void | updateStateCache(Object element)
|
| public void | validateState(Object element, Object computationContext)
|
