blob: 571de0a5e5bcf62c14b0acb848b3de7bc159c4d4 (
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
|
/*******************************************************************************
* Copyright (c) 2000, 2003 IBM Corporation 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 API and implementation
*******************************************************************************/
package org.eclipse.jface.text.presentation;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.ITypedRegion;
import org.eclipse.jface.text.TextPresentation;
/**
* Presentation repairers are used by a presentation reconciler
* to rebuild a damaged region in a document's presentation. A presentation repairer
* is assumed to be specific for a particular document content type. The presentation
* repairer gets the region which it should repair and constructs a "repair description"
* The presentation repairer adds the individual steps of this sequence into the
* text presentation it gets passed in.<p>
* This interface must either be implemented by clients or clients use the rule-based
* default implementation <code>RuleBasedDamagerRepairer</code>. Implementers should be
* registered with a presentation reconciler in order get involved in the reconciling
* process.
*
* @see IPresentationReconciler
* @see IDocument
* @see org.eclipse.swt.custom.StyleRange
* @see TextPresentation
*/
public interface IPresentationRepairer {
/**
* Tells the presentation repairer on which document it will work.
*
* @param document the damager's working document
*/
void setDocument(IDocument document);
/**
* Fills the given presentation with the style ranges which when applied to the
* presentation reconciler's text viewer repair the presentational damage described by
* the given region.
*
* @param presentation the text presentation to be filled by this repairer
* @param damage the damage to be repaired
*/
void createPresentation(TextPresentation presentation, ITypedRegion damage);
}
|
