001: /*******************************************************************************
002: * Copyright (c) 2000, 2005 IBM Corporation and others.
003: * All rights reserved. This program and the accompanying materials
004: * are made available under the terms of the Eclipse Public License v1.0
005: * which accompanies this distribution, and is available at
006: * http://www.eclipse.org/legal/epl-v10.html
007: *
008: * Contributors:
009: * IBM Corporation - initial API and implementation
010: *******************************************************************************/package org.eclipse.jface.text.presentation;
011:
012: import org.eclipse.jface.text.ITextViewer;
013:
014: /**
015: * An <code>IPresentationReconciler</code> defines and maintains the
016: * representation of a text viewer's document in the presence of changes applied
017: * to the document. An <code>IPresentationReconciler</code> is a
018: * <code>ITextViewer</code> add-on.
019: * <p>
020: * The presentation reconciler keeps track of changes applied to the text
021: * viewer. It sends each change to presentation damagers which are registered
022: * for the content types of the regions in which the change occurred. The
023: * presentation reconciler passes the computed damage to presentation repairer
024: * which construct text presentations. When applied to the presentation
025: * reconciler's text viewer, those text presentations bring the document's
026: * presentation in sync with the document's content and thus repair the damage.
027: * A presentation damager is expected to return damage which is a valid input
028: * for a presentation repairer registered for the same content type as the
029: * damager.
030: * </p>
031: * <p>
032: * A presentation reconciler should always be configured with a pair of
033: * damager/repairer strategies. I.e. for each damager there should be a
034: * corresponding repairer.
035: * </p>
036: * <p>
037: * The interface may be implemented by clients. Clients may use
038: * <code>PresentationReconciler</code> as the standard implementation of this
039: * interface.
040: * </p>
041: * <p>
042: * In order to provided backward compatibility for clients of
043: * <code>IPresentationReconciler</code>, extension interfaces are used to
044: * provide a means of evolution. The following extension interface exists:
045: * <ul>
046: * <li>
047: * {@link org.eclipse.jface.text.presentation.IPresentationReconcilerExtension}
048: * since version 3.0 adding support for documents with multiple partitionings.
049: * </li>
050: * </ul>
051: * </p>
052: *
053: * @see org.eclipse.jface.text.presentation.IPresentationReconcilerExtension
054: * @see org.eclipse.jface.text.ITextViewer
055: * @see org.eclipse.jface.text.presentation.IPresentationDamager
056: * @see org.eclipse.jface.text.presentation.IPresentationRepairer
057: * @see org.eclipse.jface.text.TextPresentation
058: */
059: public interface IPresentationReconciler {
060:
061: /**
062: * Installs this presentation reconciler on the given text viewer. After
063: * this method has been finished, the reconciler is operational. I.e., it
064: * works without requesting further client actions until
065: * <code>uninstall</code> is called.
066: * <p>
067: * The <code>install</code> and <code>uninstall</code> methods must be
068: * called in sequence; i.e. repeatedly calling <code>install</code>
069: * without calling <code>uninstall</code> may throw an exception.
070: * </p>
071: *
072: * @param viewer the viewer on which this presentation reconciler is
073: * installed
074: */
075: void install(ITextViewer viewer);
076:
077: /**
078: * Removes the reconciler from the text viewer it has previously been
079: * installed on.
080: */
081: void uninstall();
082:
083: /**
084: * Returns the presentation damager registered with this presentation reconciler
085: * for the specified content type.
086: *
087: * @param contentType the content type for which to determine the damager
088: * @return the presentation damager registered for the given content type, or
089: * <code>null</code> if there is no damager
090: */
091: IPresentationDamager getDamager(String contentType);
092:
093: /**
094: * Returns the presentation repairer registered with this presentation reconciler
095: * for the specified content type.
096: *
097: * @param contentType the content type for which to determine the repairer
098: * @return the presentation repairer registered for the given content type, or
099: * <code>null</code> if there is no repairer
100: */
101: IPresentationRepairer getRepairer(String contentType);
102: }
|