blob: 4039cb96a940160c0e57fe604c965a1791584d56 (
plain) (
blame)
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
|
/*******************************************************************************
* Copyright (c) 2000, 2005 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jface.text.presentation;
import org.eclipse.jface.text.DocumentEvent;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.IRegion;
import org.eclipse.jface.text.ITypedRegion;
/**
* A presentation damager is a strategy used by a presentation reconciler to
* determine the region of the document's presentation which must be rebuilt
* because of a document change. A presentation damager is assumed to be
* specific for a particular document content type. A presentation damager is
* expected to return a damage region which is a valid input for a presentation
* repairer. I.e. having access to the damage region only the repairer must be
* able to derive all the information needed to successfully repair this region.
* <p>
* This interface must either be implemented by clients or clients use the
* rule-based default implementation
* {@link org.eclipse.jface.text.rules.DefaultDamagerRepairer}. Implementers
* should be registered with a presentation reconciler in order get involved in
* the reconciling process.</p>
*
* @see IPresentationReconciler
* @see IDocument
* @see DocumentEvent
* @see IPresentationRepairer
*/
public interface IPresentationDamager {
/**
* Tells the presentation damager on which document it will work.
*
* @param document the damager's working document
*/
void setDocument(IDocument document);
/**
* Returns the damage in the document's presentation caused by the given document change.
* The damage is restricted to the specified partition for which the presentation damager is
* responsible. The damage may also depend on whether the document change also caused changes
* of the document's partitioning.
*
* @param partition the partition inside which the damage must be determined
* @param event the event describing the change whose damage must be determined
* @param documentPartitioningChanged indicates whether the given change changed the document's partitioning
* @return the computed damage
*/
IRegion getDamageRegion(ITypedRegion partition, DocumentEvent event, boolean documentPartitioningChanged);
}
|
